@lynxwall/cucumber-tsflow 4.0.0

package/README.md

@@ -0,0 +1,284 @@
+![CI](https://github.com/lynxwall/cucumber-js-tsflow/workflows/CI/badge.svg)
+
+# cucumber-tsflow
+
+Provides 'specflow' like bindings for CucumberJS in TypeScript 1.7+.
+
+This is a fork of the original cucumber-tsflow found here: [cucumber-tsflow](https://github.com/timjroberts/cucumber-js-tsflow)
+
+This fork contains the following updates:
+
+- Updated to use latest version of Cucumber (@cucumber/cucumber).
+- Bug fixes related to tags.
+- Added Timeout in step definition and hooks.
+- Added WrapperOptions in step definitions.
+- Added BeforeAll and AfterAll Hooks.
+- Added a behave-json-formatter that fixes json so it can be used with Behave Pro.
+- Added tsflow-snippet-syntax used to format snippet examples.
+  - examples use the [Cucumber Syntax](https://github.com/cucumber/cucumber-expressions#readme) for parameters.
+
+### Quick Start
+
+cucumber-tsflow uses TypeScript Decorators to create SpecFlow like bindings for TypeScript classes and methods that allow those classes and methods to be used in your CucumberJS support files. As such, cucumber-tsflow has a peer dependency on CucumberJS, and you still run your specifications using the cucumber command line tool.
+
+##### Install @cucumber/cucumber and @lynxwall/cucumber-tsflow
+
+###### npm
+
+```bash
+npm install @cucumber/cucumber @lynxwall/cucumber-tsflow --save-dev
+```
+
+###### yarn
+
+```bash
+yarn add --dev @cucumber/cucumber @lynxwall/cucumber-tsflow
+```
+
+###### Create .feature files to describe your specifications
+
+By default, CucumberJS looks for .feature files in a folder called 'features', so create that folder and then create a new file called 'my_feature.feature':
+
+```gherkin
+# features/my_feature.feature
+
+Feature: Example Feature
+   This is an example feature
+
+   Scenario: Adding two numbers
+     Given I enter "2" and "8"
+     Then I receive the result "10"
+```
+
+###### Create the Support Files to support the Feature
+
+By default, CucumberJS looks for support files beneath the 'features' folder. You can override this on the cucumber command line by specifying the '-r' option. However, let's work with the default and create our code in the default location. We need to write step definitions to support the two steps that we created above.
+
+Create a new 'ArithmeticSteps.ts' file:
+
+```javascript
+// features/ArithmeticSteps.ts
+
+import { binding, given, then } from "@lynxwall/cucumber-tsflow";
+
+@binding()
+class ArithmeticSteps {
+    private computedResult: number;
+
+    @given('I enter {string} and {string}')
+    iEnterstringAndstring(num1: string, num2: string): any {
+        this.computedResult = parseInt(num1) + parseInt(num2);
+    }
+
+    @then('I receive the result {string}')
+    iReceiveTheResultstring(expectedResult: string): any {
+        if (parseInt(expectedResult) !== this.computedResult) {
+            throw new Error('Arithmetic Error');
+        }
+    }
+}
+
+export = ArithmeticSteps;
+```
+
+Note how the cucumber-tsflow Decorators are being used to bind the methods in the class. During runtime, these Decorators simply call the Cucumber code on your behalf in order to register callbacks with Given(), When(), Then(), etc. The callbacks that are being registered with Cucumber are wrappers around your bound class.
+
+###### Compiling your TypeScript Support Code
+
+You'll also need a `tsconfig.json` file to compile your code. You'll also need to ensure that the `"moduleResolution": "node"` compiler option is set in order to bring in the typings that are shipped with cucumber-tsflow.
+
+Once compiled, running the cucumber command line should execute your features along with the support code that you've created in the class.
+
+In this quick example test state is encapsulated directly in the class. As your test suite grows larger and step definitions get shared between multiple classes, you can begin using 'Context Injection' to share state between running step definitions (see below).
+
+### Bindings
+
+Bindings provide the automation that connects a specification step in a Gherkin feature file to some code that
+executes for that step. When using Cucumber with TypeScript you can define this automation using a 'binding' class:
+
+```javascript
+import { binding } from "@lynxwall/cucumber-tsflow";
+
+@binding()
+class MySteps {
+    ...
+}
+
+export = MySteps;
+```
+
+*Note*: You must use the `export = <type>;` because Cucumber expects exports in this manner.
+
+### Step Definitions
+
+Step definitions can be bound to automation code in a 'binding' class by implementing a public function that is
+bound with a 'given', 'when' or 'then' binding decorator:
+
+```javascript
+import { binding, given, when, then } from "@lynxwall/cucumber-tsflow";
+
+@binding()
+class MySteps {
+    ...
+    @given(/I perform a search using the value "([^"]*)"/)
+    public givenAValueBasedSearch(searchValue: string): void {
+        ...
+    }
+    ...
+}
+
+export = MySteps;
+```
+
+The function follows the same requirements of functions you would normally supply to Cucumber which means that the
+functions may be synchronous by returning nothing, use the callback, or return a `Promise<T>`. Additionally, the
+function may also be `async` following the TypeScript async semantics.
+
+Step definitions may also be scoped at a tag level by supplying an optional tag name when using the binding
+decorators:
+
+```javascript
+@given('I perform a search using the value {string}')
+public givenAValueBasedSearch(searchValue: string): void {
+    ...
+    // The default step definition
+    ...
+}
+
+@given('I perform a search using the value {string}', "@tagName")
+public givenAValueBasedSearch(searchValue: string): void {
+    ...
+    // The step definition that will execute if the feature or
+    // scenario has the @tagName defined on it
+    ...
+}
+```
+
+#### Hooks
+
+Hooks can be used to perform additional automation on specific events such as before or after scenario execution.
+Hooks can be restricted to run for only features or scenarios with a specific tag:
+
+```typescript
+import { binding, before, after } from "@lynxwall/cucumber-tsflow";
+
+@binding()
+class MySteps {
+    ...
+    @before()
+    public beforeAllScenarios(): void {
+        ...
+    }
+    ...
+
+    @before("@requireTempDir")
+    public async beforeAllScenariosRequiringTempDirectory(): Promise<void> {
+        let tempDirInfo = await this.createTemporaryDirectory();
+
+        ...
+    }
+
+    @after()
+    public afterAllScenarios(): void {
+        ...
+    }
+
+    @after("@requireTmpDir")
+    public afterAllScenarios(): void {
+        ...
+    }
+}
+
+export = MySteps;
+```
+
+#### Timeout in step definition and hooks
+
+In step definition and hooks, we can set timeout. For example, to set the timeout for a step to be 20000ms, we can do:
+
+```typescript
+
+@given('I perform a search using the value {string}', undefined, 20000)
+public givenAValueBasedSearch(searchValue: string): void {
+    ...
+    // this step will time tou in 20000ms.
+    ...
+}
+
+```
+
+tsflow currently doesn't have a way to define a global default step timeout,
+
+but it can be easily done through cucumber.js ```setDefaultTimeout``` function.
+
+#### Passing WrapperOptions
+
+In step definition, we can pass additional wrapper options to cucumber js. For example:
+
+```typescript
+
+@given('I perform a search using the value {string}', undefined, undefined, {retry: 2})
+public givenAValueBasedSearch(searchValue: string): void {
+    ...
+    // this step will be retried by cucumber js    
+    ...
+}
+
+```
+
+#### Using behave-json-formatter and tsflow-snippet-syntax
+
+Changing the formatter used for generating json along with changing the Snippet Syntax can be done through the cucumber.js configuration file.
+
+If it doesn't already exist, create a file named cucumber.js at the root of your project. This is where we can configure different options for cucumber.js.
+
+The following example shows how to configure the formatter and snippet syntax:
+
+```javascript
+module.exports = {
+ default: [
+  '--format node_modules/@lynxwall/cucumber-tsflow/dist/behave-json-formatter:cucumber_report.json',
+  '--format-options \'{"snippetSyntax": "node_modules/@lynxwall/cucumber-tsflow/dist/tsflow-snippet-syntax"}\'',
+  '--publish-quiet'
+ ].join(' ')
+};
+```
+
+The first line tells cucumber to generate a report using the behave-json-formatter.
+
+The next line tells cucumber to generate example snippets using the tsflow-snippet-syntax.
+
+### Sharing Data between Bindings
+
+#### Context Injection
+
+Like 'specflow', cucumber-tsflow supports a simple dependency injection framework that will instantitate and inject
+class instances into 'binding' classes for each execuing scenario.
+
+To use context injection:
+
+- Create simple classes representing the shared data (they *must* have default constructors)
+- Define a constructor on the 'binding' classes that will require the shared data that accepts the context objects
+as parameters
+- Update the `@binding()` decorator to indicate the types of context objects that are required by the 'binding'
+class
+
+```javascript
+import { binding, before, after } from "@lynxwall/cucumber-tsflow";
+import { Workspace } from "./Workspace";
+
+@binding([Workspace])
+class MySteps {
+    constructor(protected workspace: Workspace)
+    { }
+
+    @before("requireTempDir")
+    public async beforeAllScenariosRequiringTempDirectory(): Promise<void> {
+        let tempDirInfo = await this.createTemporaryDirectory();
+
+        this.workspace.updateFolder(tempDirInfo);
+    }
+}
+
+export = MySteps;
+```

package/dist/behave-json-formatter.d.ts

@@ -0,0 +1,19 @@
+import JsonFormatter, { IJsonStep } from '@cucumber/cucumber/lib/formatter/json_formatter';
+import * as messages from '@cucumber/messages';
+interface IBuildJsonStepOptions {
+    isBeforeHook: boolean;
+    gherkinStepMap: Record<string, messages.Step>;
+    pickleStepMap: Record<string, messages.PickleStep>;
+    testStep: messages.TestStep;
+    testStepAttachments: messages.Attachment[];
+    testStepResult: messages.TestStepResult;
+}
+/**
+ * Extending JsonFormatter.getStepData to add a name field to 	before
+ * and After steps so that json can be exported to Behave Pro (name on steps required)
+ */
+export default class BehaveJsonFormatter extends JsonFormatter {
+    getStepData({ isBeforeHook, gherkinStepMap, pickleStepMap, testStep, testStepAttachments, testStepResult }: IBuildJsonStepOptions): IJsonStep;
+}
+export {};
+//# sourceMappingURL=behave-json-formatter.d.ts.map

package/dist/behave-json-formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"behave-json-formatter.d.ts","sourceRoot":"","sources":["../src/behave-json-formatter.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,EAAE,EAAE,SAAS,EAAE,MAAM,iDAAiD,CAAC;AAC3F,OAAO,KAAK,QAAQ,MAAM,oBAAoB,CAAC;AAO/C,UAAU,qBAAqB;IAC9B,YAAY,EAAE,OAAO,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9C,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACnD,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;IAC5B,mBAAmB,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC3C,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,aAAa;IAC7D,WAAW,CAAC,EACX,YAAY,EACZ,cAAc,EACd,aAAa,EACb,QAAQ,EACR,mBAAmB,EACnB,cAAc,EACd,EAAE,qBAAqB,GAAG,SAAS;CAwCpC"}

package/dist/behave-json-formatter.js

@@ -0,0 +1,62 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "@cucumber/cucumber/lib/formatter/json_formatter", "@cucumber/messages", "@cucumber/cucumber/lib/value_checker", "@cucumber/cucumber/lib/formatter/helpers"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    const json_formatter_1 = require("@cucumber/cucumber/lib/formatter/json_formatter");
+    const messages = require("@cucumber/messages");
+    const value_checker_1 = require("@cucumber/cucumber/lib/value_checker");
+    const helpers_1 = require("@cucumber/cucumber/lib/formatter/helpers");
+    const { getStepKeyword } = helpers_1.PickleParser;
+    /**
+     * Extending JsonFormatter.getStepData to add a name field to 	before
+     * and After steps so that json can be exported to Behave Pro (name on steps required)
+     */
+    class BehaveJsonFormatter extends json_formatter_1.default {
+        getStepData({ isBeforeHook, gherkinStepMap, pickleStepMap, testStep, testStepAttachments, testStepResult }) {
+            var _a;
+            const data = {};
+            if ((0, value_checker_1.doesHaveValue)(testStep.pickleStepId)) {
+                const pickleStep = pickleStepMap[testStep.pickleStepId];
+                data.arguments = this.formatStepArgument(pickleStep.argument, gherkinStepMap[pickleStep.astNodeIds[0]]);
+                data.keyword = getStepKeyword({ pickleStep, gherkinStepMap });
+                data.line = gherkinStepMap[pickleStep.astNodeIds[0]].location.line;
+                data.name = pickleStep.text;
+            }
+            else {
+                data.keyword = isBeforeHook ? 'Before' : 'After';
+                data.hidden = true;
+                data.name = '';
+            }
+            if ((0, value_checker_1.doesHaveValue)(testStep.stepDefinitionIds) && ((_a = testStep.stepDefinitionIds) === null || _a === void 0 ? void 0 : _a.length) === 1) {
+                const stepDefinition = this.supportCodeLibrary.stepDefinitions.find(s => s.id === testStep.stepDefinitionIds[0]);
+                data.match = { location: (0, helpers_1.formatLocation)(stepDefinition) };
+            }
+            const { message, status } = testStepResult;
+            data.result = {
+                status: messages.TestStepResultStatus[status].toLowerCase()
+            };
+            if ((0, value_checker_1.doesHaveValue)(testStepResult.duration)) {
+                data.result.duration = messages.TimeConversion.durationToMilliseconds(testStepResult.duration) * 1000000;
+            }
+            if (status === messages.TestStepResultStatus.FAILED && (0, value_checker_1.doesHaveValue)(message)) {
+                data.result.error_message = message;
+            }
+            if ((testStepAttachments === null || testStepAttachments === void 0 ? void 0 : testStepAttachments.length) > 0) {
+                data.embeddings = testStepAttachments.map(attachment => ({
+                    data: attachment.body,
+                    mime_type: attachment.mediaType
+                }));
+            }
+            return data;
+        }
+    }
+    exports.default = BehaveJsonFormatter;
+});
+//# sourceMappingURL=behave-json-formatter.js.map

package/dist/behave-json-formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"behave-json-formatter.js","sourceRoot":"","sources":["../src/behave-json-formatter.ts"],"names":[],"mappings":";;;;;;;;;;;IAAA,oFAA2F;IAC3F,+CAA+C;IAC/C,wEAAqE;IACrE,sEAAwF;IAGxF,MAAM,EAAE,cAAc,EAAE,GAAG,sBAAY,CAAC;IAWxC;;;OAGG;IACH,MAAqB,mBAAoB,SAAQ,wBAAa;QAC7D,WAAW,CAAC,EACX,YAAY,EACZ,cAAc,EACd,aAAa,EACb,QAAQ,EACR,mBAAmB,EACnB,cAAc,EACS;;YACvB,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,YAAY,CAAC,EAAE;gBACzC,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,YAAsB,CAAC,CAAC;gBAClE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,kBAAkB,CACvC,UAAU,CAAC,QAA8B,EACzC,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CACxC,CAAC;gBACF,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAC;gBAC9D,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACnE,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;aAC5B;iBAAM;gBACN,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC;gBACjD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;gBACnB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;aACf;YACD,IAAI,IAAA,6BAAa,EAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAA,MAAA,QAAQ,CAAC,iBAAiB,0CAAE,MAAM,MAAK,CAAC,EAAE;gBAC1F,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAClE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAM,QAAQ,CAAC,iBAA8B,CAAC,CAAC,CAAC,CACzD,CAAC;gBACF,IAAI,CAAC,KAAK,GAAG,EAAE,QAAQ,EAAE,IAAA,wBAAc,EAAC,cAA6B,CAAC,EAAE,CAAC;aACzE;YACD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC;YAC3C,IAAI,CAAC,MAAM,GAAG;gBACb,MAAM,EAAE,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE;aAC3D,CAAC;YACF,IAAI,IAAA,6BAAa,EAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;gBAC3C,IAAI,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC,cAAc,CAAC,sBAAsB,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC;aACzG;YACD,IAAI,MAAM,KAAK,QAAQ,CAAC,oBAAoB,CAAC,MAAM,IAAI,IAAA,6BAAa,EAAC,OAAO,CAAC,EAAE;gBAC9E,IAAI,CAAC,MAAM,CAAC,aAAa,GAAG,OAAO,CAAC;aACpC;YACD,IAAI,CAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,MAAM,IAAG,CAAC,EAAE;gBACpC,IAAI,CAAC,UAAU,GAAG,mBAAmB,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;oBACxD,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,SAAS,EAAE,UAAU,CAAC,SAAS;iBAC/B,CAAC,CAAC,CAAC;aACJ;YACD,OAAO,IAAI,CAAC;QACb,CAAC;KACD;IAhDD,sCAgDC"}

