2dc6348c90
Running a test with pdb was difficult because tox captures output and causes pdb prompt to quit. Tips for how to run with debug are provided here: https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests This change puts these commands into a debug env in tox.ini so you can do a command like: tox -e debug pycadf.tests.test_cadf_spec and when it hits your breakpoint you'll get the debug prompt. Change-Id: Ic53a888e4e305d51159d1d6a2f962786a532e089 Co-Authored-By: Brant Knudson <bknudson@us.ibm.com> Closes-Bug: #1350424
99 lines
2.9 KiB
ReStructuredText
99 lines
2.9 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.
|
|
|
|
=========================
|
|
Working with the Source
|
|
=========================
|
|
|
|
Setting up a Development Sandbox
|
|
================================
|
|
|
|
1. Set up a server or virtual machine to run OpenStack using
|
|
devstack_.
|
|
|
|
.. _devstack: http://www.devstack.org/
|
|
|
|
2. Clone the ceilometer project to the machine::
|
|
|
|
$ cd /opt/stack
|
|
$ git clone https://git.openstack.org/openstack/ceilometer
|
|
$ cd ./ceilometer
|
|
|
|
3. Once this is done, you need to setup the review process::
|
|
|
|
$ git remote add gerrit ssh://<username>@review.openstack.org:29418/openstack/ceilometer.git
|
|
|
|
4. If you are preparing a patch, create a topic branch and switch to
|
|
it before making any changes::
|
|
|
|
$ git checkout -b TOPIC-BRANCH
|
|
|
|
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. Install the test dependencies::
|
|
|
|
$ sudo pip install -r /opt/stack/ceilometer/test-requirements.txt
|
|
|
|
3. 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
|
|
|
|
.. seealso::
|
|
|
|
* tox_
|
|
|
|
.. _tox: http://tox.testrun.org/latest/
|
|
|
|
Code Reviews
|
|
============
|
|
|
|
Ceilometer uses the OpenStack review process for all code and
|
|
developer documentation contributions. Code reviews are managed
|
|
through gerrit.
|
|
|
|
.. seealso::
|
|
|
|
* http://wiki.openstack.org/GerritWorkflow
|
|
* `OpenStack Gerrit instance`_.
|
|
|
|
.. _OpenStack Gerrit instance: https://review.openstack.org/#/q/status:open+project:openstack/ceilometer,n,z
|