Warning
Starting from k6 version v0.56, this codebase has been merged and is now part of the main k6 repository. Please contribute and open issues there. This repository is no longer maintained.
A module for k6 adding browser-level APIs with rough Playwright compatibility.
Download · Documentation · Community Forum · Public Roadmap ·
k6-browser is a k6 module that supports browser automation through the Chrome Devtools Protocol (CDP). It adds browser-level APIs to interact with browsers and collect frontend performance metrics as part of your k6 tests.
As of k6 version 0.52.0, k6-browser is now bundled in k6 as a core module and usable without a separate binary or compilation step!
Special acknowledgment to the authors of Playwright and Puppeteer for their trailblazing work in this area.
- Bring browser automation to the k6 testing platform while supporting core k6 features like VU executors, scenarios, metrics, checks, thresholds, logging, DNS remapping, IP blocklists, etc.
- Test stability as the top priority by supporting non-flaky selectors combined with auto-waiting for actions just like Playwright.
- Aim for rough API compatibility with Playwright. The reason for this is twofold: first, we don't want users to have to learn a completely new API just to use xk6-browser, and second, it opens up the possibility of using the Playwright RPC server as an optional backend for the k6 browser module should we decide to support that in the future.
- Support for Chromium-compatible browsers first, and eventually Firefox and WebKit-based browsers.
Please take a look at our project roadmap for more details.
- Releases
- API Documentation - This documents how to use our API and its current state with xk6-browser.
- If you're having issues installing or running xk6-browser, refer to TROUBLESHOOTING.
- To get help with usage, report bugs, suggest features, and discuss xk6-browser with other users, see SUPPORT.md.
- Community discussion happens at the xk6-browser forum.
To find out more about xk6-browser or browser testing in general, check out the following links.
Note: Since our API is still transitioning, some of the code snippets from the links below might be inaccurate, though the concepts should still be correct. For the latest, please take a look at our up-to-date API documentation.
- How to add browser-level APIs for web performance metrics - This post explains how to get started with k6 browser to interact with browsers and collect web performance metrics as part of your Grafana k6 tests.
- Using k6 browser - Get started with the k6 browser module.