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.

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

Options:

  • --source (string, required) [ref]

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

  • --version (string) [ref]

    Branch, tag or commit ID to checkout before installation of the verifier extension (the ‘master’ branch is used by default).

  • --extra-settings (string) [ref]

    Extra installation settings for verifier extension.

rally verify configure-verifier

Configure a verifier for a specific deployment.

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

Options:

  • --env (string) [ref]

    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 env create, if the --no-use argument was not used.

    Hint

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

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

    Environment variable: RALLY_ENV

  • --reconfigure (flag) [ref]

    Reconfigure verifier.

  • --extend (string) [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.

  • --override (string) [ref]

    Override verifier configuration by another one from a given source.

  • --show (flag) [ref]

    Show verifier configuration.

rally verify create-verifier

Create a verifier.

Options:

  • --name (string, required) [ref]

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

  • --type (string, required) [ref]

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

  • --platform (string) [ref]

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

    Defaults to "".

  • --source (string) [ref]

    Path or URL to the repo to clone verifier from.

  • --version (string) [ref]

    Branch, tag or commit ID to checkout before verifier installation (the ‘master’ branch is used by default).

  • --system-wide (flag) [ref]

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

  • --extra-settings (string) [ref]

    Extra installation settings for verifier.

  • --no-use (flag) [ref]

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

rally verify delete

Delete a verification or a few verifications.

Positional arguments:

  • UUID (string, repeatable, required) [ref]

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

rally verify delete-verifier

Delete a verifier.

Positional arguments:

  • ID (string, required) [ref]

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

Options:

  • --env (string) [ref]

    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.

  • --force (flag) [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.

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

Options:

  • --name (string, required) [ref]

    Verifier extension name.

rally verify import

Import results of a test run into the Rally database.

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

Options:

  • --env (string) [ref]

    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 env create, if the --no-use argument was not used.

    Hint

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

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

    Environment variable: RALLY_ENV

  • --file (string, required) [ref]

    File to import test results from.

  • --run-args (string) [ref]

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

  • --no-use (flag) [ref]

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

rally verify list

List all verifications.

Options:

  • --id (string) [ref]

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

  • --env (string) [ref]

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

  • --tag (string, repeatable) [ref]

    Tags to filter verifications by.

  • --status [ref]

    Status to filter verifications by.

    Set of expected values: crashed, failed, finished, init, running.

rally verify list-plugins

List all plugins for verifiers management.

Options:

  • --platform (string) [ref]

    Required platform (e.g. openstack).

rally verify list-verifier-exts

List all verifier extensions.

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

rally verify list-verifier-tests

List all verifier tests.

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

Options:

  • --pattern (string) [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’).

    Defaults to "".

rally verify list-verifiers

List all verifiers.

Options:

  • --status [ref]

    Status to filter verifiers by.

    Set of expected values: extending, failed, init, installed, installing, updating.

rally verify report

Generate a report for a verification or a few verifications.

Positional arguments:

  • UUID (string, repeatable) [ref]

    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.

    Environment variable: RALLY_VERIFICATION

Options:

  • --type (string) [ref]

    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.

    Defaults to json.

  • --to (string) [ref]

    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.

  • --open (flag) [ref]

    Open the output file in a browser.

rally verify rerun

Rerun tests from a verification for a specific deployment.

Positional arguments:

  • UUID (string) [ref]

    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.

    Environment variable: RALLY_VERIFICATION

Options:

  • --env (string) [ref]

    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 env create, if the --no-use argument was not used.

    Hint

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

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

    Environment variable: RALLY_ENV

  • --failed (flag) [ref]

    Rerun only failed tests.

  • --tag (string, repeatable) [ref]

    Mark verification with a tag or a few tags.

  • --concurrency (integer) [ref]

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

  • --detailed (flag) [ref]

    Show verification details such as errors of failed tests.

  • --no-use (flag) [ref]

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

rally verify show

Show detailed information about a verification.

Positional arguments:

  • UUID (string) [ref]

    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.

    Environment variable: RALLY_VERIFICATION

Options:

  • --sort-by [ref]

    Sort tests.

    Set of expected values: name, duration, status.

    Defaults to name.

  • --detailed (flag) [ref]

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

rally verify show-verifier

Show detailed information about a verifier.

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

rally verify start

Start a verification (run verifier tests).

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

Options:

  • --env (string) [ref]

    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 env create, if the --no-use argument was not used.

    Hint

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

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

    Environment variable: RALLY_ENV

  • --tag (string, repeatable) [ref]

    Mark verification with a tag or a few tags.

  • --pattern (string) [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’).

  • --concurrency (integer) [ref]

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

    Defaults to 0.

  • --load-list (string) [ref]

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

  • --skip-list (string) [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.

  • --xfail-list (string) [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.

  • --detailed (flag) [ref]

    Show verification details such as errors of failed tests.

  • --no-use (flag) [ref]

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

rally verify update-verifier

Update a verifier.

Positional arguments:

  • ID (string) [ref]

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

    Environment variable: RALLY_VERIFIER

Options:

  • --update-venv (flag) [ref]

    Update the virtual environment for verifier.

  • --version (string) [ref]

    Branch, tag or commit ID to checkout. HINT: Specify the same version to pull the latest repo code.

  • --system-wide (flag) [ref]

    Switch to using the system-wide environment.

  • --no-system-wide (flag) [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.

Positional arguments:

  • UUID (string, required) [ref]

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

rally verify use-verifier

Choose a verifier to use for the future operations.

Positional arguments:

  • ID (string, required) [ref]

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