[FIX] Schema: Add missing metadata properties

matz3 · matz3 · commit 16894e11c5c2 · 2020-04-02T18:44:49.000+02:00
Also refactored the schema to only test and validate the metadata where
required.
diff --git a/lib/validation/schema/specVersion/2.0.json b/lib/validation/schema/specVersion/2.0.json
@@ -3,15 +3,12 @@
 	"$id": "http://ui5.sap/schema/specVersion/2.0.json",
 
 	"type": "object",
-	"required": ["specVersion", "metadata"],
+	"required": ["specVersion"],
 	"properties": {
 		"specVersion": { "enum": ["2.0"] },
 		"kind": {
 			"enum": ["project", "extension", null],
 			"$comment": "Using null to allow not defining 'kind' which defaults to project"
-		},
-		"metadata": {
-			"$ref": "../ui5.json#/definitions/metadata"
 		}
 	},
 	"if": {
diff --git a/lib/validation/schema/specVersion/2.0/kind/extension.json b/lib/validation/schema/specVersion/2.0/kind/extension.json
@@ -17,7 +17,7 @@
 			]
 		},
 		"metadata": {
-			"$ref": "../../../ui5.json#/definitions/metadata"
+			"$ref": "#/definitions/metadata"
 		}
 	},
 	"if": {
@@ -56,5 +56,20 @@
 				}
 			}
 		}
+	},
+	"definitions": {
+		"metadata": {
+			"type": "object",
+			"required": ["name"],
+			"additionalProperties": false,
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"copyright": {
+					"type": "string"
+				}
+			}
+		}
 	}
 }
