Karma should only fail production builds (microsoft#117)

Nicholas Pape · web-flow · commit ebbf0be45398 · 2017-02-23T16:33:24.000-10:00
* Only fail the karma task when in production, otherwise just write a warning.

* API Changes

* Changefile

* Fixup some unrelated stuff

* Changefile
diff --git a/common/changes/nickpape-dont-fail-karma-in-nonproduction_2017-02-24-02-26.json b/common/changes/nickpape-dont-fail-karma-in-nonproduction_2017-02-24-02-26.json
@@ -0,0 +1,15 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/gulp-core-build-karma",
+      "comment": "The KarmaTask should only cause the build to fail if we are in production, otherwise treat failing tests as a warning.",
+      "type": "minor"
+    },
+    {
+      "comment": "",
+      "packageName": "@microsoft/gulp-core-build",
+      "type": "none"
+    }
+  ],
+  "email": "nickpape@users.noreply.github.com"
+}
diff --git a/common/reviews/api/gulp-core-build.api.ts b/common/reviews/api/gulp-core-build.api.ts
@@ -49,7 +49,7 @@ class GulpTask<TASK_CONFIG> implements IExecutable {
   public fileExists(localPath: string): boolean;
   public fileWarning(filePath: string, line: number, column: number, warningCode: string, message: string): void;
   public getCleanMatch(buildConfig: IBuildConfig, taskConfig: TASK_CONFIG = this.taskConfig): string[];
-  public isEnabled(config?: IBuildConfig): boolean;
+  public isEnabled(buildConfig: IBuildConfig): boolean;
   protected loadSchema(): Object;
   public log(message: string): void;
   public logError(message: string): void;
@@ -109,11 +109,9 @@ interface ICustomGulpTask {
 
 // (undocumented)
 interface IExecutable {
-  // (undocumented)
-  enabled?: boolean;
   execute: (config: IBuildConfig) => Promise<void>;
   getCleanMatch?: (config: IBuildConfig, taskConfig?: any) => string[];
-  isEnabled?: (config?: IBuildConfig) => boolean;
+  isEnabled?: (buildConfig: IBuildConfig) => boolean;
   name?: string;
   onRegister?: () => void;
 }
diff --git a/common/reviews/api/node-library-build.api.ts b/common/reviews/api/node-library-build.api.ts
@@ -51,6 +51,7 @@ class GulpTask<TASK_CONFIG> implements IExecutable {
   buildConfig: IBuildConfig;
   cleanMatch: string[];
   copyFile(localSourcePath: string, localDestPath?: string): void;
+  enabled: boolean;
   execute(config: IBuildConfig): Promise<void>;
   abstract executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (result?: Object) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
   fileError(filePath: string, line: number, column: number, errorCode: string, message: string): void;
@@ -119,7 +120,7 @@ interface ICustomGulpTask {
 interface IExecutable {
   execute: (config: IBuildConfig) => Promise<void>;
   getCleanMatch?: (config: IBuildConfig, taskConfig?: any) => string[];
-  isEnabled?: (config?: IBuildConfig) => boolean;
+  isEnabled?: (buildConfig: IBuildConfig) => boolean;
   name?: string;
   onRegister?: () => void;
 }
diff --git a/common/reviews/api/web-library-build.api.ts b/common/reviews/api/web-library-build.api.ts
@@ -51,6 +51,7 @@ class GulpTask<TASK_CONFIG> implements IExecutable {
   buildConfig: IBuildConfig;
   cleanMatch: string[];
   copyFile(localSourcePath: string, localDestPath?: string): void;
+  enabled: boolean;
   execute(config: IBuildConfig): Promise<void>;
   abstract executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (result?: Object) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
   fileError(filePath: string, line: number, column: number, errorCode: string, message: string): void;
@@ -119,7 +120,7 @@ interface ICustomGulpTask {
 interface IExecutable {
   execute: (config: IBuildConfig) => Promise<void>;
   getCleanMatch?: (config: IBuildConfig, taskConfig?: any) => string[];
-  isEnabled?: (config?: IBuildConfig) => boolean;
+  isEnabled?: (buildConfig: IBuildConfig) => boolean;
   name?: string;
   onRegister?: () => void;
 }
diff --git a/gulp-core-build-karma/src/KarmaTask.ts b/gulp-core-build-karma/src/KarmaTask.ts
@@ -134,7 +134,13 @@ export class KarmaTask extends GulpTask<IKarmaTaskConfig> {
         singleRun: singleRun
       }, (exitCode) => {
         if (exitCode) {
-          completeCallback('Error(s) occured during karma.');
+          const message: string = 'Error(s) occured during karma.';
+          if (this.buildConfig.production) {
+            completeCallback(message);
+          } else {
+            this.logWarning(message);
+            completeCallback();
+          }
         } else {
           completeCallback();
         }
diff --git a/gulp-core-build/src/IExecutable.ts b/gulp-core-build/src/IExecutable.ts
@@ -10,10 +10,8 @@ export interface IExecutable {
   /** Optional name to give the task. If no name is provided, the "Running subtask" logging will be silent. */
   name?: string;
 
-  enabled?: boolean;
-
   /** Optional callback to indicate if the task is enabled or not. */
-  isEnabled?: (config?: IBuildConfig) => boolean;
+  isEnabled?: (buildConfig: IBuildConfig) => boolean;
 
   /** Optional method to indicate directory matches to clean up when the clean task is run. */
   getCleanMatch?: (config: IBuildConfig, taskConfig?: any) => string[]; /* tslint:disable-line:no-any */
diff --git a/gulp-core-build/src/tasks/GulpTask.ts b/gulp-core-build/src/tasks/GulpTask.ts
@@ -53,9 +53,9 @@ export abstract class GulpTask<TASK_CONFIG> implements IExecutable {
    * @param buildConfig - the build configuration which should be used when determining if the task is enabled
    * @returns true if the build is not redundant and the enabled toggle is true
    */
-  public isEnabled(config?: IBuildConfig): boolean {
-    return (!config || !config.isRedundantBuild) && this.enabled;
-  };
+  public isEnabled(buildConfig: IBuildConfig): boolean {
+    return (!buildConfig || !buildConfig.isRedundantBuild) && this.enabled;
+  }
 
   /**
    * A JSON Schema object which will be used to validate this task's configuration file.
