@qavajs/playwright-runner-adapter 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+All notable changes to the "@qavajs/steps-playwright" will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+:rocket: - new feature
+:beetle: - bugfix
+:x: - deprecation/removal
+:pencil: - chore
+:microscope: - experimental
+
+## [0.1.0]
+- :rocket: initial implementation

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 @qavajs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+[![npm version](https://badge.fury.io/js/@qavajs%2Fplaywright-runner-adapter.svg)](https://badge.fury.io/js/@qavajs%2Fplaywright-runner-adapter)
+
+# @qavajs/playwright-runner-adapter
+Adapter to run cucumberjs tests via playwright test runner
+
+## Installation
+
+`npm install @qavajs/playwright-runner-adapter`
+
+## Basic Configuration
+
+### Create cucumber config file
+Set _paths_ and _require_ properties
+```typescript
+export default {
+    paths: ['test/features/*.feature'],
+    require: ['test/step_definitions/*.ts']
+}
+```
+### Set testDir
+Set testDir to adapter
+```typescript
+export default defineConfig({
+    testDir: resolve('node_modules/@qavajs/playwright-runner-adapter/adapter')
+});
+```
+### Add cucumber config
+Set CONFIG and PROFILE environment variables e.g via dotenv library
+```dotenv
+CONFIG=test/cucumber.ts
+PROFILE=default
+```
+
+## Advanced Configuration
+### Customizing test instance
+Custom test instance can be passed to world constructor as _test_ property. 
+And then fixtures can be connected with world instance via _init_ property.
+```typescript
+import { test as base } from '@playwright/test';
+import { SettingsPage } from './settings-page';
+import { setWorldConstructor } from '@cucumber/cucumber';
+import { PlaywrightWorld } from '@qavajs/playwright-runner-adapter/PlaywrightWorld';
+
+type MyFixtures = {
+    settingsPage: SettingsPage;
+};
+
+const customTest = base.extend<MyFixtures>({
+    settingsPage: async ({ page }, use) => {
+        await use(new SettingsPage(page));
+    },
+});
+
+class ExtendedPlaywrightWorld extends PlaywrightWorld {
+    settingsPage: SettingsPage;
+    constructor(options: any) {
+        super(options);
+    }
+    
+    test = customTest;
+    
+    // init arrow function connects fixtures with Cucumber world instance
+    init = ({ settingsPage }) => {
+        this.settingsPage = settingsPage;
+    }
+
+}
+```
+
+

package/adapter/PlaywrightWorld.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlaywrightWorld = void 0;
+const test_1 = require("@playwright/test");
+class PlaywrightWorld {
+    constructor(options) {
+        this.test = test_1.test;
+        this.init = ({ browser, context, page }) => {
+            this.browser = browser;
+            this.context = context;
+            this.page = page;
+        };
+        this.log = options.log;
+        this.attach = options.attach;
+        this.parameters = options.parameters;
+    }
+}
+exports.PlaywrightWorld = PlaywrightWorld;
+//# sourceMappingURL=PlaywrightWorld.js.map

package/adapter/PlaywrightWorld.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlaywrightWorld.js","sourceRoot":"","sources":["../src/PlaywrightWorld.ts"],"names":[],"mappings":";;;AAAA,2CAA0F;AAE1F,MAAa,eAAe;IAWxB,YAAY,OAAY;QAFxB,SAAI,GAAG,WAAI,CAAC;QAQZ,SAAI,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAA6D,EAAE,EAAE;YAC7F,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;YACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC,CAAA;QATG,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACzC,CAAC;CAOJ;AAtBD,0CAsBC"}

package/adapter/adapter.spec.js

@@ -0,0 +1,98 @@
+"use strict";
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+const loader_1 = require("./loader");
+const config = require((_a = process.env.CONFIG) !== null && _a !== void 0 ? _a : 'config.js');
+const profile = (_b = process.env.PROFILE) !== null && _b !== void 0 ? _b : 'default';
+const resolvedConfig = config[profile];
+const features = (0, loader_1.loadFeatures)(resolvedConfig.paths);
+const supportCodeLibrary = (0, loader_1.loadStepDefinitions)(resolvedConfig.require);
+function log(data) {
+    console.log(data);
+}
+function attach(body, details) {
+    var _a, _b;
+    const fileName = (_a = details.fileName) !== null && _a !== void 0 ? _a : 'attachment';
+    const contentType = (_b = details.mediaType) !== null && _b !== void 0 ? _b : 'text/plain';
+    this.test.info().attach(fileName, { body, contentType });
+}
+const world = new supportCodeLibrary.World({
+    log,
+    attach
+});
+const test = world.test;
+for (const feature of features) {
+    const tests = feature.tests;
+    test.describe(feature.feature, async () => {
+        for (const beforeAllHook of supportCodeLibrary.beforeTestRunHookDefinitions) {
+            test.beforeAll(async () => {
+                await beforeAllHook.code.apply({});
+            });
+        }
+        test.beforeEach(world.init);
+        for (const testCase of tests) {
+            const tag = testCase.tags.map(tag => tag.name);
+            test(testCase.name, { tag }, async () => {
+                for (const beforeHook of supportCodeLibrary.beforeTestCaseHookDefinitions) {
+                    if (beforeHook.appliesToTestCase(testCase)) {
+                        await test.step('Before', async () => {
+                            await beforeHook.code.apply(world, [testCase]);
+                        });
+                    }
+                }
+                for (const pickleStep of testCase.steps) {
+                    await test.step(pickleStep.text, async () => {
+                        for (const beforeStep of supportCodeLibrary.beforeTestStepHookDefinitions) {
+                            if (beforeStep.appliesToTestCase(testCase)) {
+                                await beforeStep.code.apply(world);
+                            }
+                        }
+                        const steps = supportCodeLibrary.stepDefinitions
+                            .filter(stepDefinition => stepDefinition.matchesStepName(pickleStep.text));
+                        if (steps.length === 0)
+                            throw new Error(`Step '${pickleStep.text}' is not defined`);
+                        if (steps.length > 1)
+                            throw new Error(`'${pickleStep.text}' matches multiple step definitions`);
+                        const [step] = steps;
+                        const { parameters } = await step.getInvocationParameters({
+                            // @ts-ignore
+                            step: {
+                                text: pickleStep.text,
+                                argument: pickleStep.argument
+                            },
+                            world
+                        });
+                        const result = { status: 'passed' };
+                        try {
+                            await step.code.apply(world, parameters);
+                        }
+                        catch (err) {
+                            result.status = 'failed';
+                            result.error = err;
+                        }
+                        for (const afterStep of supportCodeLibrary.afterTestStepHookDefinitions) {
+                            if (afterStep.appliesToTestCase(testCase)) {
+                                await afterStep.code.apply(world, [{ result }]);
+                            }
+                        }
+                        if (result.error)
+                            throw result.error;
+                    });
+                }
+                for (const afterHook of supportCodeLibrary.afterTestCaseHookDefinitions) {
+                    if (afterHook.appliesToTestCase(testCase)) {
+                        await test.step('After', async () => {
+                            await afterHook.code.apply(world, [testCase]);
+                        });
+                    }
+                }
+            });
+        }
+        for (const afterAllHook of supportCodeLibrary.afterTestRunHookDefinitions) {
+            test.afterAll(async function () {
+                await afterAllHook.code.apply({});
+            });
+        }
+    });
+}
+//# sourceMappingURL=adapter.spec.js.map

package/adapter/adapter.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.spec.js","sourceRoot":"","sources":["../src/adapter.spec.ts"],"names":[],"mappings":";;;AAAA,qCAA2D;AAE3D,MAAM,MAAM,GAAG,OAAO,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,MAAM,mCAAI,WAAW,CAAC,CAAC;AAC1D,MAAM,OAAO,GAAG,MAAA,OAAO,CAAC,GAAG,CAAC,OAAO,mCAAI,SAAS,CAAC;AAEjD,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;AACvC,MAAM,QAAQ,GAAG,IAAA,qBAAY,EAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AACpD,MAAM,kBAAkB,GAAG,IAAA,4BAAmB,EAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AAEvE,SAAS,GAAG,CAAC,IAAS;IAClB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC;AACD,SAAS,MAAM,CAAsB,IAAS,EAAE,OAAY;;IACxD,MAAM,QAAQ,GAAG,MAAA,OAAO,CAAC,QAAQ,mCAAI,YAAY,CAAC;IAClD,MAAM,WAAW,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,YAAY,CAAC;IACtD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAA;AAC5D,CAAC;AACD,MAAM,KAAK,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC;IACvC,GAAG;IACH,MAAM;CACT,CAAC,CAAC;AAEH,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;AAExB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;IAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAiB,EAAE,KAAK,IAAI,EAAE;QAChD,KAAK,MAAM,aAAa,IAAI,kBAAkB,CAAC,4BAA4B,EAAE,CAAC;YAC1E,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE;gBACtB,MAAM,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACvC,CAAC,CAAC,CAAC;QACP,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE5B,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAE/C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAC,GAAG,EAAC,EAAE,KAAK,IAAI,EAAE;gBAClC,KAAK,MAAM,UAAU,IAAI,kBAAkB,CAAC,6BAA6B,EAAE,CAAC;oBACxE,IAAI,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACzC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;4BACjC,MAAM,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;wBACnD,CAAC,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;gBACD,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;oBACtC,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;wBACxC,KAAK,MAAM,UAAU,IAAI,kBAAkB,CAAC,6BAA6B,EAAE,CAAC;4BACxE,IAAI,UAAU,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;gCACzC,MAAM,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;4BACvC,CAAC;wBACL,CAAC;wBACD,MAAM,KAAK,GAAG,kBAAkB,CAAC,eAAe;6BAC3C,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;wBAC/E,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;4BAAE,MAAM,IAAI,KAAK,CAAC,SAAS,UAAU,CAAC,IAAI,kBAAkB,CAAC,CAAC;wBACpF,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;4BAAE,MAAM,IAAI,KAAK,CAAC,IAAI,UAAU,CAAC,IAAI,qCAAqC,CAAC,CAAC;wBAChG,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;wBACrB,MAAM,EAAE,UAAU,EAAC,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;4BACrD,aAAa;4BACb,IAAI,EAAE;gCACF,IAAI,EAAE,UAAU,CAAC,IAAI;gCACrB,QAAQ,EAAE,UAAU,CAAC,QAAQ;6BAChC;4BACD,KAAK;yBACR,CAAC,CAAC;wBACH,MAAM,MAAM,GAAoC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;wBACrE,IAAI,CAAC;4BACD,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;wBAC7C,CAAC;wBAAC,OAAO,GAAG,EAAE,CAAC;4BACX,MAAM,CAAC,MAAM,GAAG,QAAQ,CAAC;4BACzB,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;wBACvB,CAAC;wBACD,KAAK,MAAM,SAAS,IAAI,kBAAkB,CAAC,4BAA4B,EAAE,CAAC;4BACtE,IAAI,SAAS,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;gCACxC,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,EAAC,MAAM,EAAC,CAAC,CAAC,CAAC;4BAClD,CAAC;wBACL,CAAC;wBACD,IAAI,MAAM,CAAC,KAAK;4BAAE,MAAM,MAAM,CAAC,KAAK,CAAC;oBACzC,CAAC,CAAC,CAAC;gBACP,CAAC;gBACD,KAAK,MAAM,SAAS,IAAI,kBAAkB,CAAC,4BAA4B,EAAE,CAAC;oBACtE,IAAI,SAAS,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACxC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;4BAChC,MAAM,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;wBAClD,CAAC,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;YACL,CAAC,CAAC,CAAA;QACN,CAAC;QACD,KAAK,MAAM,YAAY,IAAI,kBAAkB,CAAC,2BAA2B,EAAE,CAAC;YACxE,IAAI,CAAC,QAAQ,CAAC,KAAK;gBACf,MAAM,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC,CAAC;AACP,CAAC"}

package/adapter/loader.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadStepDefinitions = exports.loadFeatures = void 0;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const gherkin_1 = require("@cucumber/gherkin");
+const messages_1 = require("@cucumber/messages");
+const cucumber_1 = require("@cucumber/cucumber");
+const glob_1 = require("glob");
+const PlaywrightWorld_1 = require("./PlaywrightWorld");
+const uuidFn = messages_1.IdGenerator.uuid();
+const builder = new gherkin_1.AstBuilder(uuidFn);
+const matcher = new gherkin_1.GherkinClassicTokenMatcher();
+const parser = new gherkin_1.Parser(builder, matcher);
+function loadFeatures(globPattern) {
+    const files = (0, glob_1.globSync)(globPattern);
+    return files.map(file => {
+        var _a;
+        const filePath = (0, node_path_1.resolve)(file);
+        const gherkinDocument = parser.parse((0, node_fs_1.readFileSync)(filePath, 'utf-8'));
+        return {
+            feature: (_a = gherkinDocument.feature) === null || _a === void 0 ? void 0 : _a.name,
+            tests: (0, gherkin_1.compile)(gherkinDocument, file, uuidFn)
+        };
+    });
+}
+exports.loadFeatures = loadFeatures;
+function loadStepDefinitions(globPattern) {
+    cucumber_1.supportCodeLibraryBuilder.reset(process.cwd(), uuidFn);
+    cucumber_1.supportCodeLibraryBuilder.methods.setWorldConstructor(PlaywrightWorld_1.PlaywrightWorld);
+    const files = (0, glob_1.globSync)(globPattern);
+    for (const file of files) {
+        const filePath = (0, node_path_1.resolve)(file);
+        require(filePath);
+    }
+    return cucumber_1.supportCodeLibraryBuilder.finalize();
+}
+exports.loadStepDefinitions = loadStepDefinitions;
+//# sourceMappingURL=loader.js.map

package/adapter/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";;;AAAA,qCAAuC;AACvC,yCAAoC;AACpC,+CAA4F;AAC5F,iDAAiD;AACjD,iDAA+D;AAC/D,+BAAgC;AAChC,uDAAkD;AAElD,MAAM,MAAM,GAAG,sBAAW,CAAC,IAAI,EAAE,CAAA;AACjC,MAAM,OAAO,GAAG,IAAI,oBAAU,CAAC,MAAM,CAAC,CAAA;AACtC,MAAM,OAAO,GAAG,IAAI,oCAA0B,EAAE,CAAC;AACjD,MAAM,MAAM,GAAG,IAAI,gBAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;AAE3C,SAAgB,YAAY,CAAC,WAAqB;IAC9C,MAAM,KAAK,GAAG,IAAA,eAAQ,EAAC,WAAW,CAAC,CAAC;IACpC,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;;QACpB,MAAM,QAAQ,GAAG,IAAA,mBAAO,EAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QACtE,OAAO;YACH,OAAO,EAAE,MAAA,eAAe,CAAC,OAAO,0CAAE,IAAI;YACtC,KAAK,EAAE,IAAA,iBAAO,EAAC,eAAe,EAAE,IAAI,EAAE,MAAM,CAAC;SAChD,CAAA;IACL,CAAC,CAAC,CAAC;AACP,CAAC;AAVD,oCAUC;AAED,SAAgB,mBAAmB,CAAC,WAAqB;IACrD,oCAAyB,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;IACvD,oCAAyB,CAAC,OAAO,CAAC,mBAAmB,CAAC,iCAAe,CAAC,CAAC;IACvE,MAAM,KAAK,GAAG,IAAA,eAAQ,EAAC,WAAW,CAAC,CAAC;IACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,IAAA,mBAAO,EAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,CAAC,QAAQ,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,oCAAyB,CAAC,QAAQ,EAAE,CAAC;AAChD,CAAC;AATD,kDASC"}

package/index.d.ts

@@ -0,0 +1 @@
+export { PlaywrightWorld } from './src/PlaywrightWorld';

package/index.js

@@ -0,0 +1,4 @@
+const { PlaywrightWorld } = require('./adapter/PlaywrightWorld');
+module.exports = {
+    PlaywrightWorld
+}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@qavajs/playwright-runner-adapter",
+  "version": "0.1.0",
+  "description": "adapter for playwright test runner",
+  "scripts": {
+    "build": "tsc",
+    "test:ui": "playwright test --config test/playwright.config.ts --ui",
+    "test:e2e": "playwright test --config test/playwright-e2e.config.ts"
+  },
+  "author": "Alexandr Galichenko",
+  "license": "MIT",
+  "dependencies": {
+    "@cucumber/gherkin": "^28.0.0",
+    "@cucumber/messages": "^24.1.0",
+    "glob": "^10.3.12"
+  },
+  "devDependencies": {
+    "@cucumber/cucumber": "^10.3.2",
+    "@playwright/test": "^1.42.1",
+    "@types/node": "^20.12.2",
+    "typescript": "^5.4.3"
+  }
+}

