openstack/cinder
Code Issues Proposed changes
114c84ae58
cinder/HACKING.rst
Jay S. Bryant d8301e58bf Add hacking check for oslo namespace usage 
We want to make sure that we don't have usage of the old
oslo.concurrency naming slipping in with new changes where
we should be using the oslo_concurrency namespace.  This change
adds a hacking check to avoid use of the deprecated namespace.
As we convert more oslo libraries to the new namespace the check
will be updated to enforce use of the new namespace.

This hacking check is based upon the same N333 hacking check
in Cinder.

Change-Id: Ibec6d09e9d313c9e723f7542cedb9da5772d3de2
2015-01-14 09:09:58 -06:00

1.6 KiB
Raw Blame History

Cinder Style Commandments

Cinder Specific Commandments

  • [N314] Check for vi editor configuration in source files.
  • [N319] Validate that debug level logs are not translated
  • [N322] Ensure default arguments are not mutable.
  • [N323] Add check for explicit import of _() to ensure proper translation.
  • [N324] Enforce no use of LOG.audit messages. LOG.info should be used instead.
  • [N327] assert_called_once is not a valid Mock method.
  • [N333] Ensure that oslo namespaces are used for namespaced libraries.

General

  • Use 'raise' instead of 'raise e' to preserve original traceback or exception being reraised:

    except Exception as e:
    ...
    raise e  # BAD

except Exception:
    ...
    raise  # OKAY

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.

Cinder is transitioning to use mock, rather than mox, and so new tests should use mock only.

For more information on creating unit tests and utilizing the testing infrastructure in OpenStack Cinder, please read the Cinder testing README.rst.