Custom Reporters (merge/fix)

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "jest.pathToJest": "npm run jest --",
+  "editor.rulers": [
+    80
+  ]
+}

integration_tests/__tests__/__snapshots__/custom-reporters-test.js.snap

@@ -13,9 +13,6 @@ Object {
   "onRunComplete": Object {
     "called": true,
     "config": "object",
-    "numFailedTests": 1,
-    "numPassedTests": 0,
-    "numTotalTests": 1,
   },
   "onRunStart": Object {
     "called": true,
@@ -29,7 +26,7 @@ Object {
   "onTestStart": Object {
     "called": true,
     "config": false,
-    "path": true,
+    "path": false,
   },
   "options": Object {
     "christop": "pojer",
@@ -44,9 +41,6 @@ Object {
   "onRunComplete": Object {
     "called": true,
     "config": "object",
-    "numFailedTests": 0,
-    "numPassedTests": 1,
-    "numTotalTests": 1,
   },
   "onRunStart": Object {
     "called": true,
@@ -60,7 +54,7 @@ Object {
   "onTestStart": Object {
     "called": true,
     "config": false,
-    "path": true,
+    "path": false,
   },
   "options": Object {
     "christop": "pojer",

integration_tests/__tests__/custom-reporters-test.js

@@ -59,11 +59,9 @@ describe('Custom Reporters Integration', () => {
   });
 
   test('TestReporter with all tests passing', () => {
-    const {
-      stdout,
-      status,
-      stderr,
-    } = runJest('custom_reporters', ['add-test.js']);
+    const {stdout, status, stderr} = runJest('custom_reporters', [
+      'add-test.js',
+    ]);
     const parsedJSON = JSON.parse(stdout);
 
     expect(status).toBe(0);
@@ -72,11 +70,9 @@ describe('Custom Reporters Integration', () => {
   });
 
   test('TestReporter with all tests failing', () => {
-    const {
-      stdout,
-      status,
-      stderr,
-    } = runJest('custom_reporters', ['add-fail-test.js']);
+    const {stdout, status, stderr} = runJest('custom_reporters', [
+      'add-fail-test.js',
+    ]);
 
     const parsedJSON = JSON.parse(stdout);
 

integration_tests/custom_reporters/__tests__/add-fail-test.js

@@ -1,3 +1,14 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ */
+
+'use strict';
+
 const add = require('../add');
 
 describe('CustomReporters', () => {

integration_tests/custom_reporters/__tests__/add-test.js

@@ -1,3 +1,14 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ */
+
+'use strict';
+
 const add = require('../add');
 
 describe('Custom Reporters', () => {

integration_tests/custom_reporters/add.js

@@ -1,3 +1,14 @@
+/**
+ * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ *
+ */
+
+'use strict';
+
 module.exports = function add(x, y) {
   return x + y;
 };

integration_tests/custom_reporters/reporters/IncompleteReporter.js

@@ -12,15 +12,15 @@
  * IncompleteReporter
  * Reporter to test for the flexibility of the interface we implemented.
  * The reporters shouldn't be required to implement all the methods
- * 
+ *
  * This only implements one mehtod onRunComplete which should be called
  */
 class IncompleteReporter {
   constructor(options) {
     this.options = {};
   }
 
-  onRunComplete(config, results) {
+  onRunComplete(contexts, config, results) {
     console.log('onRunComplete is called');
     console.log('Passed Tests: ' + results.numPassedTests);
     console.log('Failed Tests: ' + results.numFailedTests);

packages/jest-cli/src/ReporterDispatcher.js

@@ -10,10 +10,12 @@
 
 'use strict';
 
-import type {RunnerContext} from 'types/Reporters';
-import type {HasteFS} from 'types/HasteMap';
-import type {Config, Path} from 'types/Config';
+import type {GlobalConfig} from 'types/Config';
+import type {Context} from 'types/Context';
+import type {Test} from 'types/TestRunner';
 import type {TestResult, AggregatedResult} from 'types/TestResult';
+import type BaseReporter from './reporters/BaseReporter';
+import type {ReporterOnStartOptions} from 'types/Reporters';
 
 export type RunOptions = {
   estimatedTime: number,
@@ -22,88 +24,65 @@ export type RunOptions = {
 
 class ReporterDispatcher {
   _disabled: boolean;
-  _reporters: Array<Object>;
-  _runnerContext: RunnerContext;
-  _requiredMethods: Array<string>;
+  _reporters: Array<BaseReporter>;
 
-  constructor(hasteFS: HasteFS, getTestSummary: () => string) {
-    this._runnerContext = {getTestSummary, hasteFS};
+  constructor() {
     this._reporters = [];
   }
 
-  register(reporter: Object): void {
+  register(reporter: BaseReporter): void {
     this._reporters.push(reporter);
   }
 
-  unregister(ReporterClass: Function): void {
+  unregister(ReporterClass: Function) {
     this._reporters = this._reporters.filter(
       reporter => !(reporter instanceof ReporterClass),
     );
   }
 
-  onTestResult(
-    config: Config,
-    testResult: TestResult,
-    results: AggregatedResult,
-  ) {
-    this._callReporterMethod('onTestResult', [
-      config,
-      testResult,
-      results,
-      this._runnerContext,
-    ]);
-  }
-
-  onTestStart(config: Config, path: Path) {
-    this._callReporterMethod('onTestStart', [
-      config,
-      path,
-      this._runnerContext,
-    ]);
+  onTestResult(test: Test, testResult: TestResult, results: AggregatedResult) {
+    this._reporters.forEach(
+      reporter =>
+        reporter.onTestResult &&
+        reporter.onTestResult(test, testResult, results),
+    );
   }
 
-  onRunStart(config: Config, results: AggregatedResult, options: RunOptions) {
-    this._callReporterMethod('onRunStart', [
-      config,
-      results,
-      this._runnerContext,
-      options,
-    ]);
+  onTestStart(test: Test) {
+    this._reporters.forEach(
+      reporter => reporter.onTestStart && reporter.onTestStart(test),
+    );
   }
 
-  onRunComplete(config: Config, results: AggregatedResult) {
-    this._callReporterMethod('onRunComplete', [
-      config,
-      results,
-      this._runnerContext,
-    ]);
+  onRunStart(
+    config: GlobalConfig,
+    results: AggregatedResult,
+    options: ReporterOnStartOptions,
+  ) {
+    this._reporters.forEach(
+      reporter =>
+        reporter.onRunStart && reporter.onRunStart(config, results, options),
+    );
   }
 
-  /**
-   * Helper mehtod to call only the methods that exist
-   * on a given reporter
-   *
-   * @private
-   * @param {string} method name of the mehtod to be called
-   * @param {Array<any>} reporterArgs arguments passed in to call the reporter
-   */
-  _callReporterMethod(method: string, reporterArgs: Array<any>) {
-    this._reporters.forEach(reporter => {
-      if (reporter[method]) {
-        reporter[method].apply(reporter, reporterArgs);
-      }
-    });
+  onRunComplete(
+    contexts: Set<Context>,
+    config: GlobalConfig,
+    results: AggregatedResult,
+  ) {
+    this._reporters.forEach(
+      reporter =>
+        reporter.onRunComplete &&
+        reporter.onRunComplete(contexts, config, results),
+    );
   }
 
   // Return a list of last errors for every reporter
   getErrors(): Array<Error> {
-    return this._reporters.reduce(
-      (list, reporter) => {
-        const error = reporter.getLastError && reporter.getLastError();
-        return error ? list.concat(error) : list;
-      },
-      [],
-    );
+    return this._reporters.reduce((list, reporter) => {
+      const error = reporter.getLastError && reporter.getLastError();
+      return error ? list.concat(error) : list;
+    }, []);
   }
 
   hasErrors(): boolean {

packages/jest-cli/src/TestRunner.js

@@ -16,7 +16,6 @@ import type {
 } from 'types/TestResult';
 import type {Config, GlobalConfig, ReporterConfig} from 'types/Config';
 import type {Context} from 'types/Context';
-import type {Context} from 'types/Context';
 import type {PathPattern} from './SearchSource';
 import type {Test, Tests} from 'types/TestRunner';
 
@@ -276,18 +275,10 @@ class TestRunner {
     return Promise.race([runAllTests, onInterrupt]).then(cleanup, cleanup);
   }
 
-  /**
-   * Checks if default reporters should be added or not
-   * @private
-   */
   _shouldAddDefaultReporters(reporters?: Array<ReporterConfig>): boolean {
     return !reporters || reporters.indexOf(DEFAULT_REPORTER_LABEL) !== -1;
   }
 
-  /**
-   * Main method to Setup reporters to be used with TestRunner
-   * @private
-   */
   _setupReporters() {
     const config = this._config;
     const reporters = config.reporters;
@@ -308,24 +299,19 @@ class TestRunner {
       this.addReporter(new CoverageReporter());
     }
 
-
     if (config.notify) {
       this.addReporter(new NotifyReporter(this._options.startRun));
     }
   }
 
-  _setupDefaultReporters(config: Config) {
+  _setupDefaultReporters(config: GlobalConfig) {
     this.addReporter(
       config.verbose ? new VerboseReporter(config) : new DefaultReporter(),
     );
 
     this.addReporter(new SummaryReporter(this._options));
   }
 
-  /**
-   * Adds Custom reporters to Jest
-   * @private
-   */
   _addCustomReporters(reporters: Array<ReporterConfig>) {
     const customReporter = reporters.filter(reporter => reporter !== 'default');
 
@@ -348,11 +334,7 @@ class TestRunner {
 
   /**
    * Get properties of a reporter in an object
-   * to make dealing with them less painful
-   *
-   * Objects contain the following properties:
-   *  - options
-   *  - path
+   * to make dealing with them less painful.
    */
   _getReporterProps(reporter: ReporterConfig): Object {
     let props = {};

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

@@ -9,6 +9,7 @@
  */
 'use strict';
 
+import type {GlobalConfig} from 'types/Config';
 import type {
   AggregatedResult,
   AssertionResult,
@@ -22,9 +23,9 @@ const chalk = require('chalk');
 const {ICONS} = require('../constants');
 
 class VerboseReporter extends DefaultReporter {
-  _options: Config;
+  _options: GlobalConfig;
 
-  constructor(options: Config) {
+  constructor(options: GlobalConfig) {
     super();
     this._options = options;
   }