remove local hacking check for oslo namespace and log debug
oslo namespace problem has already been solved perfectly, and log debug has no effect due to i18n team will not translate those message, so remove these two local checks. since no local check is left, also remove related code and doc Change-Id: I311abac48376d76b98acf9bbff39454a48c2eddb
This commit is contained in:
ZhiQiang Fan
parent
8cf7da9040
commit
aed9a3d882
|
|
@ -7,5 +7,3 @@ Aodh Style Commandments
|
|||
|
||||
Aodh Specific Commandments
|
||||
--------------------------
|
||||
|
||||
- [C300] Check for oslo library imports use the non-namespaced packages
|
||||
|
|
|
|||
|
|
@ -1,69 +0,0 @@
|
|||
# Copyright 2015 Huawei Technologies Co., Ltd.
|
||||
#
|
||||
# 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.
|
||||
|
||||
"""
|
||||
Guidelines for writing new hacking checks
|
||||
|
||||
- Use only for aodh specific tests. OpenStack general tests
|
||||
should be submitted to the common 'hacking' module.
|
||||
- Pick numbers in the range C3xx. 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 C3xx value.
|
||||
- List the new rule in the top level HACKING.rst file
|
||||
- Add test cases for each new rule to aodh/tests/test_hacking.py
|
||||
|
||||
"""
|
||||
|
||||
import re
|
||||
|
||||
|
||||
# TODO(zqfan): When other oslo libraries switch over non-namespace'd
|
||||
# imports, we need to add them to the regexp below.
|
||||
oslo_namespace_imports = re.compile(
|
||||
r"(from|import) oslo[.](config|utils|i18n|serialization)")
|
||||
|
||||
|
||||
def check_oslo_namespace_imports(logical_line, physical_line, filename):
|
||||
# ignore openstack.common since they are not maintained by us
|
||||
if 'aodh/openstack/common/' in filename:
|
||||
return
|
||||
|
||||
if re.match(oslo_namespace_imports, logical_line):
|
||||
msg = ("C300: '%s' must be used instead of '%s'." % (
|
||||
logical_line.replace('oslo.', 'oslo_'),
|
||||
logical_line))
|
||||
yield(0, msg)
|
||||
|
||||
|
||||
def no_translate_debug_logs(logical_line, filename):
|
||||
"""Check for 'LOG.debug(_('
|
||||
|
||||
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.
|
||||
* Use filename so we can start enforcing this in specific folders instead
|
||||
of needing to do so all at once.
|
||||
|
||||
N319
|
||||
"""
|
||||
if logical_line.startswith("LOG.debug(_("):
|
||||
yield(0, "N319 Don't translate debug level logs")
|
||||
|
||||
|
||||
def factory(register):
|
||||
register(check_oslo_namespace_imports)
|
||||
register(no_translate_debug_logs)
|
||||
|
|
@ -1,89 +0,0 @@
|
|||
# Copyright 2015 Huawei Technologies Co., Ltd.
|
||||
#
|
||||
# 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 textwrap
|
||||
|
||||
import mock
|
||||
import pep8
|
||||
from testtools import testcase
|
||||
|
||||
from aodh.hacking import checks
|
||||
|
||||
|
||||
class HackingTestCase(testcase.TestCase):
|
||||
"""Test cases for aodh specific hacking rules.
|
||||
|
||||
This class tests the hacking checks in aodh.hacking.checks by
|
||||
passing strings to the check methods like the pep8/flake8 parser would.
|
||||
The parser loops over each line in the file and then passes the parameters
|
||||
to the check method. The parameter names in the check method dictate what
|
||||
type of object is passed to the check method. The parameter types are::
|
||||
|
||||
logical_line: A processed line with the following modifications:
|
||||
- Multi-line statements converted to a single line.
|
||||
- Stripped left and right.
|
||||
- Contents of strings replaced with "xxx" of same length.
|
||||
- Comments removed.
|
||||
physical_line: Raw line of text from the input file.
|
||||
lines: a list of the raw lines from the input file
|
||||
tokens: the tokens that contribute to this logical line
|
||||
line_number: line number in the input file
|
||||
total_lines: number of lines in the input file
|
||||
blank_lines: blank lines before this one
|
||||
indent_char: indentation character in this file (" " or "\t")
|
||||
indent_level: indentation (with tabs expanded to multiples of 8)
|
||||
previous_indent_level: indentation on previous line
|
||||
previous_logical: previous logical line
|
||||
filename: Path of the file being run through pep8
|
||||
|
||||
When running a test on a check method the return will be False/None if
|
||||
there is no violation in the sample input. If there is an error a tuple is
|
||||
returned with a position in the line, and a message. So to check the result
|
||||
just assertTrue if the check is expected to fail and assertFalse if it
|
||||
should pass.
|
||||
"""
|
||||
|
||||
# We are patching pep8 so that only the check under test is actually
|
||||
# installed.
|
||||
@mock.patch('pep8._checks',
|
||||
{'physical_line': {}, 'logical_line': {}, 'tree': {}})
|
||||
def _run_check(self, code, checker, filename=None):
|
||||
pep8.register_check(checker)
|
||||
|
||||
lines = textwrap.dedent(code).strip().splitlines(True)
|
||||
|
||||
checker = pep8.Checker(filename=filename, lines=lines)
|
||||
checker.check_all()
|
||||
checker.report._deferred_print.sort()
|
||||
return checker.report._deferred_print
|
||||
|
||||
def _assert_has_errors(self, code, checker, expected_errors=None,
|
||||
filename=None):
|
||||
actual_errors = [e[:3] for e in
|
||||
self._run_check(code, checker, filename)]
|
||||
self.assertEqual(expected_errors or [], actual_errors)
|
||||
|
||||
def test_oslo_namespace_imports_check(self):
|
||||
codes = [
|
||||
"from oslo.config import cfg",
|
||||
"import oslo.i18n",
|
||||
"from oslo.utils import timeutils",
|
||||
"from oslo.serialization import jsonutils",
|
||||
]
|
||||
for code in codes:
|
||||
self._assert_has_errors(code, checks.check_oslo_namespace_imports,
|
||||
expected_errors=[(1, 0, "C300")])
|
||||
self._assert_has_errors(
|
||||
code, checks.check_oslo_namespace_imports,
|
||||
filename="aodh/openstack/common/xyz.py")
|
||||
Loading…
Reference in New Issue