package/src/PlaywrightWorld.ts

@@ -0,0 +1,25 @@
+import { APIRequestContext, Browser, BrowserContext, Page, test } from '@playwright/test';
+
+export class PlaywrightWorld {
+    page!: Page;
+    context!: BrowserContext;
+    browser!: Browser;
+    browserName!: string;
+    request!: APIRequestContext;
+    log!: (data: any) => void;
+    attach!: (data: any, details?: { filename?: string, mediaType: string }) => void;
+    parameters!: string;
+    test = test;
+
+    constructor(options: any) {
+        this.log = options.log;
+        this.attach = options.attach;
+        this.parameters = options.parameters;
+    }
+
+    init = ({ browser, context, page }: { browser: Browser, context: BrowserContext, page: Page }) => {
+        this.browser = browser;
+        this.context = context;
+        this.page = page;
+    }
+}

package/src/adapter.spec.ts

@@ -0,0 +1,97 @@
+import {loadStepDefinitions, loadFeatures} from './loader';
+
+const config = require(process.env.CONFIG ?? 'config.js');
+const profile = process.env.PROFILE ?? 'default';
+
+const resolvedConfig = config[profile];
+const features = loadFeatures(resolvedConfig.paths);
+const supportCodeLibrary = loadStepDefinitions(resolvedConfig.require);
+
+function log(data: any) {
+    console.log(data);
+}
+function attach(this: { test: any }, body: any, details: any) {
+    const fileName = details.fileName ?? 'attachment';
+    const contentType = details.mediaType ?? 'text/plain';
+    this.test.info().attach(fileName, { body, contentType })
+}
+const world = new supportCodeLibrary.World({
+    log,
+    attach
+});
+
+const test = world.test;
+
+for (const feature of features) {
+    const tests = feature.tests;
+    test.describe(feature.feature as string, async () => {
+        for (const beforeAllHook of supportCodeLibrary.beforeTestRunHookDefinitions) {
+            test.beforeAll(async () => {
+                await beforeAllHook.code.apply({});
+            });
+        }
+
+        test.beforeEach(world.init);
+
+        for (const testCase of tests) {
+            const tag = testCase.tags.map(tag => tag.name);
+
+            test(testCase.name, {tag}, async () => {
+                for (const beforeHook of supportCodeLibrary.beforeTestCaseHookDefinitions) {
+                    if (beforeHook.appliesToTestCase(testCase)) {
+                        await test.step('Before', async () => {
+                            await beforeHook.code.apply(world, [testCase]);
+                        });
+                    }
+                }
+                for (const pickleStep of testCase.steps) {
+                    await test.step(pickleStep.text, async () => {
+                        for (const beforeStep of supportCodeLibrary.beforeTestStepHookDefinitions) {
+                            if (beforeStep.appliesToTestCase(testCase)) {
+                                await beforeStep.code.apply(world);
+                            }
+                        }
+                        const steps = supportCodeLibrary.stepDefinitions
+                            .filter(stepDefinition => stepDefinition.matchesStepName(pickleStep.text));
+                        if (steps.length === 0) throw new Error(`Step '${pickleStep.text}' is not defined`);
+                        if (steps.length > 1) throw new Error(`'${pickleStep.text}' matches multiple step definitions`);
+                        const [step] = steps;
+                        const { parameters} = await step.getInvocationParameters({
+                            // @ts-ignore
+                            step: {
+                                text: pickleStep.text,
+                                argument: pickleStep.argument
+                            },
+                            world
+                        });
+                        const result: { status: string, error?: any } = { status: 'passed' };
+                        try {
+                            await step.code.apply(world, parameters);
+                        } catch (err) {
+                            result.status = 'failed';
+                            result.error = err;
+                        }
+                        for (const afterStep of supportCodeLibrary.afterTestStepHookDefinitions) {
+                            if (afterStep.appliesToTestCase(testCase)) {
+                                await afterStep.code.apply(world, [{result}]);
+                            }
+                        }
+                        if (result.error) throw result.error;
+                    });
+                }
+                for (const afterHook of supportCodeLibrary.afterTestCaseHookDefinitions) {
+                    if (afterHook.appliesToTestCase(testCase)) {
+                        await test.step('After', async () => {
+                            await afterHook.code.apply(world, [testCase]);
+                        });
+                    }
+                }
+            })
+        }
+        for (const afterAllHook of supportCodeLibrary.afterTestRunHookDefinitions) {
+            test.afterAll(async function () {
+                await afterAllHook.code.apply({});
+            });
+        }
+    });
+}

