Testrunner Toolkit is a containerized testing solution that allows you to get the benefits of the Sauce Labs platform while maintaining your test suites in your favorite framework.
At the heart of the toolkit is the
saucectl command line, which performs the underlying business logic to access the tests in your existing framework, run them (either in the Sauce Labs Cloud or locally in a Docker image), then securely transmit the test assets to the Sauce Labs platform, where you can review, share, and evaluate your test outcomes at scale.
The toolkit currently supports:
|Cypress Version||Supported Platforms||Supported Browsers|
|6.6.0||Windows 10||Chrome, Firefox, MicrosoftEdge|
|5.6.0||Windows 10||Chrome, Firefox, MicrosoftEdge|
|5.5.0||Windows 10||Chrome, Firefox, MicrosoftEdge|
|Playwright Version||Supported Platforms||Supported Browsers|
|1.7.1||Windows 10||Chromium, Firefox, Webkit|
|Puppeteer Version||Supported Platforms||Supported Browsers|
|TestCafe Version||Supported Platforms||Supported Browsers|
|1.11.0||macOS 11.00||Safari, Chrome, Firefox, MicrosoftEdge|
|1.11.0||Windows 10||Chrome, Firefox, MicrosoftEdge|
|1.10.1||Windows 10||Chrome, Firefox, MicrosoftEdge|
Browser support or each framework is based on the Sauce Labs docker images provided in the
saucectl installation. Each Docker image tag is the latest image that supports the specific framework version, as detailed in the available release notes.
|Playwright Version||Supported Browsers|
|1.7.1||Please see release notes|
The rest of the Testrunner Toolkit documentation will guide you through the process of installing and configuring the
saucectl command line, and then using it to run your tests in the way that best suits your current development process. At a high level, you will:
- Download and install
- Generate and configure your
- Run a sample test to verify functionality.
Once you are confident that
saucectl is running, you can customize your configurations based on your testing objectives. The following sections offer some common scenarios.
If you already have existing tests in your project (in
cypress for example), once you install
saucectl, you can just directly modify the default configuration file, and then run your existing tests.
If you wish to run
saucectl as part of your DevOps CI toolchain, you can add it in your workflow by following one of our CI integration guides.
If you would like to see sample tests and configuration files for particular frameworks, you can clone one of our demo repositories for use as a template: