test(runValidation): Add tests

Author: dimovpetar

resources/integration_cards_guidelines.md

@@ -42,6 +42,7 @@
 ## 2. Validation
 - **ALWAYS** ensure that `manifest.json` file is valid JSON.
 - **ALWAYS** ensure that in `manifest.json` file the property `sap.app/type` is set to `"card"`.
+- **ALWAYS** validate the `manifest.json` against the UI5 Manifest schema. You must do it using the `run_manifest_validation` tool.
 - **ALWAYS** avoid deprecated properties in `manifest.json` and other places.
 - **NEVER** treat Integration Cards project as UI5 project, except for cards of type "Component".
 

src/tools/run_manifest_validation/runValidation.ts

@@ -5,11 +5,12 @@ import {readFile} from "fs/promises";
 import {getLogger} from "@ui5/logger";
 import {InvalidInputError} from "../../utils.js";
 import {getManifestSchema} from "../../utils/ui5Manifest.js";
+import {Mutex} from "async-mutex";
 
 const log = getLogger("tools:run_manifest_validation:runValidation");
-const schemaCache = new Map<string, Promise<object>>();
+const schemaCache = new Map<string, AnySchemaObject>();
+const fetchSchemaMutex = new Mutex();
 
-// Configuration constants
 const AJV_SCHEMA_PATHS = {
 	draft06: "node_modules/ajv/dist/refs/json-schema-draft-06.json",
 	draft07: "node_modules/ajv/dist/refs/json-schema-draft-07.json",
@@ -22,46 +23,35 @@ async function createUI5ManifestValidateFunction(ui5Schema: object) {
 			strict: false, // Allow additional properties that are not in schema
 			unicodeRegExp: false,
 			loadSchema: async (uri) => {
-				// Check cache first to prevent infinite loops
+				const release = await fetchSchemaMutex.acquire();
+
 				if (schemaCache.has(uri)) {
 					log.info(`Loading cached schema: ${uri}`);
-
-					try {
-						const schema = await schemaCache.get(uri)!;
-						return schema;
-					} catch {
-						schemaCache.delete(uri);
-					}
+					return schemaCache.get(uri)!;
 				}
 
-				log.info(`Loading external schema: ${uri}`);
-				let fetchSchema: Promise<object>;
-
 				try {
-					if (uri.includes("adaptive-card.json")) {
-						// Special handling for Adaptive Card schema to fix unsupported "id" property
-						// According to the JSON Schema spec Draft 06 (used by Adaptive Card schema),
-						// "$id" should be used instead of "id"
-						fetchSchema = fetchCdn(uri)
-							.then((response) => {
-								if ("id" in response && typeof response.id === "string") {
-									const typedResponse = response as Record<string, unknown>;
-									typedResponse.$id = response.id;
-									delete typedResponse.id;
-								}
-								return response;
-							});
-					} else {
-						fetchSchema = fetchCdn(uri);
+					log.info(`Loading external schema: ${uri}`);
+					const schema = await fetchCdn(uri) as AnySchemaObject;
+
+					// Special handling for Adaptive Card schema to fix unsupported "id" property
+					// According to the JSON Schema spec Draft 06 (used by Adaptive Card schema),
+					// "$id" should be used instead of "id"
+					if (uri.includes("adaptive-card.json") && typeof schema.id === "string") {
+						schema.$id = schema.id;
+						delete schema.id;
 					}
 
-					schemaCache.set(uri, fetchSchema);
-					return fetchSchema;
+					schemaCache.set(uri, schema);
+
+					return schema;
 				} catch (error) {
 					log.warn(`Failed to load external schema ${uri}:` +
 						`${error instanceof Error ? error.message : String(error)}`);
 
 					throw error;
+				} finally {
+					release();
 				}
 			},
 		});

test/fixtures/manifest_validation/schema.json

@@ -0,0 +1,46 @@
+{
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
+	"type": "object",
+	"required": ["_version", "sap.app"],
+	"properties": {
+		"_version": {
+			"type": "string"
+		},
+		"sap.app": {
+			"type": "object",
+			"required": ["id", "type", "applicationVersion"],
+			"properties": {
+				"id": {
+					"type": "string"
+				},
+				"type": {
+					"type": "string"
+				},
+				"title": {
+					"type": "string"
+				},
+				"description": {
+					"type": "string"
+				},
+				"applicationVersion": {
+					"type": "object",
+					"required": ["version"],
+					"properties": {
+						"version": {
+							"type": "string"
+						}
+					}
+				},
+				"dataSources": {
+					"type": "object"
+				}
+			}
+		},
+		"sap.ui": {
+			"type": "object"
+		},
+		"sap.ui5": {
+			"type": "object"
+		}
+	}
+}

test/fixtures/manifest_validation/valid-manifest.json

@@ -0,0 +1,26 @@
+{
+	"_version": "1.59.0",
+	"sap.app": {
+		"id": "com.example.app",
+		"type": "application",
+		"applicationVersion": {
+			"version": "1.0.0"
+		}
+	},
+	"sap.ui": {
+		"technology": "UI5",
+		"deviceTypes": {
+			"desktop": true,
+			"tablet": true,
+			"phone": true
+		}
+	},
+	"sap.ui5": {
+		"dependencies": {
+			"minUI5Version": "1.120.0",
+			"libs": {
+				"sap.m": {}
+			}
+		}
+	}
+}

test/lib/tools/run_manifest_validation/runValidation.integration.ts

@@ -0,0 +1,45 @@
+import anyTest, {TestFn} from "ava";
+import * as sinon from "sinon";
+import esmock from "esmock";
+import {readFile} from "fs/promises";
+import path from "path";
+import {fileURLToPath} from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const fixturesPath = path.join(__dirname, "..", "..", "..", "fixtures", "manifest_validation");
+
+const test = anyTest as TestFn<{
+	sinon: sinon.SinonSandbox;
+	runValidation: typeof import("../../../../src/tools/run_manifest_validation/runValidation.js").default;
+}>;
+
+test.beforeEach(async (t) => {
+	t.context.sinon = sinon.createSandbox();
+
+	const schemaFixture = await readFile(path.join(fixturesPath, "schema.json"), "utf-8");
+	const getManifestSchemaStub = t.context.sinon.stub().resolves(JSON.parse(schemaFixture));
+
+	// Import the runValidation function
+	t.context.runValidation = (await esmock(
+		"../../../../src/tools/run_manifest_validation/runValidation.js", {
+			"../../../../src/utils/ui5Manifest.js": {
+				getManifestSchema: getManifestSchemaStub,
+			},
+		}
+	)).default;
+});
+
+test.afterEach.always((t) => {
+	t.context.sinon.restore();
+});
+
+test("runValidation successfully validates valid manifest", async (t) => {
+	const {runValidation} = t.context;
+
+	const result = await runValidation(path.join(fixturesPath, "valid-manifest.json"));
+
+	t.deepEqual(result, {
+		isValid: true,
+		errors: [],
+	});
+});