Tempest plugin for automating gabbi-based testing of services.
Go to file
Chris Dent d130b0bbad Add rudimentary docs
Add basic sphinx docs setup with some rudimentary information
on how to use gabbi-tempest. This isn't perfect but provides
the basics for future improvement.

A docs template is added to .zuul.yaml.

Change-Id: If2631d92366866ba6bd149909ece17734931ae91
2018-10-29 14:28:53 +00:00
doc Add rudimentary docs 2018-10-29 14:28:53 +00:00
gabbi_tempest release 0.1.1 2018-01-10 16:17:09 +00:00
gate/gabbits Provide a gabbi-tempest job, tested by itself 2018-10-26 11:33:50 +01:00
samples Clean up packaging and docs to make this consumable 2018-01-09 17:12:00 +00:00
.gitignore Initial stab and a generic gabbi plugin for tempest 2016-04-08 15:58:31 +00:00
.gitreview Add zuul noop jobs and .gitreview to get started. 2018-10-18 17:34:25 +01:00
.zuul.yaml Add rudimentary docs 2018-10-29 14:28:53 +00:00
Makefile Clean up packaging and docs to make this consumable 2018-01-09 17:12:00 +00:00
README.rst Add rudimentary docs 2018-10-29 14:28:53 +00:00
requirements.txt Clean up packaging and docs to make this consumable 2018-01-09 17:12:00 +00:00
setup.cfg Add rudimentary docs 2018-10-29 14:28:53 +00:00
setup.py Initial stab and a generic gabbi plugin for tempest 2016-04-08 15:58:31 +00:00
tox.ini Add rudimentary docs 2018-10-29 14:28:53 +00:00

README.rst

Gabbi + Tempest

Gabbi-tempest is a Tempest plugin that enables testing the APIs of running OpenStack services, integrated with tempest but without needing to write Python. Instead the YAML format provided by gabbi is used to write and evaluate HTTP requests and responses.

Tests are placed in YAML files in one or more directories. Those directories are added to a GABBI_TEMPEST_PATH environment variable. When that variable is passed into a tempest test runner that is aware of the gabbi plugin, the files on that path will be used to create tempests tests.

The test harness sets a series of enviornment variables that can be used in the YAML to reach the available services. The available variables may be extended in two ways:

  • Adding them to the environment that calls tempest if the values are known.
  • Setting them in a subclass of the plugin if the values need to be calculated from what tempest knows.

For each service in the service catalog there are <SERVICE_TYPE>_SERVICE and <SERVICE_TYPE>_BASE variables (e.g., PLACEMENT_SERVICE and PLACEMENT_BASE). A useful SERVICE_TOKEN, IMAGE_REF, FLAVOR_REF and FLAVOR_REF_ALT are also available.

Read the docs at https://gabbi-tempest.readthedocs.io/