157 lines
5.1 KiB
Python
157 lines
5.1 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 re
|
|
|
|
"""
|
|
Guidelines for writing new hacking checks
|
|
|
|
- Use only for Glare-specific tests. OpenStack general tests
|
|
should be submitted to the common 'hacking' module.
|
|
- Pick numbers in the range G3xx. Find the current test with
|
|
the highest allocated number and then pick the next value.
|
|
If nova has an N3xx code for that test, use the same number.
|
|
- Keep the test method code in the source file ordered based
|
|
on the G3xx value.
|
|
- List the new rule in the top level HACKING.rst file
|
|
- Add test cases for each new rule to glare/tests/test_hacking.py
|
|
|
|
"""
|
|
|
|
|
|
asse_trueinst_re = re.compile(
|
|
r"(.)*assertTrue\(isinstance\((\w|\.|\'|\"|\[|\])+, "
|
|
"(\w|\.|\'|\"|\[|\])+\)\)")
|
|
asse_equal_type_re = re.compile(
|
|
r"(.)*assertEqual\(type\((\w|\.|\'|\"|\[|\])+\), "
|
|
"(\w|\.|\'|\"|\[|\])+\)")
|
|
asse_equal_end_with_none_re = re.compile(
|
|
r"(.)*assertEqual\((\w|\.|\'|\"|\[|\])+, None\)")
|
|
asse_equal_start_with_none_re = re.compile(
|
|
r"(.)*assertEqual\(None, (\w|\.|\'|\"|\[|\])+\)")
|
|
unicode_func_re = re.compile(r"(\s|\W|^)unicode\(")
|
|
|
|
_all_log_levels = {'debug', 'error', 'info', 'warning',
|
|
'critical', 'exception'}
|
|
# Since _Lx have been removed, we just need to check _()
|
|
translated_logs = re.compile(
|
|
r"(.)*LOG\.(%(level)s)\(\s*_\(" % {'level': '|'.join(_all_log_levels)})
|
|
|
|
dict_constructor_with_list_copy_re = re.compile(r".*\bdict\((\[)?(\(|\[)")
|
|
|
|
|
|
def assert_true_instance(logical_line):
|
|
"""Check for assertTrue(isinstance(a, b)) sentences
|
|
|
|
G316
|
|
"""
|
|
if asse_trueinst_re.match(logical_line):
|
|
yield (0, "G316: assertTrue(isinstance(a, b)) sentences not allowed")
|
|
|
|
|
|
def assert_equal_type(logical_line):
|
|
"""Check for assertEqual(type(A), B) sentences
|
|
|
|
G317
|
|
"""
|
|
if asse_equal_type_re.match(logical_line):
|
|
yield (0, "G317: assertEqual(type(A), B) sentences not allowed")
|
|
|
|
|
|
def assert_equal_none(logical_line):
|
|
"""Check for assertEqual(A, None) or assertEqual(None, A) sentences
|
|
|
|
G318
|
|
"""
|
|
res = (asse_equal_start_with_none_re.match(logical_line) or
|
|
asse_equal_end_with_none_re.match(logical_line))
|
|
if res:
|
|
yield (0, "G318: assertEqual(A, None) or assertEqual(None, A) "
|
|
"sentences not allowed")
|
|
|
|
|
|
def no_translate_logs(logical_line):
|
|
"""Check for use of LOG.*(_(
|
|
|
|
G319
|
|
"""
|
|
if translated_logs.match(logical_line):
|
|
yield (0, "G319: Don't translate logs")
|
|
|
|
|
|
def no_direct_use_of_unicode_function(logical_line):
|
|
"""Check for use of unicode() builtin
|
|
|
|
G320
|
|
"""
|
|
if unicode_func_re.match(logical_line):
|
|
yield(0, "G320: Use six.text_type() instead of unicode()")
|
|
|
|
|
|
def check_no_contextlib_nested(logical_line):
|
|
msg = ("G327: contextlib.nested is deprecated since Python 2.7. See "
|
|
"https://docs.python.org/2/library/contextlib.html#contextlib."
|
|
"nested for more information.")
|
|
if ("with contextlib.nested(" in logical_line or
|
|
"with nested(" in logical_line):
|
|
yield(0, msg)
|
|
|
|
|
|
def dict_constructor_with_list_copy(logical_line):
|
|
msg = ("G328: Must use a dict comprehension instead of a dict constructor "
|
|
"with a sequence of key-value pairs.")
|
|
if dict_constructor_with_list_copy_re.match(logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
def check_python3_xrange(logical_line):
|
|
if re.search(r"\bxrange\s*\(", logical_line):
|
|
yield(0, "G329: Do not use xrange. Use range, or six.moves.range for "
|
|
"large loops.")
|
|
|
|
|
|
def check_python3_no_iteritems(logical_line):
|
|
msg = ("G330: Use six.iteritems() or dict.items() instead of "
|
|
"dict.iteritems().")
|
|
if re.search(r".*\.iteritems\(\)", logical_line):
|
|
yield(0, msg)
|
|
|
|
|
|
def check_python3_no_iterkeys(logical_line):
|
|
msg = ("G331: Use six.iterkeys() or dict.keys() instead of "
|
|
"dict.iterkeys().")
|
|
if re.search(r".*\.iterkeys\(\)", logical_line):
|
|
yield(0, msg)
|
|
|
|
|
|
def check_python3_no_itervalues(logical_line):
|
|
msg = ("G332: Use six.itervalues() or dict.values instead of "
|
|
"dict.itervalues().")
|
|
if re.search(r".*\.itervalues\(\)", logical_line):
|
|
yield(0, msg)
|
|
|
|
|
|
def factory(register):
|
|
register(assert_true_instance)
|
|
register(assert_equal_type)
|
|
register(assert_equal_none)
|
|
register(no_translate_logs)
|
|
register(no_direct_use_of_unicode_function)
|
|
register(check_no_contextlib_nested)
|
|
register(dict_constructor_with_list_copy)
|
|
register(check_python3_xrange)
|
|
register(check_python3_no_iteritems)
|
|
register(check_python3_no_iterkeys)
|
|
register(check_python3_no_itervalues)
|