20b99ec5fd
Don't translate debug level logs and enforce log hints Our translation policy (https://wiki.openstack.org/wiki/LoggingStandards#Log_Translation) calls for not translating debug level logs. This is to help prioritize log translation. Furthermore translation has a performance overhead, even if the log isn't used (since neutron doesn't support lazy translation yet). NOTE: this is done on a directory by directory basis to ensure that we do not have too many conflicts and rebases. Add a local hacking rule to enforce this. This patch set enforces the directory neutron/agents Partial-bug: #1320867 Change-Id: I4bd562e5138c2d2850072440aa121f27e902463a
34 lines
1.4 KiB
ReStructuredText
34 lines
1.4 KiB
ReStructuredText
Neutron Style Commandments
|
|
=======================
|
|
|
|
- Step 1: Read the OpenStack Style Commandments
|
|
http://docs.openstack.org/developer/hacking/
|
|
- Step 2: Read on
|
|
|
|
Neutron Specific Commandments
|
|
--------------------------
|
|
|
|
- [N319] Validate that debug level logs are not translated
|
|
- [N320] Validate that LOG messages, except debug ones, have translations
|
|
- [N321] Validate that jsonutils module is used instead of json
|
|
- [N322] We do not use @authors tags in source files. We have git to track
|
|
authorship.
|
|
- [N323] assert_called_once() is not a valid method
|
|
|
|
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.
|