package/src/loader.ts

@@ -0,0 +1,35 @@
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { AstBuilder, compile, GherkinClassicTokenMatcher, Parser } from '@cucumber/gherkin';
+import { IdGenerator } from '@cucumber/messages';
+import { supportCodeLibraryBuilder } from '@cucumber/cucumber';
+import { globSync } from 'glob';
+import {PlaywrightWorld} from './PlaywrightWorld';
+
+const uuidFn = IdGenerator.uuid()
+const builder = new AstBuilder(uuidFn)
+const matcher = new GherkinClassicTokenMatcher();
+const parser = new Parser(builder, matcher)
+
+export function loadFeatures(globPattern: string[]) {
+    const files = globSync(globPattern);
+    return files.map(file => {
+        const filePath = resolve(file);
+        const gherkinDocument = parser.parse(readFileSync(filePath, 'utf-8'));
+        return {
+            feature: gherkinDocument.feature?.name,
+            tests: compile(gherkinDocument, file, uuidFn)
+        }
+    });
+}
+
+export function loadStepDefinitions(globPattern: string[]) {
+    supportCodeLibraryBuilder.reset(process.cwd(), uuidFn);
+    supportCodeLibraryBuilder.methods.setWorldConstructor(PlaywrightWorld);
+    const files = globSync(globPattern);
+    for (const file of files) {
+        const filePath = resolve(file);
+        require(filePath);
+    }
+    return supportCodeLibraryBuilder.finalize();
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "test/**/*.spec.ts"
+  ],
+  "compilerOptions": {
+    "target": "es2017",
+    "module": "node16",
+    "moduleResolution": "node16",
+    "outDir": "./adapter",
+    "esModuleInterop": true,
+    "sourceMap": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "types": [
+      "node"
+    ]
+  }
+}