@quickpickle/playwright

@quickpickle/playwright is an extension for QuickPickle that integrates Playwright for end-to-end testing of web applications in a full browser context.

Features

• A custom world constructor with a configurable browser
• Pre-defined step definitions for common browser actions and assertions
• Support for easy visual regression testing
• Support for multiple browsers (Chromium, Firefox, WebKit)
• Configuration options for the browser and the test runner

Installation

1npm install --save-dev quickpickle @quickpickle/playwright

Usage

Setup quickpickle with Vitest

First set up vitest to recognize your features and setup files. This is the example from the quickpickle documentation:

1// vite.config.ts
2import { quickpickle } from 'quickpickle';
3
4export default {
5  plugins: [
6    quickpickle() // <-- Add the quickpickle plugin
7  ],
8  test: {
9    include : [
10      'features/*.feature', // <-- Add Gherkin feature files into "test" configuration
11      // (you'll probably want other test files too, for unit tests etc.)
12    ],
13    setupFiles: ['./tests/tests.steps.ts'] // <-- specify each setupfile here
14  },
15};

Using the default PlaywrightWorld constructor

To use the default PlaywrightWorld constructor, import @quickpickle/playwright/world in one of your setup files:

1// tests/tests.steps.ts
2import '@quickpickle/playwright/world'

Using the provided step definitions

@quickpickle/playwright provides a wide range of step definitions for common actions and assertions related to UI testing in a browser context. These step definitions are available in the following files, which can also be imported in your setup files:

1// tests/tests.steps.ts
2import '@quickpickle/playwright/actions'
3import '@quickpickle/playwright/outcomes'

Note that these step definitions are NOT STABLE, and this is the primary reason this package has not achieved a full release. What we want is to define a set of step definitions that can be used across all projects for UI testing, and we're probably not really close.

Extending the PlaywrightWorld constructor

You can extend the PlaywrightWorld constructor to meet your own environmental requirements:

1import { PlaywrightWorld, PlaywrightWorldConfig } from '@quickpickle/playwright';
2import type { TestContext } from 'vitest';
3import type { QuickPickleWorldInterface } from 'quickpickle';
4
5export class CustomPlaywrightWorld extends PlaywrightWorld {
6  customProperty: string;
7
8  constructor(context: TestContext, info: QuickPickleWorldInterface['info'], worldConfig: Partial<PlaywrightWorldConfig> = {}) {
9    super(context, info, worldConfig);
10    this.customProperty = 'Custom value';
11  }
12
13  async init() {
14    await super.init();
15    // Add custom initialization logic here
16    console.log('Custom world initialized');
17  }
18
19  customMethod() {
20    console.log(`Custom method called with ${this.customProperty}`);
21  }
22}
23
24// Don't forget to set the world constructor
25import { setWorldConstructor } from 'quickpickle';
26setWorldConstructor(CustomPlaywrightWorld);

Configuring the PlaywrightWorld constructor

The PlaywrightWorld constructor can be configured by passing an object to the quickpickle Vite plugin builder, or by passing a quickpickle configuration object to the "test" object. Both of these are demonstrated in the file below, but only one is needed:

1// vite.config.ts
2import { quickpickle } from 'quickpickle';
3
4export default {
5  plugins: [
6    quickpickle({ // <-- add the quickpickle plugin
7
8      // General quickpickle configuration
9      explodeTags: [
10        ['nojs','js'],
11        ['chromium','firefox','webkit'],
12        ['mobile','tablet','desktop','widescreen'],
13      ],
14
15      // PlaywrightWorld configuration
16      worldConfig: {
17        port: 5173, // sets the port
18        slowMo: 50, // turns on "slowMo" for 50ms
19      }
20
21    })
22  ],
23  test: {
24    include : [
25      'features/*.feature',
26    ],
27    setupFiles: ['./tests/tests.steps.ts'],
28    quickpickle: {
29
30      // General quickpickle configuration
31      explodeTags: [
32        ['nojs','js'],
33        ['chromium','firefox','webkit'],
34        ['mobile','tablet','desktop','widescreen'],
35      ],
36
37      // PlaywrightWorld configuration
38      worldConfig: {
39        port: 5173, // sets the port
40        slowMo: 50, // turns on "slowMo" for 50ms
41      }
42
43    }
44  },

The full list of options, with defaults, is here:

1export type PlaywrightWorldConfigSetting = Partial<{
2  host: string, // default host, including protocol (default: http://localhost)
3  port: number, // port to which the browser should connect (default: undefined)
4  screenshotDir: string, // directory in which to save screenshots (default: "screenshots")
5  screenshotOptions: ScreenshotSetting // options for the screenshots, for clipping and masking, etc.
6  nojsTags: string|string[] // tags for scenarios to run without javascript (default: @nojs, @noscript)
7  showBrowserTags: string|string[] // tags for scenarios to run with browser visible (default: @browser, @show-browser, @showbrowser)
8  slowMoTags: string|string[] // tags for scenarios to be run with slow motion enabled (default: @slowmo)
9  headless: boolean // whether to run the browser in headless mode (default true)
10  slowMo: boolean|number // whether to run the browser with slow motion enabled (default false)
11  slowMoMs: number // the number of milliseconds to slow down the browser by (default 500)
12  keyboardDelay: number // the number of milliseconds between key presses (default:20)
13  defaultBrowser: 'chromium'|'firefox'|'webkit' // the default browser to use (default: chromium)
14  browserSizes: Record<string,string> // the default browser sizes to use, in the form "widthxheight"
15  // (default: { mobile: "480x640", tablet: "1024x768", desktop: "1920x1080", widescreen: "3440x1440" })
16  defaultBrowserSize: string // the default browser size to use (default: desktop)
17}>

Use @quickpickle/playwright in CI

In order to run playwright tests in CI, you'll need to set up the playwright browsers. See quickpickle's release.yml Github action for example.