cinder/HACKING.rst
Christian Berendt 5061ab9586 debug level logs should not be translated
According to the OpenStack translation policy available at
https://wiki.openstack.org/wiki/LoggingStandards debug messages
should not be translated. Like mentioned in several changes in
Nova by garyk this is to help prioritize log translation.

This patch adds a new hacking check - N319 - that ensures all
debug log messages don't have translations.

Change-Id: Id9c2715f25c8f2ea52235aba4bd1583655391584
Implements: blueprint debug-translation-removal
Closes-Bug: #1318713
2014-06-18 09:03:02 -06:00

1.2 KiB

Cinder Style Commandments

Cinder Specific Commandments

  • [N319] Validate that debug level logs are not translated

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.