openstack/neutron
Code Issues Proposed changes
83c9578fcc
neutron/HACKING.rst
Hirofumi Ichihara 2c62cd6ec0 Use assertTrue(observed) instead of assertEqual(True, observed) 
We should use assertTrue not assertEqual.

Closes-Bug: #1503071

Change-Id: Ib75dd9f8965fd04fe581f09a5e5df3df43542d89
2015-10-09 23:13:58 +09: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

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.