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 remotely on Sauce Labs cloud — using the saucectl
CLI. This gives 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.
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
Supported Testing Platforms
Sauce Labs supports the following test configurations for Cypress:
- Sauce Labs
- Docker
Cypress Version | Supported Platforms | Supported Browsers | End of Life |
---|---|---|---|
9.7.0 | macOS: 11.00, 12 | Chrome, Firefox, MicrosoftEdge | Jun 6, 2023 |
Windows: 10, 11 | |||
9.5.3 | macOS: 11.00, 12 | Chrome, Firefox, MicrosoftEdge | Apr 16, 2023 |
Windows: 10, 11 | |||
9.3.1 | macOS: 11.00 | Chrome, Firefox, MicrosoftEdge | Feb 2, 2023 |
Windows: 10 | |||
9.1.0 | Windows: 10 | Chrome, Firefox, MicrosoftEdge | Nov 29, 2022 |
8.6.0 | Windows: 10 | Chrome, Firefox, MicrosoftEdge | Oct 13, 2022 |
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.
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
saucectl
to run your existing tests just by modifying theconfig.yml
file for your project. - Try Cypress with Cucumber:
saucectl
supports Cypress using Cucumber, and the Cypress demo repo includes an example! - Incorporate saucectl in your pipeline: Cypress on Sauce supports CI integrations with Circle 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.
Limitations
Special Characters in Test Names
We recommend that you avoid the use of special characters when naming your tests. If your test name contains any special characters, your test may not run or its artifacts may not be visible in our platform.
Firefox 101 + Windows
Cypress does currently not work with Firefox 101 on Windows.