openstack/neutron
Code Issues Proposed changes
4cd1600b25
neutron/HACKING.rst
ankitagrawal 4cd1600b25 Remove use of contextlib.nested 
Removed use of contextlib.nested call from codebase, as it has been
deprecated since Python 2.7.

There are also known issues with contextlib.nested that were addressed
by the native support for multiple "with" variables. For instance, if
the first object is created but the second one throws an exception,
the first object's __exit__ is never called. For more information see
https://docs.python.org/2/library/contextlib.html#contextlib.nested
contextlib.nested is also not compatible with Python 3.

This is the first patch in a series for removing use of
contextlib.nested.

Added hacking check to catch if any new instances are added to
the codebase.

Line continuation markers (e.g. '\') had to be used or syntax
errors were thrown. While using parentheses is the preferred way
for multiple line statements, but in case of long with statements
backslashes are acceptable.

Partial-Bug: 1428424
Change-Id: I171fbdb89892a3d4548bf2ca52f4a7dd9ef8dccb
2015-05-06 04:43:01 -07:00

1.4 KiB
Raw Blame History

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

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] Detect common errors with assert_called_once_with
  • [N323] Enforce namespace-less imports for oslo libraries
  • [N324] Prevent use of deprecated contextlib.nested.

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.