[CI/CD] Add task validation step (#18775)

- Added check for validating sources and generated tasks
- Added log method for printing errors

Author: DmitriiBobreshev

ci/check-tasks.js renamed to ci/after-build-check-tasks.js

@@ -115,5 +115,4 @@ function findNonUniqueTaskLib() {
     console.log('No duplicates found.');
     return null;
 }
-
 findNonUniqueTaskLib();

ci/before-build-check-tasks.js

@@ -0,0 +1,75 @@
+const util = require('./ci-util');
+const fs = require('fs');
+const path = require('path');
+
+const argv = require('minimist')(process.argv.slice(2));
+const { genTaskPath, tasksSourcePath, makeOptionPath, logToPipeline } = require('./ci-util');
+
+/**
+ * Function validating that all passed tasks are presented in tasks folder
+ * @param {Array<Tasks>} taskList
+ * @returns {Array<Tasks>} - array of messages which are not presented in tasks folder
+ */
+function validateTaskSources( taskList ) {
+  const errorList = [];
+
+  for (const task of taskList) {
+    const taskPath = path.join(tasksSourcePath, task);
+    if (!fs.existsSync(taskPath)) {
+      errorList.push(`Sources for ${task} task not found in ${tasksSourcePath} but the task found in ${makeOptionPath}`);
+      continue;
+    }
+  }
+
+  return errorList;
+}
+
+/** 
+ * Function validating that for all generated task has versionmap file
+ * @param {Object} makeOptionJson - make-options.json as object
+ * @returns {Array<String>} - array of messages with tasks which don't have versionmap file 
+ */
+function validateGeneratedTasksExists( makeOptionJson ) {
+  const excludedKeys = ['tasks', 'taskResources'];
+  const errorList = [];
+
+  for (const key in makeOptionJson) {
+    if (excludedKeys.includes(key)) continue;
+    if (!Array.isArray(makeOptionJson[key])) continue;
+    
+    const taskList = makeOptionJson[key];
+    for (const task of taskList) {
+      const versionMapFile = `${task}.versionmap.txt`;
+      if (fs.existsSync(path.join(genTaskPath, versionMapFile))) continue;
+      errorList.push(`Task ${task} doesn't have versionmap file but found in ${key} section in make-options.json`);
+    }
+  }
+  return errorList;
+}
+
+/** 
+ * Function validating that all tasks presented in make-options.json are valid
+ */
+function validateMakeOption() {
+  if (!fs.existsSync(makeOptionPath)) {
+    throw new Error(`make-options.json doesn't exist in ${makeOptionPath}`);
+  }
+
+  const makeOptions = JSON.parse(fs.readFileSync(makeOptionPath, { encoding: 'utf-8' }));
+  const messages = [
+    ...validateGeneratedTasksExists(makeOptions),
+    ...validateTaskSources(makeOptions.tasks)
+  ];
+
+  if (messages.length > 0) {
+    console.warn(`\nProblems with ${messages.length} task(s) should be resolved:\n`);
+    
+    messages.forEach((message) => {
+      logToPipeline("error", message);
+    });
+
+    process.exit(1);
+  }
+}
+
+validateMakeOption();

ci/build-all-steps.yml

@@ -55,6 +55,10 @@ steps:
     PACKAGE_ENDPOINT: $(Package.Endpoint)
     PACKAGE_TOKEN: $(Package.Token)
 
+- script: node ./ci/before-build-check-tasks.js
+  displayName: Check that tasks has no duplicated libs
+  condition: and(succeeded(), eq(variables['build.reason'], 'PullRequest'), ne(variables['numTasks'], 0))
+
 - script: node ./ci/check-downgrading.js --task "$(task_pattern)" --sprint $(currentSprint) --week $(currentSprintWeek)
   displayName: Check for downgrading tasks
   condition: |
@@ -84,7 +88,7 @@ steps:
   displayName: Build Tasks
   condition: and(succeeded(), ne(variables['numTasks'], 0))
 
-- script: node ./ci/check-tasks.js
+- script: node ./ci/after-build-check-tasks.js
   displayName: Check that tasks has no duplicated libs
   condition: and(succeeded(), eq(variables['build.reason'], 'PullRequest'), ne(variables['numTasks'], 0))
 

ci/check-downgrading.js

@@ -5,15 +5,15 @@ const {
 } = require('fs');
 const { mkdir, rm } = require('shelljs');
 const { platform } = require('os');
-const { run, resolveTaskList } = require('./ci-util');
+const { run, resolveTaskList, logToPipeline } = require('./ci-util');
 const { eq, inc, parse, lte, neq } = require('semver');
 
 const taskVersionBumpingDocUrl = "https://aka.ms/azp-tasks-version-bumping";
 
 const packageEndpoint = process.env['PACKAGE_VERSIONS_ENDPOINT'];
 
 if (!packageEndpoint) {
-  console.log('##vso[task.logissue type=error]Failed to get info from package endpoint because no endpoint was specified. Try setting the PACKAGE_VERSIONS_ENDPOINT environment variable.');
+  logToPipeline('error', 'Failed to get info from package endpoint because no endpoint was specified. Try setting the PACKAGE_VERSIONS_ENDPOINT environment variable.')
   process.exit(1);
 }
 
@@ -120,7 +120,7 @@ function getTasksVersions(tasks, basepath) {
     const taskJSONPath = join(basepath, 'Tasks' , x, 'task.json');
 
     if (!existsSync(taskJSONPath)) {
-      console.log(`##vso[task.logissue type=error]Task.json of ${x} does not exist by path ${taskJSONPath}`);
+      logToPipeline('error', `Task.json of ${x} does not exist by path ${taskJSONPath}`);
       process.exit(1);
     }
 
@@ -142,7 +142,7 @@ async function clientWrapper(url) {
   try {
     return await client.get(url);
   } catch (error) {
-    console.log(`##vso[task.logissue type=error]Cannot access to ${url} due to error ${error}`);
+    logToPipeline('error', `Cannot access to ${url} due to error ${error}`);
     process.exit(1);
   }
 }
@@ -151,7 +151,7 @@ async function getFeedTasksVersions() {
   const { result, statusCode } = await clientWrapper(packageEndpoint);
 
   if (statusCode !== 200) {
-    console.log(`##vso[task.logissue type=error]Failed while fetching feed versions.\nStatus code: ${statusCode}\nResult: ${result}`);
+    logToPipeline('error', `Failed while fetching feed versions.\nStatus code: ${statusCode}\nResult: ${result}`);
     process.exit(1);
   }
 
@@ -203,7 +203,7 @@ function compareLocalTaskLoc(localTasks) {
     const taskLocJSONPath = join(__dirname, '..', 'Tasks' , localTask.name, 'task.loc.json');
 
     if (!existsSync(taskLocJSONPath)) {
-      console.log(`##vso[task.logissue type=error]Task.json of ${localTask.name} does not exist by path ${taskLocJSONPath}`);
+      logToPipeline('error', `Task.json of ${localTask.name} does not exist by path ${taskLocJSONPath}`);
       process.exit(1);
     }
 
@@ -248,7 +248,7 @@ async function main({ task, sprint, week }) {
     console.warn(`\nProblems with ${messages.length} task(s) should be resolved:\n`);
 
     for (const message of messages) {
-      console.log(`##vso[task.logissue type=${message.type}]${message.payload}`);
+      logToPipeline(message.type, message.payload);
     }
 
     console.log('\nor you might have an outdated branch, try to merge/rebase your branch from master');

ci/ci-util.js

@@ -29,6 +29,7 @@ var aggregateNuspecPath = path.join(packagePath, 'Mseng.MS.TF.Build.Tasks.nuspec
 var publishLayoutPath = path.join(packagePath, 'publish-layout');
 var publishPushCmdPath = path.join(packagePath, 'publish-layout', 'push.cmd');
 var genTaskPath = path.join(__dirname, '..', '_generated');
+var makeOptionPath = path.join(__dirname, '..', 'make-options.json');
 
 exports.buildTasksPath = buildTasksPath;
 exports.packagePath = packagePath;
@@ -50,6 +51,7 @@ exports.aggregateNuspecPath = aggregateNuspecPath;
 exports.publishLayoutPath = publishLayoutPath;
 exports.publishPushCmdPath = publishPushCmdPath;
 exports.genTaskPath = genTaskPath;
+exports.makeOptionPath = makeOptionPath;
 
 //------------------------------------------------------------------------------
 // generic functions
@@ -493,3 +495,24 @@ var resolveTaskList = function(taskPattern) {
     return taskList;
 }
 exports.resolveTaskList = resolveTaskList;
+
+/**
+ * @param {string} type - log type
+ * @param {string} payload - log message
+ */
+function logToPipeline(type, payload) {
+    if (!payload) throw new Error('payload are required');
+
+    switch (type) {
+        case 'error':
+        case 'warning':
+            console.log(`##vso[task.logissue type=${type}]${payload}`);
+            break;
+        case 'debug':
+            console.log(`##vso[task.debug]${payload}`);
+            break;
+        default: 
+            console.log(payload);
+    }
+}
+exports.logToPipeline = logToPipeline;