added gherkinDocument to hooks parameter (#40)

Author: AlexGalichenko

CHANGELOG.md

@@ -14,6 +14,9 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 :microscope: - experimental
 
+## [Unreleased]
+- :rocket: added `gherkinDocument` to hooks parameter
+
 ## [1.7.1]
 - :beetle: fixed `result` property in `After` and `AfterStep` hooks
 

src/cucumber.spec.ts

@@ -1,5 +1,6 @@
 import { load } from './loader';
 import type { TestInfo } from '@playwright/test';
+import type { ITestCaseHookParameter, ITestStepHookParameter } from '@cucumber/cucumber';
 
 const { features, supportCodeLibrary } = load();
 
@@ -8,9 +9,9 @@ function getResult(testInfo: TestInfo) {
         ? testInfo.errors.map((err: any) => err.message).join('\n')
         : undefined;
     return {
-        duration: testInfo.duration,
+        duration: testInfo.duration as any,
         message,
-        status: testInfo.status,
+        status: testInfo.status?.toUpperCase(),
         exception: testInfo.error
     };
 }
@@ -68,8 +69,9 @@ for (const feature of features) {
                     await test.step(
                         hookName,
                         () => beforeHook.code.apply(world, [{
+                            gherkinDocument: feature.gherkinDocument,
                             pickle: testCase
-                        }]),
+                        } as ITestCaseHookParameter]),
                         location
                     );
                 }
@@ -103,6 +105,7 @@ for (const feature of features) {
                                 await test.step(
                                     'Before Step',
                                     () => beforeStep.code.apply(world, [{
+                                        gherkinDocument: feature.gherkinDocument,
                                         pickle: testCase,
                                         pickleStep
                                     }]),
@@ -130,15 +133,18 @@ for (const feature of features) {
                                     await test.step(
                                         'After Step',
                                         () => afterStep.code.apply(world, [{
+                                            gherkinDocument: feature.gherkinDocument,
+                                            testCaseStartedId: '0',
+                                            testStepId: '0',
                                             pickle: testCase,
                                             pickleStep,
                                             result: {
-                                                duration: 0,
+                                                duration: 0 as any,
                                                 message: result.error?.message,
-                                                status: result.status,
+                                                status: result.status.toUpperCase(),
                                                 exception: result.error
                                             }
-                                        }]),
+                                        } as ITestStepHookParameter]),
                                         location
                                     );
                                 }
@@ -163,9 +169,11 @@ for (const feature of features) {
                     await test.step(
                         hookName,
                         () => afterHook.code.apply(world, [{
+                            gherkinDocument: feature.gherkinDocument,
+                            testCaseStartedId: '0',
                             pickle: testCase,
                             result: getResult(testInfo)
-                        }]),
+                        } as ITestCaseHookParameter]),
                         location
                     );
                 }

src/loader.ts

@@ -33,6 +33,7 @@ export function loadFeatures(globPattern: string[]) {
         const gherkinDocument = parser.parse(readFileSync(filePath, 'utf-8'));
         return {
             feature: gherkinDocument.feature?.name,
+            gherkinDocument,
             tests: duplicates(compile(gherkinDocument, file, uuidFn) as any)
         }
     });

test/step_definitions/steps.ts

@@ -100,9 +100,10 @@ Before(async function (this: ExtendedPlaywrightWorld, testCase: ITestCaseHookPar
 });
 
 After(async function (this: ExtendedPlaywrightWorld, testCase: ITestCaseHookParameter) {
+    this.expect(testCase.gherkinDocument).toBeTruthy();
     this.expect(testCase.pickle).toBeTruthy();
     this.expect(testCase.result).toBeTruthy();
-    this.expect(testCase.result?.status).toEqual('passed');
+    this.expect(testCase.result?.status).toEqual('PASSED');
     this.expect(testCase.result?.duration).toBeGreaterThan(0);
 });
 
@@ -112,20 +113,22 @@ BeforeStep(async function (this: ExtendedPlaywrightWorld, testCase: ITestStepHoo
 });
 
 AfterStep(async function (this: ExtendedPlaywrightWorld, testCase: ITestStepHookParameter) {
+    this.expect(testCase.gherkinDocument).toBeTruthy();
     this.expect(testCase.pickle).toBeTruthy();
     this.expect(testCase.pickleStep).toBeTruthy();
     this.expect(testCase.result).toBeTruthy();
-    this.expect(testCase.result?.status).toEqual('passed');
+    this.expect(testCase.result?.status).toEqual('PASSED');
 });
 
 Before({name: 'Named Before'}, async function (this: ExtendedPlaywrightWorld, testCase: ITestCaseHookParameter) {
     this.expect(testCase.pickle).toBeTruthy();
 });
 
 After({name: 'Named After'}, async function (this: ExtendedPlaywrightWorld, testCase: ITestCaseHookParameter) {
+    this.expect(testCase.gherkinDocument).toBeTruthy();
     this.expect(testCase.pickle).toBeTruthy();
     this.expect(testCase.result).toBeTruthy();
-    this.expect(testCase.result?.status).toEqual('passed');
+    this.expect(testCase.result?.status).toEqual('PASSED');
     this.expect(testCase.result?.duration).toBeGreaterThan(0);
 });