48751822dd
- remove specific comments about preferring notifications v. polling just say, polling can add load - remove kafka publisher reference - remove database publisher reference - move key links (wiki, launchpad, ml, etc...) to index - put all meter details in one area - clean up testing Change-Id: I1993a9945334ffe631f2ddb3dcd0316d0e71f258
52 lines
1.7 KiB
ReStructuredText
52 lines
1.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. 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/unit/image::
|
|
|
|
$ tox -e py27 -- image
|
|
|
|
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.unit.test_bin
|
|
|
|
For reference, the ``debug`` tox environment implements the instructions
|
|
here: https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests
|
|
|
|
.. _tox: https://tox.readthedocs.io/en/latest/
|