Cypress on Sauce Labs
Cypress is an end-to-end javascript testing framework that you can use to test your web apps either locally in Docker or through Sauce Labs using the saucectl CLI, giving you the flexibility to run your tests in the environment that best suits your organization, while still benefiting from the Sauce Labs vast collection of devices, browser, and operating system combinations and test result data analytics.
Supported Testing Platforms#
Sauce Labs supports the following test configurations for Cypress:
- Sauce Labs
- Docker
| Cypress Version | Supported Platforms | Supported Browsers |
|---|---|---|
| 9.1.0 | Windows 10 | Chrome, Firefox, MicrosoftEdge |
| 8.6.0 | Windows 10 | Chrome, Firefox, MicrosoftEdge |
| 8.3.0 | Windows 10 | Chrome, Firefox, MicrosoftEdge |
| 7.7.0 | Windows 10 | Chrome, Firefox, MicrosoftEdge |
Browser support for 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.
| Cypress Version | Supported Browsers |
|---|---|
| 9.1.0 | Please see release notes |
| 8.6.0 | Please see release notes |
| 8.3.0 | Please see release notes |
| 7.7.0 | Please see release notes |
System Requirements#
You can run saucectl locally via Docker (Installation Requirements or remotely via the Sauce Labs cloud, so system requirements vary depending on your intention. The following reference serves as a general guide:
- macOS
- Linux
- Windows
How to Get Started#
- Quickstart: Use our demo repo to quickly set up and run a sample Cypress project and test to see the results.
- Run Your own Tests: Customize
saucectlto run your existing tests just by modifying theconfig.ymlfile for your project. - Try Cypress with Cucumber:
saucectlsupports Cypress using Cucumber, and the Cypress demo repo includes an example! - Incorporate saucectl in your pipeline: Cypress on Sauce supports CI integrations with Cirlce CI, GitLab, Jenkins, and GitHub Actions.
Cypress Plugin for Sauce Labs#
If you would prefer to stay in Cypress, try the new Cypress Sauce Labs Plugin. Connect to your Sauce Labs account from within your Cypress project to configure and run your tests directly from Cypress.