TestCafe Advanced Configuration
Environment Variable Expansion
All values in your
saucectl configuration support environment variable expansion.
config.yml will be replaced according to your shell's environment variables. References to undefined variables will be replaced with an empty string.
Predefined Environment Variables
The following environment variables are available during test execution.
|SAUCE_ARTIFACTS_DIRECTORY||Absolute path to the artifacts directory. Files placed in this folder are persisted with the Job.|
Tailoring Your Test File Bundle
saucectl command line bundles your root directory (
rootDir parameter of
config.yml) and transmits it to the Sauce Labs cloud, then unpacks the bundle and runs the tests. This functionality is partly what allows Sauce Control to operate in a framework-agnostic capacity. However, you can and should manage the inclusion and exclusion of files that get bundled to optimize performance and ensure security.
Excluding Files from the Bundle
.sauceignore file allows you to designate certain files to be excluded from bundling.
Add any files that are not direct test dependencies to
.sauceignore to reduce the size of your bundle, improve test speed, and protect sensitive information.
Examples of what can be included in
# Ignore node_modules
# Ignore all log files
# Ignore executables/binaries
# Ignore media files
# Ignore documentation
# Ignore sensitive data
Sometimes it's easier to do the inverse: Including files for the bundle.
# Ignore all files by default.
# Re-include files we selectively want as part of the payload by prefixing the lines with '!'.
# Since the whole '/cypress' folder is now included, this would also include any
# subdirectories that potentially contain auto-generated test artifacts from
# the local dev environment.
# It'd be wasteful to include them in the payload, so let's ignore those subfolders.
Including Node Dependencies
.sauceignore file lists
node_modules/ so locally installed node dependencies are excluded from the bundle. If your tests require node dependencies to run, you can either:
Remove "node_modules" from
Delete or comment out
node_modules/ in your
.sauceignore file to bundle your node dependencies. For example,
# Do NOT exclude node_modules from bundle
Node dependencies can increase your bundle by potentially hundreds of megabytes, so consider including only the required dependencies rather than the entire
node_modules directory. The following sections provide some methods for limiting the scope of dependencies you must include.
Install "devDependencies" Only
Consider only installing NPM
devDependencies if your tests do not require all prod
# Only install dev dependencies
npm install --only=dev
Uninstall Nonessential Dependencies
If your standard install includes dependencies that aren't needed to run your tests, uninstall them prior to bundling.
# Install node dependencies
npm ci # or "npm install"
# Remove unneeded dependencies
npm uninstall appium
npm uninstall express
Install Essential Dependencies Individually
If you know that your tests require only specific dependencies, install them individually instead of running
npm install or
# Install individual dependencies
npm install playwright-xpath
npm install @playwright/react
Set NPM Packages in
You can avoid installing or uninstalling dependencies prior to each bundling operation by defining a default set of NPM packages to install in your sauce configuration file using the
npm parameter, as shown in the following example:
Alternatively, you can let
saucectl selectively include already installed dependencies from the
This feature is highly experimental.
Attaching Test Assets
Any test assets created by your tests at runtime (such as logs, screenshots or reports) you wish to retain along with your test results must be placed in the
__assets__ directory of your project root folder. On Sauce Labs VMs, this path is relative to the current working directory.
Nested assets are stored flat in Sauce Labs. A test asset like
__assets__/mylogs/log.txt would therefore be stored and available for download as
Please keep that in mind when creating custom assets, as examples like
__assets__/myotherlogs/log.txt would eventually collide when persisted.
Setting up a Proxy
If you need to go through a proxy server, you can set it through the following variables:
HTTP_PROXY: Proxy to use to access HTTP websites
HTTPS_PROXY: Proxy to use to access HTTPS websites