openstack/neutron
Code Issues Proposed changes
6b43ef8ef7
neutron/HACKING.rst
Gary Kotton 2b7fb6ff08 Removes the use of mutables as default args 
Passing mutable objects as default args is a known Python pitfall.
We'd better avoid this. This commit changes mutable default args with
None, then use 'arg = arg or {}', 'arg = arg or []'. For unit code which
doesn't use the args , just set with None. This commit also adds hacking
check.

This code was taken from commit 0bea84ac20fe498bd08f7212a0017196c8cb0812
in Nova.

Change-Id: I36d07cade687690dc02a8f6cc3d70f5d00caf112
Co-Authored-By: ChangBo Guo(gcb) <glongwave@gmail.com>
2015-10-29 07:57:31 -07:00

1.6 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.
  • [N325] Python 3: Do not use xrange.
  • [N326] Python 3: do not use basestring.
  • [N327] Python 3: do not use dict.iteritems.
  • [N328] Detect wrong usage with assertEqual
  • [N329] Method's default argument shouldn't be mutable

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.