test(project): Add case for JSDoc builds (Standard Tasks)

Author: maxreichmann

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

@@ -444,6 +444,123 @@ test.serial.skip("Build application.a (dependency content changes)", async (t) =
 	t.true(builtFileContent2.includes(`console.log('something new');`), "Build dest contains changed file content");
 });
 
+test.serial("Build application.a (JSDoc build)", async (t) => {
+	const fixtureTester = new FixtureTester(t, "application.a");
+	const destPath = fixtureTester.destPath;
+
+	// This test should cover a scenario with an application depending on a library.
+	// We're executing a JSDoc build including dependencies (as with "ui5 build jsdoc --all")
+	// and testing if the output contains the expected JSDoc contents.
+	// Then, we're adding some additional JSDoc annotations to the library
+	// and testing the same again.
+
+	// #1 build (no cache, no changes)
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5.yaml"},
+		config: {destPath, cleanDest: true, jsdoc: "jsdoc", dependencyIncludes: {includeAllDependencies: true}},
+		assertions: {
+			projects: {
+				"library.d": {},
+				"library.a": {},
+				"library.b": {},
+				"library.c": {},
+				"application.a": {}
+			}
+		}
+	});
+
+	// Check that JSDoc build ran successfully:
+	await t.throwsAsync(fs.readFile(`${destPath}/resources/library/d/some-dbg.js`, {encoding: "utf8"}));
+	await t.throwsAsync(fs.readFile(`${destPath}/resources/library/d/some.js.map`, {encoding: "utf8"}));
+	const builtFileContent = await fs.readFile(`${destPath}/resources/library/d/some.js`, {encoding: "utf8"});
+	// Check that output contains correct file content:
+	t.false(builtFileContent.includes(`//# sourceMappingURL=some.js.map`),
+		"Build dest does not contain source map reference");
+
+
+	// #2 build (with cache, no changes)
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5.yaml"},
+		config: {destPath, cleanDest: true, jsdoc: "jsdoc", dependencyIncludes: {includeAllDependencies: true}},
+		assertions: {
+			projects: {}
+		}
+	});
+
+
+	// Add additional JSDoc annotations to library.d:
+	const jsdocContent = `/*!
+* ` + "${copyright}" + `
+*/
+
+/**
+* Example JSDoc annotation
+*
+* @public
+* @static
+* @param {object} param
+* @returns {string} output
+*/
+function functionWithJSDoc(param) {return "test"}`;
+
+	await fs.writeFile(`${fixtureTester.fixturePath}/node_modules/library.d/main/src/library/d/some.js`,
+		jsdocContent);
+
+	// #3 build (no cache, with changes)
+	// application.a should get skipped:
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5.yaml"},
+		config: {destPath, cleanDest: true, jsdoc: "jsdoc", dependencyIncludes: {includeAllDependencies: true}},
+		assertions: {
+			projects: {
+				"library.d": {
+					skippedTasks: [
+						"buildThemes",
+						"enhanceManifest",
+						"escapeNonAsciiCharacters",
+						"executeJsdocSdkTransformation",
+					]
+				}
+			}
+		}
+	});
+
+	// Check that JSDoc build ran successfully:
+	await t.throwsAsync(fs.readFile(`${destPath}/resources/library/d/some-dbg.js`, {encoding: "utf8"}));
+	await t.throwsAsync(fs.readFile(`${destPath}/resources/library/d/some.js.map`, {encoding: "utf8"}));
+	const builtFileContent2 = await fs.readFile(`${destPath}/resources/library/d/some.js`, {encoding: "utf8"});
+	t.true(builtFileContent2.includes(`Example JSDoc annotation`), "Build dest contains new JSDoc content");
+	// Check that output contains new file content:
+	t.false(builtFileContent2.includes(`//# sourceMappingURL=some.js.map`),
+		"Build dest does not contain source map reference");
+
+
+	// #4 build (no cache, no changes)
+	// Normal build again (non-JSDoc build); should not execute task "generateJsdoc":
+	await fixtureTester.buildProject({
+		graphConfig: {rootConfigPath: "ui5.yaml"},
+		config: {destPath, cleanDest: true, dependencyIncludes: {includeAllDependencies: true}},
+		assertions: {
+			projects: {
+				"library.d": {},
+				"library.a": {},
+				"library.b": {},
+				"library.c": {},
+				"application.a": {}
+			}
+		}
+	});
+
+	// Check that normal build ran successfully:
+	await t.notThrowsAsync(fs.readFile(`${destPath}/resources/library/d/some-dbg.js`, {encoding: "utf8"}));
+	await t.notThrowsAsync(fs.readFile(`${destPath}/resources/library/d/some.js.map`, {encoding: "utf8"}));
+	const builtFileContent3 = await fs.readFile(`${destPath}/resources/library/d/some.js`, {encoding: "utf8"});
+	t.false(builtFileContent3.includes(`Example JSDoc annotation`), "Build dest doesn't contain JSDoc content anymore");
+	// Check that output contains content generated by the normal build:
+	t.true(builtFileContent3.includes(`//# sourceMappingURL=some.js.map`),
+		"Build dest does contain source map reference");
+});
+
 test.serial("Build library.d project multiple times", async (t) => {
 	const fixtureTester = new FixtureTester(t, "library.d");
 	const destPath = fixtureTester.destPath;