feat: add bddStep before/after step hook (#2343)

Author: wojtkowiak

docs/hooks.md

@@ -374,12 +374,14 @@ Available events:
 * `event.suite.before(suite)` - *async* before a suite
 * `event.suite.after(suite)` - *async* after a suite
 * `event.step.before(step)` - *async* when the step is scheduled for execution
-* `event.step.after(step)`- *async* after a step
+* `event.step.after(step)` - *async* after a step
 * `event.step.started(step)` - *sync* when step starts.
 * `event.step.passed(step)` - *sync* when step passed.
 * `event.step.failed(step, err)` - *sync* when step failed.
 * `event.step.finished(step)` - *sync* when step finishes.
 * `event.step.comment(step)` - *sync* fired for comments like `I.say`.
+* `event.bddStep.before(bddStep)` - *async* when the gherkin step is scheduled for execution
+* `event.bddStep.after(bddStep)` - *async* after a gherkin step
 * `event.all.before` - before running tests
 * `event.all.after` - after running tests
 * `event.all.result` - when results are printed

lib/event.js

@@ -78,6 +78,17 @@ module.exports = {
     finished: 'step.finish', // sync
     comment: 'step.comment',
   },
+  /**
+   * @type {object}
+   * @constant
+   * @inner
+   * @property {'suite.before'} before
+   * @property {'suite.after'} after
+   */
+  bddStep: {
+    before: 'bddStep.before',
+    after: 'bddStep.after',
+  },
   /**
    * @type {object}
    * @constant

lib/interfaces/gherkin.js

@@ -28,6 +28,7 @@ module.exports = (text) => {
 
   const runSteps = async (steps) => {
     for (const step of steps) {
+      event.emit(event.bddStep.before, step);
       const metaStep = new Step.MetaStep(null, step.text);
       metaStep.actor = step.keyword.trim();
       const setMetaStep = (step) => {
@@ -49,6 +50,7 @@ module.exports = (text) => {
       } finally {
         event.dispatcher.removeListener(event.step.before, setMetaStep);
       }
+      event.emit(event.bddStep.after, step);
     }
   };
 

test/unit/bdd_test.js

@@ -11,6 +11,7 @@ const run = require('../../lib/interfaces/gherkin');
 const recorder = require('../../lib/recorder');
 const container = require('../../lib/container');
 const actor = require('../../lib/actor');
+const event = require('../../lib/event');
 
 const text = `
   Feature: checkout process
@@ -168,6 +169,25 @@ describe('BDD', () => {
     assert.equal('bird', fn.params[0]);
   });
 
+  it('should produce step events', (done) => {
+    const text = `
+    Feature: Emit step event
+
+      Scenario:
+        Then I emit step events
+    `;
+    Then('I emit step events', () => {});
+    let listeners = 0;
+    event.dispatcher.addListener(event.bddStep.before, () => listeners++);
+    event.dispatcher.addListener(event.bddStep.after, () => listeners++);
+
+    const suite = run(text);
+    suite.tests[0].fn(() => {
+      listeners.should.eql(2);
+      done();
+    });
+  });
+
   it('should use shortened form for step definitions', () => {
     let fn;
     Given('I am a {word}', params => params[0]);
@@ -214,7 +234,7 @@ describe('BDD', () => {
       Given I have product with price <price>$ in my cart
       And discount is 10 %
       Then I should see price is "<total>" $
-      
+
       Examples:
         | price | total |
         | 10    | 9     |