openstack/cinder
Code Issues Proposed changes
cinder/HACKING.rst
Sean McGinnis 3578d9e341 Logging not using oslo.i18n guidelines 
Part of multi-patch set for easier chunks.

There have been quite a few instances found where the
i18n guidelines are not being followed. I believe this
has helped lead to some of the confusion around how to
correctly do this. Other developers see this code and
assume it is an example of the correct usage.

This patch attempts to clean up most of those violations
in the existing codebase to hopefully help avoid some of
that confusion in reviews.

Some issues address:
* Correct log translation markers for different log levels
* Passing format values as arguments to call, not preformatting
* Not forcing translation via six.text_type and others

Guidelines can be found here:
http://docs.openstack.org/developer/oslo.i18n/guidelines.html

Hacking checks will not be able to identify all violations of
the guidelines, but it could be useful for catching obvious ones
such as LOG.info("No markers!").

Change-Id: I38f52c6408b47ccb59ec2064b360f7d4427d6830
Partial-bug: 1433216
2015-03-19 12:28:12 -05:00

1.9 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.
  • [N328] LOG.info messages require translations _LI().
  • [N329] LOG.exception and LOG.error messages require translations _LE().
  • [N330] LOG.warning messages require translations _LW().
  • [N333] Ensure that oslo namespaces are used for namespaced libraries.
  • [N339] Prevent use of deprecated contextlib.nested.
  • [C301] timeutils.utcnow() from oslo_utils should be used instead of datetime.now().

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.