README
¶
Browser automation and end-to-end web testing for k6
An extension for k6 adding browser-level APIs with rough Playwright compatibility.
Download · Documentation · Community Forum
xk6-browser is a k6 extension 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.43.0, xk6-browser is now bundled in k6 as an experimental 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. This project is heavily influenced and in some regards based on the code of those projects.
Goals
- 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 two-fold; for one we don't want users to have to learn a completely new API just to use xk6-browser, and secondly, it opens up for using the Playwright RPC server as an optional backend for xk6-browser should we decide to support that in the future.
- Support for Chromium compatible browsers first, and eventually Firefox and WebKit-based browsers.
See our project roadmap for more details.
Get started
Documentation
- Releases
- API Documentation - This documents how to use our API and its current state with xk6-browser.
Get help
- If you're having issues installing or running xk6-browser, refer to TROUBLESHOOTING.
- To get help about usage, report bugs, suggest features, and discuss xk6-browser with other users see SUPPORT.md.
- Community discussion happens at the xk6-browser forum.
Additional resources
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, refer to our up-to-date API documentation.
- Introducing browser automation and end-to-end web testing with k6 - A blog post from our CEO, Robin Gustafsson, where he introduced xk6-browser.
- What is Browser Testing - An introductory chat with our DevRel team about what browser testing is and why we need to test with browsers.
- Getting started with xk6-browser - Office Hours episode where our DevRel team shared insights on how to get started with xk6-browser and the state of browser testing with k6
- Hybrid Performance Testing with k6 - Office Hours episode where our DevRel team talked about what a hybrid performance testing is and how xk6-browser can help.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package browser provides an entry point to the browser module.
|
Package browser provides an entry point to the browser module. |
|
Package common contains the implementation of API elements that do not depend on the browser type.
|
Package common contains the implementation of API elements that do not depend on the browser type. |
|
Package env provides types to interact with environment setup.
|
Package env provides types to interact with environment setup. |
|
Package k6error contains ErrFatal.
|
Package k6error contains ErrFatal. |
|
Package k6ext acts as an encapsulation layer between the k6 core and xk6-browser.
|
Package k6ext acts as an encapsulation layer between the k6 core and xk6-browser. |
|
k6test
Package k6test provides mock implementations of k6 elements for testing purposes.
|
Package k6test provides mock implementations of k6 elements for testing purposes. |
|
Package tests contains integration tests.
|
Package tests contains integration tests. |
|
ws
Package ws provides a test WebSocket server.
|
Package ws provides a test WebSocket server. |