Skip to main content

Tempest plugin for whitebox testing of TripleO/Director-based OpenStack deployments

Project description

Whitebox Tempest plugin
=======================

This repo is a Tempest plugin that contains scenario tests ran against
TripleO/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/a

Requirements
------------

The tests assume a TripleO/Director-based deployment with an undercloud and
overcloud. The tests will be run from the undercloud therefore Tempest should
be installed and configured on the undercloud node. It's assumed that the Unix
user running the tests, generally *stack*, has SSH access to all the compute
nodes running in the overcloud.

Most tests have specific hardware requirements. These are documented in the
tests themselves and the tests should fast-fail if these hardware requirements
are not met. You will require multiple nodes to run these tests and will need
to manually specify which test to run on which node. For more information on
our plans here, refer to :ref:`roadmap`.

For more information on TripleO/Director, refer to the `Red Hat OpenStack
Platform documentation`__.

__ https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/11/html/director_installation_and_usage/chap-introduction

Install, configure and run
--------------------------

1. Install the plugin.

This should be done from source. ::

WORKSPACE=/some/directory
cd $WORKSPACE
git clone https://github.com/redhat-openstack/whitebox-tempest-plugin
sudo pip install whitebox-tempest-plugin

2. Configure Tempest.

Add the following lines at the end of your ``tempest.conf`` file. These
determine how your undercloud node, which is running Tempest, should connect
to 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_rsa
containers = true
max_compute_nodes = 2 # Some tests depend on there being a single
# (available) compute node

3. 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" APIs
which 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 future
version of Tempest could break.

__ http://docs.openstack.org/tempest/latest/plugin.html

.. _roadmap:

Roadmap
-------

The different tests found here all have different hardware requirements, and
these requirements often conflict. For example, a test that requires a host
without HyperThreading enabled cannot be used for a test that requires
HyperThreading. As a result, it's not possible to have one "master
configuration" that can be used to run all tests. Instead, different tests must
be run on different nodes.

At present, this plugin exists in isolation and the running of individual tests
on 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 test
suite of against *N* overcloud nodes, where each node has a different hardware
configuration and *N* is the total number of different hardware configurations
required (one for real-time, one for SR-IOV, etc.). Each node would have a
different profile__ and host aggregates would likely be used to ensure each
test runs on its preferred hardware. To get here, we should probably provide a
recipe along with hardware configuration steps.

This being said, the above is way off yet. For now, we're focussed on getting
the tests in place so we can stop doing all this stuff by hand.

__ http://tripleo.org/install/advanced_deployment/profile_matching.html



Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whitebox-tempest-plugin-0.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

whitebox_tempest_plugin-0-py2-none-any.whl (27.8 kB view details)

Uploaded Python 2

File details

Details for the file whitebox-tempest-plugin-0.tar.gz.

File metadata

  • Download URL: whitebox-tempest-plugin-0.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.15

File hashes

Hashes for whitebox-tempest-plugin-0.tar.gz
Algorithm Hash digest
SHA256 038341fb941ec2f17d17c6462d34a326cf06cad6945ca9c47d75049861d89ed8
MD5 0a07949c1c5a5dfda572c97e384119b8
BLAKE2b-256 a2d1f73fb122e3de52b8b6ced7bc275588b94e55efbca2b6fd84e7354dfa384c

See more details on using hashes here.

File details

Details for the file whitebox_tempest_plugin-0-py2-none-any.whl.

File metadata

  • Download URL: whitebox_tempest_plugin-0-py2-none-any.whl
  • Upload date:
  • Size: 27.8 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.15

File hashes

Hashes for whitebox_tempest_plugin-0-py2-none-any.whl
Algorithm Hash digest
SHA256 81171fa022b091696fe643c17f9730035b4deed4fa0933f8e90bbcd212945a4c
MD5 6cffd499a8f41dc51fd59c0a63d71c75
BLAKE2b-256 a41491233796b357315da266c4fa0991ce463e1d6a6237100c4d7906722b7857

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page