feat(core): The new StreamReporter helps to analyse issues that have …

…occurred at runtime
serenity-js · Jun 23, 2019 · f96f9f8 · f96f9f8
1 parent 3dacda2
commit f96f9f8
Show file tree

Hide file tree

Showing 16 changed files with 38 additions and 37 deletions.
diff --git a/examples/cucumber-reporting/features/support/configure_serenity.ts b/examples/cucumber-reporting/features/support/configure_serenity.ts
@@ -1,6 +1,6 @@
 import { serenity } from '@serenity-js/core';
 import { FileSystem, Path } from '@serenity-js/core/lib/io';
-import { ArtifactArchiver, DebugReporter, SerenityBDDReporter } from '@serenity-js/core/lib/stage';
+import { ArtifactArchiver, SerenityBDDReporter } from '@serenity-js/core/lib/stage';
 
 import { setDefaultTimeout } from 'cucumber';
 
@@ -9,5 +9,4 @@ setDefaultTimeout(5000);
 serenity.setTheStage(
     new ArtifactArchiver(new FileSystem(new Path('./target/site/serenity'))),
     new SerenityBDDReporter(),
-    // new DebugReporter(),
 );
diff --git a/integration/cucumber-1-runner/src/support/configure_serenity.ts b/integration/cucumber-1-runner/src/support/configure_serenity.ts
@@ -1,5 +1,5 @@
 import { ChildProcessReporter } from '@integration/testing-tools';
