Command Line Interface

Cut down from Global Command Line Interface

Category: verify

Run external verifier test suites.

rally verify add-verifier-ext

Add a verifier extension.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

  • --source [ref]

Path or URL to the repo to clone verifier extension from.

type: text

  • --extra-settings [ref]

Extra installation settings for verifier extension.

type: text

rally verify configure-verifier

Configure a verifier for a specific deployment.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

Note

The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

Environment name or UUID. HINT: You can list all environments, executing command rally env list.

type: text

  • --reconfigure [ref]

Reconfigure verifier.

  • --extend [ref]

Extend verifier configuration with extra options. If options are already present, the given ones will override them. Can be a path to a regular config file or just a json/yaml.

type: text

  • --override [ref]

Override verifier configuration by another one from a given source.

type: text

Show verifier configuration.

rally verify create-verifier

Create a verifier.

Command arguments:

Verifier name (for example, ‘My verifier’).

type: text

Verifier plugin name. HINT: You can list all verifier plugins, executing command rally verify list-plugins.

type: text

  • --platform [ref]

Verifier plugin platform. Should be specified in case of two verifier plugins with equal names but in different platforms.

type: text

default:

  • --source [ref]

Path or URL to the repo to clone verifier from.

type: text

  • --system-wide [ref]

Use the system-wide environment for verifier instead of a virtual environment.

  • --extra-settings [ref]

Extra installation settings for verifier.

type: text

  • --no-use [ref]

Not to set the created verifier as the default verifier for future operations.

rally verify delete

Delete a verification or a few verifications.

Command arguments:

UUIDs of verifications. HINT: You can list all verifications, executing command rally verify list.

type: text

rally verify delete-verifier

Delete a verifier.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

Environment name or UUID. If specified, only the environment-specific data will be deleted for verifier. HINT: You can list all environments, executing command rally env list.

type: text

  • --force [ref]

Delete all stored verifications of the specified verifier. If a deployment specified, only verifications of this deployment will be deleted. Use this argument carefully! You can delete verifications that may be important to you.

rally verify delete-verifier-ext

Delete a verifier extension.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

Verifier extension name.

type: text

rally verify import

Import results of a test run into the Rally database.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

Note

The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

Environment name or UUID. HINT: You can list all environments, executing command rally env list.

type: text

File to import test results from.

type: text

  • --run-args [ref]

Arguments that might be used when running tests. For example, ‘{concurrency: 2, pattern: set=identity}’.

type: text

  • --no-use [ref]

Not to set the created verification as the default verification for future operations.

rally verify list

List all verifications.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

Environment name or UUID. HINT: You can list all environments, executing command rally env list.

type: text

Tags to filter verifications by.

type: text

  • --status [ref]

Status to filter verifications by.

type: choice

rally verify list-plugins

List all plugins for verifiers management.

Command arguments:

  • --platform [ref]

Required platform (e.g. openstack).

type: text

rally verify list-verifier-exts

List all verifier extensions.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

rally verify list-verifier-tests

List all verifier tests.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

  • --pattern [ref]

Pattern which will be used for matching. Can be a regexp or a verifier-specific entity (for example, in case of Tempest you can specify ‘set=smoke’).

type: text

default:

rally verify list-verifiers

List all verifiers.

Command arguments:

  • --status [ref]

Status to filter verifiers by.

type: choice

rally verify report

Generate a report for a verification or a few verifications.

Command arguments:

Note

The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import, if the --no-use argument was not used.

Hint

You can set the default value by executing rally verify use <uuid> (ref).

UUIDs of verifications. HINT: You can list all verifications, executing command rally verify list.

type: text

Report type (Defaults to JSON). Out-of-the-box types: HTML, HTML-Static, JSON, JUnit-XML. HINT: You can list all types, executing rally plugin list –plugin-base VerificationReporter command.

type: text

default: json

Report destination. Can be a path to a file (in case of HTML, JSON, etc. types) to save the report to or a connection string. It depends on the report type.

type: text

Open the output file in a browser.

rally verify rerun

Rerun tests from a verification for a specific deployment.

Command arguments:

Note

The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import, if the --no-use argument was not used.

Hint

You can set the default value by executing rally verify use <uuid> (ref).

Verification UUID. HINT: You can list all verifications, executing command rally verify list.

type: text

Note

The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

Environment name or UUID. HINT: You can list all environments, executing command rally env list.

type: text

  • --failed [ref]

Rerun only failed tests.

Mark verification with a tag or a few tags.

type: text

  • --concurrency [ref]

How many processes to be used for running verifier tests. The default value (0) auto-detects your CPU count.

type: integer

  • --detailed [ref]

Show verification details such as errors of failed tests.

  • --no-use [ref]

Not to set the finished verification as the default verification for future operations.

rally verify show

Show detailed information about a verification.

Command arguments:

Note

The default value for the UUID argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally verify start, rally verify import, if the --no-use argument was not used.

Hint

You can set the default value by executing rally verify use <uuid> (ref).

Verification UUID. HINT: You can list all verifications, executing command rally verify list.

type: text

  • --sort-by [ref]

Sort tests.

type: choice

default: name

  • --detailed [ref]

Show verification details such as run arguments and errors of failed tests.

rally verify show-verifier

Show detailed information about a verifier.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

rally verify start

Start a verification (run verifier tests).

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

Note

The default value for the --env argument is taken from the Rally environment. Usually, the default value is equal to the UUID of the last successful run of rally deployment create, if the --no-use argument was not used.

Hint

You can set the default value by executing rally deployment use <uuid> (ref).

Environment name or UUID. HINT: You can list all environments, executing command rally env list.

type: text

Mark verification with a tag or a few tags.

type: text

  • --pattern [ref]

Pattern which will be used for running tests. Can be a regexp or a verifier-specific entity (for example, in case of Tempest you can specify ‘set=smoke’).

type: text

  • --concurrency [ref]

How many processes to be used for running verifier tests. The default value (0) auto-detects your CPU count.

type: integer

default: 0

  • --load-list [ref]

Path to a file with a list of tests to run.

type: text

  • --skip-list [ref]

Path to a file with a list of tests to skip. Format: json or yaml like a dictionary where keys are regexes matching test names and values are reasons.

type: text

  • --xfail-list [ref]

Path to a file with a list of tests that will be considered as expected failures. Format: json or yaml like a dictionary where keys are test names and values are reasons.

type: text

  • --detailed [ref]

Show verification details such as errors of failed tests.

  • --no-use [ref]

Not to set the finished verification as the default verification for future operations.

rally verify update-verifier

Update a verifier.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text

  • --update-venv [ref]

Update the virtual environment for verifier.

  • --system-wide [ref]

Switch to using the system-wide environment.

  • --no-system-wide [ref]

Switch to using the virtual environment. If the virtual environment doesn’t exist, it will be created.

rally verify use

Choose a verification to use for the future operations.

Command arguments:

Verification UUID. HINT: You can list all verifications, executing command rally verify list.

type: text

rally verify use-verifier

Choose a verifier to use for the future operations.

Command arguments:

Verifier name or UUID. HINT: You can list all verifiers, executing command rally verify list-verifiers.

type: text