[INTERNAL] Schema: Update error messages / fix framework schema

Author: matz3

lib/validation/ValidationError.js

@@ -79,13 +79,16 @@ class ValidationError extends Error {
 
 		switch (error.keyword) {
 		case "additionalProperties":
-			message += `property ${error.params.additionalProperty} is not expected to be here`;
+			message += `property ${error.params.additionalProperty} must not be provided here`;
 			break;
 		case "type":
-			message += `should be of type '${error.params.type}'`;
+			message += `must be of type '${error.params.type}'`;
+			break;
+		case "required":
+			message += `must have required property '${error.params.missingProperty}'`;
 			break;
 		case "enum":
-			message += error.message + "\n";
+			message += "must be equal to one of the allowed values\n";
 			message += "Allowed values: " + error.params.allowedValues.join(", ");
 			break;
 		default:

lib/validation/schema/specVersion/2.0/kind/project.json

@@ -256,7 +256,7 @@
 		"framework": {
 			"type": "object",
 			"additionalProperties": false,
-			"required": ["name", "version"],
+			"required": ["name"],
 			"properties": {
 				"name": {
 					"enum": ["OpenUI5", "SAPUI5"]

test/lib/extensions.js

@@ -154,7 +154,7 @@ test("Project with project-shim extension with invalid dependency configuration"
 	const validationError = await t.throwsAsync(projectPreprocessor.processTree(tree), {
 		instanceOf: ValidationError
 	});
-	t.true(validationError.message.includes("Configuration should have required property 'metadata'"),
+	t.true(validationError.message.includes("Configuration must have required property 'metadata'"),
 		"ValidationError should contain error about missing metadata configuration");
 });
 

test/lib/validation/ValidationError.js

@@ -797,7 +797,7 @@ test.serial("ValidationError.formatMessage: keyword=type dataPath=", (t) => {
 		schemaPath: "#/type",
 	};
 
-	const expectedErrorMessage = "Configuration should be of type 'object'";
+	const expectedErrorMessage = "Configuration must be of type 'object'";
 
 	const errorMessage = ValidationError.formatMessage(error);
 	t.is(errorMessage, expectedErrorMessage);
@@ -814,7 +814,7 @@ test.serial("ValidationError.formatMessage: keyword=type", (t) => {
 		schemaPath: "#/type",
 	};
 
-	const expectedErrorMessage = `Configuration ${chalk.underline(chalk.red("foo"))} should be of type 'object'`;
+	const expectedErrorMessage = `Configuration ${chalk.underline(chalk.red("foo"))} must be of type 'object'`;
 
 	const errorMessage = ValidationError.formatMessage(error);
 	t.is(errorMessage, expectedErrorMessage);
@@ -831,7 +831,7 @@ test.serial("ValidationError.formatMessage: keyword=required w/o dataPath", (t)
 		schemaPath: "#/required",
 	};
 
-	const expectedErrorMessage = "Configuration should have required property 'specVersion'";
+	const expectedErrorMessage = "Configuration must have required property 'specVersion'";
 
 	const errorMessage = ValidationError.formatMessage(error);
 	t.is(errorMessage, expectedErrorMessage);
@@ -846,7 +846,7 @@ test.serial("ValidationError.formatMessage: keyword=required", (t) => {
 		message: "should have required property 'name'"
 	};
 
-	const expectedErrorMessage = `Configuration ${chalk.underline(chalk.red("metadata"))} should have required property 'name'`;
+	const expectedErrorMessage = `Configuration ${chalk.underline(chalk.red("metadata"))} must have required property 'name'`;
 
 	const errorMessage = ValidationError.formatMessage(error);
 	t.is(errorMessage, expectedErrorMessage);
@@ -902,7 +902,7 @@ test.serial("ValidationError.formatMessage: keyword=additionalProperties", (t) =
 	};
 
 	const expectedErrorMessage =
-`Configuration ${chalk.underline(chalk.red("resources/configuration"))} property propertiesFileEncoding is not expected to be here`;
+`Configuration ${chalk.underline(chalk.red("resources/configuration"))} property propertiesFileEncoding must not be provided here`;
 
 	const errorMessage = ValidationError.formatMessage(error);
 	t.is(errorMessage, expectedErrorMessage);
@@ -920,7 +920,7 @@ test.serial("ValidationError.formatMessage: keyword=enum", (t) => {
 	};
 
 	const expectedErrorMessage =
-`Configuration ${chalk.underline(chalk.red("type"))} should be equal to one of the allowed values
+`Configuration ${chalk.underline(chalk.red("type"))} must be equal to one of the allowed values
 Allowed values: application, library, theme-library, module`;
 
 	const errorMessage = ValidationError.formatMessage(error);

test/lib/validation/schema/specVersion/2.0/kind/project/application.js

@@ -630,3 +630,24 @@ test("framework configuration: Invalid", async (t) => {
 		}
 	]);
 });
+
+test("framework configuration: Missing 'name'", async (t) => {
+	await assertValidation(t, {
+		"specVersion": "2.0",
+		"type": "application",
+		"metadata": {
+			"name": "my-application"
+		},
+		"framework": {}
+	}, [
+		{
+			dataPath: "/framework",
+			keyword: "required",
+			message: "should have required property 'name'",
+			params: {
+				missingProperty: "name"
+			},
+			schemaPath: "../project.json#/definitions/framework/required",
+		}
+	]);
+});

test/lib/validation/schema/specVersion/2.0/kind/project/library.js

@@ -702,3 +702,24 @@ test("framework configuration: Invalid", async (t) => {
 		}
 	]);
 });
+
+test("framework configuration: Missing 'name'", async (t) => {
+	await assertValidation(t, {
+		"specVersion": "2.0",
+		"type": "library",
+		"metadata": {
+			"name": "my-library"
+		},
+		"framework": {}
+	}, [
+		{
+			dataPath: "/framework",
+			keyword: "required",
+			message: "should have required property 'name'",
+			params: {
+				missingProperty: "name"
+			},
+			schemaPath: "../project.json#/definitions/framework/required",
+		}
+	]);
+});