diff --git a/lib/validation/schema/specVersion/2.0/kind/extension/project-shim.json b/lib/validation/schema/specVersion/2.0/kind/extension/project-shim.json
@@ -14,7 +14,7 @@
 			"enum": ["project-shim"]
 		},
 		"metadata": {
-			"$ref": "../../../../ui5.json#/definitions/metadata"
+			"$ref": "../extension.json#/definitions/metadata"
 		},
 		"shims": {
 			"type": "object",
diff --git a/lib/validation/schema/specVersion/2.0/kind/extension/server-middleware.json b/lib/validation/schema/specVersion/2.0/kind/extension/server-middleware.json
@@ -14,7 +14,7 @@
 			"enum": ["server-middleware"]
 		},
 		"metadata": {
-			"$ref": "../../../../ui5.json#/definitions/metadata"
+			"$ref": "../extension.json#/definitions/metadata"
 		},
 		"middleware": {
 			"type": "object",
diff --git a/lib/validation/schema/specVersion/2.0/kind/extension/task.json b/lib/validation/schema/specVersion/2.0/kind/extension/task.json
@@ -14,7 +14,7 @@
 			"enum": ["task"]
 		},
 		"metadata": {
-			"$ref": "../../../../ui5.json#/definitions/metadata"
+			"$ref": "../extension.json#/definitions/metadata"
 		},
 		"task": {
 			"type": "object",
diff --git a/lib/validation/schema/specVersion/2.0/kind/project.json b/lib/validation/schema/specVersion/2.0/kind/project.json
@@ -3,7 +3,7 @@
 	"$id": "http://ui5.sap/schema/specVersion/2.0/kind/project.json",
 
 	"type": "object",
-	"required": ["specVersion", "type", "metadata"],
+	"required": ["specVersion", "type"],
 	"properties": {
 		"specVersion": { "enum": ["2.0"] },
 		"kind": {
@@ -17,9 +17,6 @@
 				"theme-library",
 				"module"
 			]
-		},
-		"metadata": {
-			"$ref": "../../../ui5.json#/definitions/metadata"
 		}
 	},
 	"if": {
@@ -71,6 +68,31 @@
 	},
 
 	"definitions": {
+		"metadata": {
+			"type": "object",
+			"required": ["name"],
+			"additionalProperties": false,
+			"properties": {
+				"name": {
+					"type": "string"
+				},
+				"copyright": {
+					"type": "string"
+				},
+				"deprecated": {
+					"type": "boolean",
+					"default": false
+				},
+				"sapInternal": {
+					"type": "boolean",
+					"default": false
+				},
+				"allowSapInternal": {
+					"type": "boolean",
+					"default": false
+				}
+			}
+		},
 		"resources-configuration-propertiesFileSourceEncoding": {
 			"enum": ["UTF-8", "ISO-8859-1"],
 			"default": "UTF-8",
diff --git a/lib/validation/schema/specVersion/2.0/kind/project/application.json b/lib/validation/schema/specVersion/2.0/kind/project/application.json
@@ -14,7 +14,7 @@
 			"enum": ["application"]
 		},
 		"metadata": {
-			"$ref": "../../../../ui5.json#/definitions/metadata"
+			"$ref": "../project.json#/definitions/metadata"
 		},
 		"framework": {
 			"$ref": "../project.json#/definitions/framework"
diff --git a/lib/validation/schema/specVersion/2.0/kind/project/library.json b/lib/validation/schema/specVersion/2.0/kind/project/library.json
@@ -14,7 +14,7 @@
 			"enum": ["library"]
 		},
 		"metadata": {
-			"$ref": "../../../../ui5.json#/definitions/metadata"
+			"$ref": "../project.json#/definitions/metadata"
 		},
 		"framework": {
 			"$ref": "../project.json#/definitions/framework"
diff --git a/lib/validation/schema/specVersion/2.0/kind/project/module.json b/lib/validation/schema/specVersion/2.0/kind/project/module.json
@@ -14,7 +14,7 @@
 			"enum": ["module"]
 		},
 		"metadata": {
-			"$ref": "../../../../ui5.json#/definitions/metadata"
+			"$ref": "../project.json#/definitions/metadata"
 		},
 		"resources": {
 			"type": "object",
diff --git a/lib/validation/schema/specVersion/2.0/kind/project/theme-library.json b/lib/validation/schema/specVersion/2.0/kind/project/theme-library.json
@@ -14,7 +14,7 @@
 			"enum": ["theme-library"]
 		},
 		"metadata": {
-			"$ref": "../../../../ui5.json#/definitions/metadata"
+			"$ref": "../project.json#/definitions/metadata"
 		},
 		"framework": {
 			"$ref": "../project.json#/definitions/framework"
diff --git a/lib/validation/schema/ui5.json b/lib/validation/schema/ui5.json
@@ -34,22 +34,5 @@
 		"then": {
 			"additionalProperties": true
 		}
-	},
-
-	"definitions": {
-
-		"metadata": {
-			"type": "object",
-			"required": ["name"],
-			"additionalProperties": false,
-			"properties": {
-				"name": {
-					"type": "string"
-				},
-				"copyright": {
-					"type": "string"
-				}
-			}
-		}
 	}
 }
