Merge pull request microsoft#1757 from microsoft/zhas/add-json-flag-to-check

iclanton · web-flow · commit 64ebf51bd8e5 · 2020-02-27T19:41:49.000-08:00
add --json flag to rush check
diff --git a/apps/rush-lib/src/cli/actions/CheckAction.ts b/apps/rush-lib/src/cli/actions/CheckAction.ts
@@ -2,14 +2,19 @@
 // See LICENSE in the project root for license information.
 
 import * as colors from 'colors';
+import {
+  CommandLineStringParameter,
+  CommandLineFlagParameter
+} from '@microsoft/ts-command-line';
+
 import { RushCommandLineParser } from '../RushCommandLineParser';
 import { BaseRushAction } from './BaseRushAction';
 import { VersionMismatchFinder } from '../../logic/versionMismatch/VersionMismatchFinder';
 import { Variants } from '../../api/Variants';
-import { CommandLineStringParameter } from '@microsoft/ts-command-line';
 
 export class CheckAction extends BaseRushAction {
   private _variant: CommandLineStringParameter;
+  private _jsonFlag: CommandLineFlagParameter;
 
   public constructor(parser: RushCommandLineParser) {
     super({
@@ -25,6 +30,10 @@ export class CheckAction extends BaseRushAction {
 
   protected onDefineParameters(): void {
     this._variant = this.defineStringParameter(Variants.VARIANT_PARAMETER);
+    this._jsonFlag = this.defineFlagParameter({
+      parameterLongName: '--json',
+      description: 'If this flag is specified, output will be in JSON format.'
+    });
   }
 
   protected run(): Promise<void> {
@@ -38,7 +47,8 @@ export class CheckAction extends BaseRushAction {
     }
 
     VersionMismatchFinder.rushCheck(this.rushConfiguration, {
-      variant: this._variant.value
+      variant: this._variant.value,
+      printAsJson: this._jsonFlag.value
     });
     return Promise.resolve();
   }
diff --git a/apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap b/apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap
@@ -205,7 +205,7 @@ Optional arguments:
 `;
 
 exports[`CommandLineHelp prints the help for each action: check 1`] = `
-"usage: rush check [-h] [--variant VARIANT]
+"usage: rush check [-h] [--variant VARIANT] [--json]
 
 Checks each project's package.json files and ensures that all dependencies 
 are of the same version throughout the repository.
@@ -215,6 +215,7 @@ Optional arguments:
   --variant VARIANT  Run command using a variant installation configuration. 
                      This parameter may alternatively specified via the 
                      RUSH_VARIANT environment variable.
+  --json             If this flag is specified, output will be in JSON format.
 "
 `;
 
diff --git a/apps/rush-lib/src/logic/versionMismatch/VersionMismatchFinder.ts b/apps/rush-lib/src/logic/versionMismatch/VersionMismatchFinder.ts
@@ -12,9 +12,11 @@ import { CommonVersionsConfiguration } from '../../api/CommonVersionsConfigurati
 import { VersionMismatchFinderEntity } from './VersionMismatchFinderEntity';
 import { VersionMismatchFinderProject } from './VersionMismatchFinderProject';
 import { VersionMismatchFinderCommonVersions } from './VersionMismatchFinderCommonVersions';
+import { AlreadyReportedError } from '../../utilities/AlreadyReportedError';
 
 export interface IVersionMismatchFinderRushCheckOptions {
   variant?: string | undefined;
+  printAsJson?: boolean | undefined;
 }
 
 export interface IVersionMismatchFinderEnsureConsistentVersionsOptions {
@@ -25,6 +27,20 @@ export interface IVersionMismatchFinderGetMismatchesOptions {
   variant?: string | undefined;
 }
 
+export interface IMismatchDependency {
+  dependencyName: string;
+  versions: IMismatchDependencyVersion[];
+}
+
+export interface IMismatchDependencyVersion {
+  version: string,
+  projects: string[];
+}
+
+export interface IMismatchDependencies {
+  mismatchedVersions: IMismatchDependency[];
+}
+
 export class VersionMismatchFinder {
  /* store it like this:
   * {
@@ -96,20 +112,24 @@ export class VersionMismatchFinder {
     options: {
       isRushCheckCommand: boolean;
       variant?: string | undefined;
+      printAsJson?: boolean | undefined;
     }
   ): void {
-
     if (rushConfiguration.ensureConsistentVersions || options.isRushCheckCommand) {
       const mismatchFinder: VersionMismatchFinder = VersionMismatchFinder.getMismatches(rushConfiguration, options);
 
-      mismatchFinder.print();
-
-      if (mismatchFinder.numberOfMismatches) {
-        console.log(colors.red(`Found ${mismatchFinder.numberOfMismatches} mis-matching dependencies!`));
-        process.exit(1);
+      if (options.printAsJson) {
+        mismatchFinder.printAsJson();
       } else {
-        if (options.isRushCheckCommand) {
-          console.log(colors.green(`Found no mis-matching dependencies!`));
+        mismatchFinder.print();
+
+        if (mismatchFinder.numberOfMismatches > 0) {
+          console.log(colors.red(`Found ${mismatchFinder.numberOfMismatches} mis-matching dependencies!`));
+          throw new AlreadyReportedError();
+        } else {
+          if (options.isRushCheckCommand) {
+            console.log(colors.green(`Found no mis-matching dependencies!`));
+          }
         }
       }
     }
@@ -139,6 +159,36 @@ export class VersionMismatchFinder {
     return mismatchedVersion;
   }
 
+  public printAsJson(): void {
+    const mismatchDependencies: IMismatchDependency[] = [];
+
+    this.getMismatches().forEach((dependency: string) => {
+      const mismatchDependencyVersionArray: IMismatchDependencyVersion[] = [];
+      this.getVersionsOfMismatch(dependency)!.forEach((version: string) => {
+        const projects: string[] = []
+        this.getConsumersOfMismatch(dependency, version)!.forEach((project: VersionMismatchFinderEntity) => {
+          projects.push(project.friendlyName);
+        });
+        const mismatchDependencyVersion: IMismatchDependencyVersion = {
+          version: version,
+          projects: projects
+        };
+        mismatchDependencyVersionArray.push(mismatchDependencyVersion);
+      });
+      const mismatchDepency: IMismatchDependency = {
+          dependencyName: dependency,
+          versions: mismatchDependencyVersionArray
+      };
+      mismatchDependencies.push(mismatchDepency);
+    });
+
+    const output: IMismatchDependencies = {
+      mismatchedVersions: mismatchDependencies
+    };
+
+    console.log(JSON.stringify(output, undefined, 2));
+  }
+
   public print(): void {
     // Iterate over the list. For any dependency with mismatching versions, print the projects
     this.getMismatches().forEach((dependency: string) => {
diff --git a/common/changes/@microsoft/rush/zhas-add-json-flag-to-check_2020-02-26-22-23.json b/common/changes/@microsoft/rush/zhas-add-json-flag-to-check_2020-02-26-22-23.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add a --json flag for \"rush check\" to facilitate automation",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "zhas@microsoft.com"
+}
