Fix tests III, cleanup TaskUtil

Author: RandomByte

lib/tasks/TaskUtil.js

@@ -19,9 +19,15 @@ class TaskUtil {
 	 * @public
 	 * @typedef {object} module:@ui5/builder.tasks.TaskUtil~StandardBuildTags
 	 * @property {string} OmitFromBuildResult
-	 * 		Setting this tag to true for a resource will prevent it from being written to the build target
+	 * 		Setting this tag to true will prevent the resource from being written to the build target directory
 	 * @property {string} IsBundle
 	 * 		This tag identifies resources that contain (i.e. bundle) multiple other resources
+	 * @property {string} IsDebugVariant
+	 * 		This tag identifies resources that are a debug variant (typically named with a "-dbg" suffix)
+	 * 		of another resource. This tag is part of the build manifest.
+	 * @property {string} HasDebugVariant
+	 * 		This tag identifies resources for which a debug variant has been created.
+	 * 		This tag is part of the build manifest.
 	 */
 
 	/**
@@ -34,20 +40,21 @@ class TaskUtil {
 	 */
 	constructor({projectBuildContext}) {
 		this._projectBuildContext = projectBuildContext;
-
-		this.GLOBAL_TAGS = Object.freeze({
-			IsDebugVariant: "ui5:IsDebugVariant",
-			HasDebugVariant: "ui5:HasDebugVariant"
-		});
-
 		/**
 		 * @member {module:@ui5/builder.tasks.TaskUtil~StandardBuildTags}
 		 * @public
 		*/
 		this.STANDARD_TAGS = Object.freeze({
+			// "Project" tags:
+			// Will be stored on project instance and are hence part of the build manifest
+			IsDebugVariant: "ui5:IsDebugVariant",
+			HasDebugVariant: "ui5:HasDebugVariant",
+
+			// "Build" tags:
+			// Will be stored on the project build context
+			// They are only available to the build tasks of a single project
 			OmitFromBuildResult: "ui5:OmitFromBuildResult",
-			IsBundle: "ui5:IsBundle",
-			...this.GLOBAL_TAGS
+			IsBundle: "ui5:IsBundle"
 		});
 	}
 
@@ -69,7 +76,7 @@ class TaskUtil {
 	setTag(resource, tag, value) {
 		if (typeof resource === "string") {
 			throw new Error("Deprecated parameter: " +
-				"Since UI5 Tooling 3.0, setTag requires a resource instance. Strings are no longer accepted");
+				"Since UI5 Tooling 3.0, #setTag requires a resource instance. Strings are no longer accepted");
 		}
 
 		const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
@@ -92,7 +99,7 @@ class TaskUtil {
 	getTag(resource, tag) {
 		if (typeof resource === "string") {
 			throw new Error("Deprecated parameter: " +
-				"Since UI5 Tooling 3.0, getTag requires a resource instance. Strings are no longer accepted");
+				"Since UI5 Tooling 3.0, #getTag requires a resource instance. Strings are no longer accepted");
 		}
 		const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
 		return collection.getTag(resource, tag);
@@ -113,7 +120,7 @@ class TaskUtil {
 	clearTag(resource, tag) {
 		if (typeof resource === "string") {
 			throw new Error("Deprecated parameter: " +
-				"Since UI5 Tooling 3.0, clearTag requires a resource instance. Strings are no longer accepted");
+				"Since UI5 Tooling 3.0, #clearTag requires a resource instance. Strings are no longer accepted");
 		}
 		const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
 		return collection.clearTag(resource, tag);
@@ -164,6 +171,10 @@ class TaskUtil {
 	/**
 	 * Retrieve a single project from the dependency graph
 	 *
+	 * </br></br>
+	 * This method is only available to custom task extensions defining
+	 * <b>Specification Version 2.7 and above</b>.
+	 *
 	 * @param {string} projectName Name of the project to retrieve
 	 * @returns {module:@ui5/project.specifications.Project|undefined}
 	 *					project instance or undefined if the project is unknown to the graph
@@ -173,18 +184,6 @@ class TaskUtil {
 		return this._projectBuildContext.getProject(projectName);
 	}
 
-	createResource(parameters) {
-		if (!parameters.project) {
-			parameters.project = this.getProject();
-		}
-		const Resource = require("@ui5/fs").Resource;
-		return new Resource(parameters);
-	}
-
-	getCreateResourceFn() {
-		return this.createResource.bind(this);
-	}
-
 	/**
 	 * Get an interface to an instance of this class that only provides those functions
 	 * that are supported by the given custom task extension specification version.
@@ -210,18 +209,16 @@ class TaskUtil {
 		case "2.5":
 		case "2.6":
 			return baseInterface;
-		case "3.0":
+		case "2.7":
 			baseInterface.getProject = (projectName) => {
 				const project = this.getProject(projectName);
 				const baseProjectInterface = {};
 				bindFunctions(project, baseProjectInterface, [
 					"getName", "getVersion", "getNamespace"
 				]);
 				switch (specVersion) {
-				case "3.0":
+				case "2.7":
 					return baseProjectInterface;
-				default:
-					throw new Error(`TaskUtil: Unknown or unsupported Specification Version ${specVersion}`);
 				}
 			};
 			return baseInterface;

test/lib/processors/manifestCreator.js

@@ -186,7 +186,6 @@ test.serial("default manifest creation (multi-line documentation)", async (t) =>
 	t.is(errorLogStub.callCount, 0);
 });
 
-
 test.serial("default manifest creation i18n empty string", async (t) => {
 	const {manifestCreator, errorLogStub, getProjectVersion} = t.context;
 	const prefix = "/resources/sap/ui/mine/";
@@ -331,7 +330,7 @@ test.serial("default manifest creation with sourceTemplate and thirdparty", asyn
 	t.is(errorLogStub.callCount, 0);
 });
 
-test.serial("default manifest creation no dependency version", async (t) => {
+test.serial("default manifest creation no project versions", async (t) => {
 	const {manifestCreator, errorLogStub, getProjectVersion} = t.context;
 	const prefix = "/resources/sap/ui/mine/";
 	const libraryResource = {
@@ -358,13 +357,13 @@ test.serial("default manifest creation no dependency version", async (t) => {
 		}
 	};
 
-	const error = await t.throwsAsync(manifestCreator({
-		libraryResource,
-		resources: [],
-		getProjectVersion
-	}));
-	t.deepEqual(error.message,
-		"Couldn't find version for library 'my.lib', project dependency missing?", "error message correct");
+	const expectedManifestContentObjectModified = expectedManifestContentObject();
+	expectedManifestContentObjectModified["sap.app"]["i18n"] = undefined;
+	expectedManifestContentObjectModified["sap.app"]["applicationVersion"] = {};
+	expectedManifestContentObjectModified["sap.ui5"]["dependencies"]["libs"]["my.lib"] = {};
+	const expectedManifestContent = JSON.stringify(expectedManifestContentObjectModified, null, 2);
+	const result = await manifestCreator({libraryResource, resources: [], getProjectVersion, options: {}});
+	t.is(await result.getString(), expectedManifestContent, "Correct result returned");
 	t.is(errorLogStub.callCount, 0);
 });