Skip to main content

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 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:

  • OS: 10.14+ (Mojave, Catalina, or Big Sur)
  • Docker: Desktop

Supported Testing Platforms

Sauce Labs supports the following test configurations for TestCafe:

TestCafe VersionSupported PlatformsSupported BrowsersEnd of Life
2.0.0macOS: 11.00, 12Safari, Chrome, Firefox, Microsoft EdgeSep 7, 2023
Windows: 10, 11Chrome, Firefox, Microsoft Edge
iOS: 13.4, 14.0, 14.3Safari
1.20.0macOS: 11.00, 12Safari, Chrome, Firefox, Microsoft EdgeJul 29, 2023
Windows: 10, 11Chrome, Firefox, Microsoft Edge
iOS: 13.4, 14.0, 14.3Safari
1.19.0macOS: 11.00, 12Safari, Chrome, Firefox, Microsoft EdgeJun 6, 2023
Windows: 10, 11Chrome, Firefox, Microsoft Edge
iOS: 13.4, 14.0, 14.3Safari
1.18.5macOS: 11.00, 12Safari, Chrome, Firefox, Microsoft EdgeApr 16, 2023
Windows: 10, 11Chrome, Firefox, Microsoft Edge
iOS: 13.4, 14.0, 14.3Safari
1.18.3macOS: 11.00Safari, Chrome, Firefox, Microsoft EdgeFeb 2, 2023
Windows: 10Chrome, Firefox, Microsoft Edge
iOS: 13.4, 14.0, 14.3Safari
1.17.1macOS: 11.00Safari, Chrome, Firefox, Microsoft EdgeNov 29, 2022
Windows: 10Chrome, Firefox, Microsoft Edge
iOS: 13.4, 14.0, 14.3Safari
1.16.1macOS: 11.00Safari, Chrome, Firefox, Microsoft EdgeOct 13, 2022
Windows: 10Chrome, Firefox, Microsoft Edge
iOS: 13.4, 14.0, 14.3Safari

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 the config.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

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.