Tempest plugin for whitebox testing. For testing things not exposed through the REST APIs.
Go to file
Balazs Gibizer a9d3bf9f4a Use compute-feature-enabled as the config group name
The tempest config group name is compute-feature-enabled the python code
needs to use CONF.compute_feature_enabled to access that group. But the
test skipping message should point to the group config name instead of
the python variable name to avoid confusion

Change-Id: I5b852d9f8dbb9392329d82c70a1686f96628a5e8
2023-12-08 18:10:07 +01:00
devstack Add global nodes variable 2023-11-13 13:39:53 -05:00
playbooks Add global nodes variable 2023-11-13 13:39:53 -05:00
whitebox_tempest_plugin Use compute-feature-enabled as the config group name 2023-12-08 18:10:07 +01:00
.gitignore Update gitignore 2019-04-02 15:51:24 +00:00
.gitreview Fix repo after rename 2020-06-13 07:08:00 +02:00
.stestr.conf Subclass API tests instead of scenario 2018-07-13 10:38:09 -04:00
.zuul.yaml Remove unit tests 2023-11-16 12:05:00 -05:00
LICENSE Includes license and fixes copyright headers 2017-12-12 17:55:00 +01:00
README.rst Fix typo 2022-05-12 16:29:27 +02:00
requirements.txt Update requirements for paramiko for Downstream Train 2023-10-20 12:42:23 -04:00
setup.cfg Update jobs for Bobcat development cycle 2023-05-26 12:24:28 -04:00
setup.py Initial commit 2017-12-12 17:55:00 +01:00
test-requirements.txt Remove tempest and oslo.log from requirements.txt 2020-07-30 12:09:17 -04:00
tox.ini Add global nodes variable 2023-11-13 13:39:53 -05:00


Whitebox Tempest plugin

This is a Tempest plugin for whitebox testing. While Tempest's scope is limited to only the REST APIs, whitebox allows tests to peak behind the curtain, similar to how a cloud admin might. Examining things on the compute host(s) and/or the controller(s) is not only allowed, it's required for a test to be in whitebox's scope. Whitebox tests must still be REST API-driven, however their assertions can involve things like the instance XML (if the Nova libvirt driver is in use) or the database.


While Tempest is cloud-agnostic because all clouds expose the same OpenStack APIs (with some caveats around extensions), whitebox peaks behind the curtain, and thus is coupled to the way the cloud was deployed. Currently, devstack and TripleO (with undercloud and overcloud) are supported, with only devstack being tested in CI.

Some tests have specific hardware requirements. These should be documented as config options, and tests are expected to skip if their hardware requirements are not declared in the configuration.

Install, configure and run

  1. Tempest needs to be installed and configured.

  2. Install the plugin.

    This should be done from source. :

    git clone https://opendev.org/openstack/whitebox-tempest-plugin
    sudo pip install whitebox-tempest-plugin
  3. Configure Tempest.

    The exact configuration will depend on the deployment. There is no configuration reference yet, have a look at whitebox_tempest_plugin/config.py instead. As an example, here is a configuration for a multinode TripleO deployment:


    ctlplane_addresses = compute-0.localdomain:,compute-1.localdomain: ctlplane_ssh_username = heat-admin ctlplane_ssh_private_key_path = /home/stack/.ssh/id_rsa containers = true max_compute_nodes = 2 # Some tests depend on there being a single # (available) compute node

  4. Execute the tests. :

    tempest run --serial --regex whitebox_tempest_plugin.


    Whitebox expects its tests to run one at a time. Make sure to pass --serial or --concurrency 1 to tempest run.

How to add a new test

Tests should fit whitebox's scope. If a test intereacts with REST APIs and nothing else, it is better suited for Tempest itself. New tests should be added in their respective subdirectories. For example, tests that use the compute API live in whitebox_tempest_plugin/api/compute. Test code does not need unit tests, but helpers or utilities do. Unit tests live in whitebox_tempest_plugin/tests. Whitebox does not adhere to the Tempest plugin interface <https://docs.openstack.org/tempest/latest/plugin.html>. As mentioned, whitebox tests run one at a time, so it's safe for a test to modify the environment and/or be destructive, as long as it cleans up after itself. For example, changing Nova configuration values and/or restarting services is acceptable, as long as the original values and service state are restored.