added notifyMode flag to specify when a notification should display

Author: psilospore

docs/Configuration.md

@@ -384,6 +384,18 @@ Default: `false`
 
 Activates notifications for test results.
 
+### `notifyMode` [string]
+
+Default: `always`
+
+Specifies notification mode.
+
+#### Modes
+* `always`: always send a notification.
+* `failure`: send a notification when tests fail.
+* `success`: send a notification when tests pass.
+* `change`: send a notification when the status changed.
+
 ### `preset` [string]
 
 Default: `undefined`

integration_tests/__tests__/__snapshots__/show_config.test.js.snap

@@ -78,6 +78,7 @@ exports[`--showConfig outputs config info and exits 1`] = `
     \\"noStackTrace\\": false,
     \\"nonFlagArgs\\": [],
     \\"notify\\": false,
+    \\"notifyMode\\": \\"always\\",
     \\"passWithNoTests\\": false,
     \\"rootDir\\": \\"<<REPLACED_ROOT_DIR>>\\",
     \\"runTestsByPath\\": false,

packages/jest-cli/src/cli/args.js

@@ -348,6 +348,11 @@ export const options = {
     description: 'Activates notifications for test results.',
     type: 'boolean',
   },
+  notifyMode: {
+    default: undefined,
+    description: 'Specifies when notifications will appear for test results.',
+    type: 'string',
+  },
   onlyChanged: {
     alias: 'o',
     default: undefined,

packages/jest-cli/src/reporters/notify_reporter.js

@@ -23,6 +23,7 @@ const icon = path.resolve(__dirname, '../assets/jest_logo.png');
 export default class NotifyReporter extends BaseReporter {
   _startRun: (globalConfig: GlobalConfig) => *;
   _globalConfig: GlobalConfig;
+  _previousSuccess: boolean;
 
   constructor(
     globalConfig: GlobalConfig,
@@ -31,21 +32,37 @@ export default class NotifyReporter extends BaseReporter {
     super();
     this._globalConfig = globalConfig;
     this._startRun = startRun;
+    this._previousSuccess = false;
+    this._firstRun = true;
   }
 
   onRunComplete(contexts: Set<Context>, result: AggregatedResult): void {
     const success =
       result.numFailedTests === 0 && result.numRuntimeErrorTestSuites === 0;
 
-    if (success) {
+    if (
+      success &&
+      (this._globalConfig === 'always' ||
+        this._globalConfig === 'success' ||
+        (this._globalConfig === 'change' &&
+          (!this._previousSuccess || this._firstRun)))
+    ) {
       const title = util.format('%d%% Passed', 100);
       const message = util.format(
         (isDarwin ? '\u2705 ' : '') + '%d tests passed',
         result.numPassedTests,
       );
 
       notifier.notify({icon, message, title});
-    } else {
+      this._previousSuccess = true;
+      this._firstRun = false;
+    } else if (
+      !success &&
+      (this._globalConfig === 'always' ||
+        this._globalConfig === 'failure' ||
+        (this._globalConfig === 'change' &&
+          (this._previousSuccess || this._firstRun)))
+    ) {
       const failed = result.numFailedTests / result.numTotalTests;
 
       const title = util.format(
@@ -81,6 +98,8 @@ export default class NotifyReporter extends BaseReporter {
           }
         },
       );
+      this._previousSuccess = false;
+      this._firstRun = false;
     }
   }
 }

packages/jest-config/src/defaults.js

@@ -51,6 +51,7 @@ export default ({
   modulePathIgnorePatterns: [],
   noStackTrace: false,
   notify: false,
+  notifyMode: 'always',
   preset: null,
   resetMocks: false,
   resetModules: false,

packages/jest-config/src/index.js

@@ -98,6 +98,7 @@ const getConfigs = (
       noStackTrace: options.noStackTrace,
       nonFlagArgs: options.nonFlagArgs,
       notify: options.notify,
+      notifyMode: options.notifyMode,
       onlyChanged: options.onlyChanged,
       onlyFailures: options.onlyFailures,
       outputFile: options.outputFile,

packages/jest-validate/src/__tests__/fixtures/jest_config.js

@@ -39,6 +39,7 @@ const defaultConfig = {
   modulePathIgnorePatterns: [],
   noStackTrace: false,
   notify: false,
+  notifyMode: 'always',
   preset: null,
   resetMocks: false,
   resetModules: false,
@@ -95,6 +96,7 @@ const validConfig = {
   name: 'string',
   noStackTrace: false,
   notify: false,
+  notifyMode: 'always',
   preset: 'react-native',
   resetMocks: false,
   resetModules: false,

test_utils.js

@@ -37,6 +37,7 @@ const DEFAULT_GLOBAL_CONFIG: GlobalConfig = {
   noStackTrace: false,
   nonFlagArgs: [],
   notify: false,
+  notifyMode: 'always',
   onlyChanged: false,
   onlyFailures: false,
   outputFile: null,

types/Config.js

@@ -43,6 +43,7 @@ export type DefaultOptions = {|
   modulePathIgnorePatterns: Array<string>,
   noStackTrace: boolean,
   notify: boolean,
+  notifyMode: string,
   preset: ?string,
   resetMocks: boolean,
   resetModules: boolean,
@@ -105,6 +106,7 @@ export type InitialOptions = {
   name?: string,
   noStackTrace?: boolean,
   notify?: boolean,
+  notifyMode?: string,
   onlyChanged?: boolean,
   outputFile?: Path,
   passWithNoTests?: boolean,
@@ -179,6 +181,7 @@ export type GlobalConfig = {|
   nonFlagArgs: Array<string>,
   noSCM: ?boolean,
   notify: boolean,
+  notifyMode: string,
   outputFile: ?Path,
   onlyChanged: boolean,
   onlyFailures: boolean,