saucectl authoring testsuites
Group test cases created with Sauce AI for Test Authoring into suites, and run every test case in a suite at once.
Aliases: testsuite, ts
Usage
$ saucectl authoring testsuites [command] [flags]
Commands
| Command | Description |
|---|---|
list | List test suites. |
get | Show a test suite. |
create | Create a test suite. |
update | Update a test suite's name, tags, or test cases. |
delete | Delete a test suite. |
run | Queue a run of every test case in a suite. |
All commands also accept the global options, such as --region.
list
List test suites.
Alias: ls
$ saucectl authoring testsuites list [flags]
| Flag | Shorthand | Description |
|---|---|---|
| --out | -o | Output format. Options: text (default) and json. |
| --id | None | Only these suite IDs. Repeatable. |
| --search | None | Case-insensitive substring match on the suite name. |
| --start-date | None | Only suites created on or after this ISO 8601 date. |
| --end-date | None | Only suites created on or before this ISO 8601 date. |
| --user-id | None | Filter by the ID of the user who created the suite. |
| --team-id | None | Filter by team ID. |
| --skip | None | Number of results to skip. Default is 0. |
| --limit | None | Maximum number of results to return. Default is 20. Use 0 to return only the total count. |
| --all | None | Return every result, fetching all pages. --limit is ignored. |
saucectl authoring testsuites list
saucectl authoring testsuites list --search regression -o json
get
Show a test suite.
$ saucectl authoring testsuites get <id> [flags]
| Flag | Shorthand | Description |
|---|---|---|
| --out | -o | Output format. Options: text (default) and json. |
saucectl authoring testsuites get <test-suite-id>
create
Create a test suite.
$ saucectl authoring testsuites create [flags]
| Flag | Shorthand | Description |
|---|---|---|
| --name | None | Required. Name of the suite, 1 to 255 characters. |
| --tag | None | Tag for the suite. Repeatable. |
| --test-case | None | ID of a test case to include. Repeatable. |
| --out | -o | Output format. Options: text (default) and json. |
saucectl authoring testsuites create --name "Checkout Regression" --tag smoke \
--test-case <test-case-id> --test-case <another-test-case-id>
update
Update a test suite's name, tags, or test cases. You must specify at least one change.
To change the suite's test cases, either replace the whole list with --test-case, or add and remove individual test cases with --add-test-case and --remove-test-case. You can't combine the two forms.
$ saucectl authoring testsuites update <id> [flags]
| Flag | Shorthand | Description |
|---|---|---|
| --name | None | New name for the suite. |
| --tag | None | Replace the suite's tags with these. Repeatable. |
| --test-case | None | Replace the suite's test cases with these test case IDs. Repeatable. |
| --add-test-case | None | Add this test case ID to the suite. Repeatable. |
| --remove-test-case | None | Remove this test case ID from the suite. Repeatable. |
| --out | -o | Output format. Options: text (default) and json. |
saucectl authoring testsuites update <test-suite-id> --name "Checkout Regression v2"
saucectl authoring testsuites update <test-suite-id> --add-test-case <test-case-id>
saucectl authoring testsuites update <test-suite-id> --remove-test-case <another-test-case-id>
delete
Delete a test suite. The suite's test cases are kept and are no longer assigned to a suite, unless you pass --delete-test-cases, which deletes every test case in the suite too.
Alias: rm
$ saucectl authoring testsuites delete <id> [flags]
| Flag | Shorthand | Description |
|---|---|---|
| --delete-test-cases | None | Also delete every test case in the suite. |
| --yes | -y | Skip the confirmation prompt. Required when saucectl is not running interactively. |
saucectl authoring testsuites delete <test-suite-id>
saucectl authoring testsuites delete <test-suite-id> --delete-test-cases --yes
run
Queue a run of every test case in a suite. The command reports only how many runs were queued. It doesn't return run IDs, so you can't follow the results from this command.
To wait for results and fail a pipeline when a test fails, use saucectl run with a kind: authoring configuration instead.
$ saucectl authoring testsuites run <id> [flags]
| Flag | Shorthand | Description |
|---|---|---|
| --build | None | Build name to group the runs under. |
| --out | -o | Output format. Options: text (default) and json. |
saucectl authoring testsuites run <test-suite-id> --build nightly