watcher-tempest-plugin/doc/source/readme.rst

Tempest tests

The following procedure gets you started with Tempest testing but you can also refer to the Tempest documentation for more details.

Tempest installation

To install Tempest you can issue the following commands:

$ git clone https://opendev.org/openstack/tempest
$ cd tempest/
$ pip install .

The folder's path you are now in will be called <TEMPEST_DIR> from now onwards.

Please note that although it is fully working outside a virtual environment, it is recommended to install within a venv.

Watcher Tempest testing setup

You can now install Watcher alongside it in development mode by issuing the following command:

$  pip install -e <WATCHER_SRC_DIR>

Then set up a local working environment (here watcher-cloud) for running Tempest for Watcher which shall contain the configuration for your OpenStack integration platform.

In a virtual environment, you can do so by issuing the following command:

$ cd <TEMPEST_DIR>
$ tempest init watcher-cloud

Otherwise, if you are not using a virtualenv:

$ cd <TEMPEST_DIR>
$ tempest init --config-dir ./etc watcher-cloud

By default the configuration file is empty so before starting, you need to issue the following commands:

$ cd <TEMPEST_DIR>/watcher-cloud/etc
$ cp tempest.conf.sample tempest.conf

At this point, you need to edit the watcher-cloud/etc/tempest.conf file as described in the Tempest configuration guide. Shown below is a minimal configuration you need to set within your tempest.conf configuration file which can get you started.

For Keystone V3:

[identity]
uri_v3 = http://<KEYSTONE_PUBLIC_ENDPOINT_IP>:<KEYSTONE_PORT>/v3
auth_version = v3

[auth]
admin_username = <ADMIN_USERNAME>
admin_password = <ADMIN_PASSWORD>
admin_tenant_name = <ADMIN_TENANT_NAME>
admin_domain_name = <ADMIN_DOMAIN_NAME>

[identity-feature-enabled]
api_v3 = true

[network]
public_network_id = <PUBLIC_NETWORK_ID>

You now have the minimum configuration for running Watcher Tempest tests on a single node.

Since deploying Watcher with only a single compute node is not very useful, a few more configurations have to be set in your tempest.conf file in order to enable the execution of multi-node scenarios:

[compute]
# To indicate Tempest test that you have provided enough compute nodes
min_compute_nodes = 2

# Image UUID you can get using the "glance image-list" command
image_ref = <IMAGE_UUID>

For more information, please refer to:

• Keystone connection: https://docs.openstack.org/tempest/latest/configuration.html#keystone-connection-info
• Dynamic Keystone Credentials: https://docs.openstack.org/tempest/latest/configuration.html#dynamic-credentials

Watcher Tempest tests execution

To list all Watcher Tempest cases, you can issue the following commands:

$ cd <TEMPEST_DIR>
$ tempest run --list-tests --regex watcher_tempest_plugin

To run only these tests in Tempest, you can then issue these commands:

$ tempest run --config-file watcher-cloud/etc/tempest.conf --regex watcher_tempest_plugin

Alternatively, the following commands if you are in the Tempest directory:

$ cd <TEMPEST_DIR>/watcher-cloud
$ tempest run --regex watcher_tempest_plugin

To run a single test case, go to the Tempest directory, then run with the test case name, e.g.:

$ cd <TEMPEST_DIR>
$ tempest run --config-file watcher-cloud/etc/tempest.conf --regex \
    watcher_tempest_plugin.tests.api.admin.test_audit_template.TestCreateDeleteAuditTemplate.test_create_audit_template

Alternatively, you can also run the Watcher Tempest plugin tests using tox. But before you can do so, you need to follow the Tempest explanation on running tox with plugins. Then, run:

$ export TEMPEST_CONFIG_DIR=<TEMPEST_DIR>/watcher-cloud/etc/
$ tox -eall-plugin watcher

And, to run a specific test:

$ export TEMPEST_CONFIG_DIR=<TEMPEST_DIR>/watcher-cloud/etc/
$ tox -eall-plugin watcher_tempest_plugin.tests.api.admin.test_audit_template.TestCreateDeleteAuditTemplate.test_create_audit_template

Watcherclient Tempest tests execution

To run Watcherclient functional tests you need to execute tempest run command:

$ tempest run --regex watcher_tempest_plugin.tests.client_functional

You can run specified test(s) by using a regular expression:

$ tempest run --regex watcher_tempest_plugin.tests.client_functional.v1.test_action.ActionTests.test_action_list