feat(cucumber): support for Cucumber.js 3.x

affects: @serenity-js/core, @serenity-js/cucumber, @integration/cucumber-1-runner,
@integration/cucumber-2-runner, @integration/cucumber-3-runner, @integration/cucumber,
@integration/testing-tools

ISSUES CLOSED: #28

integration/cucumber-1-runner/README.md

@@ -4,4 +4,4 @@ This is an internal test module that embeds Cucumber 1.3
 so that it can be executed against the integration tests in [`integration/cucumber`](../cucumber)
 
 ## Notes
-- [Cucumber.js step definitions](https://github.com/cucumber/cucumber-js/blob/1.x/docs/support_files/step_definitions.md)
+- [Cucumber.js step definitions](https://github.com/cucumber/cucumber-js/blob/v1.3.3/docs/support_files/step_definitions.md)

integration/cucumber-1-runner/package.json

@@ -35,10 +35,10 @@
   "dependencies": {
     "@integration/testing-tools": "*",
     "@serenity-js/core": "*",
-    "@serenity-js/cucumber": "*"
+    "@serenity-js/cucumber": "*",
+    "cucumber": "1.3.3"
   },
   "devDependencies": {
-    "@types/cucumber": "1.3.3",
-    "cucumber": "1.3.3"
+    "@types/cucumber": "1.3.3"
   }
 }

integration/cucumber-1-runner/tsconfig-lint.json

@@ -2,7 +2,8 @@
   "extends": "./tsconfig",
   "include": [
     "src/**/*.ts",
-    "spec/**/*.ts"
+    "spec/**/*.ts",
+    "features/**/*.ts"
   ],
   "exclude": [
     "node_modules"

integration/cucumber-2-runner/README.md

@@ -4,4 +4,4 @@ This is an internal test module that embeds Cucumber 2.3
 so that it can be executed against the integration tests in [`integration/cucumber`](../cucumber)
 
 ## Notes
-- [Cucumber.js step definitions](https://github.com/cucumber/cucumber-js/blob/2.x/docs/support_files/step_definitions.md)
+- [Cucumber.js step definitions](https://github.com/cucumber/cucumber-js/blob/v2.3.1/docs/support_files/step_definitions.md)

integration/cucumber-2-runner/features/support/configure_serenity.ts

@@ -6,8 +6,6 @@ import { defineSupportCode } from 'cucumber';
 defineSupportCode(({ setDefaultTimeout }) => {
     setDefaultTimeout(5000);
 
-    console.log('>>> configure_serenity :: loading serenity from', require.resolve('@serenity-js/core'));
-
     serenity.stageManager.register(
         new ChildProcessReporter(),
         new DebugReporter(),

integration/cucumber-2-runner/package.json

@@ -35,10 +35,10 @@
   "dependencies": {
     "@integration/testing-tools": "*",
     "@serenity-js/core": "*",
-    "@serenity-js/cucumber": "*"
+    "@serenity-js/cucumber": "*",
+    "cucumber": "2.3.1"
   },
   "devDependencies": {
-    "@types/cucumber": "2.1.0",
-    "cucumber": "2.3.1"
+    "@types/cucumber": "2.1.0"
   }
 }

integration/cucumber-2-runner/tsconfig-lint.json

@@ -2,7 +2,8 @@
   "extends": "./tsconfig",
   "include": [
     "src/**/*.ts",
-    "spec/**/*.ts"
+    "spec/**/*.ts",
+    "features/**/*.ts"
   ],
   "exclude": [
     "node_modules"

integration/cucumber-3-runner/.gitignore

@@ -0,0 +1,7 @@
+# Node
+node_modules
+*.log
+
+# Build artifacts
+.nyc_output
+lib

integration/cucumber-3-runner/README.md

@@ -0,0 +1,8 @@
+# Cucumber 2.x runner
+
+This is an internal test module that embeds Cucumber 2.3
+so that it can be executed against the integration tests in [`integration/cucumber`](../cucumber)
+
+## Notes
+- [Cucumber.js step definitions](https://github.com/cucumber/cucumber-js/blob/v3.2.1/docs/support_files/step_definitions.md)
+- [Sample event protocol events](https://github.com/cucumber/cucumber-js/blob/v4.2.1/src/formatter/event_protocol_formatter.js)

integration/cucumber-3-runner/features/step_definitions/ambiguous.steps.ts

@@ -0,0 +1,12 @@
+import { defineSupportCode } from 'cucumber';
+
+defineSupportCode(({ Given }) => {
+
+    Given(/^.*step (?:.*) passes$/, function() {
+        return void 0;
+    });
+
+    Given(/^.*step (?:.*) passes$/, function() {
+        return void 0;
+    });
+});

integration/cucumber-3-runner/features/step_definitions/callback.steps.ts

@@ -0,0 +1,30 @@
+import { defineSupportCode, TableDefinition } from 'cucumber';
+
+type Callback =  (error?: Error, pending?: string) => void;
+
+defineSupportCode(({ Given }) => {
+
+    Given(/^.*step (?:.*) passes$/, function(done: Callback) {
+        done();
+    });
+
+    Given(/^.*step (?:.*) fails$/, function(done: Callback) {
+        done(new Error(`Something's wrong`));
+    });
+
+    Given(/^.*step (?:.*) marked as pending/, function(done: Callback) {
+        done(void 0, 'pending');
+    });
+
+    Given(/^.*step (?:.*) receives a table:$/, function(data: TableDefinition, done) {
+        done();
+    });
+
+    Given(/^.*step (?:.*) receives a doc string:$/, function(docstring: string, done) {
+        done();
+    });
+
+    Given(/^.*step that times out$/,  { timeout: 100 }, function(done: Callback) {
+        setTimeout(done, 1000);
+    });
+});

integration/cucumber-3-runner/features/step_definitions/promise.steps.ts

@@ -0,0 +1,29 @@
+import { defineSupportCode, TableDefinition } from 'cucumber';
+
+defineSupportCode(({ Given }) => {
+    Given(/^.*step (?:.*) passes$/, function() {
+        return Promise.resolve();
+    });
+
+    Given(/^.*step (?:.*) fails$/, function() {
+        return Promise.reject(new Error(`Something's wrong`));
+    });
+
+    Given(/^.*step (?:.*) marked as pending/, function() {
+        return Promise.resolve('pending');
+    });
+
+    Given(/^.*step (?:.*) receives a table:$/, function(data: TableDefinition) {
+        return Promise.resolve();
+    });
+
+    Given(/^.*step (?:.*) receives a doc string:$/, function(docstring: string) {
+        return Promise.resolve();
+    });
+
+    Given(/^.*step that times out$/,  { timeout: 100 }, function() {
+        return new Promise((resolve, reject) => {
+            setTimeout(resolve, 1000);
+        });
+    });
+});

integration/cucumber-3-runner/features/step_definitions/synchronous.steps.ts

@@ -0,0 +1,23 @@
+import { defineSupportCode, TableDefinition } from 'cucumber';
+
+defineSupportCode(({ Given }) => {
+    Given(/^.*step (?:.*) passes$/, function() {
+        return void 0;
+    });
+
+    Given(/^.*step (?:.*) fails$/, function() {
+        throw new Error(`Something's wrong`);
+    });
+
+    Given(/^.*step (?:.*) marked as pending/, function() {
+        return 'pending';
+    });
+
+    Given(/^.*step (?:.*) receives a table:$/, function(data: TableDefinition) {
+        return void 0;
+    });
+
+    Given(/^.*step (?:.*) receives a doc string:$/, function(docstring: string) {
+        return void 0;
+    });
+});

integration/cucumber-3-runner/features/support/after_hook.ts

@@ -0,0 +1,8 @@
+import { defineSupportCode } from 'cucumber';
+
+defineSupportCode(({ After }) => {
+
+    After(function() {
+        // no-op
+    });
+});

integration/cucumber-3-runner/features/support/before_hook.ts

@@ -0,0 +1,8 @@
+import { defineSupportCode } from 'cucumber';
+
+defineSupportCode(({ Before }) => {
+
+    Before(function() {
+        // no-op
+    });
+});

integration/cucumber-3-runner/features/support/configure_serenity.ts

@@ -0,0 +1,13 @@
+import { ChildProcessReporter } from '@integration/testing-tools';
+import { serenity } from '@serenity-js/core';
+import { DebugReporter } from '@serenity-js/core/lib/stage';
+import { defineSupportCode } from 'cucumber';
+
+defineSupportCode(({ setDefaultTimeout }) => {
+    setDefaultTimeout(5000);
+
+    serenity.stageManager.register(
+        new ChildProcessReporter(),
+        new DebugReporter(),
+    );
+});

integration/cucumber-3-runner/features/support/wip_hook.ts

@@ -0,0 +1,8 @@
+import { defineSupportCode } from 'cucumber';
+
+defineSupportCode(({ Before }) => {
+
+    Before({ tags: '@wip' }, function() {
+        return 'pending';
+    });
+});

integration/cucumber-3-runner/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@integration/cucumber-3-runner",
+  "version": "0.0.0",
+  "description": "Cucumber JS 3.x test runner",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "author": {
+    "name" : "Jan Molak",
+    "email" : "jan.molak@smartcodeltd.co.uk",
+    "url" : "https://janmolak.com"
+  },
+  "homepage": "http://serenity-js.org",
+  "license": "Apache-2.0",
+  "private": true,
+  "config": {
+    "access": "private"
+  },
+  "scripts": {
+    "clean": "rimraf lib",
+    "lint": "tslint --project tsconfig-lint.json --config ../../tslint.json --format stylish",
+    "test": "exit 0",
+    "compile": "tsc --project tsconfig.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jan-molak/serenity-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jan-molak/serenity-js/issues"
+  },
+  "engines": {
+    "node": ">= 6.9.x",
+    "npm": ">= 3"
+  },
+  "dependencies": {
+    "@integration/testing-tools": "*",
+    "@serenity-js/core": "*",
+    "@serenity-js/cucumber": "*",
+    "cucumber": "3.2.1"
+  },
+  "devDependencies": {
+    "@types/cucumber": "3.2.2"
+  }
+}

integration/cucumber-3-runner/src/index.ts

@@ -0,0 +1,19 @@
+import { spawner, SpawnResult } from '@integration/testing-tools';
+import * as path from 'path';
+
+const cucumberExecutable = path.resolve(
+    require.resolve('cucumber/package.json'),
+    '..',
+    'bin',
+    'cucumber.js',
+);
+
+const cucumberSpawner = spawner(
+    cucumberExecutable,
+    { cwd: path.resolve(__dirname, '..') },
+);
+
+export = (...params: string[]): Promise<SpawnResult> => cucumberSpawner(
+    '--compiler', 'ts:ts-node/register',
+    ...params,
+);

integration/cucumber-3-runner/tsconfig-lint.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig",
+  "include": [
+    "src/**/*.ts",
+    "spec/**/*.ts",
+    "features/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}

integration/cucumber-3-runner/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": [ "es5", "es6" ],
+    "module": "commonjs",
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "sourceMap": true,
+    "declaration": true,
+    "outDir": "./lib"
+  },
+
+  "include": [
+    "src"
+  ],
+
+  "exclude": [
+    "node_modules"
+  ]
+}

integration/cucumber/features/passing_scenario.feature

@@ -3,4 +3,3 @@ Feature: Serenity/JS recognises a passing scenario
   Scenario: A passing scenario
 
     Given a step that passes
-

integration/cucumber/package.json

@@ -16,7 +16,7 @@
   "scripts": {
     "clean": "rimraf lib",
     "lint": "tslint --project tsconfig-lint.json --config ../../tslint.json --format stylish",
-    "test": "mocha --opts ../../mocha.opts 'spec/**/*.spec.*'",
+    "test": "parallel-mocha --opts ../../mocha.opts 'spec/**/*.spec.*'",
     "test:parallel": "mocha-parallel-tests --opts ../../mocha.opts 'spec/**/*.spec.*'"
   },
   "repository": {
@@ -34,11 +34,8 @@
     "@integration/testing-tools": "*",
     "@integration/cucumber-1-runner": "*",
     "@integration/cucumber-2-runner": "*",
+    "@integration/cucumber-3-runner": "*",
     "@serenity-js/core": "*",
     "@serenity-js/cucumber": "*"
-  },
-  "devDependencies": {
-    "@types/cucumber": "1.3.3",
-    "cucumber": "1.3.3"
   }
 }