Package: whitebox-tempest-plugin
Whitebox Tempest plugin=======================This repo is a Tempest plugin that contains scenario tests ran againstTripleO/Director-based deployments... important::This is still a work in progress.* Free software: Apache license* Documentation: n/a* Source: https://review.rdoproject.org/r/gitweb?p=openstack/whitebox-tempest-plugin.git* Bugs: n/aRequirements------------The tests assume a TripleO/Director-based deployment with an undercloud andovercloud. The tests will be run from the undercloud therefore Tempest shouldbe installed and configured on the undercloud node. It's assumed that the Unixuser running the tests, generally *stack*, has SSH access to all the computenodes running in the overcloud.Most tests have specific hardware requirements. These are documented in thetests themselves and the tests should fast-fail if these hardware requirementsare not met. You will require multiple nodes to run these tests and will needto manually specify which test to run on which node. For more information onour plans here, refer to :ref:`roadmap`.For more information on TripleO/Director, refer to the `Red Hat OpenStackPlatform documentation`__.__ https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/11/html/director_installation_and_usage/chap-introductionInstall, configure and run--------------------------1. Install the plugin.This should be done from source. ::WORKSPACE=/some/directorycd $WORKSPACEgit clone https://github.com/redhat-openstack/whitebox-tempest-pluginsudo pip install whitebox-tempest-plugin2. Configure Tempest.Add the following lines at the end of your ``tempest.conf`` file. Thesedetermine how your undercloud node, which is running Tempest, should connectto the compute nodes in the overcloud and vice versa. For example::[whitebox]hypervisors = compute-0.localdomain:192.168.24.6,compute-1.localdomain:192.168.24.12# Only set the following if different from the defaults listed# ctlplane_ssh_username = heat-admin# ctlplane_ssh_private_key_path = /home/stack/.ssh/id_rsacontainers = truemax_compute_nodes = 2 # Some tests depend on there being a single# (available) compute node3. Execute the tests. ::tempest run --regex whitebox_tempest_plugin.How to add a new test---------------------New tests should be added to the ``whitebox_tempest_plugin/tests`` directory.According to the plugin interface doc__, you should mainly import "stable" APIswhich usually are:* ``tempest.lib.*``* ``tempest.config``* ``tempest.test_discover.plugins``* ``tempest.common.credentials_factory``* ``tempest.clients``* ``tempest.test``Importing classes from ``tempest.api.*`` could be dangerous since futureversion of Tempest could break.__ http://docs.openstack.org/tempest/latest/plugin.html.. _roadmap:Roadmap-------The different tests found here all have different hardware requirements, andthese requirements often conflict. For example, a test that requires a hostwithout HyperThreading enabled cannot be used for a test that requiresHyperThreading. As a result, it's not possible to have one "masterconfiguration" that can be used to run all tests. Instead, different tests mustbe run on different nodes.At present, this plugin exists in isolation and the running of individual testson nodes, along with the configuration of said nodes, remains a manual process.However, the end goal for this project is to be able to kick run this testsuite of against *N* overcloud nodes, where each node has a different hardwareconfiguration and *N* is the total number of different hardware configurationsrequired (one for real-time, one for SR-IOV, etc.). Each node would have adifferent profile__ and host aggregates would likely be used to ensure eachtest runs on its preferred hardware. To get here, we should probably provide arecipe along with hardware configuration steps.This being said, the above is way off yet. For now, we're focussed on gettingthe tests in place so we can stop doing all this stuff by hand.__ http://tripleo.org/install/advanced_deployment/profile_matching.html