Chapter 23. Integration Test Suite command-line client
The tempest client is the command-line interface (CLI) for the OpenStack integration test suite. This chapter documents tempest version
0.0.0
.
For help on a specific tempest command, enter:
tempest help COMMAND
$ tempest help COMMAND
23.1. tempest usage Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
usage: tempest [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
usage: tempest [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
23.2. tempest optional arguments Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
- --version
- show program's version number and exit
- -v, --verbose
- Increase verbosity of output. Can be repeated.
- -q, --quiet
- Suppress output except warnings and errors.
- --log-file LOG_FILE
- Specify a file to log output. Disabled by default.
- -h, --help
- Show help message and exit.
- --debug
- Show tracebacks on errors.
23.3. tempest account-generator Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
usage: tempest account-generator [-h] [-c /etc/tempest.conf] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--tag TAG] -r CONCURRENCY [--with-admin] accounts_file.yaml
usage: tempest account-generator [-h] [-c /etc/tempest.conf] [--os-username <auth-user-name>] [--os-password <auth-password>] [--os-tenant-name <auth-tenant-name>] [--tag TAG] -r CONCURRENCY [--with-admin] accounts_file.yaml
Create accounts.yaml file for concurrent test runs. One primary user, one alt user, one swift admin, one stack owner and one admin (optionally) will be created for each concurrent thread.
Positional arguments
- accounts_file.yaml
- Output accounts yaml file
Optional arguments
- -h, --help
- show this help message and exit
- -c /etc/tempest.conf, --config-file /etc/tempest.conf
- path to tempest config file
- --os-username <auth-user-name>
- User should have permissions to create new user accounts and tenants. Defaults to env[OS_USERNAME].
- --os-password <auth-password>
- Defaults to env[OS_PASSWORD].
- --os-tenant-name <auth-tenant-name>
- Defaults to env[OS_TENANT_NAME].
- --tag TAG
- Resources tag
- -r CONCURRENCY, --concurrency CONCURRENCY
- Concurrency count
- --with-admin
- Creates admin for each concurrent group
23.4. tempest cleanup Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
usage: tempest cleanup [-h] [--init-saved-state] [--delete-tempest-conf-objects] [--dry-run]
usage: tempest cleanup [-h] [--init-saved-state] [--delete-tempest-conf-objects] [--dry-run]
Cleanup after tempest run
Optional arguments
- -h, --help
- show this help message and exit
- --init-saved-state
- Creates JSON file: saved_state.json, representing the current state of your deployment, specifically object types tempest creates and destroys during a run. You must run with this flag prior to executing cleanup in normal mode, which is with no arguments.
- --delete-tempest-conf-objects
- Force deletion of the tempest and alternate tempest users and tenants.
- --dry-run
- Generate JSON file:dry_run.json, that reports the objects that would have been deleted had a full cleanup been run.
23.5. tempest init Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
usage: tempest init [-h] [--config-dir CONFIG_DIR] [dir]
usage: tempest init [-h] [--config-dir CONFIG_DIR] [dir]
Setup a local working environment for running tempest
Positional arguments
- dir
Optional arguments
- -h, --help
- show this help message and exit
- --config-dir CONFIG_DIR, -c CONFIG_DIR
23.6. tempest list-plugins Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
usage: tempest list-plugins [-h]
usage: tempest list-plugins [-h]
List all tempest plugins
Optional arguments
- -h, --help
- show this help message and exit
23.7. tempest run-stress Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
usage: tempest run-stress [-h] [-d DURATION] [-s] [-S] [-n NUMBER] [-a] [-T TYPE] [-i] [-t [TESTS]]
usage: tempest run-stress [-h] [-d DURATION] [-s] [-S] [-n NUMBER] [-a] [-T TYPE] [-i] [-t [TESTS]]
Run tempest stress tests
Optional arguments
- -h, --help
- show this help message and exit
- -d DURATION, --duration DURATION
- Duration of test in secs
- -s, --serial
- Trigger running tests serially
- -S, --stop
- Stop on first error
- -n NUMBER, --number NUMBER
- How often an action is executed for each process
- -a, --all
- Execute all stress tests
- -T TYPE, --type TYPE
- Filters tests of a certain type (e.g. gate)
- -i, --call-inherited
- Call also inherited function with stress attribute
- -t [TESTS], --tests [TESTS]
- Name of the file with test description
23.8. tempest verify-config Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
usage: tempest verify-config [-h] [-u] [-o OUTPUT] [-r]
usage: tempest verify-config [-h] [-u] [-o OUTPUT] [-r]
Verify your current tempest configuration
Optional arguments
- -h, --help
- show this help message and exit
- -u, --update
- Update the config file with results from api queries. This assumes whatever is set in the config file is incorrect. In the case of endpoint checks where it could either be the incorrect catalog type or the service available option the service available option is assumed to be incorrect and is thus changed
- -o OUTPUT, --output OUTPUT
- Output file to write an updated config file to. This has to be a separate file from the original config file. If one isn't specified with -u the new config file will be printed to STDOUT
- -r, --replace-ext
- If specified the all option will be replaced with a full list of extensions