openstack/deb-ceilometer
Code Issues Proposed changes
253a6288e8
deb-ceilometer/doc/source/testing.rst
gordon chung 2b6bb8b5ba create a developer section and refactor 
- remove contributing folder contents
   - move plugins into first level
   - keep testing info from 'working with source' and move to first
     level
   - keep a generic contributing page to point to gerrit workflow and
     standard links (git repo, launchpad, etc...)
   - delete everything else
- split TOC into:
   - overview - general stuff
   - developer - dev related stuff
   - appendix - random stuff

Change-Id: I8c460a655427141eb8bb8db9d4c2ecd253eb6cb1
2015-02-26 16:55:34 -05:00

2.7 KiB
Raw Blame History

Running the Tests

Ceilometer includes an extensive set of automated unit tests which are run through tox.

  1. Install tox:

    $ sudo pip install tox

  2. On Ubuntu install mongodb and libmysqlclient-dev packages:

    $ sudo apt-get install mongodb
$ sudo apt-get install libmysqlclient-dev

    For Fedora20 there is no libmysqlclient-dev package, so you’ll need to install mariadb-devel.x86-64 (or mariadb-devel.i386) instead:

    $ sudo yum install mongodb
$ sudo yum install mariadb-devel.x86_64

  3. Install the test dependencies:

    $ sudo pip install -r /opt/stack/ceilometer/test-requirements.txt

  4. Run the unit and code-style tests:

    $ cd /opt/stack/ceilometer
$ tox -e py27,pep8

    As tox is a wrapper around testr, it also accepts the same flags as testr. See the testr documentation for details about these additional flags.

    Use a double hyphen to pass options to testr. For example, to run only tests under tests/api/v2:

    $ tox -e py27 -- api.v2

    To debug tests (ie. break into pdb debugger), you can use ''debug'' tox environment. Here's an example, passing the name of a test since you'll normally only want to run the test that hits your breakpoint:

    $ tox -e debug ceilometer.tests.test_bin

    For reference, the debug tox environment implements the instructions here: https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests

  5. There is a growing suite of tests which use a tool called gabbi to test and validate the behavior of the Ceilometer API. These tests are run when using the usual py27 tox target but if desired they can be run by themselves:

    $ tox -e gabbi

    The YAML files used to drive the gabbi tests can be found in ceilometer/tests/gabbi/gabbits. If you are adding to or adjusting the API you should consider adding tests here.