]> review.fuel-infra Code Review - openstack-build/neutron-build.git/blob - HACKING.rst
Merge "Add support for neutron-full and api jobs using pecan to gate_hook"
[openstack-build/neutron-build.git] / HACKING.rst
1 Neutron Style Commandments
2 ==========================
3
4 - Step 1: Read the OpenStack Style Commandments
5   http://docs.openstack.org/developer/hacking/
6 - Step 2: Read on
7
8 Neutron Specific Commandments
9 -----------------------------
10
11 - [N319] Validate that debug level logs are not translated
12 - [N320] Validate that LOG messages, except debug ones, have translations
13 - [N321] Validate that jsonutils module is used instead of json
14 - [N322] Detect common errors with assert_called_once_with
15 - [N323] Enforce namespace-less imports for oslo libraries
16 - [N324] Prevent use of deprecated contextlib.nested.
17 - [N325] Python 3: Do not use xrange.
18 - [N326] Python 3: do not use basestring.
19 - [N327] Python 3: do not use dict.iteritems.
20 - [N328] Detect wrong usage with assertEqual
21 - [N329] Method's default argument shouldn't be mutable
22 - [N330] Use assertEqual(*empty*, observed) instead of
23          assertEqual(observed, *empty*)
24 - [N331] Detect wrong usage with assertTrue(isinstance()).
25
26 Creating Unit Tests
27 -------------------
28 For every new feature, unit tests should be created that both test and
29 (implicitly) document the usage of said feature. If submitting a patch for a
30 bug that had no unit test, a new passing unit test should be added. If a
31 submitted bug fix does have a unit test, be sure to add a new one that fails
32 without the patch and passes with the patch.
33
34 All unittest classes must ultimately inherit from testtools.TestCase. In the
35 Neutron test suite, this should be done by inheriting from
36 neutron.tests.base.BaseTestCase.
37
38 All setUp and tearDown methods must upcall using the super() method.
39 tearDown methods should be avoided and addCleanup calls should be preferred.
40 Never manually create tempfiles. Always use the tempfile fixtures from
41 the fixture library to ensure that they are cleaned up.