project/lib/validation/validator.js

  1. const path = require("path");
  2. const {promisify} = require("util");
  3. const readFile = promisify(require("fs").readFile);
  5. async function loadSchema(schemaPath) {
  6. 	const filePath = schemaPath.replace("http://ui5.sap/schema/", "");
  7. 	const schemaFile = await readFile(path.join(__dirname, "schema", filePath), {encoding: "utf8"});
  8. 	return JSON.parse(schemaFile);
  9. }
  11. /**
  12.  * @private
  13.  * @memberof module:@ui5/project.validation
  14.  */
  15. class Validator {
  16. 	constructor() {
  17. 		const Ajv = require("ajv");
  18. 		this.ajv = new Ajv({
  19. 			allErrors: true,
  20. 			jsonPointers: true,
  21. 			loadSchema
  22. 		});
  23. 		const ajvErrors = require("ajv-errors");
  24. 		ajvErrors(this.ajv);
  25. 	}
  27. 	_compileSchema() {
  28. 		if (!this._compiling) {
  29. 			this._compiling = Promise.resolve().then(async () => {
  30. 				const schema = await loadSchema("ui5.json");
  31. 				const validate = await this.ajv.compileAsync(schema);
  32. 				return validate;
  33. 			});
  34. 		}
  35. 		return this._compiling;
  36. 	}
  38. 	async validate({config, project, yaml}) {
  39. 		const fnValidate = await this._compileSchema();
  40. 		const valid = fnValidate(config);
  41. 		if (!valid) {
  42. 			const ValidationError = require("./ValidationError");
  43. 			throw new ValidationError({
  44. 				errors: fnValidate.errors,
  45. 				schema: fnValidate.schema,
  46. 				project,
  47. 				yaml
  48. 			});
  49. 		}
  50. 	}
  51. }
  53. let validator;
  55. /**
  56.  * @public
  57.  * @namespace
  58.  * @alias module:@ui5/project.validation.validator
  59.  */
  60. module.exports = {
  61. 	/**
  62. 	 * Validates the given configuration.
  63. 	 *
  64. 	 * @param {object} options
  65. 	 * @param {object} options.config UI5 Configuration to validate
  66. 	 * @param {object} options.project Project information
  67. 	 * @param {string} options.project.id ID of the project
  68. 	 * @param {object} [options.yaml] YAML information
  69. 	 * @param {string} options.yaml.path Path of the YAML file
  70. 	 * @param {string} options.yaml.source Content of the YAML file
  71. 	 * @param {number} [options.yaml.documentIndex=0] Document index in case the YAML file contains multiple documents
  72. 	 * @throws {module:@ui5/project.validation.ValidationError}
  73. 	 *   Rejects with a {@link module:@ui5/project.validation.ValidationError ValidationError}
  74. 	 *   when the validation fails.
  75. 	 * @returns {Promise<undefined>} Returns a Promise that resolves when the validation succeeds
  76. 	 * @public
  77. 	 */
  78. 	validate: async (options) => {
  79. 		if (!validator) {
  80. 			validator = new Validator();
  81. 		}
  82. 		await validator.validate(options);
  83. 	},
  84. 	_Validator: Validator // For testing only
  85. };