[FEATURE] specVersion 2.2 (#341)

- Allows custom task extensions to use the new `taskUtil` API. - No structural changes to the ui5.yaml schema RFC: SAP/ui5-tooling#243
SAP · Aug 11, 2020 · f44d14e · f44d14e
1 parent 29e1710
commit f44d14e
Show file tree

Hide file tree

Showing 25 changed files with 151 additions and 191 deletions.
diff --git a/lib/projectPreprocessor.js b/lib/projectPreprocessor.js
@@ -278,7 +278,7 @@ class ProjectPreprocessor {
 
 		if (project.specVersion !== "0.1" && project.specVersion !== "1.0" &&
 			project.specVersion !== "1.1" && project.specVersion !== "2.0" &&
-			project.specVersion !== "2.1") {
+			project.specVersion !== "2.1" && project.specVersion !== "2.2") {
 			throw new Error(
 				`Unsupported specification version ${project.specVersion} defined for project ` +
 				`${project.id}. Your UI5 CLI installation might be outdated. ` +
@@ -354,7 +354,8 @@ class ProjectPreprocessor {
 				extension.specVersion !== "1.0" &&
 				extension.specVersion !== "1.1" &&
 				extension.specVersion !== "2.0" &&
-				extension.specVersion !== "2.1") {
+				extension.specVersion !== "2.1" &&
+				extension.specVersion !== "2.2") {
 			throw new Error(
 				`Unsupported specification version ${extension.specVersion} defined for extension ` +
 				`${extension.metadata.name}. Your UI5 CLI installation might be outdated. ` +

diff --git a/lib/translators/ui5Framework.js b/lib/translators/ui5Framework.js
@@ -83,7 +83,7 @@ const utils = {
 		if (!project.framework) {
 			return;
 		}
-		if (project.specVersion !== "2.0" && project.specVersion !== "2.1") {
+		if (project.specVersion !== "2.0" && project.specVersion !== "2.1" && project.specVersion !== "2.2") {
 			log.warn(`Project ${project.metadata.name} defines invalid ` +
 				`specification version ${project.specVersion} for framework.libraries configuration`);
 			return;
@@ -239,7 +239,7 @@ module.exports = {
 			});
 			queue.push(...project.dependencies);
 
-			if ((project.specVersion === "2.0" || project.specVersion === "2.1") &&
+			if ((project.specVersion === "2.0" || project.specVersion === "2.1" || project.specVersion === "2.2") &&
 					project.framework && project.framework.libraries) {
 				const frameworkDeps = project.framework.libraries
 					.filter((dependency) => {

diff --git a/lib/validation/schema/specVersion/2.0.json b/lib/validation/schema/specVersion/2.0.json
@@ -5,7 +5,7 @@
 	"type": "object",
 	"required": ["specVersion"],
 	"properties": {
-		"specVersion": { "enum": ["2.1", "2.0"] },
+		"specVersion": { "enum": ["2.2", "2.1", "2.0"] },
 		"kind": {
 			"enum": ["project", "extension", null],
 			"$comment": "Using null to allow not defining 'kind' which defaults to project"

diff --git a/lib/validation/schema/specVersion/2.0/kind/extension.json b/lib/validation/schema/specVersion/2.0/kind/extension.json
@@ -5,7 +5,7 @@
 	"type": "object",
 	"required": ["specVersion", "kind", "type", "metadata"],
 	"properties": {
-		"specVersion": { "enum": ["2.1", "2.0"] },
+		"specVersion": { "enum": ["2.2", "2.1", "2.0"] },
 		"kind": {
 			"enum": ["extension"]
 		},

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
@@ -6,14 +6,14 @@
 	"required": ["specVersion", "kind", "type", "metadata", "shims"],
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["2.1"] }
+			"specVersion": { "enum": ["2.1", "2.2"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
 			"specVersion": {
-				"enum": ["2.1"]
+				"enum": ["2.1", "2.2"]
 			},
 			"kind": {
 				"enum": ["extension"]

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
@@ -7,13 +7,13 @@
 	"required": ["specVersion", "kind", "type", "metadata", "middleware"],
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["2.1"] }
+			"specVersion": { "enum": ["2.1", "2.2"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["2.1"] },
+			"specVersion": { "enum": ["2.1", "2.2"] },
 			"kind": {
 				"enum": ["extension"]
 			},

diff --git a/lib/validation/schema/specVersion/2.0/kind/extension/task.json b/lib/validation/schema/specVersion/2.0/kind/extension/task.json
@@ -6,13 +6,13 @@
 	"required": ["specVersion", "kind", "type", "metadata", "task"],
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["2.1"] }
+			"specVersion": { "enum": ["2.1", "2.2"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["2.1"] },
+			"specVersion": { "enum": ["2.1", "2.2"] },
 			"kind": {
 				"enum": ["extension"]
 			},

diff --git a/lib/validation/schema/specVersion/2.0/kind/project.json b/lib/validation/schema/specVersion/2.0/kind/project.json
@@ -5,7 +5,7 @@
 	"type": "object",
 	"required": ["specVersion", "type"],
 	"properties": {
-		"specVersion": { "enum": ["2.1", "2.0"] },
+		"specVersion": { "enum": ["2.2", "2.1", "2.0"] },
 		"kind": {
 			"enum": ["project", null],
 			"$comment": "Using null to allow not defining 'kind' which defaults to project"

diff --git a/lib/validation/schema/specVersion/2.0/kind/project/application.json b/lib/validation/schema/specVersion/2.0/kind/project/application.json
@@ -4,25 +4,15 @@
 
 	"type": "object",
 	"required": ["specVersion", "type", "metadata"],
-	"properties": {
-		"specVersion": { "enum": ["2.1", "2.0"] },
-		"kind": {
-			"enum": ["project", null]
-		},
-		"type": {
-			"enum": ["application"]
-		}
-	},
-
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["2.1"] }
+			"specVersion": { "enum": ["2.1", "2.2"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["2.1"] },
+			"specVersion": { "enum": ["2.1", "2.2"] },
 			"kind": {
 				"enum": ["project", null]
 			},

diff --git a/lib/validation/schema/specVersion/2.0/kind/project/library.json b/lib/validation/schema/specVersion/2.0/kind/project/library.json
@@ -4,25 +4,15 @@
 
 	"type": "object",
 	"required": ["specVersion", "type", "metadata"],
-	"properties": {
-		"specVersion": { "enum": ["2.1","2.0"] },
-		"kind": {
-			"enum": ["project", null]
-		},
-		"type": {
-			"enum": ["library"]
-		}
-	},
-
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["2.1"] }
+			"specVersion": { "enum": ["2.1", "2.2"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["2.1"] },
+			"specVersion": { "enum": ["2.1", "2.2"] },
 			"kind": {
 				"enum": ["project", null]
 			},

diff --git a/lib/validation/schema/specVersion/2.0/kind/project/module.json b/lib/validation/schema/specVersion/2.0/kind/project/module.json
@@ -4,31 +4,15 @@
 
 	"type": "object",
 	"required": ["specVersion", "type", "metadata"],
-	"properties": {
-		"specVersion": { "enum": ["2.1","2.0"] },
-		"kind": {
-			"enum": ["project", null]
-		},
-		"type": {
-			"enum": ["module"]
-		},
-		"metadata": {
-			"$ref": "../project.json#/definitions/metadata"
-		},
-		"resources": {
-			"$ref": "#/definitions/resources"
-		}
-	},
-
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["2.1"] }
+			"specVersion": { "enum": ["2.1", "2.2"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["2.1"] },
+			"specVersion": { "enum": ["2.1", "2.2"] },
 			"kind": {
 				"enum": ["project", null]
 			},

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
@@ -4,40 +4,15 @@
 
 	"type": "object",
 	"required": ["specVersion", "type", "metadata"],
-	"properties": {
-		"specVersion": { "enum": ["2.1", "2.0"] },
-		"kind": {
-			"enum": ["project", null]
-		},
-		"type": {
-			"enum": ["theme-library"]
-		},
-		"metadata": {
-			"$ref": "../project.json#/definitions/metadata"
-		},
-		"framework": {
-			"$ref": "../project.json#/definitions/framework"
-		},
-		"resources": {
-			"$ref": "library.json#/definitions/resources"
-		},
-		"builder": {
-			"$ref": "#/definitions/builder"
-		},
-		"server": {
-			"$ref": "../project.json#/definitions/server"
-		}
-	},
-
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["2.1"] }
+			"specVersion": { "enum": ["2.1", "2.2"] }
 		}
 	},
 	"then": {
 		"additionalProperties": false,
 		"properties": {
-			"specVersion": { "enum": ["2.1"] },
+			"specVersion": { "enum": ["2.1", "2.2"] },
 			"kind": {
 				"enum": ["project", null]
 			},

diff --git a/lib/validation/schema/ui5.json b/lib/validation/schema/ui5.json
@@ -10,16 +10,16 @@
 	"properties": {
 		"specVersion": {
 			"enum": [
-				"2.1", "2.0",
+				"2.2", "2.1", "2.0",
 				"1.1", "1.0", "0.1"
 			],
-			"errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"2.1\", \"2.0\", \"1.1\", \"1.0\", \"0.1\"\nFor details see: https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions"
+			"errorMessage": "Unsupported \"specVersion\"\nYour UI5 CLI installation might be outdated.\nSupported specification versions: \"2.2\", \"2.1\", \"2.0\", \"1.1\", \"1.0\", \"0.1\"\nFor details see: https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions"
 		}
 	},
 
 	"if": {
 		"properties": {
-			"specVersion": { "enum": ["2.1", "2.0"] }
+			"specVersion": { "enum": ["2.2", "2.1", "2.0"] }
 		}
 	},
 	"then": {

diff --git a/test/lib/projectPreprocessor.js b/test/lib/projectPreprocessor.js
@@ -1718,6 +1718,22 @@ test("specVersion: Project with valid version 2.1", async (t) => {
 	t.deepEqual(res.specVersion, "2.1", "Correct spec version");
 });
 
+test("specVersion: Project with valid version 2.2", async (t) => {
+	const tree = {
+		id: "application.a",
+		path: applicationAPath,
+		dependencies: [],
+		version: "1.0.0",
+		specVersion: "2.2",
+		type: "application",
+		metadata: {
+			name: "xy"
+		}
+	};
+	const res = await projectPreprocessor.processTree(tree);
+	t.deepEqual(res.specVersion, "2.2", "Correct spec version");
+});
+
 test("isBeingProcessed: Is not being processed", (t) => {
 	const preprocessor = new projectPreprocessor._ProjectPreprocessor({});
 

diff --git a/test/lib/validation/schema/__helper__/customConfiguration.js b/test/lib/validation/schema/__helper__/customConfiguration.js
@@ -36,17 +36,19 @@ module.exports = {
 			]);
 		});
 
-		test(`${type}: Valid customConfiguration (specVersion 2.1)`, async (t) => {
-			await assertValidation(t, Object.assign( {
-				"specVersion": "2.1",
-				"type": type,
-				"metadata": {
-					"name": "my-" + type
-				},
-				"customConfiguration": {
-					"foo": "bar"
-				}
-			}, additionalConfiguration));
+		["2.2", "2.1"].forEach((specVersion) => {
+			test(`${type}: Valid customConfiguration (specVersion ${specVersion})`, async (t) => {
+				await assertValidation(t, Object.assign( {
+					"specVersion": specVersion,
+					"type": type,
+					"metadata": {
+						"name": "my-" + type
+					},
+					"customConfiguration": {
+						"foo": "bar"
+					}
+				}, additionalConfiguration));
+			});
 		});
 	}
 };
diff --git a/test/lib/validation/schema/__helper__/extension.js b/test/lib/validation/schema/__helper__/extension.js
@@ -18,7 +18,7 @@ module.exports = {
 
 		customConfiguration.defineTests(test, assertValidation, type, additionalConfiguration);
 
-		["2.0", "2.1"].forEach((specVersion) => {
+		["2.2", "2.1", "2.0"].forEach((specVersion) => {
 			test(`kind: extension / type: ${type} basic (${specVersion})`, async (t) => {
 				await assertValidation(t, Object.assign({
 					"specVersion": specVersion,
@@ -44,7 +44,7 @@ module.exports = {
 					params: {
 						"additionalProperty": "resources"
 					},
-					schemaPath: specVersion === "2.1" ? "#/then/additionalProperties" : "#/else/additionalProperties"
+					schemaPath: specVersion !== "2.0" ? "#/then/additionalProperties" : "#/else/additionalProperties"
 				}]);
 			});
 
@@ -65,7 +65,7 @@ module.exports = {
 							additionalProperty: "notAllowed",
 						},
 						schemaPath:
-							specVersion === "2.1" ? "#/then/additionalProperties" : "#/else/additionalProperties"
+							specVersion !== "2.0" ? "#/then/additionalProperties" : "#/else/additionalProperties"
 					}]);
 				});
 		});

diff --git a/test/lib/validation/schema/__helper__/framework.js b/test/lib/validation/schema/__helper__/framework.js
@@ -10,7 +10,7 @@ module.exports = {
 	 * @param {string} type one of "application", "library" and "theme-library"
 	 */
 	defineTests: function(test, assertValidation, type) {
-		["2.0", "2.1"].forEach((specVersion) => {
+		["2.2", "2.1", "2.0"].forEach((specVersion) => {
 			test(`${type} (specVersion ${specVersion}): framework configuration: OpenUI5`, async (t) => {
 				const config = {
 					"specVersion": specVersion,

diff --git a/test/lib/validation/schema/__helper__/project.js b/test/lib/validation/schema/__helper__/project.js
@@ -22,10 +22,9 @@ module.exports = {
 		// customConfiguration tests
 		customConfiguration.defineTests(test, assertValidation, type);
 
-
 		// version specific tests
-		["2.0", "2.1"].forEach((specVersion) => {
-			// tests for all kinds and version 2.0 and 2.1
+		["2.2", "2.1", "2.0"].forEach((specVersion) => {
+			// tests for all kinds and version 2.0 and above
 			test(`${type} (specVersion ${specVersion}): No metadata`, async (t) => {
 				await assertValidation(t, {
 					"specVersion": specVersion,
@@ -279,7 +278,7 @@ module.exports = {
 					params: {
 						additionalProperty: "notAllowed",
 					},
-					schemaPath: specVersion === "2.1" ? "#/then/additionalProperties" : "#/else/additionalProperties",
+					schemaPath: specVersion !== "2.0" ? "#/then/additionalProperties" : "#/else/additionalProperties",
 				}]);
 			});
 		});

diff --git a/test/lib/validation/schema/specVersion/2.0/kind/extension.js b/test/lib/validation/schema/specVersion/2.0/kind/extension.js
@@ -33,7 +33,7 @@ test.after.always((t) => {
 	};
 	t.context.ajvCoverage.verify(thresholds);
 });
-["2.0", "2.1"].forEach((specVersion) => {
+["2.2", "2.1", "2.0"].forEach((specVersion) => {
 	test(`Type project-shim (${specVersion})`, async (t) => {
 		await assertValidation(t, {
 			"specVersion": specVersion,