saucectl

README

saucectl

A command line interface for the Sauce Labs Testrunner Toolkit. This repository contains the Go binary that you use to kick off tests. If you look for more documentation on it, please have a look into our example repo.

Development Requirements

• Go (v1.14 or higher)
• Homebrew (v2.2.13 or higher)

Install

Run the following to install all dependencies:

$ make install

Build

To build the project, run:

$ make build

Test

To execute unit tests, run:

$ make test

Using saucectl

The new Command

saucectl new

This command will ask you to choose one of the frameworks:

• Puppeteer
• Playwright
• TestCafe
• Cypress

After that, a ./sauce/config.yml file and an example test under the tests directory will be created, where you can start working from.

The run Command

saucectl run

This command will run the test based on the ./.sauce/config.yml file.

Flags

config

saucectl run --config <path>

Using the --config flag will run the tests specified by that config file.

env

saucectl run --env <key1>=<value1> --env <key2>=<value2> ...

Using the --env flag will define environment variables that are then available for use by the test framework.

region

saucectl run --region <region>

Using the --region flag will set the Sauce Labs region for the test execution. The region corresponds to the available regions at saucelabs.com and affects where your job information and assets are going to be stored.

timeout

saucectl run --timeout <seconds>

Using the --timeout flag will set the test timeout for the test runner framework.

Private registry

In case you need to use an image from a private registry you can use environment variables for authentification;

export REGISTRY_USERNAME=registry-user
export REGISTRY_PASSWORD=registry-pass

and in your config.yml setup the image name to your registry like:

image:
  base: quay.io/saucelabs/stt-cypress-mocha-node

Licensing

saucectl is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.