deb-ceilometer/doc/source
Chris Dent 552c63849e Declarative HTTP testing for the Ceilometer API
A 'gabbi' tox target is added which runs a declarative HTTP tests
described in YAML files in 'ceilometer/tests/gabbi/gabbits' and loaded by
'ceilometer/tests/gabbi/test_gabbi.py'. These are driven by the 'gabbi'
python package (available from PyPI).

tox and testr are configured to start and run the tests efficiently:

* a mongodb server, using multiple databases, is made available
* the API wsgi application is used directly via 'wsgi-intercept', no
  web server required
* each YAML file is run as a sequence and where number of processors
  allows, in a different test process
* individual tests can be requested in the usual way:

    tox -egabbi -- <test pattern>

  If this is done, all the tests prior to the one requested, from
  its YAML file, will be run as ordered prerequisites.
* tox targets that already run the tests in ceilometer/tests will
  also discover gabbi tests. If there is no mongodb, they will
  be skipped.

A ConfigFixture does the necessary work of adjusting the configuration
and pipeline to use the mongodb database and nothing else. An
internal InterceptFixture uses wsgi-intercept to access the
ceilometer API. Each yaml file has its own intercepted host.

Fixtures are implemented as nested context managers that are declared
per YAML file, see ceilometer/gabbi/fixtures.py and fixtures-samples.yaml
for an example of how they can be used. Every yaml file uses at
least ConfigFixture.

YAML files can use a variety of strategies for formatting requests
and evaluating the correctness of response. See:
http://gabbi.readthedocs.org/en/latest/format.html

The YAML files included here test simple API features for creating and
retrieving samples. Subsequent patches can (and should) create
additional YAML files to describe more complex scenarios that cover
the entire API (for example alarms are not touched at all by this
patch).

Change-Id: I52551f88bc3beac4bf8a92afa45ac70cd97ffcec
Implements: blueprint declarative-http-tests
2015-02-03 13:03:39 +00:00
..
_templates Apply the official OpenStack stylesheets and templates to the Doc build. 2013-01-05 21:51:02 +01:00
contributing Declarative HTTP testing for the Ceilometer API 2015-02-03 13:03:39 +00:00
install add event listener to collector 2015-02-02 11:00:47 -05:00
releasenotes Add release notes URL for Juno 2015-01-05 19:26:08 -05:00
webapi Add Event and Trait API to document 2015-01-16 10:02:51 +08:00
1-agents.png refresh ceilometer architecture documentation 2014-10-20 10:21:55 -04:00
2-accessmodel.png refresh ceilometer architecture documentation 2014-10-20 10:21:55 -04:00
3-Pipeline.png refresh ceilometer architecture documentation 2014-10-20 10:21:55 -04:00
4-Transformer.png Update the high level architecture 2013-09-09 08:25:59 +02:00
5-multi-publish.png Update the high level architecture 2013-09-09 08:25:59 +02:00
6-storagemodel.png refresh ceilometer architecture documentation 2014-10-20 10:21:55 -04:00
architecture.rst Fix docs to suit merged compute/central agents concept 2014-12-15 13:11:55 +03:00
ceilo-arch.png refresh ceilometer architecture documentation 2014-10-20 10:21:55 -04:00
conf.py remove unexistent module from doc/source/conf.py 2015-01-26 17:03:53 +08:00
configuration.rst Remove duplicated config doc 2014-11-06 15:48:49 +01:00
events.rst Improve links in config docs 2014-12-11 11:21:29 +02:00
format.rst Document the standard for PaaS service notifications 2014-09-07 15:11:17 -06:00
glossary.rst Fix docs to suit merged compute/central agents concept 2014-12-15 13:11:55 +03:00
index.rst Document the standard for PaaS service notifications 2014-09-07 15:11:17 -06:00
measurements.rst Add disk latency metrics implementation in Hyper-V Inspector 2015-02-02 17:18:01 -08:00