cinder/HACKING.rst
Sean McGinnis 46e1f1741d Remove useless logging from unit tests
It has been discussed that there really isn't much point in having
unit tests making any kind of logger calls. Some usage has already
been cleaned up. This patch removes the remaining instances of log
calls under the cinder/tests directory.

Also cleaned up a lot of cases where the source files would import
oslo_logging and declare a LOG variable which was never actually
used.

Leaving logging in the cinder/tests/unit/integrated tree for now
until a plan is decided as to what to do with all of these type of
tests.

Added hacking check to prevent new instances from slipping by code
reviews.

Change-Id: If177394486d5c92fa5466cd3825b15d30cf5fb18
2015-07-13 17:39:44 +00:00

2.4 KiB

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.
  • [N325] str() and unicode() cannot be used on an exception. Remove or use six.text_type().
  • [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.
  • [N336] Must use a dict comprehension instead of a dict constructor with a sequence of key-value pairs.
  • [C301] timeutils.utcnow() from oslo_utils should be used instead of datetime.now().
  • [C302] six.text_type should be used instead of unicode
  • [C303] Ensure that there are no 'print()' statements in code that is being committed.
  • [C304] Enforce no use of LOG.audit messages. LOG.info should be used instead.
  • [C305] Prevent use of deprecated contextlib.nested.
  • [C306] timeutils.strtime() must not be used (deprecated).
  • [C307] LOG.warn is deprecated. Enforce use of LOG.warning.
  • [C308] timeutils.isotime() must not be used (deprecated).
  • [C309] Unit tests should not perform logging.

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.