Testery CLI

The Testery CLI is available as a pip package here: https://pypi.org/project/testery/.

To install, run

pip install --upgrade testery

You can see the command line help by running,

> testery --help
Usage: testery [OPTIONS] COMMAND [ARGS]...
Testery CLI
Kick off test runs from your CI/CD platform and run them on Testery's
next-generation, cloud-based testing grid.
Options:
--help Show this message and exit.
Commands:
add-file Adds a file to a test run.
cancel-test-run Cancels a test run.
create-deploy Creates a deploy for a project and...
create-environment Creates an environment where tests can be...
create-test-run Submits a Git-based test run to the Testery...
delete-environment Deletes an environment.
list-environments Returns a list of environments.
load-users
monitor-test-run
monitor-test-runs
report-test-run Outputs individual test results for the...
update-environment Updates an environment where tests can be...
upload-build-artifacts Uploads a file or directory of build...
verify-token Verifies your username and authentication...

Create a Deployment

Creating a deployment is useful for telling Testery when you've pushed new code into your test environment. What tests you want to run can be configured with Schedules.

> testery create-deploy --help
Usage: testery create-deploy [OPTIONS]
Creates a deploy for a project and environment.
Options:
--api-url TEXT The URL for the Testery API. Only required for
development purposes.
--token TEXT Your Testery API token. [required]
--project TEXT The project key of the repo being deployed. [required]
--git-provider TEXT The Git provider used for the repository that is being
deployed. Should be GitHub or BitBucket
--git-owner TEXT The organization owner in Git for the repository that
is being deployed.
--git-repo TEXT The repository name that is being deployed.
--build-id TEXT The build the atifact should be associated with.
--environment TEXT Which environment you would like to run your tests
against. [required]
--commit TEXT Which environment you would like to run your tests
against. [required]
--branch TEXT The Git branch the deploy came from.
--help Show this message and exit.

Upload Build Artifacts

If your project is using a compiled language (like .Net) or if you aren't attaching a code repository to your project, then you'll have to upload your build artifacts to Testery before you can run a test. To do that you can use the upload-build-artifacts command of the Testery CLI.

> testery upload-build-artifacts --help
Usage: testery upload-build-artifacts [OPTIONS]
Uploads a file or directory of build artifacts and associates them with
the specified build-id
Options:
--api-url TEXT The URL for the Testery API. Only required for
development purposes.
--token TEXT Your Testery API token. [required]
--project TEXT Legacy option. Use --project-key instead.
--project-key TEXT The project key.
--branch TEXT The Git branch the build came from.
--build-id TEXT The build the artifact should be associated with.
[required]
--path TEXT The path to the file or directory you want to upload.
[required]
--zip-dir Creates a zip file of the directory contents before
uploading.
--help Show this message and exit.