aboutsummaryrefslogtreecommitdiffstats
path: root/keystone-moon/keystone/tests/hacking/checks.py
diff options
context:
space:
mode:
authorRHE <rebirthmonkey@gmail.com>2017-11-24 13:54:26 +0100
committerRHE <rebirthmonkey@gmail.com>2017-11-24 13:54:26 +0100
commit920a49cfa055733d575282973e23558c33087a4a (patch)
treed371dab34efa5028600dad2e7ca58063626e7ba4 /keystone-moon/keystone/tests/hacking/checks.py
parentef3eefca70d8abb4a00dafb9419ad32738e934b2 (diff)
remove keystone-moon
Change-Id: I80d7c9b669f19d5f6607e162de8e0e55c2f80fdd Signed-off-by: RHE <rebirthmonkey@gmail.com>
Diffstat (limited to 'keystone-moon/keystone/tests/hacking/checks.py')
-rw-r--r--keystone-moon/keystone/tests/hacking/checks.py445
1 files changed, 0 insertions, 445 deletions
diff --git a/keystone-moon/keystone/tests/hacking/checks.py b/keystone-moon/keystone/tests/hacking/checks.py
deleted file mode 100644
index 581dbcf9..00000000
--- a/keystone-moon/keystone/tests/hacking/checks.py
+++ /dev/null
@@ -1,445 +0,0 @@
-# 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.
-
-"""Keystone's pep8 extensions.
-
-In order to make the review process faster and easier for core devs we are
-adding some Keystone specific pep8 checks. This will catch common errors
-so that core devs don't have to.
-
-There are two types of pep8 extensions. One is a function that takes either
-a physical or logical line. The physical or logical line is the first param
-in the function definition and can be followed by other parameters supported
-by pep8. The second type is a class that parses AST trees. For more info
-please see pep8.py.
-"""
-
-import ast
-import re
-
-import six
-
-
-class BaseASTChecker(ast.NodeVisitor):
- """Provides a simple framework for writing AST-based checks.
-
- Subclasses should implement visit_* methods like any other AST visitor
- implementation. When they detect an error for a particular node the
- method should call ``self.add_error(offending_node)``. Details about
- where in the code the error occurred will be pulled from the node
- object.
-
- Subclasses should also provide a class variable named CHECK_DESC to
- be used for the human readable error message.
-
- """
-
- def __init__(self, tree, filename):
- """This object is created automatically by pep8.
-
- :param tree: an AST tree
- :param filename: name of the file being analyzed
- (ignored by our checks)
- """
- self._tree = tree
- self._errors = []
-
- def run(self):
- """Called automatically by pep8."""
- self.visit(self._tree)
- return self._errors
-
- def add_error(self, node, message=None):
- """Add an error caused by a node to the list of errors for pep8."""
- message = message or self.CHECK_DESC
- error = (node.lineno, node.col_offset, message, self.__class__)
- self._errors.append(error)
-
-
-class CheckForMutableDefaultArgs(BaseASTChecker):
- """Checks for the use of mutable objects as function/method defaults.
-
- We are only checking for list and dict literals at this time. This means
- that a developer could specify an instance of their own and cause a bug.
- The fix for this is probably more work than it's worth because it will
- get caught during code review.
-
- """
-
- CHECK_DESC = 'K001 Using mutable as a function/method default'
- MUTABLES = (
- ast.List, ast.ListComp,
- ast.Dict, ast.DictComp,
- ast.Set, ast.SetComp,
- ast.Call)
-
- def visit_FunctionDef(self, node):
- for arg in node.args.defaults:
- if isinstance(arg, self.MUTABLES):
- self.add_error(arg)
-
- super(CheckForMutableDefaultArgs, self).generic_visit(node)
-
-
-def block_comments_begin_with_a_space(physical_line, line_number):
- """There should be a space after the # of block comments.
-
- There is already a check in pep8 that enforces this rule for
- inline comments.
-
- Okay: # this is a comment
- Okay: #!/usr/bin/python
- Okay: # this is a comment
- K002: #this is a comment
-
- """
- MESSAGE = "K002 block comments should start with '# '"
-
- # shebangs are OK
- if line_number == 1 and physical_line.startswith('#!'):
- return
-
- text = physical_line.strip()
- if text.startswith('#'): # look for block comments
- if len(text) > 1 and not text[1].isspace():
- return physical_line.index('#'), MESSAGE
-
-
-class CheckForAssertingNoneEquality(BaseASTChecker):
- """Ensures that code does not use a None with assert(Not*)Equal."""
-
- CHECK_DESC_IS = ('K003 Use self.assertIsNone(...) when comparing '
- 'against None')
- CHECK_DESC_ISNOT = ('K004 Use assertIsNotNone(...) when comparing '
- ' against None')
-
- def visit_Call(self, node):
- # NOTE(dstanek): I wrote this in a verbose way to make it easier to
- # read for those that have little experience with Python's AST.
-
- def _is_None(node):
- if six.PY3:
- return (isinstance(node, ast.NameConstant)
- and node.value is None)
- else:
- return isinstance(node, ast.Name) and node.id == 'None'
-
- if isinstance(node.func, ast.Attribute):
- if node.func.attr == 'assertEqual':
- for arg in node.args:
- if _is_None(arg):
- self.add_error(node, message=self.CHECK_DESC_IS)
- elif node.func.attr == 'assertNotEqual':
- for arg in node.args:
- if _is_None(arg):
- self.add_error(node, message=self.CHECK_DESC_ISNOT)
-
- super(CheckForAssertingNoneEquality, self).generic_visit(node)
-
-
-class CheckForLoggingIssues(BaseASTChecker):
-
- DEBUG_CHECK_DESC = 'K005 Using translated string in debug logging'
- NONDEBUG_CHECK_DESC = 'K006 Not using translating helper for logging'
- EXCESS_HELPER_CHECK_DESC = 'K007 Using hints when _ is necessary'
- USING_DEPRECATED_WARN = 'K009 Using the deprecated Logger.warn'
- LOG_MODULES = ('logging', 'oslo_log.log')
- I18N_MODULES = (
- 'keystone.i18n._',
- 'keystone.i18n._LI',
- 'keystone.i18n._LW',
- 'keystone.i18n._LE',
- 'keystone.i18n._LC',
- )
- TRANS_HELPER_MAP = {
- 'debug': None,
- 'info': '_LI',
- 'warning': '_LW',
- 'error': '_LE',
- 'exception': '_LE',
- 'critical': '_LC',
- }
-
- def __init__(self, tree, filename):
- super(CheckForLoggingIssues, self).__init__(tree, filename)
-
- self.logger_names = []
- self.logger_module_names = []
- self.i18n_names = {}
-
- # NOTE(dstanek): this kinda accounts for scopes when talking
- # about only leaf node in the graph
- self.assignments = {}
-
- def generic_visit(self, node):
- """Called if no explicit visitor function exists for a node."""
- for field, value in ast.iter_fields(node):
- if isinstance(value, list):
- for item in value:
- if isinstance(item, ast.AST):
- item._parent = node
- self.visit(item)
- elif isinstance(value, ast.AST):
- value._parent = node
- self.visit(value)
-
- def _filter_imports(self, module_name, alias):
- """Keeps lists of logging and i18n imports."""
- if module_name in self.LOG_MODULES:
- self.logger_module_names.append(alias.asname or alias.name)
- elif module_name in self.I18N_MODULES:
- self.i18n_names[alias.asname or alias.name] = alias.name
-
- def visit_Import(self, node):
- for alias in node.names:
- self._filter_imports(alias.name, alias)
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- def visit_ImportFrom(self, node):
- for alias in node.names:
- full_name = '%s.%s' % (node.module, alias.name)
- self._filter_imports(full_name, alias)
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- def _find_name(self, node):
- """Return the fully qualified name or a Name or Attribute."""
- if isinstance(node, ast.Name):
- return node.id
- elif (isinstance(node, ast.Attribute)
- and isinstance(node.value, (ast.Name, ast.Attribute))):
- method_name = node.attr
- obj_name = self._find_name(node.value)
- if obj_name is None:
- return None
- return obj_name + '.' + method_name
- elif isinstance(node, six.string_types):
- return node
- else: # could be Subscript, Call or many more
- return None
-
- def visit_Assign(self, node):
- """Look for 'LOG = logging.getLogger'
-
- This handles the simple case:
- name = [logging_module].getLogger(...)
-
- - or -
-
- name = [i18n_name](...)
-
- And some much more comple ones:
- name = [i18n_name](...) % X
-
- - or -
-
- self.name = [i18n_name](...) % X
-
- """
- attr_node_types = (ast.Name, ast.Attribute)
-
- if (len(node.targets) != 1
- or not isinstance(node.targets[0], attr_node_types)):
- # say no to: "x, y = ..."
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- target_name = self._find_name(node.targets[0])
-
- if (isinstance(node.value, ast.BinOp) and
- isinstance(node.value.op, ast.Mod)):
- if (isinstance(node.value.left, ast.Call) and
- isinstance(node.value.left.func, ast.Name) and
- node.value.left.func.id in self.i18n_names):
- # NOTE(dstanek): this is done to match cases like:
- # `msg = _('something %s') % x`
- node = ast.Assign(value=node.value.left)
-
- if not isinstance(node.value, ast.Call):
- # node.value must be a call to getLogger
- self.assignments.pop(target_name, None)
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- # is this a call to an i18n function?
- if (isinstance(node.value.func, ast.Name)
- and node.value.func.id in self.i18n_names):
- self.assignments[target_name] = node.value.func.id
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- if (not isinstance(node.value.func, ast.Attribute)
- or not isinstance(node.value.func.value, attr_node_types)):
- # function must be an attribute on an object like
- # logging.getLogger
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- object_name = self._find_name(node.value.func.value)
- func_name = node.value.func.attr
-
- if (object_name in self.logger_module_names
- and func_name == 'getLogger'):
- self.logger_names.append(target_name)
-
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- def visit_Call(self, node):
- """Look for the 'LOG.*' calls."""
- # obj.method
- if isinstance(node.func, ast.Attribute):
- obj_name = self._find_name(node.func.value)
- if isinstance(node.func.value, ast.Name):
- method_name = node.func.attr
- elif isinstance(node.func.value, ast.Attribute):
- obj_name = self._find_name(node.func.value)
- method_name = node.func.attr
- else: # could be Subscript, Call or many more
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- # if dealing with a logger the method can't be "warn"
- if obj_name in self.logger_names and method_name == 'warn':
- msg = node.args[0] # first arg to a logging method is the msg
- self.add_error(msg, message=self.USING_DEPRECATED_WARN)
-
- # must be a logger instance and one of the support logging methods
- if (obj_name not in self.logger_names
- or method_name not in self.TRANS_HELPER_MAP):
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- # the call must have arguments
- if not node.args:
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- if method_name == 'debug':
- self._process_debug(node)
- elif method_name in self.TRANS_HELPER_MAP:
- self._process_non_debug(node, method_name)
-
- return super(CheckForLoggingIssues, self).generic_visit(node)
-
- def _process_debug(self, node):
- msg = node.args[0] # first arg to a logging method is the msg
-
- # if first arg is a call to a i18n name
- if (isinstance(msg, ast.Call)
- and isinstance(msg.func, ast.Name)
- and msg.func.id in self.i18n_names):
- self.add_error(msg, message=self.DEBUG_CHECK_DESC)
-
- # if the first arg is a reference to a i18n call
- elif (isinstance(msg, ast.Name)
- and msg.id in self.assignments
- and not self._is_raised_later(node, msg.id)):
- self.add_error(msg, message=self.DEBUG_CHECK_DESC)
-
- def _process_non_debug(self, node, method_name):
- msg = node.args[0] # first arg to a logging method is the msg
-
- # if first arg is a call to a i18n name
- if isinstance(msg, ast.Call):
- try:
- func_name = msg.func.id
- except AttributeError:
- # in the case of logging only an exception, the msg function
- # will not have an id associated with it, for instance:
- # LOG.warning(six.text_type(e))
- return
-
- # the function name is the correct translation helper
- # for the logging method
- if func_name == self.TRANS_HELPER_MAP[method_name]:
- return
-
- # the function name is an alias for the correct translation
- # helper for the loggine method
- if (self.i18n_names[func_name] ==
- self.TRANS_HELPER_MAP[method_name]):
- return
-
- self.add_error(msg, message=self.NONDEBUG_CHECK_DESC)
-
- # if the first arg is not a reference to the correct i18n hint
- elif isinstance(msg, ast.Name):
-
- # FIXME(dstanek): to make sure more robust we should be checking
- # all names passed into a logging method. we can't right now
- # because:
- # 1. We have code like this that we'll fix when dealing with the %:
- # msg = _('....') % {}
- # LOG.warning(msg)
- # 2. We also do LOG.exception(e) in several places. I'm not sure
- # exactly what we should be doing about that.
- if msg.id not in self.assignments:
- return
-
- helper_method_name = self.TRANS_HELPER_MAP[method_name]
- if (self.assignments[msg.id] != helper_method_name
- and not self._is_raised_later(node, msg.id)):
- self.add_error(msg, message=self.NONDEBUG_CHECK_DESC)
- elif (self.assignments[msg.id] == helper_method_name
- and self._is_raised_later(node, msg.id)):
- self.add_error(msg, message=self.EXCESS_HELPER_CHECK_DESC)
-
- def _is_raised_later(self, node, name):
-
- def find_peers(node):
- node_for_line = node._parent
- for _field, value in ast.iter_fields(node._parent._parent):
- if isinstance(value, list) and node_for_line in value:
- return value[value.index(node_for_line) + 1:]
- continue
- return []
-
- peers = find_peers(node)
- for peer in peers:
- if isinstance(peer, ast.Raise):
- if six.PY3:
- exc = peer.exc
- else:
- exc = peer.type
- if (isinstance(exc, ast.Call) and
- len(exc.args) > 0 and
- isinstance(exc.args[0], ast.Name) and
- name in (a.id for a in exc.args)):
- return True
- else:
- return False
- elif isinstance(peer, ast.Assign):
- if name in (t.id for t in peer.targets if hasattr(t, 'id')):
- return False
-
-
-def dict_constructor_with_sequence_copy(logical_line):
- """Should use a dict comprehension instead of a dict constructor.
-
- PEP-0274 introduced dict comprehension with performance enhancement
- and it also makes code more readable.
-
- Okay: lower_res = {k.lower(): v for k, v in six.iteritems(res[1])}
- Okay: fool = dict(a='a', b='b')
- K008: lower_res = dict((k.lower(), v) for k, v in six.iteritems(res[1]))
- K008: attrs = dict([(k, _from_json(v))
- K008: dict([[i,i] for i in range(3)])
-
- """
- MESSAGE = ("K008 Must use a dict comprehension instead of a dict"
- " constructor with a sequence of key-value pairs.")
-
- dict_constructor_with_sequence_re = (
- re.compile(r".*\bdict\((\[)?(\(|\[)(?!\{)"))
-
- if dict_constructor_with_sequence_re.match(logical_line):
- yield (0, MESSAGE)
-
-
-def factory(register):
- register(CheckForMutableDefaultArgs)
- register(block_comments_begin_with_a_space)
- register(CheckForAssertingNoneEquality)
- register(CheckForLoggingIssues)
- register(dict_constructor_with_sequence_copy)