Merge pull request #228 from ychavoya/done-callback

feat: add basic done callback compatibility in steps
bencompton · May 15, 2024 · 793a056 · 793a056
2 parents fb5b2a2 + c92e634
commit 793a056
Show file tree

Hide file tree

Showing 13 changed files with 178 additions and 19 deletions.
diff --git a/docs/AsynchronousSteps.md b/docs/AsynchronousSteps.md
@@ -33,19 +33,38 @@ defineFeature(feature, test => {
 });
 ```
 
-Jest Cucumber does not support callbacks, but when steps are running asynchronous code that uses callbacks, the simplest solution is to wrap that code in a promise:
+## Callbacks
+
+Jest Cucumber also supports callbacks for asynchronous tasks. If an additional callback parameter is defined on the step function, it will wait for that callback to be called to continue with the next step:
 
 ```javascript
 defineFeature(feature, test => {	
   test('Adding a todo', ({ given, when, then }) => {
     ...
 
-    when('I save my changes', () => {
-      return new Promise((resolve) => {
-        todo.saveChanges(() => {
-            console.log('Changes saved');
-            resolve();
-        });
+    when('I save my changes', done => {
+      todo.saveChanges(() => {
+          console.log('Changes saved');
+          done(); // When the callback is called, the step will end
+      });
+    });
+
+    ...
+  });
+});
+```
+
+The callback should always be the last parameter:
+
+```javascript
+defineFeature(feature, test => {	
+  test('Adding a todo', ({ given, when, then }) => {
+    ...
+
+    when(/I save my changes with name (\w+)/, (name, done) => {
+      todo.saveChanges(() => {
+          console.log(`Changes saved with name ${name}`);
+          done();
       });
     });
 
@@ -54,6 +73,31 @@ defineFeature(feature, test => {
 });
 ```
 
+Like in jest, if an argument is passed to the callback function, it will fail the test:
+
+```javascript
+defineFeature(feature, test => {	
+  test('Adding a todo', ({ given, when, then }) => {
+    ...
+
+    when('I save my changes', done => {
+      todo.saveChanges(error => {
+          if (error) {
+            done(error); // the test will fail if called with an argument
+          } else {
+            console.log(`Changes saved`);
+            done(); // the test will succeed if no argument is passed
+          }
+      });
+    });
+
+    ...
+  });
+});
+```
+
+## Timeout
+
 You can also control how long Jest will wait for asynchronous operations before failing your test by passing a timeout (milliseconds) into your test:
 
 ```javascript

diff --git a/examples/typescript/specs/features/using-latest-gherkin-keywords.feature b/examples/typescript/specs/features/using-latest-gherkin-keywords.feature
@@ -35,4 +35,4 @@ Feature: Using latest Gherkin keywords
             Examples: Unsuccessful division
 
             | firstOperand | secondOperand | output    |
-            | 4            | 0             | undefined |
+            | 4            | 0             | Infinity  |
diff --git a/examples/typescript/specs/step-definitions/using-latest-gherkin-keywords.steps.ts b/examples/typescript/specs/step-definitions/using-latest-gherkin-keywords.steps.ts
@@ -37,7 +37,7 @@ defineFeature(feature, test => {
   };
 
   const thenTheOutputOfXShouldBeDisplayed = (then: DefineStepFunction) => {
-    then(/^the output of "(\d+)" should be displayed$/, (expectedOutput: string) => {
+    then(/^the output of "(\w+)" should be displayed$/, (expectedOutput: string) => {
       if (!expectedOutput) {
         expect(output).toBeFalsy();
       } else {

diff --git a/examples/typescript/src/calculator.ts b/examples/typescript/src/calculator.ts
@@ -20,7 +20,7 @@ export class Calculator {
   }
 
   public computeOutput() {
-    if (!this.firstOperand || !this.secondOperand || !this.operator) {
+    if (this.firstOperand === null || this.secondOperand === null) {
       return null;
     }
 

diff --git a/examples/vitest/specs/features/using-latest-gherkin-keywords.feature b/examples/vitest/specs/features/using-latest-gherkin-keywords.feature
@@ -35,4 +35,4 @@ Feature: Using latest Gherkin keywords
             Examples: Unsuccessful division
 
             | firstOperand | secondOperand | output    |
-            | 4            | 0             | undefined |
+            | 4            | 0             | Infinity  |
diff --git a/examples/vitest/specs/step-definitions/using-latest-gherkin-keywords.steps.ts b/examples/vitest/specs/step-definitions/using-latest-gherkin-keywords.steps.ts
@@ -39,7 +39,7 @@ defineFeature(feature, test => {
   };
 
   const thenTheOutputOfXShouldBeDisplayed = (then: DefineStepFunction) => {
-    then(/^the output of "(\d+)" should be displayed$/, (expectedOutput: string) => {
+    then(/^the output of "(\w+)" should be displayed$/, (expectedOutput: string) => {
       if (!expectedOutput) {
         expect(output).toBeFalsy();
       } else {

diff --git a/examples/vitest/src/calculator.ts b/examples/vitest/src/calculator.ts
@@ -20,7 +20,7 @@ export class Calculator {
   }
 
   public computeOutput() {
-    if (!this.firstOperand || !this.secondOperand || !this.operator) {
+    if (this.firstOperand === null || this.secondOperand === null) {
       return null;
     }
 

diff --git a/specs/features/steps/step-execution.feature b/specs/features/steps/step-execution.feature
@@ -31,4 +31,18 @@ Feature: Step definitions
       When I execute that scenario in Jest Cucumber
       Then I should see the error that occurred
       And I should see which step failed
-      And no more steps should execute
+      And no more steps should execute
+
+  Rule: When a step function provides a done callback, then the next step should not be executed until the callback is called
+
+    Scenario: Scenario with a done callback step
+      Given a scenario with a done callback step
+      When I execute that scenario in Jest Cucumber
+      Then the next step should not execute until the done callback is called
+
+    Scenario: Scenario with a failing done callback step
+      Given a scenario with a failing done callback step
+      When I execute that scenario in Jest Cucumber
+      Then I should see the error that occurred
+      And I should see which step failed
+      And no more steps should execute
diff --git a/specs/step-definitions/step-execution.steps.ts b/specs/step-definitions/step-execution.steps.ts
@@ -1,7 +1,9 @@
 import { loadFeature, defineFeature, DefineStepFunction } from '../../src';
 import {
   asyncStep,
+  doneCallbackStep,
   failingAsyncStep,
+  failingDoneCallbackStep,
   failingSynchronousStep,
   featureToExecute,
   synchronousSteps,
@@ -116,4 +118,38 @@ defineFeature(feature, test => {
       expect(logs[1]).toBe('when step started');
     });
   });
+
+  test('Scenario with a done callback step', ({ given, when, then }) => {
+    given('a scenario with a done callback step', () => {
+      featureFile = featureToExecute;
+      stepDefinitions = doneCallbackStep(logs);
+    });
+
+    whenIExecuteThatScenarioInJestCucumber(when);
+
+    then('the next step should not execute until the done callback is called', () => {
+      expect(logs).toHaveLength(4);
+      expect(logs[0]).toBe('given step');
+      expect(logs[1]).toBe('when step started');
+      expect(logs[2]).toBe('when step completed');
+      expect(logs[3]).toBe('then step');
+    });
+  });
+
+  test('Scenario with a failing done callback step', ({ given, when, then, and }) => {
+    given('a scenario with a failing done callback step', () => {
+      featureFile = featureToExecute;
+      stepDefinitions = failingDoneCallbackStep(logs);
+    });
+
+    whenIExecuteThatScenarioInJestCucumber(when);
+    thenIShouldSeeTheErrorThatOccurred(then);
+    andIShouldSeeWhichStepFailed(and);
+
+    and('no more steps should execute', () => {
+      expect(logs).toHaveLength(2);
+      expect(logs[0]).toBe('given step');
+      expect(logs[1]).toBe('when step started');
+    });
+  });
 });
diff --git a/specs/test-data/step-execution.ts b/specs/test-data/step-execution.ts
@@ -104,3 +104,50 @@ export const failingAsyncStep = (logs: string[]): MockStepDefinitions => {
     });
   };
 };
+
+export const doneCallbackStep = (logs: string[]): MockStepDefinitions => {
+  return (mockFeature: ParsedFeature, defineMockFeature: DefineFeatureFunction) => {
+    defineMockFeature(mockFeature, test => {
+      test('Executing a scenario', ({ given, when, then }) => {
+        given('a given step', () => {
+          logs.push('given step');
+        });
+
+        when('i run the when step', done => {
+          logs.push('when step started');
+          setTimeout(() => {
+            logs.push('when step completed');
+            done();
+          }, 5);
+        });
+
+        then('it should run the then step', () => {
+          logs.push('then step');
+        });
+      });
+    });
+  };
+};
+
+export const failingDoneCallbackStep = (logs: string[]): MockStepDefinitions => {
+  return (mockFeature: ParsedFeature, defineMockFeature: DefineFeatureFunction) => {
+    defineMockFeature(mockFeature, test => {
+      test('Executing a scenario', ({ given, when, then }) => {
+        given('a given step', () => {
+          logs.push('given step');
+        });
+
+        when('i run the when step', done => {
+          logs.push('when step started');
+          setTimeout(() => {
+            done('when step failure');
+          }, 5);
+        });
+
+        then('it should run the then step', () => {
+          logs.push('then step');
+        });
+      });
+    });
+  };
+};
diff --git a/src/feature-definition-creation.ts b/src/feature-definition-creation.ts
@@ -200,9 +200,25 @@ export const createDefineFeature = (): DefineFeatureFunction => {
             args.push(stepArgument as string);
           }
 
+          const hasDoneCallback = nextStep.stepFunction.length > args.length;
+
           return promiseChain.then(() => {
             return Promise.resolve()
-              .then(() => nextStep.stepFunction(...args))
+              .then(async () => {
+                if (hasDoneCallback) {
+                  return new Promise<void>((resolve, reject) => {
+                    const doneFunction = (reason?: Error | string) => {
+                      if (reason) {
+                        reject(typeof reason === 'string' ? new Error(reason) : reason);
+                      } else {
+                        resolve();
+                      }
+                    };
+                    nextStep.stepFunction(...args, doneFunction);
+                  });
+                }
+                return nextStep.stepFunction(...args);
+              })
               .catch(error => {
                 const formattedError = error;
                 formattedError.message = `Failing step: "${parsedStep.stepText}"\n\nStep arguments: ${JSON.stringify(args)}\n\nError: ${error.message}`;

diff --git a/src/models.ts b/src/models.ts
@@ -15,10 +15,12 @@ export type FeatureFromStepDefinitions = {
   scenarios: ScenarioFromStepDefinitions[];
 };
 
+export type ParsedStepArgument = (string | []) | null;
+
 export type ParsedStep = {
   keyword: string;
   stepText: string;
-  stepArgument: string | NonNullable<unknown>;
+  stepArgument: ParsedStepArgument;
   lineNumber: number;
 };
 

diff --git a/src/parsed-feature-loading.ts b/src/parsed-feature-loading.ts
@@ -7,7 +7,7 @@ import { Parser, AstBuilder, Dialect, dialects, GherkinClassicTokenMatcher } fro
 import { v4 as uuidv4 } from 'uuid';
 
 import { getJestCucumberConfiguration, Options } from './configuration';
-import { ParsedFeature, ParsedScenario, ParsedStep, ParsedScenarioOutline } from './models';
+import { ParsedFeature, ParsedScenario, ParsedStep, ParsedScenarioOutline, ParsedStepArgument } from './models';
 
 const parseDataTableRow = (astDataTableRow: any) => {
   return astDataTableRow.cells.map((col: any) => col.value) as string[];
@@ -85,7 +85,7 @@ const parseScenarioOutlineExampleSteps = (exampleTableRow: any, scenarioSteps: P
       return processedStepText.replace(new RegExp(`<${nextTableColumn}>`, 'g'), exampleTableRow[nextTableColumn]);
     }, scenarioStep.stepText);
 
-    let stepArgument: string | NonNullable<unknown> = '';
+    let stepArgument: ParsedStepArgument = null;
 
     if (scenarioStep.stepArgument) {
       if (Array.isArray(scenarioStep.stepArgument)) {
@@ -106,7 +106,7 @@ const parseScenarioOutlineExampleSteps = (exampleTableRow: any, scenarioSteps: P
       } else {
         stepArgument = scenarioStep.stepArgument;
 
-        if (typeof scenarioStep.stepArgument === 'string' || scenarioStep.stepArgument instanceof String) {
+        if (typeof scenarioStep.stepArgument === 'string') {
           Object.keys(exampleTableRow).forEach(nextTableColumn => {
             stepArgument = (stepArgument as string).replace(
               new RegExp(`<${nextTableColumn}>`, 'g'),