8fe52197c6
Reference the OpenStack hacking guide in HACKING.rst and remove duplicate entries. Adds placeholder section for neutron specific rules. Change-Id: I4bfbab50b77e7592178dda44c7f4f52edc7fdc21
1.5 KiB
Neutron Style Commandments =======================
- Step 1: Read the OpenStack Style Commandments https://github.com/openstack-dev/hacking/blob/master/doc/source/index.rst
- Step 2: Read on
Neutron Specific Commandments --------------------------
None so far
Creating Unit Tests
For every new feature, unit tests should be created that both test and (implicitly) document the usage of said feature. If submitting a patch for a bug that had no unit test, a new passing unit test should be added. If a submitted bug fix does have a unit test, be sure to add a new one that fails without the patch and passes with the patch.
All unittest classes must ultimately inherit from testtools.TestCase. In the Neutron test suite, this should be done by inheriting from neutron.tests.base.BaseTestCase.
All setUp and tearDown methods must upcall using the super() method. tearDown methods should be avoided and addCleanup calls should be preferred. Never manually create tempfiles. Always use the tempfile fixtures from the fixture library to ensure that they are cleaned up.
openstack-common
A number of modules from openstack-common are imported into the project.
These modules are "incubating" in openstack-common and are kept in sync with the help of openstack-common's update.py script. See:
The copy of the code should never be directly modified here. Please always update openstack-common first and then run the script to copy the changes across.