package/dist/binding-decorator.d.ts

@@ -0,0 +1,11 @@
+import { ContextType, TypeDecorator } from './types';
+/**
+ * A class decorator that marks the associated class as a CucumberJS binding.
+ *
+ * @param requiredContextTypes An optional array of Types that will be created and passed into the created
+ * object for each scenario.
+ *
+ * An instance of the decorated class will be created for each scenario.
+ */
+export declare function binding(requiredContextTypes?: ContextType[]): TypeDecorator;
+//# sourceMappingURL=binding-decorator.d.ts.map

package/dist/binding-decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding-decorator.d.ts","sourceRoot":"","sources":["../src/binding-decorator.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,WAAW,EAAe,aAAa,EAAE,MAAM,SAAS,CAAC;AAyBlE;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,GAAG,aAAa,CAyB3E"}

package/dist/binding-decorator.js

@@ -0,0 +1,189 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "@cucumber/cucumber", "underscore", "./logger", "./binding-registry", "./managed-scenario-context", "./step-binding"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.binding = void 0;
+    /* eslint-disable prefer-rest-params */
+    const cucumber_1 = require("@cucumber/cucumber");
+    const _ = require("underscore");
+    const logger_1 = require("./logger");
+    const binding_registry_1 = require("./binding-registry");
+    const managed_scenario_context_1 = require("./managed-scenario-context");
+    const step_binding_1 = require("./step-binding");
+    /**
+     * The property name of the current scenario context that will be attached to the Cucumber
+     * world object.
+     */
+    const SCENARIO_CONTEXT_SLOTNAME = '__SCENARIO_CONTEXT';
+    /**
+     * A set of step patterns that have been registered with Cucumber.
+     *
+     * In order to support scoped (or tagged) step definitions, we must ensure that any step binding is
+     * only registered with Cucumber once. The binding function for that step pattern then becomes
+     * responsible for looking up and execuing the step binding based on the context that is in scope at
+     * the point of invocation.
+     */
+    const stepPatternRegistrations = new Map();
+    // tslint:disable:no-bitwise
+    /**
+     * A class decorator that marks the associated class as a CucumberJS binding.
+     *
+     * @param requiredContextTypes An optional array of Types that will be created and passed into the created
+     * object for each scenario.
+     *
+     * An instance of the decorated class will be created for each scenario.
+     */
+    function binding(requiredContextTypes) {
+        return (target) => {
+            ensureSystemBindings();
+            const bindingRegistry = binding_registry_1.BindingRegistry.instance;
+            bindingRegistry.registerContextTypesForTarget(target.prototype, requiredContextTypes);
+            const allBindings = [];
+            allBindings.push(...bindingRegistry.getStepBindingsForTarget(target));
+            allBindings.push(...bindingRegistry.getStepBindingsForTarget(target.prototype));
+            allBindings.forEach(stepBinding => {
+                if (stepBinding.bindingType & step_binding_1.StepBindingFlags.StepDefinitions) {
+                    let stepBindingFlags = stepPatternRegistrations.get(stepBinding.stepPattern.toString());
+                    if (stepBindingFlags === undefined) {
+                        stepBindingFlags = step_binding_1.StepBindingFlags.none;
+                    }
+                    if (stepBindingFlags & stepBinding.bindingType) {
+                        return;
+                    }
+                    bindStepDefinition(stepBinding);
+                    stepPatternRegistrations.set(stepBinding.stepPattern.toString(), stepBindingFlags | stepBinding.bindingType);
+                }
+                else if (stepBinding.bindingType & step_binding_1.StepBindingFlags.Hooks) {
+                    bindHook(stepBinding);
+                }
+            });
+        };
+    }
+    exports.binding = binding;
+    /**
+     * Ensures that the 'cucumber-tsflow' hooks are bound to Cucumber.
+     *
+     * @param cucumber The cucumber object.
+     *
+     * The hooks will only be registered with Cucumber once regardless of which binding invokes the
+     * function.
+     */
+    const ensureSystemBindings = _.once(() => {
+        (0, cucumber_1.Before)(function (scenario) {
+            var _a, _b, _c, _d;
+            logger_1.default.trace('Setting up scenario context for scenario:', JSON.stringify(scenario));
+            this[SCENARIO_CONTEXT_SLOTNAME] = new managed_scenario_context_1.ManagedScenarioContext((_b = (_a = scenario.pickle) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : '', _.map((_d = (_c = scenario.pickle) === null || _c === void 0 ? void 0 : _c.tags) !== null && _d !== void 0 ? _d : new Array(), (tag) => { var _a; return (_a = tag === null || tag === void 0 ? void 0 : tag.name) !== null && _a !== void 0 ? _a : ''; }));
+        });
+        (0, cucumber_1.After)(function () {
+            const scenarioContext = this[SCENARIO_CONTEXT_SLOTNAME];
+            if (scenarioContext) {
+                scenarioContext.dispose();
+            }
+        });
+    });
+    /**
+     * Binds a step definition to Cucumber.
+     *
+     * @param stepBinding The [[StepBinding]] that represents a 'given', 'when', or 'then' step definition.
+     */
+    function bindStepDefinition(stepBinding) {
+        const bindingFunc = function () {
+            const bindingRegistry = binding_registry_1.BindingRegistry.instance;
+            const scenarioContext = this[SCENARIO_CONTEXT_SLOTNAME];
+            const matchingStepBindings = bindingRegistry.getStepBindings(stepBinding.stepPattern.toString(), scenarioContext.scenarioInfo.tags);
+            if (matchingStepBindings.length > 1) {
+                let message = `Ambiguous step definitions for '${matchingStepBindings[0].stepPattern}':\n`;
+                matchingStepBindings.forEach(matchingStepBinding => {
+                    message =
+                        message +
+                            `\t\t${String(matchingStepBinding.targetPropertyKey)} (${matchingStepBinding.callsite.toString()})\n`;
+                });
+                throw new Error(message);
+            }
+            else if (matchingStepBindings.length === 0) {
+                throw new Error(`Cannot find matched step definition for ${stepBinding.stepPattern.toString()} with tag ${scenarioContext.scenarioInfo.tags} in binding registry`);
+            }
+            const contextTypes = bindingRegistry.getContextTypesForTarget(matchingStepBindings[0].targetPrototype);
+            const bindingObject = scenarioContext.getOrActivateBindingClass(matchingStepBindings[0].targetPrototype, contextTypes);
+            bindingObject._worldObj = this;
+            return bindingObject[matchingStepBindings[0].targetPropertyKey].apply(bindingObject, arguments);
+        };
+        Object.defineProperty(bindingFunc, 'length', {
+            value: stepBinding.argsLength
+        });
+        if (stepBinding.bindingType & step_binding_1.StepBindingFlags.given) {
+            (0, cucumber_1.Given)(stepBinding.stepPattern, {
+                timeout: stepBinding.timeout,
+                wrapperOptions: stepBinding.wrapperOption
+            }, bindingFunc);
+        }
+        else if (stepBinding.bindingType & step_binding_1.StepBindingFlags.when) {
+            (0, cucumber_1.When)(stepBinding.stepPattern, {
+                timeout: stepBinding.timeout,
+                wrapperOptions: stepBinding.wrapperOption
+            }, bindingFunc);
+        }
+        else if (stepBinding.bindingType & step_binding_1.StepBindingFlags.then) {
+            (0, cucumber_1.Then)(stepBinding.stepPattern, {
+                timeout: stepBinding.timeout,
+                wrapperOptions: stepBinding.wrapperOption
+            }, bindingFunc);
+        }
+    }
+    /**
+     * Binds a hook to Cucumber.
+     *
+     * @param cucumber The cucumber object.
+     * @param stepBinding The [[StepBinding]] that represents a 'before', or 'after', step definition.
+     */
+    function bindHook(stepBinding) {
+        const bindingFunc = function () {
+            const scenarioContext = this[SCENARIO_CONTEXT_SLOTNAME];
+            const contextTypes = binding_registry_1.BindingRegistry.instance.getContextTypesForTarget(stepBinding.targetPrototype);
+            const bindingObject = scenarioContext.getOrActivateBindingClass(stepBinding.targetPrototype, contextTypes);
+            bindingObject._worldObj = this;
+            return bindingObject[stepBinding.targetPropertyKey].apply(bindingObject, arguments);
+        };
+        const globalBindFunc = () => {
+            const targetPrototype = stepBinding.targetPrototype;
+            const targetPropertyKey = stepBinding.targetPropertyKey;
+            return targetPrototype[targetPropertyKey].apply();
+        };
+        Object.defineProperty(bindingFunc, 'length', {
+            value: stepBinding.argsLength
+        });
+        const tags = stepBinding.tag === binding_registry_1.DEFAULT_TAG ? undefined : stepBinding.tag;
+        switch (stepBinding.bindingType) {
+            case step_binding_1.StepBindingFlags.before: {
+                (0, cucumber_1.Before)({
+                    tags: tags,
+                    timeout: stepBinding.timeout
+                }, bindingFunc);
+                break;
+            }
+            case step_binding_1.StepBindingFlags.after: {
+                (0, cucumber_1.After)({
+                    tags: tags,
+                    timeout: stepBinding.timeout
+                }, bindingFunc);
+                break;
+            }
+            case step_binding_1.StepBindingFlags.beforeAll: {
+                (0, cucumber_1.BeforeAll)(globalBindFunc);
+                break;
+            }
+            case step_binding_1.StepBindingFlags.afterAll: {
+                (0, cucumber_1.AfterAll)(globalBindFunc);
+                break;
+            }
+        }
+    }
+});
+//# sourceMappingURL=binding-decorator.js.map

