TestCafe on Sauce Labs
TestCafe is a 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 TestCafe 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 Languages
JavaScript and TypeScript are supported out of the box.
Supported Testing Platforms
Sauce Labs supports the following test configurations for TestCafe:
- Sauce Labs
- Docker
TestCafe Version | Supported Platforms | Supported Browsers | End of Life |
---|---|---|---|
2.3.1 | macOS: 11.00, 12, 13 | Safari, Chrome, Firefox, Microsoft Edge | Mar 01, 2024 |
Windows: 10, 11 | Chrome, Firefox, Microsoft Edge | ||
iOS:13.4, 14.5, 15.4, 16.0, 16.1 | Safari | ||
2.2.0 | macOS: 11.00, 12, 13 | Safari, Chrome, Firefox, Microsoft Edge | Jan 15, 2024 |
Windows: 10, 11 | Chrome, Firefox, Microsoft Edge | ||
iOS:13.4, 14.5, 15.4, 16.0, 16.1 | Safari | ||
2.1.0 | macOS: 11.00, 12, 13 | Safari, Chrome, Firefox, Microsoft Edge | Nov 30, 2023 |
Windows: 10, 11 | Chrome, Firefox, Microsoft Edge | ||
iOS: 13.4, 14.0, 14.3 | Safari | ||
2.0.1 | macOS: 11.00, 12, 13 | Safari, Chrome, Firefox, Microsoft Edge | Oct 20, 2023 |
Windows: 10, 11 | Chrome, Firefox, Microsoft Edge | ||
iOS: 13.4, 14.0, 14.3 | Safari | ||
2.0.0 | macOS: 11.00, 12, 13 | Safari, Chrome, Firefox, Microsoft Edge | Sep 7, 2023 |
Windows: 10, 11 | Chrome, Firefox, Microsoft Edge | ||
iOS: 13.4, 14.0, 14.3 | Safari | ||
1.20.0 | macOS: 11.00, 12, 13 | Safari, Chrome, Firefox, Microsoft Edge | Jul 29, 2023 |
Windows: 10, 11 | Chrome, Firefox, Microsoft Edge | ||
iOS: 13.4, 14.0, 14.3 | Safari | ||
1.19.0 | macOS: 11.00, 12, 13 | Safari, Chrome, Firefox, Microsoft Edge | Jun 6, 2023 |
Windows: 10, 11 | Chrome, Firefox, Microsoft Edge | ||
iOS: 13.4, 14.0, 14.3 | Safari | ||
1.18.5 | macOS: 11.00, 12, 13 | Safari, Chrome, Firefox, Microsoft Edge | Apr 16, 2023 |
Windows: 10, 11 | Chrome, Firefox, Microsoft Edge | ||
iOS: 13.4, 14.0, 14.3 | Safari |
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 TestCafe 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. - Incorporate saucectl in your pipeline: TestCafe on Sauce supports CI integrations with Cirlce CI, GitLab, Jenkins, and GitHub Actions.
TestCafe Plugins for Sauce Labs
If you would prefer to stay in TestCafe, try the new TestCafe Sauce Labs Plugin. Connect to your Sauce Labs account from within your TestCafe project to configure and run your tests directly from TestCafe. If all you want is to publish your TestCafe test results to Sauce Labs (but not run on Sauce Labs), please check out our TestCafe reporter!
Limitations
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.