2b6bb8b5ba
- 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
83 lines
2.7 KiB
ReStructuredText
83 lines
2.7 KiB
ReStructuredText
..
|
||
Copyright 2012 New Dream Network, LLC (DreamHost)
|
||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||
not use this file except in compliance with the License. You may obtain
|
||
a copy of the License at
|
||
|
||
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
Unless required by applicable law or agreed to in writing, software
|
||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||
License for the specific language governing permissions and limitations
|
||
under the License.
|
||
|
||
=================
|
||
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.
|
||
|
||
.. _testr documentation: https://testrepository.readthedocs.org/en/latest/MANUAL.html
|
||
|
||
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.
|
||
|
||
.. _gabbi: https://gabbi.readthedocs.org/
|
||
|
||
.. seealso::
|
||
|
||
* tox_
|
||
|
||
.. _tox: http://tox.testrun.org/latest/
|