package/dist/binding-decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding-decorator.js","sourceRoot":"","sources":["../src/binding-decorator.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uCAAuC;IACvC,iDAAkG;IAGlG,gCAAgC;IAChC,qCAA8B;IAE9B,yDAAkE;IAClE,yEAAoE;IACpE,iDAA+D;IAQ/D;;;OAGG;IACH,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;IAEvD;;;;;;;OAOG;IACH,MAAM,wBAAwB,GAAG,IAAI,GAAG,EAAiC,CAAC;IAE1E,4BAA4B;IAE5B;;;;;;;OAOG;IACH,SAAgB,OAAO,CAAC,oBAAoC;QAC3D,OAAO,CAAI,MAAmC,EAAE,EAAE;YACjD,oBAAoB,EAAE,CAAC;YACvB,MAAM,eAAe,GAAG,kCAAe,CAAC,QAAQ,CAAC;YACjD,eAAe,CAAC,6BAA6B,CAAC,MAAM,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;YACtF,MAAM,WAAW,GAAkB,EAAE,CAAC;YACtC,WAAW,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC;YACtE,WAAW,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,wBAAwB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YAEhF,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;gBACjC,IAAI,WAAW,CAAC,WAAW,GAAG,+BAAgB,CAAC,eAAe,EAAE;oBAC/D,IAAI,gBAAgB,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACxF,IAAI,gBAAgB,KAAK,SAAS,EAAE;wBACnC,gBAAgB,GAAG,+BAAgB,CAAC,IAAI,CAAC;qBACzC;oBACD,IAAI,gBAAgB,GAAG,WAAW,CAAC,WAAW,EAAE;wBAC/C,OAAO;qBACP;oBACD,kBAAkB,CAAC,WAAW,CAAC,CAAC;oBAChC,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,gBAAgB,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;iBAC7G;qBAAM,IAAI,WAAW,CAAC,WAAW,GAAG,+BAAgB,CAAC,KAAK,EAAE;oBAC5D,QAAQ,CAAC,WAAW,CAAC,CAAC;iBACtB;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC;IACH,CAAC;IAzBD,0BAyBC;IAED;;;;;;;OAOG;IACH,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;QACxC,IAAA,iBAAM,EAAC,UAA+B,QAAQ;;YAC7C,gBAAM,CAAC,KAAK,CAAC,2CAA2C,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;YAEpF,IAAI,CAAC,yBAAyB,CAAC,GAAG,IAAI,iDAAsB,CAC3D,MAAA,MAAA,QAAQ,CAAC,MAAM,0CAAE,IAAI,mCAAI,EAAE,EAC3B,CAAC,CAAC,GAAG,CAAC,MAAA,MAAA,QAAQ,CAAC,MAAM,0CAAE,IAAI,mCAAI,IAAI,KAAK,EAAa,EAAE,CAAC,GAAuB,EAAE,EAAE,WAAC,OAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,mCAAI,EAAE,CAAA,EAAA,CAAC,CACpG,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAA,gBAAK,EAAC;YACL,MAAM,eAAe,GAAG,IAAI,CAAC,yBAAyB,CAA2B,CAAC;YAElF,IAAI,eAAe,EAAE;gBACpB,eAAe,CAAC,OAAO,EAAE,CAAC;aAC1B;QACF,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH;;;;OAIG;IACH,SAAS,kBAAkB,CAAC,WAAwB;QACnD,MAAM,WAAW,GAAG;YACnB,MAAM,eAAe,GAAG,kCAAe,CAAC,QAAQ,CAAC;YAEjD,MAAM,eAAe,GAAG,IAAI,CAAC,yBAAyB,CAA2B,CAAC;YAElF,MAAM,oBAAoB,GAAG,eAAe,CAAC,eAAe,CAC3D,WAAW,CAAC,WAAW,CAAC,QAAQ,EAAE,EAClC,eAAe,CAAC,YAAY,CAAC,IAAI,CACjC,CAAC;YAEF,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACpC,IAAI,OAAO,GAAG,mCAAmC,oBAAoB,CAAC,CAAC,CAAC,CAAC,WAAW,MAAM,CAAC;gBAE3F,oBAAoB,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE;oBAClD,OAAO;wBACN,OAAO;4BACP,OAAO,MAAM,CAAC,mBAAmB,CAAC,iBAAiB,CAAC,KAAK,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC;gBACxG,CAAC,CAAC,CAAC;gBAEH,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;aACzB;iBAAM,IAAI,oBAAoB,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC7C,MAAM,IAAI,KAAK,CACd,2CAA2C,WAAW,CAAC,WAAW,CAAC,QAAQ,EAAE,aAC5E,eAAe,CAAC,YAAY,CAAC,IAC9B,sBAAsB,CACtB,CAAC;aACF;YAED,MAAM,YAAY,GAAG,eAAe,CAAC,wBAAwB,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;YACvG,MAAM,aAAa,GAAG,eAAe,CAAC,yBAAyB,CAC9D,oBAAoB,CAAC,CAAC,CAAC,CAAC,eAAe,EACvC,YAAY,CACZ,CAAC;YAEF,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;YAE/B,OAAQ,aAAa,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAgB,CAAC,KAAK,CACpF,aAAa,EACb,SAAgB,CAChB,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,QAAQ,EAAE;YAC5C,KAAK,EAAE,WAAW,CAAC,UAAU;SAC7B,CAAC,CAAC;QAEH,IAAI,WAAW,CAAC,WAAW,GAAG,+BAAgB,CAAC,KAAK,EAAE;YACrD,IAAA,gBAAK,EACJ,WAAW,CAAC,WAAW,EACvB;gBACC,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,cAAc,EAAE,WAAW,CAAC,aAAa;aACzC,EACD,WAAW,CACX,CAAC;SACF;aAAM,IAAI,WAAW,CAAC,WAAW,GAAG,+BAAgB,CAAC,IAAI,EAAE;YAC3D,IAAA,eAAI,EACH,WAAW,CAAC,WAAW,EACvB;gBACC,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,cAAc,EAAE,WAAW,CAAC,aAAa;aACzC,EACD,WAAW,CACX,CAAC;SACF;aAAM,IAAI,WAAW,CAAC,WAAW,GAAG,+BAAgB,CAAC,IAAI,EAAE;YAC3D,IAAA,eAAI,EACH,WAAW,CAAC,WAAW,EACvB;gBACC,OAAO,EAAE,WAAW,CAAC,OAAO;gBAC5B,cAAc,EAAE,WAAW,CAAC,aAAa;aACzC,EACD,WAAW,CACX,CAAC;SACF;IACF,CAAC;IAED;;;;;OAKG;IACH,SAAS,QAAQ,CAAC,WAAwB;QACzC,MAAM,WAAW,GAAG;YACnB,MAAM,eAAe,GAAG,IAAI,CAAC,yBAAyB,CAA2B,CAAC;YAClF,MAAM,YAAY,GAAG,kCAAe,CAAC,QAAQ,CAAC,wBAAwB,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;YACpG,MAAM,aAAa,GAAG,eAAe,CAAC,yBAAyB,CAAC,WAAW,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;YAE3G,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;YAE/B,OAAQ,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAgB,CAAC,KAAK,CAAC,aAAa,EAAE,SAAgB,CAAC,CAAC;QAC5G,CAAC,CAAC;QAEF,MAAM,cAAc,GAAG,GAAG,EAAE;YAC3B,MAAM,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC;YACpD,MAAM,iBAAiB,GAAG,WAAW,CAAC,iBAAiB,CAAC;YACxD,OAAO,eAAe,CAAC,iBAAiB,CAAC,CAAC,KAAK,EAAE,CAAC;QACnD,CAAC,CAAC;QAEF,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,QAAQ,EAAE;YAC5C,KAAK,EAAE,WAAW,CAAC,UAAU;SAC7B,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,KAAK,8BAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC;QAE3E,QAAQ,WAAW,CAAC,WAAW,EAAE;YAChC,KAAK,+BAAgB,CAAC,MAAM,CAAC,CAAC;gBAC7B,IAAA,iBAAM,EACL;oBACC,IAAI,EAAE,IAAI;oBACV,OAAO,EAAE,WAAW,CAAC,OAAO;iBAC5B,EACD,WAAW,CACX,CAAC;gBACF,MAAM;aACN;YACD,KAAK,+BAAgB,CAAC,KAAK,CAAC,CAAC;gBAC5B,IAAA,gBAAK,EACJ;oBACC,IAAI,EAAE,IAAI;oBACV,OAAO,EAAE,WAAW,CAAC,OAAO;iBAC5B,EACD,WAAW,CACX,CAAC;gBACF,MAAM;aACN;YACD,KAAK,+BAAgB,CAAC,SAAS,CAAC,CAAC;gBAChC,IAAA,oBAAS,EAAC,cAAc,CAAC,CAAC;gBAC1B,MAAM;aACN;YACD,KAAK,+BAAgB,CAAC,QAAQ,CAAC,CAAC;gBAC/B,IAAA,mBAAQ,EAAC,cAAc,CAAC,CAAC;gBACzB,MAAM;aACN;SACD;IACF,CAAC"}

