saucectl orb

saucectl orb provides an easy way to run your saucectl tests.

Usage

It can be used as a command, or as a job.
Both are called saucectl-run.

You need to have set the following environment variables to be able to run saucectl:

• SAUCE_USERNAME
• SAUCE_ACCESS_KEY

Alternatively, you can use the sauce-username and sauce-access-key parameters of the orb.

Parameters

Parameter name	Description	Default value
sauce-username	Sauce Username to use for authentification
sauce-access-key	Sauce Access Key to use for authentification
saucectl-version	Version of saucectl to use. Example: v0.68.2	latest
config-file	Configuration file to use with saucectl	.sauce/config.yml
working-directory	Working directory to use when running saucectl	.
region	Region to pass to saucectl
select-suite	Run a particular suite instead of all
show-console-log	Show console log when suite succeed	false
env	Environment variable to pass to saucectl
sauceignore	Sauceignore file to be used
timeout	Test timeout in seconds
tunnel-name	Sets the sauce-connect tunnel name to be used for the run
tunnel-owner	Sets the sauce-connect tunnel owner to be used for the run
tunnel-timeout	How long to wait for the specified tunnel to be ready
ccy	Sets the concurrency to be used for the run
retries	Sets the number of retries to do for the run
test-env-silent	Skips the test environment announcement	false
async	Launches tests without awaiting outcomes; operates in a fire-and-forget manner	false

Example

command

version: 2.1
orbs:
  saucectl: saucelabs/saucectl-run@3.0.0
jobs:
  run_saucectl:
    docker:
      - image: cimg/node:lts
    steps:
      - checkout
      - saucectl/saucectl-run:
          env: |
            MY_VAR1=VALUE
            MY_VAR2=VALUE
          show-console-log: true
workflows:
  test_local_and_remote:
    jobs:
      - run_saucectl