Implemented task.json validation for tfx extension create command (microsoft#477)

* Implemented task.json validation for tfx extension create command

* Bump version. Add missing space

* Display warnings instead of errors when task.json validation fails during extension creation

* Added more info to warning message

* Slight code improvements

---------

Co-authored-by: v-levockina <undefined>

Author: aleksandrlevochkin

app/exec/build/tasks/upload.ts

@@ -14,10 +14,6 @@ export function getCommand(args: string[]): BuildTaskUpload {
 
 var c_taskJsonFile: string = "task.json";
 
-interface TaskJson {
-	id: string;
-}
-
 export class BuildTaskUpload extends tasksBase.BuildTaskBase<agentContracts.TaskDefinition> {
 	protected description = "Upload a Build Task.";
 	protected serverCommand = true;
@@ -46,7 +42,7 @@ export class BuildTaskUpload extends tasksBase.BuildTaskBase<agentContracts.Task
 
 			// find task.json inside zip, make sure its there then deserialize content
 			const fileContent: string = await z.files[c_taskJsonFile].async('text');
-			const taskJson: TaskJson = JSON.parse(fileContent);
+			const taskJson: vm.TaskJson = JSON.parse(fileContent);
 
 			sourceLocation = taskZipPath;
 			taskId = taskJson.id;
@@ -57,7 +53,7 @@ export class BuildTaskUpload extends tasksBase.BuildTaskBase<agentContracts.Task
 			vm.exists(taskPath, "specified directory " + taskPath + " does not exist.");
 
 			const taskJsonPath: string = path.join(taskPath, c_taskJsonFile);
-			const taskJson: TaskJson = await vm.validate(taskJsonPath, "no " + c_taskJsonFile + " in specified directory");
+			const taskJson: vm.TaskJson = vm.validate(taskJsonPath, "no " + c_taskJsonFile + " in specified directory");
 
 			const archive = archiver("zip");
 			archive.on("error", function(error) {

app/exec/extension/_lib/merger.ts

@@ -24,6 +24,7 @@ import version = require("../../../lib/dynamicVersion");
 import { promisify } from "util";
 import { readdir, readFile, writeFile, lstat } from "fs";
 import { exists } from "../../../lib/fsUtils";
+import { validate, TaskJson } from "../../../lib/jsonvalidate";
 
 /**
  * Combines the vsix and vso manifests into one object
@@ -163,6 +164,7 @@ export class Merger {
 		return Promise.all(manifestPromises).then(partials => {
 			// Determine the targets so we can construct the builders
 			let targets: TargetDeclaration[] = [];
+			const taskJsonValidationPromises: Promise<any>[] = [];
 			partials.forEach(partial => {
 				if (_.isArray(partial["targets"])) {
 					targets = targets.concat(partial["targets"]);
@@ -221,6 +223,9 @@ export class Merger {
 							absolutePath = path.join(path.dirname(partial.__origin), asset.path);
 						}
 						asset.path = path.relative(this.settings.root, absolutePath);
+
+						const taskJsonPattern: string = path.join(absolutePath, '**', "task.json");
+						taskJsonValidationPromises.push(this.validateTaskJson(taskJsonPattern));
 					});
 				}
 				// Transform icon paths as above
@@ -280,6 +285,7 @@ export class Merger {
 				return Promise.all(
 					[updateVersionPromise].concat(
 						this.manifestBuilders.map(b => b.finalize(packageFiles, resourceData, this.manifestBuilders)),
+						taskJsonValidationPromises
 					),
 				).then(() => {
 					// const the composer do validation
@@ -401,4 +407,28 @@ export class Merger {
 		}
 		return files;
 	}
+
+	private async validateTaskJson(taskJsonSearchPattern: string): Promise<TaskJson> {
+		try {
+			const matches: string[] = await promisify(glob)(taskJsonSearchPattern);
+			
+			if (matches.length === 0) {
+				trace.debug(`No task.json file found for validation in ${taskJsonSearchPattern}`);
+				return;
+			}
+
+			const taskJsonPath = matches[0];
+			const taskJsonExists = await exists(taskJsonPath);
+			
+			if (taskJsonExists) {
+				return validate(taskJsonPath, "no task.json in specified directory");
+			}
+
+		} catch (err) {
+			const warningMessage = "Please, make sure the task.json file is correct. In the future, this warning will be treated as an error.\n";
+			trace.warn(err && err instanceof Error
+				? warningMessage + err.message
+				: `Error occurred while validating task.json. ${warningMessage}`);
+		}
+	}
 }

app/lib/jsonvalidate.ts

@@ -1,21 +1,22 @@
-import { defer } from "./promiseUtils";
-
 var fs = require("fs");
 var check = require("validator");
 var trace = require("./trace");
 
 const deprecatedRunners = ["Node6", "Node10", "Node16"];
 
+export interface TaskJson {
+	id: string;
+}
+
 /*
  * Checks a json file for correct formatting against some validation function
  * @param jsonFilePath path to the json file being validated
  * @param jsonValidationFunction function that validates parsed json data against some criteria
  * @return the parsed json file
  * @throws InvalidDirectoryException if json file doesn't exist, InvalidJsonException on failed parse or *first* invalid field in json
 */
-export function validate(jsonFilePath: string, jsonMissingErrorMessage?: string): Promise<any> {
+export function validate(jsonFilePath: string, jsonMissingErrorMessage?: string): TaskJson {
 	trace.debug("Validating task json...");
-	var deferred = defer<any>();
 	var jsonMissingErrorMsg: string = jsonMissingErrorMessage || "specified json file does not exist.";
 	this.exists(jsonFilePath, jsonMissingErrorMsg);
 
@@ -34,13 +35,12 @@ export function validate(jsonFilePath: string, jsonMissingErrorMessage?: string)
 			output += "\n\t" + issues[i];
 		}
 		trace.debug(output);
-		deferred.reject(new Error(output));
+		throw new Error(output);
 	}
 
 	trace.debug("Json is valid.");
 	validateRunner(taskJson);
-	deferred.resolve(taskJson);
-	return <any>deferred.promise;
+	return taskJson;
 }
 
 /*

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "tfx-cli",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "CLI for Azure DevOps Services and Team Foundation Server",
   "repository": {
     "type": "git",