416 lines
14 KiB
Python
416 lines
14 KiB
Python
# Copyright (c) 2014 OpenStack Foundation.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import os
|
|
import re
|
|
|
|
from debtcollector import moves
|
|
from hacking import core
|
|
from neutron_lib.hacking import checks
|
|
import pep8
|
|
import six
|
|
|
|
|
|
def flake8ext(f):
|
|
"""Decorator to indicate flake8 extension.
|
|
|
|
This is borrowed from hacking.core.flake8ext(), but at now it is used
|
|
only for unit tests to know which are neutron flake8 extensions.
|
|
"""
|
|
f.name = __name__
|
|
return f
|
|
|
|
|
|
# Guidelines for writing new hacking checks
|
|
#
|
|
# - Use only for Neutron specific tests. OpenStack general tests
|
|
# should be submitted to the common 'hacking' module.
|
|
# - Pick numbers in the range N3xx. Find the current test with
|
|
# the highest allocated number and then pick the next value.
|
|
# - Keep the test method code in the source file ordered based
|
|
# on the N3xx value.
|
|
# - List the new rule in the top level HACKING.rst file
|
|
# - Add test cases for each new rule to
|
|
# neutron/tests/unit/hacking/test_checks.py
|
|
|
|
_all_log_levels = {
|
|
'reserved': '_', # this should never be used with a log unless
|
|
# it is a variable used for a log message and
|
|
# a exception
|
|
'error': '_LE',
|
|
'info': '_LI',
|
|
'warning': '_LW',
|
|
'critical': '_LC',
|
|
'exception': '_LE',
|
|
}
|
|
_all_hints = set(_all_log_levels.values())
|
|
|
|
|
|
def _regex_for_level(level, hint):
|
|
return r".*LOG\.%(level)s\(\s*((%(wrong_hints)s)\(|'|\")" % {
|
|
'level': level,
|
|
'wrong_hints': '|'.join(_all_hints - set([hint])),
|
|
}
|
|
|
|
|
|
log_string_interpolation = re.compile(r".*LOG\.(?:error|warn|warning|info"
|
|
r"|critical|exception|debug)"
|
|
r"\([^,]*%[^,]*[,)]")
|
|
log_translation_hint = re.compile(
|
|
'|'.join('(?:%s)' % _regex_for_level(level, hint)
|
|
for level, hint in six.iteritems(_all_log_levels)))
|
|
|
|
log_warn = re.compile(
|
|
r"(.)*LOG\.(warn)\(\s*('|\"|_)")
|
|
unittest_imports_dot = re.compile(r"\bimport[\s]+unittest\b")
|
|
unittest_imports_from = re.compile(r"\bfrom[\s]+unittest\b")
|
|
filter_match = re.compile(r".*filter\(lambda ")
|
|
|
|
|
|
@flake8ext
|
|
def validate_log_translations(logical_line, physical_line, filename):
|
|
"""N320 - Log messages require translation."""
|
|
# Translations are not required in the test directory
|
|
if "neutron/tests" in filename:
|
|
return
|
|
if pep8.noqa(physical_line):
|
|
return
|
|
|
|
msg = "N320: Log messages require translation hints!"
|
|
if log_translation_hint.match(logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def use_jsonutils(logical_line, filename):
|
|
"""N321 - Use jsonutils instead of json."""
|
|
msg = "N321: jsonutils.%(fun)s must be used instead of json.%(fun)s"
|
|
|
|
# Some files in the tree are not meant to be run from inside Neutron
|
|
# itself, so we should not complain about them not using jsonutils
|
|
json_check_skipped_patterns = [
|
|
"neutron/plugins/ml2/drivers/openvswitch/agent/xenapi/etc/xapi.d/"
|
|
"plugins/netwrap",
|
|
]
|
|
|
|
for pattern in json_check_skipped_patterns:
|
|
if pattern in filename:
|
|
return
|
|
|
|
if "json." in logical_line:
|
|
json_funcs = ['dumps(', 'dump(', 'loads(', 'load(']
|
|
for f in json_funcs:
|
|
pos = logical_line.find('json.%s' % f)
|
|
if pos != -1:
|
|
yield (pos, msg % {'fun': f[:-1]})
|
|
|
|
|
|
@flake8ext
|
|
def no_translate_debug_logs(logical_line, filename):
|
|
"""N319 - Check for 'LOG.debug(_(' and 'LOG.debug(_Lx('
|
|
|
|
As per our translation policy,
|
|
https://wiki.openstack.org/wiki/LoggingStandards#Log_Translation
|
|
we shouldn't translate debug level logs.
|
|
|
|
* This check assumes that 'LOG' is a logger.
|
|
"""
|
|
for hint in _all_hints:
|
|
if logical_line.startswith("LOG.debug(%s(" % hint):
|
|
yield(0, "N319 Don't translate debug level logs")
|
|
|
|
|
|
@flake8ext
|
|
def check_assert_called_once_with(logical_line, filename):
|
|
"""N322 - Try to detect unintended calls of nonexistent mock methods like:
|
|
assert_called_once
|
|
assertCalledOnceWith
|
|
assert_has_called
|
|
called_once_with
|
|
"""
|
|
if 'neutron/tests/' in filename:
|
|
if '.assert_called_once_with(' in logical_line:
|
|
return
|
|
uncased_line = logical_line.lower().replace('_', '')
|
|
|
|
check_calls = ['.assertcalledonce', '.calledoncewith']
|
|
if any(x for x in check_calls if x in uncased_line):
|
|
msg = ("N322: Possible use of no-op mock method. "
|
|
"please use assert_called_once_with.")
|
|
yield (0, msg)
|
|
|
|
if '.asserthascalled' in uncased_line:
|
|
msg = ("N322: Possible use of no-op mock method. "
|
|
"please use assert_has_calls.")
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_no_contextlib_nested(logical_line, filename):
|
|
"""N324 - Don't use contextlib.nested."""
|
|
msg = ("N324: contextlib.nested is deprecated. With Python 2.7 and later "
|
|
"the with-statement supports multiple nested objects. See https://"
|
|
"docs.python.org/2/library/contextlib.html#contextlib.nested for "
|
|
"more information.")
|
|
|
|
if checks.contextlib_nested.match(logical_line):
|
|
yield(0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_python3_xrange(logical_line):
|
|
"""N325 - Do not use xrange."""
|
|
if re.search(r"\bxrange\s*\(", logical_line):
|
|
yield(0, "N325: Do not use xrange. Use range, or six.moves.range for "
|
|
"large loops.")
|
|
|
|
|
|
@flake8ext
|
|
def check_no_basestring(logical_line):
|
|
"""N326 - Don't use basestring."""
|
|
if re.search(r"\bbasestring\b", logical_line):
|
|
msg = ("N326: basestring is not Python3-compatible, use "
|
|
"six.string_types instead.")
|
|
yield(0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_python3_no_iteritems(logical_line):
|
|
"""N327 - Use six.iteritems()"""
|
|
if re.search(r".*\.iteritems\(\)", logical_line):
|
|
msg = ("N327: Use six.iteritems() instead of dict.iteritems().")
|
|
yield(0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_asserttruefalse(logical_line, filename):
|
|
"""N328 - Don't use assertEqual(True/False, observed)."""
|
|
if 'neutron/tests/' in filename:
|
|
if re.search(r"assertEqual\(\s*True,[^,]*(,[^,]*)?", logical_line):
|
|
msg = ("N328: Use assertTrue(observed) instead of "
|
|
"assertEqual(True, observed)")
|
|
yield (0, msg)
|
|
if re.search(r"assertEqual\([^,]*,\s*True(,[^,]*)?", logical_line):
|
|
msg = ("N328: Use assertTrue(observed) instead of "
|
|
"assertEqual(True, observed)")
|
|
yield (0, msg)
|
|
if re.search(r"assertEqual\(\s*False,[^,]*(,[^,]*)?", logical_line):
|
|
msg = ("N328: Use assertFalse(observed) instead of "
|
|
"assertEqual(False, observed)")
|
|
yield (0, msg)
|
|
if re.search(r"assertEqual\([^,]*,\s*False(,[^,]*)?", logical_line):
|
|
msg = ("N328: Use assertFalse(observed) instead of "
|
|
"assertEqual(False, observed)")
|
|
yield (0, msg)
|
|
|
|
|
|
check_asserttrue = flake8ext(
|
|
moves.moved_function(
|
|
check_asserttruefalse, 'check_asserttrue', __name__,
|
|
version='Newton', removal_version='Ocata'))
|
|
|
|
|
|
check_assertfalse = flake8ext(
|
|
moves.moved_function(
|
|
check_asserttruefalse, 'check_assertfalse', __name__,
|
|
version='Newton', removal_version='Ocata'))
|
|
|
|
|
|
@flake8ext
|
|
def no_mutable_default_args(logical_line):
|
|
"""N329 - Don't use mutable default arguments."""
|
|
msg = "N329: Method's default argument shouldn't be mutable!"
|
|
if checks.mutable_default_args.match(logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_assertempty(logical_line, filename):
|
|
"""N330 - Enforce using assertEqual parameter ordering in case of empty
|
|
objects.
|
|
"""
|
|
if 'neutron/tests/' in filename:
|
|
msg = ("N330: Use assertEqual(*empty*, observed) instead of "
|
|
"assertEqual(observed, *empty*). *empty* contains "
|
|
"{}, [], (), set(), '', \"\"")
|
|
empties = r"(\[\s*\]|\{\s*\}|\(\s*\)|set\(\s*\)|'\s*'|\"\s*\")"
|
|
reg = r"assertEqual\(([^,]*,\s*)+?%s\)\s*$" % empties
|
|
if re.search(reg, logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_assertisinstance(logical_line, filename):
|
|
"""N331 - Enforce using assertIsInstance."""
|
|
if 'neutron/tests/' in filename:
|
|
if re.search(r"assertTrue\(\s*isinstance\(\s*[^,]*,\s*[^,]*\)\)",
|
|
logical_line):
|
|
msg = ("N331: Use assertIsInstance(observed, type) instead "
|
|
"of assertTrue(isinstance(observed, type))")
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_assertequal_for_httpcode(logical_line, filename):
|
|
"""N332 - Enforce correct oredering for httpcode in assertEqual."""
|
|
msg = ("N332: Use assertEqual(expected_http_code, observed_http_code) "
|
|
"instead of assertEqual(observed_http_code, expected_http_code)")
|
|
if 'neutron/tests/' in filename:
|
|
if re.search(r"assertEqual\(\s*[^,]*,[^,]*HTTP[^\.]*\.code\s*\)",
|
|
logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_log_warn_deprecated(logical_line, filename):
|
|
"""N333 - Use LOG.warning."""
|
|
msg = "N333: Use LOG.warning due to compatibility with py3"
|
|
if log_warn.match(logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_oslo_i18n_wrapper(logical_line, filename, noqa):
|
|
"""N340 - Check for neutron.i18n usage.
|
|
|
|
Okay(neutron/foo/bar.py): from neutron._i18n import _
|
|
Okay(neutron_lbaas/foo/bar.py): from neutron_lbaas._i18n import _
|
|
N340(neutron/foo/bar.py): from neutron.i18n import _
|
|
N340(neutron_lbaas/foo/bar.py): from neutron_lbaas.i18n import _
|
|
N340(neutron_lbaas/foo/bar.py): from neutron.i18n import _
|
|
N340(neutron_lbaas/foo/bar.py): from neutron._i18n import _
|
|
Okay(neutron/foo/bar.py): from neutron.i18n import _ # noqa
|
|
"""
|
|
|
|
if noqa:
|
|
return
|
|
|
|
split_line = logical_line.split()
|
|
modulename = os.path.normpath(filename).split('/')[0]
|
|
bad_i18n_module = '%s.i18n' % modulename
|
|
|
|
if (len(split_line) > 1 and split_line[0] in ('import', 'from')):
|
|
if (split_line[1] == bad_i18n_module or
|
|
modulename != 'neutron' and split_line[1] in ('neutron.i18n',
|
|
'neutron._i18n')):
|
|
msg = ("N340: %(found)s is found. Use %(module)s._i18n instead."
|
|
% {'found': split_line[1], 'module': modulename})
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_builtins_gettext(logical_line, tokens, filename, lines, noqa):
|
|
"""N341 - Check usage of builtins gettext _().
|
|
|
|
Okay(neutron/foo.py): from neutron._i18n import _\n_('foo')
|
|
N341(neutron/foo.py): _('foo')
|
|
Okay(neutron/_i18n.py): _('foo')
|
|
Okay(neutron/i18n.py): _('foo')
|
|
Okay(neutron/foo.py): _('foo') # noqa
|
|
"""
|
|
|
|
if noqa:
|
|
return
|
|
|
|
modulename = os.path.normpath(filename).split('/')[0]
|
|
|
|
if '%s/tests' % modulename in filename:
|
|
return
|
|
|
|
if os.path.basename(filename) in ('i18n.py', '_i18n.py'):
|
|
return
|
|
|
|
token_values = [t[1] for t in tokens]
|
|
i18n_wrapper = '%s._i18n' % modulename
|
|
|
|
if '_' in token_values:
|
|
i18n_import_line_found = False
|
|
for line in lines:
|
|
split_line = [elm.rstrip(',') for elm in line.split()]
|
|
if (len(split_line) > 1 and split_line[0] == 'from' and
|
|
split_line[1] == i18n_wrapper and
|
|
'_' in split_line):
|
|
i18n_import_line_found = True
|
|
break
|
|
if not i18n_import_line_found:
|
|
msg = ("N341: _ from python builtins module is used. "
|
|
"Use _ from %s instead." % i18n_wrapper)
|
|
yield (0, msg)
|
|
|
|
|
|
@core.flake8ext
|
|
@core.off_by_default
|
|
def check_unittest_imports(logical_line):
|
|
"""N334 - Use unittest2 instead of unittest"""
|
|
if (re.match(unittest_imports_from, logical_line) or
|
|
re.match(unittest_imports_dot, logical_line)):
|
|
msg = "N334: '%s' must be used instead of '%s'." % (
|
|
logical_line.replace('unittest', 'unittest2'), logical_line)
|
|
yield (0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_delayed_string_interpolation(logical_line, filename, noqa):
|
|
"""N342 String interpolation should be delayed at logging calls.
|
|
|
|
N342: LOG.debug('Example: %s' % 'bad')
|
|
Okay: LOG.debug('Example: %s', 'good')
|
|
"""
|
|
msg = ("N342 String interpolation should be delayed to be "
|
|
"handled by the logging code, rather than being done "
|
|
"at the point of the logging call. "
|
|
"Use ',' instead of '%'.")
|
|
|
|
if noqa:
|
|
return
|
|
|
|
if 'neutron/tests/' in filename:
|
|
return
|
|
|
|
if log_string_interpolation.match(logical_line):
|
|
yield(0, msg)
|
|
|
|
|
|
@flake8ext
|
|
def check_python3_no_filter(logical_line):
|
|
"""N344 - Use list comprehension instead of filter(lambda)."""
|
|
|
|
msg = ("N343: Use list comprehension instead of "
|
|
"filter(lambda obj: test(obj), data) on python3.")
|
|
|
|
if filter_match.match(logical_line):
|
|
yield(0, msg)
|
|
|
|
|
|
def factory(register):
|
|
register(validate_log_translations)
|
|
register(use_jsonutils)
|
|
register(check_assert_called_once_with)
|
|
register(no_translate_debug_logs)
|
|
register(check_no_contextlib_nested)
|
|
register(check_python3_xrange)
|
|
register(check_no_basestring)
|
|
register(check_python3_no_iteritems)
|
|
register(check_asserttruefalse)
|
|
register(no_mutable_default_args)
|
|
register(check_assertempty)
|
|
register(check_assertisinstance)
|
|
register(check_assertequal_for_httpcode)
|
|
register(check_log_warn_deprecated)
|
|
register(check_oslo_i18n_wrapper)
|
|
register(check_builtins_gettext)
|
|
register(check_unittest_imports)
|
|
register(check_delayed_string_interpolation)
|
|
register(check_python3_no_filter)
|