package/dist/binding-registry.d.ts

@@ -0,0 +1,75 @@
+import { StepBinding } from './step-binding';
+import { ContextType, StepPattern, TagName } from './types';
+/**
+ * Represents the default step pattern.
+ */
+export declare const DEFAULT_STEP_PATTERN = "/.*/";
+/**
+ * Represents the default tag.
+ */
+export declare const DEFAULT_TAG = "*";
+/**
+ * A metadata registry that captures information about bindings and their bound step bindings.
+ */
+export declare class BindingRegistry {
+    private _bindings;
+    private _targetBindings;
+    /**
+     * Gets the binding registry singleton.
+     *
+     * @returns A [[BindingRegistry]].
+     */
+    static get instance(): BindingRegistry;
+    /**
+     * Updates the binding registry with information about the context types required by a
+     * binding class.
+     *
+     * @param targetPrototype The class representing the binding (constructor function).
+     * @param contextTypes An array of [[ContextType]] that define the types of objects that
+     * should be injected into the binding class during a scenario execution.
+     */
+    registerContextTypesForTarget(targetPrototype: any, contextTypes?: ContextType[]): void;
+    /**
+     * Retrieves the context types that have been registered for a given binding class.
+     *
+     * @param targetPrototype The class representing the binding (constructor function).
+     *
+     * @returns An array of [[ContextType]] that have been registered for the specified
+     * binding class.
+     */
+    getContextTypesForTarget(targetPrototype: any): ContextType[];
+    /**
+     * Updates the binding registry indexes with a step binding.
+     *
+     * @param stepBinding The step binding that is to be registered with the binding registry.
+     */
+    registerStepBinding(stepBinding: StepBinding): void;
+    /**
+     * Retrieves the step bindings that have been registered for a given binding class.
+     *
+     * @param targetPrototype The class representing the binding (constructor function).
+     *
+     * @returns An array of [[StepBinding]] objects that have been registered for the specified
+     * binding class.
+     */
+    getStepBindingsForTarget(targetPrototype: any): StepBinding[];
+    /**
+     * Retrieves the step bindings for a given step pattern and collection of tag names.
+     *
+     * @param stepPattern The step pattern to search.
+     * @param tags An array of [[TagName]] to search.
+     *
+     * @returns An array of [[StepBinding]] that map to the given step pattern and set of tag names.
+     */
+    getStepBindings(stepPattern: StepPattern, tags: TagName[]): StepBinding[];
+    /**
+     * Maps an array of tag names to an array of associated step bindings.
+     *
+     * @param tags An array of [[TagName]].
+     * @param tagMap The map of [[TagName]] -> [[StepBinding]] to use when mapping.
+     *
+     * @returns An array of [[StepBinding]].
+     */
+    private mapTagNamesToStepBindings;
+}
+//# sourceMappingURL=binding-registry.d.ts.map

package/dist/binding-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding-registry.d.ts","sourceRoot":"","sources":["../src/binding-registry.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAiB5D;;GAEG;AACH,eAAO,MAAM,oBAAoB,SAAS,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,WAAW,MAAM,CAAC;AAE/B;;GAEG;AACH,qBAAa,eAAe;IAC3B,OAAO,CAAC,SAAS,CAAuD;IACxE,OAAO,CAAC,eAAe,CAAiC;IAExD;;;;OAIG;IACH,WAAkB,QAAQ,IAAI,eAAe,CAU5C;IAED;;;;;;;OAOG;IACI,6BAA6B,CAAC,eAAe,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,WAAW,EAAE,GAAG,IAAI;IAmB9F;;;;;;;OAOG;IACI,wBAAwB,CAAC,eAAe,EAAE,GAAG,GAAG,WAAW,EAAE;IAUpE;;;;OAIG;IACI,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI;IA6D1D;;;;;;;OAOG;IACI,wBAAwB,CAAC,eAAe,EAAE,GAAG,GAAG,WAAW,EAAE;IAUpE;;;;;;;OAOG;IACI,eAAe,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE;IAgBhF;;;;;;;OAOG;IACH,OAAO,CAAC,yBAAyB;CAKjC"}