karma-playwright-launcher

Provides six browsers to Karma:

• Chromium
• ChromiumHeadless
• Firefox
• FirefoxHeadless
• WebKit
• WebKitHeadless

Powered by Playwright.

Use Playwright capabilities within your test

You may need to use Playwright capabilities right within sandboxed javascript code. That can be achieved using exposeBinding API.

You can pass callbacks that will be available within your tests by providing bindings object. The one from example is accessable by default.

In karma.conf.js:

    ...
    customLaunchers: {
        WebkitClickablr: {
            base: 'Webkit',
            bindings: {
                click: ({ frame }, selector) => frame.locator(selector).click()
            }
        }
    },
    ...

In spec file:

...
document.body.addEventListener('click', (event) => {
    expect(event.isTrusted).toBeTruthy();
    done();
})
click('body');
...

Device emulation

Playwright supports device emulation to control various aspects of the browser. This is probably more important for E2E testing than unit testing, but some configuration (like locale and timezone) may be useful for unit testing as well.

You can control these settings by providing device and/or contextOptions in karma.conf.js.

    ...
    customLaunchers: {
        iPhone: {
            base: 'Webkit',
            displayName: 'iPhone',
            device: 'iPhone 6',
            contextOptions: {
                locale: 'sv-SE'
            }
        }
    },

    browsers: [
        'iPhone',
    ],
    ...

Non-bundled browsers

The "real" Chrome, Edge or custom versions of the browsers can be configured by providing launchOptions in your Karma configuration. The browsers must be downloaded and installed manually.

    ...
    customLaunchers: {
        EdgeHeadless: {
            base: 'ChromiumHeadless',
            displayName: 'EdgeHeadless',
            launchOptions: {
                channel: 'msedge'
            }
        }
    },

    browsers: [
        'ChromiumHeadless',
        'EdgeHeadless',
        'FirefoxHeadless',
        'WebKitHeadless',
    ],
    ...

Valid values for the channel option are: chrome, chrome-beta, chrome-dev, chrome-canary, msedge, msedge-beta, msedge-dev, msedge-canary.

Older browsers

Each Playwright release bundles specific versions of Chromium, Firefox and WebKit. If you use Yarn or pnpm, it's possible you may lock the version of the playwright package in order to force a specific version. npm does not support this yet, but there is a package available that might work.

See the Playwright Release Notes for what browsers are bundled.

History

0.4.0

• Ivan Frolkin: Add bindings and tests.

0.3.0

• Martin Blom: Now uses the Karma decorators and event handling instead of a custom class.

0.2.1

• Martin Blom: Fixed typo. Bumped rev.

0.2.0

• Martin Blom: Publish forked package as @onslip/karma-playwright-launcher.
• Martin Blom: Added device emulation support.

0.1.1

• Martin Blom: Relaxed required playwright version and added note about pinning.

0.1.0

• Martin Blom: Provide both headful and headless browsers, support custom launch options.
• Emil Björklund: Add guard for missing browser.

0.0.1

• Joel Einbinder/Endy Jasmi: Original version, published as karma-playwright-launcher.