[INTERNAL] SpecificationVersion: Add test helper function #getVersionsForRange

Author: RandomByte

lib/specifications/SpecificationVersion.js

@@ -63,8 +63,8 @@ class SpecificationVersion {
 	 * Test whether the instance's Specification Version falls into the provided range
 	 *
 	 * @public
-@param {string} range [Semver]{@link https://www.npmjs.com/package/semver}-style version range,
-for example <code>2.2 - 2.4</code>
+	 * @param {string} range [Semver]{@link https://www.npmjs.com/package/semver}-style version range,
+	 * for example <code>2.2 - 2.4</code> or <code>=3.0</code>
 	 * @returns {boolean} True if the instance's Specification Version falls into the provided range
 	 */
 	satisfies(range) {
@@ -263,6 +263,22 @@ for example <code>2.2 - 2.4</code>
 		const comparator = new SpecificationVersion(specVersion);
 		return comparator.neq(testVersion);
 	}
+
+	/**
+	 * Create an array of Specification Versions that match with the provided range. This is mainly used
+	 * for testing purposes. I.e. to execute identical tests for a range of specification versions.
+	 *
+	 * @public
+	 * @param {string} range [Semver]{@link https://www.npmjs.com/package/semver}-style version range,
+	 * for example <code>2.2 - 2.4</code> or <code>=3.0</code>
+	 * @returns {string[]} Array of versions that match the specified range
+	 */
+	static getVersionsForRange(range) {
+		return SUPPORTED_VERSIONS.filter((specVersion) => {
+			const comparator = new SpecificationVersion(specVersion);
+			return comparator.satisfies(range);
+		});
+	}
 }
 
 function getUnsupportedSpecVersionMessage(specVersion) {

test/lib/specifications/SpecificationVersion.js

@@ -67,6 +67,12 @@ test("(instance) satisfies", (t) => {
 	t.is(new SpecificationVersion("2.2").satisfies("^2.2"), true);
 	t.is(new SpecificationVersion("2.3").satisfies("^2.2"), true);
 
+	// range: >=2.2
+	t.is(new SpecificationVersion("2.1").satisfies(">=2.2"), false);
+	t.is(new SpecificationVersion("2.2").satisfies(">=2.2"), true);
+	t.is(new SpecificationVersion("2.3").satisfies(">=2.2"), true);
+	t.is(new SpecificationVersion("3.1").satisfies(">=2.2"), true);
+
 	// range: > 1.0
 	t.is(new SpecificationVersion("1.0").satisfies("> 1.0"), false);
 	t.is(new SpecificationVersion("1.1").satisfies("> 1.0"), true);
@@ -162,6 +168,12 @@ test("(static) satisfies", (t) => {
 	t.is(SpecificationVersion.satisfies("2.2", "^2.2"), true);
 	t.is(SpecificationVersion.satisfies("2.3", "^2.2"), true);
 
+	// range: >=2.2
+	t.is(SpecificationVersion.satisfies("2.1", ">=2.2"), false);
+	t.is(SpecificationVersion.satisfies("2.2", ">=2.2"), true);
+	t.is(SpecificationVersion.satisfies("2.3", ">=2.2"), true);
+	t.is(SpecificationVersion.satisfies("3.1", ">=2.2"), true);
+
 	// range: > 1.0
 	t.is(SpecificationVersion.satisfies("1.0", "> 1.0"), false);
 	t.is(SpecificationVersion.satisfies("1.1", "> 1.0"), true);
@@ -212,6 +224,45 @@ test("(static) low level comparator", (t) => {
 	t.is(SpecificationVersion.neq("2.2", "2.2"), false);
 });
 
+test("(static) getVersionsForRange", (t) => {
+	// range: 1.x
+	t.deepEqual(SpecificationVersion.getVersionsForRange("1.x"), [
+		"1.0", "1.1"
+	]);
+
+	// range: ^2.2
+	t.deepEqual(SpecificationVersion.getVersionsForRange("^2.2"), [
+		"2.2", "2.3", "2.4", "2.5", "2.6"
+	]);
+
+	// range: >=2.2
+	t.deepEqual(SpecificationVersion.getVersionsForRange(">=2.2"), [
+		"2.2", "2.3", "2.4", "2.5", "2.6",
+		"3.0", "3.1",
+	]);
+
+	// range: > 1.0
+	t.deepEqual(SpecificationVersion.getVersionsForRange("> 1.0"), [
+		"1.1",
+		"2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6",
+		"3.0", "3.1",
+	]);
+
+	// range: 2.2 - 2.4
+	t.deepEqual(SpecificationVersion.getVersionsForRange("2.2 - 2.4"), [
+		"2.2", "2.3", "2.4"
+	]);
+
+	// range: 0.1 || 1.0 - 1.1 || ^2.5
+	t.deepEqual(SpecificationVersion.getVersionsForRange("0.1 || 1.0 - 1.1 || ^2.5"), [
+		"0.1", "1.0", "1.1",
+		"2.5", "2.6"
+	]);
+
+	// Incorrect range returns empty array
+	t.deepEqual(SpecificationVersion.getVersionsForRange("not a range"), []);
+});
+
 test("getSemverCompatibleVersion", (t) => {
 	t.is(__localFunctions__.getSemverCompatibleVersion("0.1"), "0.1.0");
 	t.is(__localFunctions__.getSemverCompatibleVersion("1.1"), "1.1.0");

test/lib/validation/schema/__helper__/builder-bundleOptions.js

@@ -1,3 +1,5 @@
+import SpecificationVersion from "../../../../../lib/specifications/SpecificationVersion.js";
+
 /**
  * Common test functionality for builder/bundles/bundleOptions section in config
  */
@@ -10,13 +12,9 @@ export default {
 	 * @param {string} type one of "application" and "library", "component"
 	 */
 	defineTests: function(test, assertValidation, type) {
-		// Version specific tests
-		let specVersionsToTest = ["3.1", "3.0"];
-		if (type === "component") {
-			// Component type only became available with specVersion 3.1
-			specVersionsToTest = ["3.1"];
-		}
-		specVersionsToTest.forEach(function(specVersion) {
+		// Version specific tests (component type only became available with specVersion 3.1)
+		const range = type === "component" ? ">=3.1" : ">=3.0";
+		SpecificationVersion.getVersionsForRange(range).forEach(function(specVersion) {
 			test(`${type} (specVersion ${specVersion}): builder/bundles/bundleOptions`, async (t) => {
 				await assertValidation(t, {
 					"specVersion": specVersion,

test/lib/validation/schema/__helper__/customConfiguration.js

@@ -1,3 +1,5 @@
+import SpecificationVersion from "../../../../../lib/specifications/SpecificationVersion.js";
+
 /**
  * Common test functionality for customConfiguration section in config
  */
@@ -13,31 +15,32 @@ export default {
 	 */
 	defineTests: function(test, assertValidation, type, additionalConfiguration) {
 		additionalConfiguration = additionalConfiguration || {};
-		if (type === "component") {
-			return;
-		}
-		// version specific tests for customConfiguration
-		test(`${type}: Invalid customConfiguration (specVersion 2.0)`, async (t) => {
-			await assertValidation(t, Object.assign({
-				"specVersion": "2.0",
-				"type": type,
-				"metadata": {
-					"name": "my-" + type
-				},
-				"customConfiguration": {}
-			}, additionalConfiguration), [
-				{
-					dataPath: "",
-					keyword: "additionalProperties",
-					message: "should NOT have additional properties",
-					params: {
-						additionalProperty: "customConfiguration",
+		if (type !== "component") { // Component type only became available with specVersion 3.1
+			// version specific tests for customConfiguration
+			test(`${type}: Invalid customConfiguration (specVersion 2.0)`, async (t) => {
+				await assertValidation(t, Object.assign({
+					"specVersion": "2.0",
+					"type": type,
+					"metadata": {
+						"name": "my-" + type
+					},
+					"customConfiguration": {}
+				}, additionalConfiguration), [
+					{
+						dataPath: "",
+						keyword: "additionalProperties",
+						message: "should NOT have additional properties",
+						params: {
+							additionalProperty: "customConfiguration",
+						}
 					}
-				}
-			]);
-		});
+				]);
+			});
+		}
 
-		["2.6", "2.5", "2.4", "2.3", "2.2", "2.1"].forEach((specVersion) => {
+		// Component type only became available with specVersion 3.1
+		const range = type === "component" ? ">=3.1" : ">=2.1";
+		SpecificationVersion.getVersionsForRange(range).forEach((specVersion) => {
 			test(`${type}: Valid customConfiguration (specVersion ${specVersion})`, async (t) => {
 				await assertValidation(t, Object.assign( {
 					"specVersion": specVersion,

test/lib/validation/schema/__helper__/extension.js

@@ -1,3 +1,4 @@
+import SpecificationVersion from "../../../../../lib/specifications/SpecificationVersion.js";
 import customConfiguration from "./customConfiguration.js";
 
 /**
@@ -18,7 +19,7 @@ export default {
 
 		customConfiguration.defineTests(test, assertValidation, type, additionalConfiguration);
 
-		["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"].forEach((specVersion) => {
+		SpecificationVersion.getVersionsForRange(">=2.0").forEach((specVersion) => {
 			test(`kind: extension / type: ${type} basic (${specVersion})`, async (t) => {
 				await assertValidation(t, Object.assign({
 					"specVersion": specVersion,
@@ -67,7 +68,7 @@ export default {
 				});
 		});
 
-		["2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"].forEach((specVersion) => {
+		SpecificationVersion.getVersionsForRange("2.0 - 2.6").forEach((specVersion) => {
 			test(`kind: extension / type: ${type}: Invalid metadata.name (${specVersion})`, async (t) => {
 				await assertValidation(t, Object.assign({
 					"specVersion": specVersion,
@@ -86,7 +87,7 @@ export default {
 			});
 		});
 
-		["3.1", "3.0"].forEach((specVersion) => {
+		SpecificationVersion.getVersionsForRange(">=3.0").forEach((specVersion) => {
 			test(`kind: extension / type: ${type}: Invalid metadata.name (${specVersion})`, async (t) => {
 				await assertValidation(t, Object.assign({
 					"specVersion": specVersion,

test/lib/validation/schema/__helper__/framework.js

@@ -1,3 +1,5 @@
+import SpecificationVersion from "../../../../../lib/specifications/SpecificationVersion.js";
+
 /**
  * Common test functionality for framework section in config
  */
@@ -11,12 +13,9 @@ export default {
 	 * @param {string} type one of "application", "component", library" and "theme-library"
 	 */
 	defineTests: function(test, assertValidation, type) {
-		let specVersionsToTest = ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"];
-		if (type === "component") {
-			// Component type only became available with specVersion 3.1
-			specVersionsToTest = ["3.1"];
-		}
-		specVersionsToTest.forEach((specVersion) => {
+		// Component type only became available with specVersion 3.1
+		const range = type === "component" ? ">=3.1" : ">=2.0";
+		SpecificationVersion.getVersionsForRange(range).forEach((specVersion) => {
 			test(`${type} (specVersion ${specVersion}): framework configuration: OpenUI5`, async (t) => {
 				const config = {
 					"specVersion": specVersion,

test/lib/validation/schema/__helper__/project.js

@@ -1,3 +1,4 @@
+import SpecificationVersion from "../../../../../lib/specifications/SpecificationVersion.js";
 import framework from "./framework.js";
 import customConfiguration from "./customConfiguration.js";
 import bundleOptions from "./builder-bundleOptions.js";
@@ -29,12 +30,9 @@ export default {
 		}
 
 		// version specific tests
-		let specVersionsToTest = ["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"];
-		if (type === "component") {
-			// Component type only became available with specVersion 3.1
-			specVersionsToTest = ["3.1"];
-		}
-		specVersionsToTest.forEach((specVersion) => {
+		// Component type only became available with specVersion 3.1
+		const range = type === "component" ? ">=3.1" : ">=2.0";
+		SpecificationVersion.getVersionsForRange(range).forEach((specVersion) => {
 			// tests for all kinds and version 2.0 and above
 			test(`${type} (specVersion ${specVersion}): No metadata`, async (t) => {
 				await assertValidation(t, {
@@ -288,12 +286,9 @@ export default {
 			});
 		}
 
-		let specVersionsToTest2 = ["3.1", "3.0"];
-		if (type === "component") {
-			// Component type only became available with specVersion 3.1
-			specVersionsToTest2 = ["3.1"];
-		}
-		specVersionsToTest2.forEach((specVersion) => {
+		// Component type only became available with specVersion 3.1
+		const v3Range = type === "component" ? ">=3.1" : ">=3.0";
+		SpecificationVersion.getVersionsForRange(v3Range).forEach((specVersion) => {
 			test(`${type} (specVersion ${specVersion}): Invalid metadata.name`, async (t) => {
 				await assertValidation(t, {
 					"specVersion": specVersion,

test/lib/validation/schema/specVersion/kind/extension.js

@@ -1,6 +1,7 @@
 import test from "ava";
 import Ajv from "ajv";
 import ajvErrors from "ajv-errors";
+import SpecificationVersion from "../../../../../../lib/specifications/SpecificationVersion.js";
 import AjvCoverage from "../../../../../utils/AjvCoverage.js";
 import {_Validator as Validator} from "../../../../../../lib/validation/validator.js";
 import ValidationError from "../../../../../../lib/validation/ValidationError.js";
@@ -38,7 +39,8 @@ test.after.always((t) => {
 	};
 	t.context.ajvCoverage.verify(thresholds);
 });
-["3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"].forEach((specVersion) => {
+
+SpecificationVersion.getVersionsForRange(">=2.0").forEach((specVersion) => {
 	test(`Type project-shim (${specVersion})`, async (t) => {
 		await assertValidation(t, {
 			"specVersion": specVersion,

test/lib/validation/schema/specVersion/kind/extension/project-shim.js

@@ -1,6 +1,7 @@
 import test from "ava";
 import Ajv from "ajv";
 import ajvErrors from "ajv-errors";
+import SpecificationVersion from "../../../../../../../lib/specifications/SpecificationVersion.js";
 import AjvCoverage from "../../../../../../utils/AjvCoverage.js";
 import {_Validator as Validator} from "../../../../../../../lib/validation/validator.js";
 import ValidationError from "../../../../../../../lib/validation/ValidationError.js";
@@ -45,7 +46,7 @@ test.after.always((t) => {
 	t.context.ajvCoverage.verify(thresholds);
 });
 
-["3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0"].forEach((specVersion) => {
+SpecificationVersion.getVersionsForRange(">=2.0").forEach((specVersion) => {
 	test(`kind: extension / type: project-shim (${specVersion})`, async (t) => {
 		await assertValidation(t, {
 			"specVersion": specVersion,
@@ -127,7 +128,7 @@ test.after.always((t) => {
 	});
 });
 
-["3.0"].forEach(function(specVersion) {
+SpecificationVersion.getVersionsForRange(">=3.0").forEach(function(specVersion) {
 	test(`Invalid extension name (specVersion ${specVersion})`, async (t) => {
 		await assertValidation(t, {
 			"specVersion": specVersion,

test/lib/validation/schema/specVersion/kind/extension/server-middleware.js

@@ -1,6 +1,7 @@
 import test from "ava";
 import Ajv from "ajv";
 import ajvErrors from "ajv-errors";
+import SpecificationVersion from "../../../../../../../lib/specifications/SpecificationVersion.js";
 import AjvCoverage from "../../../../../../utils/AjvCoverage.js";
 import {_Validator as Validator} from "../../../../../../../lib/validation/validator.js";
 import ValidationError from "../../../../../../../lib/validation/ValidationError.js";
@@ -45,7 +46,7 @@ test.after.always((t) => {
 	t.context.ajvCoverage.verify(thresholds);
 });
 
-["3.0"].forEach(function(specVersion) {
+SpecificationVersion.getVersionsForRange(">=3.0").forEach(function(specVersion) {
 	test(`Invalid extension name (specVersion ${specVersion})`, async (t) => {
 		await assertValidation(t, {
 			"specVersion": specVersion,