added _expect_ to default world (#14)

Author: AlexGalichenko

CHANGELOG.md

@@ -12,6 +12,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [0.5.0]
 - :rocket: updated gherkin dependency
+- :rocket: added _expect_ to default world
 
 ## [0.4.0]
 - :rocket: added support of _requireModules_ option

README.md

@@ -35,7 +35,7 @@ export default defineConfig({
 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 { test as base, expect as baseExpect } from '@playwright/test';
 import { SettingsPage } from './settings-page';
 import { setWorldConstructor } from '@cucumber/cucumber';
 import { PlaywrightWorld } from '@qavajs/playwright-runner-adapter/PlaywrightWorld';
@@ -50,6 +50,12 @@ const customTest = base.extend<MyFixtures>({
     },
 });
 
+const customExpect = baseExpect.extend({
+    async customMatcher() {
+        // implementation
+    }
+});
+
 class ExtendedPlaywrightWorld extends PlaywrightWorld {
     settingsPage: SettingsPage;
     constructor(options: any) {
@@ -58,6 +64,7 @@ class ExtendedPlaywrightWorld extends PlaywrightWorld {
 
     // set test property with extened one
     test = customTest;
+    expect = customExpect;
 
     // init arrow function connects fixtures with Cucumber world instance
     init = ({ settingsPage }) => {

src/PlaywrightWorld.ts

@@ -1,4 +1,4 @@
-import { APIRequestContext, Browser, BrowserContext, Page, test } from '@playwright/test';
+import { APIRequestContext, Browser, BrowserContext, Page, test, expect } from '@playwright/test';
 
 /**
  * Cucumber world for playwright adapter
@@ -13,6 +13,7 @@ export class PlaywrightWorld {
     attach!: (data: any, details?: { fileName?: string, mediaType: string }) => void;
     parameters!: string;
     test = test;
+    expect = expect;
 
     constructor(options: any) {
         this.log = options.log;

test/features/feature.feature

@@ -40,3 +40,6 @@ Feature: test feature
 
   Scenario: custom fixture
     Given custom fixture
+
+  Scenario: custom expect
+    Given custom expect

test/step_definitions/steps.ts

@@ -1,5 +1,5 @@
 import { Given, When, setWorldConstructor, DataTable } from '@cucumber/cucumber';
-import { test as base, expect, Page } from '@playwright/test';
+import { test as base, expect as baseExpect, Page, Locator } from '@playwright/test';
 import { PlaywrightWorld } from '../../src/PlaywrightWorld';
 
 const fixture = base.extend({
@@ -8,13 +8,26 @@ const fixture = base.extend({
     }
 });
 
+const customExpect = baseExpect.extend({
+    toAlwaysPass(locator: Locator) {
+        return {
+            message: () => 'pass',
+            pass: true,
+            name: 'toAlwaysPass',
+            expected: 'foo',
+            actual: 'foo',
+        }
+    }
+});
+
 class ExtendedPlaywrightWorld extends PlaywrightWorld {
     constructor(options: any) {
         super(options);
     }
 
     customFixture!: number;
     test = fixture;
+    expect = customExpect;
 
     init = ({ page, customFixture }: { page: Page, customFixture: number }) => {
         this.page = page;
@@ -33,11 +46,11 @@ When(/^simple step$/, async function () {
 });
 
 When('data table step', async function (dataTable: DataTable) {
-    expect(dataTable.raw()).toEqual([['1'], ['2']])
+    this.expect(dataTable.raw()).toEqual([['1'], ['2']])
 });
 
 When('multiline step', async function (multiline: string) {
-    expect(multiline).toEqual('first\nsecond')
+    this.expect(multiline).toEqual('first\nsecond')
 });
 
 When('log', async function () {
@@ -49,5 +62,9 @@ When('attach', async function () {
 });
 
 When('custom fixture', async function (this: ExtendedPlaywrightWorld) {
-    expect(this.customFixture).toEqual(42);
+    this.expect(this.customFixture).toEqual(42);
+});
+
+When('custom expect', async function (this: ExtendedPlaywrightWorld) {
+    this.expect(this.page.locator('body')).toAlwaysPass();
 });