ba717a08ec
As per [1], this patch adds a new hacking check that verifies raised exceptions don't use unlocalized string messages. This patch also adds unit tests for the new check and enables checks for neutron-lib itself (as per tox.ini). Note: Perhaps this check better belongs in openstack-dev/hacking but it seems we already have a number of more generic checks in neutron. We can discuss that here need be. NB: Without [1] this new hacking check fails when running pep8 on neutron-lib. [1] https://review.openstack.org/#/c/324374/ Change-Id: Ia13f190ec6843ab360d115871d345c4ddc302cc5
93 lines
2.9 KiB
Python
93 lines
2.9 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
|
|
|
|
import pep8
|
|
|
|
_all_log_levels = {
|
|
'critical': '_LC',
|
|
'error': '_LE',
|
|
'exception': '_LE',
|
|
'info': '_LI',
|
|
'reserved': '_', # this should never be used with a log unless
|
|
# it is a variable used for a log message and
|
|
# a exception
|
|
'warning': '_LW',
|
|
}
|
|
_all_hints = set(_all_log_levels.values())
|
|
_log_warn = re.compile(
|
|
r"(.)*LOG\.(warn)\(\s*('|\"|_)")
|
|
|
|
|
|
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_translation_hint = re.compile(
|
|
'|'.join('(?:%s)' % _regex_for_level(level, hint)
|
|
for level, hint in _all_log_levels.items()))
|
|
|
|
|
|
def validate_log_translations(logical_line, physical_line, filename):
|
|
# Do not do these validations on tests
|
|
if "/tests/" in filename:
|
|
return
|
|
|
|
if pep8.noqa(physical_line):
|
|
return
|
|
|
|
msg = "N531: Log messages require translation hints!"
|
|
if _log_translation_hint.match(logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
def check_log_warn_deprecated(logical_line, filename):
|
|
msg = "N532: Use LOG.warning due to compatibility with py3"
|
|
if _log_warn.match(logical_line):
|
|
yield (0, msg)
|
|
|
|
|
|
def no_translate_debug_logs(logical_line, filename):
|
|
"""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.
|
|
N533
|
|
"""
|
|
for hint in _all_hints:
|
|
if logical_line.startswith("LOG.debug(%s(" % hint):
|
|
yield(0, "N533 Don't translate debug level logs")
|
|
|
|
|
|
def check_raised_localized_exceptions(logical_line, filename):
|
|
# NOTE(boden): tox.ini doesn't permit per check exclusion
|
|
if "/tests/" in filename:
|
|
return
|
|
|
|
logical_line = logical_line.strip()
|
|
raised_search = re.compile(
|
|
r"raise (?:\w*)\((.*)\)").match(logical_line)
|
|
if raised_search:
|
|
exception_msg = raised_search.groups()[0]
|
|
if exception_msg.startswith("\"") or exception_msg.startswith("\'"):
|
|
msg = "N534: Untranslated exception message."
|
|
yield (logical_line.index(exception_msg), msg)
|