diff --git a/test/lib/validation/ValidationError.js b/test/lib/validation/ValidationError.js
@@ -841,7 +841,7 @@ test.serial("ValidationError.formatMessage: keyword=required", (t) => {
 	const error = {
 		keyword: "required",
 		dataPath: "/metadata",
-		schemaPath: "../ui5.json#/definitions/metadata/required",
+		schemaPath: "#/definitions/metadata/required",
 		params: {missingProperty: "name"},
 		message: "should have required property 'name'"
 	};
diff --git a/test/lib/validation/schema/specVersion/2.0/kind/project.js b/test/lib/validation/schema/specVersion/2.0/kind/project.js
@@ -26,8 +26,8 @@ test.before((t) => {
 test.after.always((t) => {
 	t.context.ajvCoverage.createReport("html", {dir: "coverage/ajv-project"});
 	const thresholds = {
-		statements: 90,
-		branches: 80,
+		statements: 85,
+		branches: 75,
 		functions: 100,
 		lines: 90
 	};
@@ -194,112 +194,3 @@ test("No specVersion", async (t) => {
 		schemaPath: "#/required",
 	}]);
 });
-
-test("No metadata", async (t) => {
-	await assertValidation(t, {
-		"specVersion": "2.0",
-		"type": "application"
-	}, [{
-		dataPath: "",
-		keyword: "required",
-		message: "should have required property 'metadata'",
-		params: {
-			missingProperty: "metadata",
-		},
-		schemaPath: "#/required",
-	}]);
-});
-
-test("Metadata not type object", async (t) => {
-	await assertValidation(t, {
-		"specVersion": "2.0",
-		"type": "application",
-		"metadata": "foo"
-	}, [{
-		dataPath: "/metadata",
-		keyword: "type",
-		message: "should be object",
-		params: {
-			type: "object",
-		},
-		schemaPath: "../ui5.json#/definitions/metadata/type",
-	}]);
-});
-
-test("No metadata.name", async (t) => {
-	await assertValidation(t, {
-		"specVersion": "2.0",
-		"type": "application",
-		"metadata": {}
-	}, [{
-		dataPath: "/metadata",
-		keyword: "required",
-		message: "should have required property 'name'",
-		params: {
-			missingProperty: "name",
-		},
-		schemaPath: "../ui5.json#/definitions/metadata/required",
-	}]);
-});
-
-test("Invalid metadata.name", async (t) => {
-	await assertValidation(t, {
-		"specVersion": "2.0",
-		"type": "application",
-		"metadata": {
-			"name": {}
-		}
-	}, [
-		{
-			dataPath: "/metadata/name",
-			keyword: "type",
-			message: "should be string",
-			params: {
-				type: "string"
-			},
-			schemaPath: "../ui5.json#/definitions/metadata/properties/name/type",
-		}
-	]);
-});
-
-test("Invalid metadata.copyright", async (t) => {
-	await assertValidation(t, {
-		"specVersion": "2.0",
-		"type": "application",
-		"metadata": {
-			"name": "foo",
-			"copyright": 123
-		}
-	}, [
-		{
-			dataPath: "/metadata/copyright",
-			keyword: "type",
-			message: "should be string",
-			params: {
-				type: "string"
-			},
-			schemaPath: "../ui5.json#/definitions/metadata/properties/copyright/type",
-		}
-	]);
-});
-
-test("Additional metadata property", async (t) => {
-	await assertValidation(t, {
-		"specVersion": "2.0",
-		"type": "application",
-		"metadata": {
-			"name": "foo",
-			"copyrihgt": "typo"
-		}
-	}, [
-		{
-			dataPath: "/metadata",
-			keyword: "additionalProperties",
-			message: "should NOT have additional properties",
-			params: {
-				additionalProperty: "copyrihgt"
-			},
-			schemaPath: "../ui5.json#/definitions/metadata/additionalProperties",
-		}
-	]);
-});
diff --git a/test/lib/validation/schema/specVersion/2.0/kind/project/application.js b/test/lib/validation/schema/specVersion/2.0/kind/project/application.js
diff --git a/test/lib/validation/schema/specVersion/2.0/kind/project/library.js b/test/lib/validation/schema/specVersion/2.0/kind/project/library.js
diff --git a/test/lib/validation/schema/specVersion/2.0/kind/project/module.js b/test/lib/validation/schema/specVersion/2.0/kind/project/module.js
diff --git a/test/lib/validation/schema/specVersion/2.0/kind/project/theme-library.js b/test/lib/validation/schema/specVersion/2.0/kind/project/theme-library.js
diff --git a/test/lib/validation/schema/ui5.js b/test/lib/validation/schema/ui5.js

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`]`
`18`	`18`	`},`
`19`	`19`	`"metadata": {`
`20`		`- "$ref": "../../../ui5.json#/definitions/metadata"`
	`20`	`+ "$ref": "#/definitions/metadata"`
`21`	`21`	`}`
`22`	`22`	`},`
`23`	`23`	`"if": {`
`@@ -56,5 +56,20 @@`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`	`}`
	`59`	`+ },`
	`60`	`+ "definitions": {`
	`61`	`+ "metadata": {`
	`62`	`+ "type": "object",`
	`63`	`+ "required": ["name"],`
	`64`	`+ "additionalProperties": false,`
	`65`	`+ "properties": {`
	`66`	`+ "name": {`
	`67`	`+ "type": "string"`
	`68`	`+ },`
	`69`	`+ "copyright": {`
	`70`	`+ "type": "string"`
	`71`	`+ }`
	`72`	`+ }`
	`73`	`+ }`
`59`	`74`	`}`
`60`	`75`	`}`