-import { DebugReporter, serenity, WithStage } from '@serenity-js/core';
+import { serenity, StreamReporter, WithStage } from '@serenity-js/core';
 import { Actors } from './Actors';
 
 export = function () {
@@ -8,7 +8,7 @@ export = function () {
 
     serenity.setTheStage(
         new ChildProcessReporter(),
-        new DebugReporter(),
+        new StreamReporter(),
     );
 
     this.World = function (this: WithStage) {

diff --git a/integration/cucumber-2-runner/src/support/configure_serenity.ts b/integration/cucumber-2-runner/src/support/configure_serenity.ts
@@ -1,5 +1,5 @@
 import { ChildProcessReporter } from '@integration/testing-tools';
-import { DebugReporter, serenity, WithStage } from '@serenity-js/core';
+import { serenity, StreamReporter, WithStage } from '@serenity-js/core';
 import { defineSupportCode } from 'cucumber';
 import { Actors } from './Actors';
 
@@ -8,7 +8,7 @@ defineSupportCode(({ setDefaultTimeout, setWorldConstructor }) => {
 
     serenity.setTheStage(
         new ChildProcessReporter(),
-        new DebugReporter(),
+        new StreamReporter(),
     );
 
     setWorldConstructor(function (this: WithStage) {

diff --git a/integration/cucumber-3-runner/src/support/configure_serenity.ts b/integration/cucumber-3-runner/src/support/configure_serenity.ts
@@ -1,5 +1,5 @@
 import { ChildProcessReporter } from '@integration/testing-tools';
-import { DebugReporter, serenity, WithStage } from '@serenity-js/core';
+import { serenity, StreamReporter, WithStage } from '@serenity-js/core';
 import { defineSupportCode } from 'cucumber';
 import { Actors } from './Actors';
 
@@ -8,7 +8,7 @@ defineSupportCode(({ setDefaultTimeout, setWorldConstructor }) => {
 
     serenity.setTheStage(
         new ChildProcessReporter(),
-        new DebugReporter(),
+        new StreamReporter(),
     );
 
     setWorldConstructor(function (this: WithStage) {

diff --git a/integration/cucumber-4-runner/src/support/configure_serenity.ts b/integration/cucumber-4-runner/src/support/configure_serenity.ts
@@ -1,13 +1,13 @@
 import { ChildProcessReporter } from '@integration/testing-tools';
-import { DebugReporter, serenity, WithStage } from '@serenity-js/core';
+import { serenity, StreamReporter, WithStage } from '@serenity-js/core';
 import { setDefaultTimeout, setWorldConstructor } from 'cucumber';
 import { Actors } from './Actors';
 
 setDefaultTimeout(5000);
 
 serenity.setTheStage(
     new ChildProcessReporter(),
-    new DebugReporter(),
+    new StreamReporter(),
 );
 
 setWorldConstructor(function (this: WithStage) {

diff --git a/integration/cucumber-5-runner/src/support/configure_serenity.ts b/integration/cucumber-5-runner/src/support/configure_serenity.ts
@@ -1,13 +1,13 @@
 import { ChildProcessReporter } from '@integration/testing-tools';
-import { DebugReporter, serenity, WithStage } from '@serenity-js/core';
+import { serenity, StreamReporter, WithStage } from '@serenity-js/core';
 import { setDefaultTimeout, setWorldConstructor } from 'cucumber';
 import { Actors } from './Actors';
 
 setDefaultTimeout(5000);
 
 serenity.setTheStage(
     new ChildProcessReporter(),
-    new DebugReporter(),
+    new StreamReporter(),
 );
 
 setWorldConstructor(function (this: WithStage) {

diff --git a/integration/cucumber/features/support/configure_serenity.ts b/integration/cucumber/features/support/configure_serenity.ts
@@ -1,13 +1,12 @@
 import { ChildProcessReporter } from '@integration/testing-tools';
-import { serenity } from '@serenity-js/core';
-import { DebugReporter } from '@serenity-js/core/lib/stage';
+import { serenity, StreamReporter } from '@serenity-js/core';
 
 export = function () {
 
     this.setDefaultTimeout(5000);
 
     serenity.setTheStage(
         new ChildProcessReporter(),
-        new DebugReporter(),
+        new StreamReporter(),
     );
 };
diff --git a/integration/cucumber/package.json b/integration/cucumber/package.json
@@ -16,8 +16,7 @@
   "scripts": {
     "clean": "rimraf lib",
     "lint": "tslint --project tsconfig-lint.json --config ../../tslint.json --format stylish",
-    "test": "parallel-mocha --opts ../../mocha.opts 'spec/**/*.spec.*'",
-    "test:parallel": "mocha-parallel-tests --opts ../../mocha.opts 'spec/**/*.spec.*'"
+    "test": "parallel-mocha --opts ../../mocha.opts 'spec/**/*.spec.*'"
   },
   "repository": {
     "type": "git",

diff --git a/integration/jasmine/examples/setup.js b/integration/jasmine/examples/setup.js
@@ -1,8 +1,8 @@
 const
     { ChildProcessReporter } = require('@integration/testing-tools'),
-    { serenity, DebugReporter } = require('@serenity-js/core');
+    { serenity, StreamReporter } = require('@serenity-js/core');
 
 serenity.setTheStage(
     new ChildProcessReporter(),
-    new DebugReporter(),
+    new StreamReporter(),
 );
diff --git a/integration/jasmine/package.json b/integration/jasmine/package.json
@@ -16,8 +16,7 @@
   "scripts": {
     "clean": "rimraf lib",
     "lint": "tslint --project tsconfig-lint.json --config ../../tslint.json --format stylish",
-    "test": "parallel-mocha --opts ../../mocha.opts 'spec/**/*.spec.*'",
-    "test:parallel": "mocha-parallel-tests --opts ../../mocha.opts 'spec/**/*.spec.*'"
+    "test": "parallel-mocha --opts ../../mocha.opts 'spec/**/*.spec.*'"
   },
   "repository": {
     "type": "git",

diff --git a/integration/protractor-jasmine/examples/protractor.conf.js b/integration/protractor-jasmine/examples/protractor.conf.js
@@ -1,6 +1,6 @@
 const
     path = require('path'),
-    { DebugReporter } = require('@serenity-js/core'),
+    { StreamReporter } = require('@serenity-js/core'),
     { ChildProcessReporter } = require('@integration/testing-tools');
 
 exports.config = {
@@ -20,7 +20,7 @@ exports.config = {
         runner: 'jasmine',
         crew: [
             new ChildProcessReporter(),
-            new DebugReporter(),
+            new StreamReporter(),
         ]
     },
 

diff --git a/integration/protractor-jasmine/package.json b/integration/protractor-jasmine/package.json
@@ -16,8 +16,7 @@
   "scripts": {
     "clean": "rimraf lib",
     "lint": "tslint --project tsconfig-lint.json --config ../../tslint.json --format stylish",
-    "test": "parallel-mocha --opts ../../mocha.opts 'spec/**/*.spec.*'",
-    "test:parallel": "mocha-parallel-tests --opts ../../mocha.opts 'spec/**/*.spec.*'"
+    "test": "mocha --opts ../../mocha.opts 'spec/**/*.spec.*'"
   },
   "repository": {
     "type": "git",

diff --git a/packages/core/src/stage/crew/debug-reporter/index.ts b/packages/core/src/stage/crew/debug-reporter/index.ts
diff --git a/packages/core/src/stage/crew/index.ts b/packages/core/src/stage/crew/index.ts
@@ -1,4 +1,4 @@
 export * from './artifact-archiver';
 export * from './console-reporter';
-export * from './debug-reporter';
+export * from './stream-reporter';
 export * from './serenity-bdd-reporter';
diff --git a/...tage/crew/debug-reporter/DebugReporter.ts → ...ge/crew/stream-reporter/StreamReporter.ts b/...tage/crew/debug-reporter/DebugReporter.ts → ...ge/crew/stream-reporter/StreamReporter.ts
@@ -5,21 +5,28 @@ import { StageCrewMember } from '../../StageCrewMember';
 
 /**
  * @desc
- *  Serialises all the {@link DomainEvent} objects it receives and outputs
+ *  Serialises all the {@link DomainEvent} objects it receives and streams
  *  them as [ndjson](http://ndjson.org/)
- *  so that they can be analysed by the Serenity/JS team.
+ *  to the output stream.
  *
- * @example <caption>Writing the DomainEvents to a file</caption>
- * import { serenity } form '@serenity-js/core';
+ * @example <caption>Writing DomainEvents to standard output</caption>
+ * import { serenity, StreamReporter } form '@serenity-js/core';
+ *
+ * serenity.setTheStage(
+ *     new StreamReporter(process.stdout),
+ * );
+ *
+ * @example <caption>Writing DomainEvents to a file</caption>
+ * import { serenity, StreamReporter } form '@serenity-js/core';
  * import fs = require('fs');
  *
  * serenity.setTheStage(
- *     new DebugReporter(fs.createWriteStream('./debug-output.ndjson')),
+ *     new StreamReporter(fs.createWriteStream('./debug-output.ndjson')),
  * );
  *
  * @extends {StageCrewMember}
  */
-export class DebugReporter implements StageCrewMember {
+export class StreamReporter implements StageCrewMember {
 
     /**
      * @param {WriteStream} output - A WriteStream that should receive the output
@@ -41,18 +48,17 @@ export class DebugReporter implements StageCrewMember {
      * @returns {StageCrewMember} - A new instance of this {@link StageCrewMember}
      */
     assignedTo(stage: Stage): StageCrewMember {
-        return new DebugReporter(this.output, stage);
+        return new StreamReporter(this.output, stage);
     }
 
     /**
      * @desc
-     *  Handles {@link DomainEvent} objects emitted by the {@link Stage}
-     *  this {@link StageCrewMember} is assigned to.
+     *  Handles {@link DomainEvent} objects emitted by the {@link StageManager}.
      *
      * @see {@link StageCrewMember}
      *
      * @param {DomainEvent} event
-     * @returns void
+     * @returns {void}
      */
     notifyOf(event: DomainEvent): void {
         this.output.write(

diff --git a/packages/core/src/stage/crew/stream-reporter/index.ts b/packages/core/src/stage/crew/stream-reporter/index.ts
@@ -0,0 +1 @@
+export * from './StreamReporter';