feat: enable citgm run comparisons

Author: codebytere

bin/ncu-ci

@@ -15,6 +15,7 @@ const {
   BenchmarkRun,
   CommitBuild,
   CITGMBuild,
+  CITGMComparisonBuild,
   HealthBuild,
   listBuilds,
   FailureAggregator,
@@ -126,13 +127,17 @@ const argv = yargs
     handler
   })
   .command({
-    command: 'citgm <jobid>',
+    command: 'citgm <jobid> [jobid2]',
     desc: 'Show results of a citgm-smoker CI job',
     builder: (yargs) => {
       yargs
         .positional('jobid', {
           describe: 'id of the job',
           type: 'number'
+        })
+        .positional('jobid2', {
+          describe: 'id of the second job, if doing a comparison',
+          type: 'number'
         });
     },
     handler
@@ -209,7 +214,12 @@ class CICommand {
           build = new CommitBuild(cli, request, job.jobid);
           break;
         case CITGM:
-          build = new CITGMBuild(cli, request, job.jobid);
+          if (job.jobid2) {
+            const ids = [job.jobid, job.jobid2];
+            build = new CITGMComparisonBuild(cli, request, ids);
+          } else {
+            build = new CITGMBuild(cli, request, job.jobid);
+          }
           break;
         case BENCHMARK:
           build = new BenchmarkRun(cli, request, job.jobid);
@@ -320,7 +330,8 @@ class JobCommand extends CICommand {
 
     queue.push({
       type: commandToType[this.command],
-      jobid: argv.jobid
+      jobid: argv.jobid,
+      jobid2: argv.jobid2
     });
   }
 }

lib/ci/build-types/citgm_build.js

@@ -13,7 +13,7 @@ const {
   FAILURE_CONSTRUCTORS: {
     [NCU_FAILURE]: NCUFailure
   }
-} = require('./ci_failure_parser');
+} = require('../ci_failure_parser');
 
 class CITGMBuild extends TestBuild {
   constructor(cli, request, id) {

lib/ci/build-types/citgm_comparison_build.js

@@ -0,0 +1,138 @@
+'use strict';
+
+const { statusType } = require('../ci_utils');
+const { CITGMBuild } = require('./citgm_build');
+
+class CITGMComparisonBuild {
+  constructor(cli, request, ids) {
+    const baseBuild = new CITGMBuild(cli, request, ids[0]);
+    const comparisonBuild = new CITGMBuild(cli, request, ids[1]);
+
+    this.cli = cli;
+    this.builds = { baseBuild, comparisonBuild };
+    this.results = {};
+    this.ids = ids;
+  }
+
+  async getResults() {
+    const { builds } = this;
+    const { baseBuild, comparisonBuild } = builds;
+
+    // Result in a comparison context reflects
+    // whether or not there were failures in
+    // comparisonBuild not present in baseBuild,
+    // e.g if there were new failures.
+    let result = statusType.SUCCESS;
+
+    await baseBuild.getResults();
+    await comparisonBuild.getResults();
+
+    const { failures: baseFailures } = baseBuild.results;
+    const { failures: comparisonFailures } = comparisonBuild.results;
+
+    const failures = {};
+    for (const platform in baseFailures) {
+      const { modules: baseModules } = comparisonFailures[platform];
+      const { modules: comparisonModules } = comparisonFailures[platform];
+
+      const newFailures = comparisonModules.filter(f => {
+        return !baseModules.includes(f.name);
+      });
+
+      if (newFailures.length !== 0) {
+        result = statusType.FAILURE;
+      }
+
+      failures[platform] = newFailures;
+    }
+
+    this.results.failures = failures;
+    this.result = result;
+
+    return result;
+  }
+
+  display() {
+    const { builds } = this;
+
+    // Display header for both CITGM runs.
+    builds.baseBuild.displayHeader();
+    builds.comparisonBuild.displayHeader();
+
+    this.displayBuilds();
+  }
+
+  displayBuilds() {
+    const { builds, cli, results, result } = this;
+
+    const baseID = builds.baseBuild.id;
+    const comparisonID = builds.comparisonBuild.id;
+
+    cli.separator('Results');
+
+    if (result === statusType.SUCCESS) {
+      cli.log('\n\n');
+      const str = `No new failures in ${baseID} compared to ${comparisonID}`;
+      cli.log(`${statusType.SUCCESS}: ${str}\n\n`);
+      return;
+    }
+
+    const output = {};
+    for (const platform in results.failures) {
+      const modules = results.failures[platform];
+      const failures = modules.map(f => f.name);
+
+      output[platform] = failures;
+    }
+
+    console.table(output);
+  }
+
+  formatAsJson() {
+    const { builds, results } = this;
+    const { baseBuild, comparisonBuild } = builds;
+
+    const result = {
+      baseBuild: {
+        source: baseBuild.sourceURL,
+        upstream: comparisonBuild.jobUrl
+      },
+      comparisonBuild: {
+        source: comparisonBuild.sourceURL,
+        upstream: baseBuild.jobUrl
+      },
+      ...results.failures
+    };
+
+    return JSON.parse(JSON.stringify(result));
+  }
+
+  formatAsMarkdown() {
+    const { builds, result, results } = this;
+    const { baseBuild, comparisonBuild } = builds;
+
+    const bLink = `[#${baseBuild.id}](${baseBuild.jobUrl})`;
+    const cLink = `[#${comparisonBuild.id}](${comparisonBuild.jobUrl})`;
+
+    let output = `# CITGM Data for ${bLink} - ${cLink}\n\n`;
+
+    if (result === 'success') {
+      const bID = baseBuild.id;
+      const cID = comparisonBuild.id;
+      output += `No new failures in ${cID} compared to ${bID}`;
+      return output;
+    }
+
+    output += `## New Failures in job ${cLink}\n\n`;
+    for (const failure in results.failures) {
+      const data = results.failures[failure];
+      output += `### ${failure}\n\n`;
+
+      const failures = data.map(f => `* ${f.name}`);
+      output += failures.length ? `${failures.join('\n')}\n\n` : 'None.\n\n';
+    }
+    return output;
+  }
+}
+
+module.exports = { CITGMComparisonBuild };

lib/ci/ci_result_parser.js

@@ -34,6 +34,9 @@ const { fold, statusType, pad } = require('./ci_utils');
 const { Job, jobCache } = require('./build-types/job');
 const { TestBuild } = require('./build-types/test_build');
 const { CITGMBuild } = require('./build-types/citgm_build');
+const {
+  CITGMComparisonBuild
+} = require('./build-types/citgm_comparison_build');
 const { flatten } = require('../utils');
 const qs = require('querystring');
 const _ = require('lodash');
@@ -744,6 +747,7 @@ module.exports = {
   BenchmarkRun,
   CommitBuild,
   CITGMBuild,
+  CITGMComparisonBuild,
   HealthBuild,
   jobCache,
   parseJobFromURL,