test(project): Add case for multiple custom tasks (tag handling)

Author: maxreichmann

packages/project/test/fixtures/application.a/custom-tasks/custom-task-0.js

@@ -0,0 +1,29 @@
+module.exports = async function ({
+	workspace, taskUtil,
+	options: {projectNamespace}
+}) {
+	console.log("Custom task 0 executed");
+
+	// For #1 Build: Read a file which is an input of custom-task-1 (which sets a tag on it)
+	const testJS = await workspace.byPath(`/resources/${projectNamespace}/test.js`);
+
+	// For #3 Build: Read a different file (which is NOT an input of custom-task-1)
+	const test2JS = await workspace.byPath(`/resources/${projectNamespace}/test2.js`);
+
+	const tag = taskUtil.getTag(testJS, taskUtil.STANDARD_TAGS.IsDebugVariant);
+	if (!test2JS && testJS) {
+		// For #1 Build:
+		if (tag) {
+			throw new Error("Tag set by custom-task-1 is present in custom-task-0, which is UNEXPECTED.");
+		} else {
+			console.log("Tag set by custom-task-1 is not present in custom-task-0, as EXPECTED.");
+		}
+	} else {
+		// For #3 Build (NEW behavior expected as in #1):
+		if (tag) {
+			console.log("Tag set by custom-task-1 is present in custom-task-0 now, as EXPECTED.");
+		} else {
+			throw new Error("Tag set by custom-task-1 is NOT present in custom-task-0, which is UNEXPECTED.");
+		}
+	}
+};

packages/project/test/fixtures/application.a/custom-tasks/custom-task-1.js

@@ -0,0 +1,12 @@
+module.exports = async function ({
+	workspace, taskUtil,
+	options: {projectNamespace}
+}) {
+	console.log("Custom task 1 executed");
+
+	// Set a tag on a specific resource
+	const resource = await workspace.byPath(`/resources/${projectNamespace}/test.js`);
+	if (resource) {
+		taskUtil.setTag(resource, taskUtil.STANDARD_TAGS.IsDebugVariant);
+	};
+};

packages/project/test/fixtures/application.a/custom-tasks/custom-task-2.js

@@ -0,0 +1,29 @@
+module.exports = async function ({
+	workspace, taskUtil,
+	options: {projectNamespace}
+}) {
+	console.log("Custom task 2 executed");
+
+	// For #1 Build: Read a file which is an input of custom-task-1 (which sets a tag on it)
+	const testJS = await workspace.byPath(`/resources/${projectNamespace}/test.js`);
+
+	// For #3 Build: Read a different file (which is NOT an input of custom-task-1)
+	const test2JS = await workspace.byPath(`/resources/${projectNamespace}/test2.js`);
+
+	const tag = taskUtil.getTag(testJS, taskUtil.STANDARD_TAGS.IsDebugVariant);
+	if (!test2JS && testJS) {
+		// For #1 Build:
+		if (tag) {
+			console.log("Tag set by custom-task-1 is present in custom-task-2, as EXPECTED.");
+		} else {
+			throw new Error("Tag set by custom-task-1 is NOT present in custom-task-2, which is UNEXPECTED.");
+		}
+	} else {
+		// For #3 Build (SAME behavior expected as in #1):
+		if (tag) {
+			console.log("Tag set by custom-task-1 is present in custom-task-2, as EXPECTED.");
+		} else {
+			throw new Error("Tag set by custom-task-1 is NOT present in custom-task-2, which is UNEXPECTED.");
+		}
+	}
+};

packages/project/test/fixtures/application.a/ui5-multiple-customTasks.yaml

@@ -0,0 +1,37 @@
+---
+specVersion: "5.0"
+type: application
+metadata:
+  name: application.a
+builder:
+  customTasks:
+    - name: custom-task-0
+      afterTask: minify
+    - name: custom-task-1
+      afterTask: custom-task-0
+    - name: custom-task-2
+      afterTask: custom-task-1
+---
+specVersion: "5.0"
+kind: extension
+type: task
+metadata:
+  name: custom-task-0
+task:
+  path: custom-tasks/custom-task-0.js
+---
+specVersion: "5.0"
+kind: extension
+type: task
+metadata:
+  name: custom-task-1
+task:
+  path: custom-tasks/custom-task-1.js
+---
+specVersion: "5.0"
+kind: extension
+type: task
+metadata:
+  name: custom-task-2
+task:
+  path: custom-tasks/custom-task-2.js

packages/project/test/lib/build/ProjectBuilder.integration.js

@@ -207,7 +207,7 @@ test.serial.skip("Build application.a (custom task and tag handling)", async (t)
 
 	// Create new file which should get tagged as "OmitFromBuildResult" by a custom task
 	await fs.writeFile(`${fixtureTester.fixturePath}/webapp/fileToBeOmitted.js`,
-		`console.log("this file should be ommited in the build result")`);
+		`console.log("this file should be omitted in the build result")`);
 
 	// #2 build (with cache, with changes, with custom tasks)
 	await fixtureTester.buildProject({
@@ -258,6 +258,68 @@ test.serial.skip("Build application.a (custom task and tag handling)", async (t)
 	});
 });
 
+
+test.only("Build application.a (multiple custom tasks)", async (t) => {
+	const fixtureTester = new FixtureTester(t, "application.a");
+	const destPath = fixtureTester.destPath;
+
+	// This test should cover a scenario with multiple custom tasks.
+	// Specifically, a tag is set in custom-task-1 on a resource which is read in custom-task-0 and custom-task-2.
+	// The expected behavior is that the tag is not present in custom-task-0 (which runs before custom-task-1),
+	// but is present in custom-task-2 (which runs after custom-task-1).
+	// (for testing purposes, the custom tasks already check for this tag by themselves and handle errors accordingly)
+
+	// #1 build (no cache, no changes, with custom tasks)
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5-multiple-customTasks.yaml"},
+		config: {destPath, cleanDest: true},
+		assertions: {
+			projects: {
+				"application.a": {}
+			}
+		}
+	});
+
+	// #2 build (with cache, no changes, with custom tasks)
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5-multiple-customTasks.yaml"},
+		config: {destPath, cleanDest: true},
+		assertions: {
+			projects: {}
+		}
+	});
+
+
+	// Create a new file to allow a new build:
+	// Logic of custom-task-1 will NOT handle this file, while custom-task-0 and 2 WILL DO it,
+	// resulting in custom-task-1 getting skipped (cache reuse).
+	// The test should then verify that the tag is still set and now readable for custom-task-0 AND 2.
+	// (as in #1 build, the custom tasks already check for this tag by themselves and handle errors accordingly)
+	await fs.cp(`${fixtureTester.fixturePath}/webapp/test.js`,
+		`${fixtureTester.fixturePath}/webapp/test2.js`);
+
+	// #3 build (with cache, with changes, with custom tasks)
+	// FIXME: Currently failing, because for custom-task-0 and 2 the tag is NOT set yet.
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5-multiple-customTasks.yaml"},
+		config: {destPath, cleanDest: true},
+		assertions: {
+			projects: {
+				"application.a": {
+					skippedTasks: [
+						"custom-task-1", // SHOULD BE SKIPPED
+						// remaining skipped tasks don't matter here:
+						"enhanceManifest",
+						"escapeNonAsciiCharacters",
+						"generateFlexChangesBundle",
+						"replaceCopyright",
+					]
+				}
+			}
+		}
+	});
+});
+
 test.serial("Build library.d project multiple times", async (t) => {
 	const fixtureTester = new FixtureTester(t, "library.d");
 	const destPath = fixtureTester.destPath;