openstack/neutron-vpnaas
Code Issues Proposed changes
1683bea1c6
neutron-vpnaas/HACKING.rst
Gary Kotton 2c29ba63ad Remove @author(s) from copyright statements 
We have git to track authorship, so let's not pad source files
with it as well.

A hacking check has been added for this. The value is N322.

Change-Id: Iab0b64d417e0bb41a6b455e2ac377deee64ec3ee
2014-09-15 21:40:09 +09:00

1.2 KiB
Raw Blame History

Neutron Style Commandments =======================

Neutron Specific Commandments --------------------------

  • [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.

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.