https://github.com/google/karma-webkit-launcher
A Karma plugin. Launcher for Webkit.
https://github.com/google/karma-webkit-launcher
epiphany karma karma-plugin safari webkit
Last synced: 13 days ago
JSON representation
A Karma plugin. Launcher for Webkit.
- Host: GitHub
- URL: https://github.com/google/karma-webkit-launcher
- Owner: google
- License: apache-2.0
- Created: 2021-06-11T19:47:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-21T00:19:59.000Z (7 months ago)
- Last Synced: 2025-04-08T20:07:37.880Z (14 days ago)
- Topics: epiphany, karma, karma-plugin, safari, webkit
- Language: JavaScript
- Homepage:
- Size: 279 KB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# karma-webkit-launcher
[](https://github.com/google/karma-webkit-launcher/actions/workflows/playwright_macos_tests.yml)
[](https://github.com/google/karma-webkit-launcher/actions/workflows/playwright_ubuntu_tests.yml)
[](https://github.com/google/karma-webkit-launcher/actions/workflows/playwright_windows_tests.yml)
[](https://github.com/google/karma-webkit-launcher/actions/workflows/epiphany_tests.yml)
[](https://www.npmjs.org/package/karma-webkit-launcher)
[](https://nodei.co/npm/karma-webkit-launcher/)
Karma Launcher for Apple's Webkit
## Installation
The easiest way is to keep karma-webkit-launcher as a devDependency in your package.json, by running
```bash
npm install karma-webkit-launcher --save-dev
```
## Supported WebKit-Launcher
This karma-webkit-launcher provides the following browser launcher.
| Karma Runner Browsers | ENV | Type | CI note |
| --------------------- | ------------------- | ----------------------------------------------------------------- | -------------- |
| WebKit | WEBKIT_BIN | Native / [Playwright][playwright] / [Safari][safari] (MacOS only) | - |
| WebKitHeadless | WEBKIT_HEADLESS_BIN | Native / [Playwright][playwright] | - |
| Safari | SAFARI_BIN | Native MacOS only | not supported |
| Epiphany | EPIPHANY_BIN | Native Ubuntu only | needs xvfb-run |
## Configuration
For the configuration just add `Webkit` or `WebkitHeadless` in your browser list.
```js
// karma.conf.js
export default (config) => {
config.set({
browsers: ['Webkit'], // You may use 'WebkitHeadless' or other supported browser
```
You can pass the list of browsers as a CLI argument too:
```bash
karma start --browsers Webkit
```
## Headless Webkit with Playwright / Playwright-Webkit
[Playwright](https://github.com/microsoft/playwright) is a Node.js library to automate Chromium, Firefox and WebKit with a single API. Playwright is built to enable cross-browser web automation that is ever-green, capable, reliable and fast.
Headless execution is supported for all the browsers on all platforms.
Check out [system requirements](https://playwright.dev/docs/intro/#system-requirements) for details.
If no environment variable is set and Playwright is available, it will be automatically utilized.
Additionally, if you exclusively intend to perform WebKit testing, you can install 'playwright-webkit' exclusively for that purpose.
### Example Usage
#### Installing Playwright and karma-webkit-launcher
```bash
npm install playwright karma-webkit-launcher --save-dev
```
#### Example Karma configuration
```js
// karma.conf.js
module.exports = function (config) {
config.set({
browsers: ["WebkitHeadless"],
});
};
```
### Manually define Playwright executable
To force the use of Playwright over an local Webkit instance, just overwrite the `WEBKIT_HEADLESS_BIN` or `WEBKIT_BIN` environment variable.
```js
// karma.conf.js
import playwright from "playwright";
process.env.WEBKIT_HEADLESS_BIN = playwright.webkit.executablePath();
module.exports = function (config) {
config.set({
browsers: ["WebkitHeadless"],
});
};
```
## Advanced Topics
### Detected if Safari or Playwright is used
In some instances it is helpful to detect if Playwright or a real Safari Browser is used.
For this reason it's possible to detect which kind of browser is currently running the tests over this runner.
```javascript
if (
new URLSearchParams(document.referrer || window.location.search).get(
"test_browser"
) == "Playwright"
) {
// Playwright specific tests
}
```
See: [Playwright Karma Test](test/playwright_test.js)
```javascript
if (
new URLSearchParams(document.referrer || window.location.search).get(
"test_browser"
) == "Safari"
) {
// Safari specific tests
}
```
See: [Safari Karma Test](test/safari_test.js)
For more information on Karma see the [Karma Homepage][karma].
[karma]: https://karma-runner.github.io/
[playwright]: https://playwright.dev/
[safari]: https://www.apple.com/safari/