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
168 lines
6.9 KiB
Python
168 lines
6.9 KiB
Python
# 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 testtools
|
|
|
|
from neutron_lib.hacking import checks
|
|
from neutron_lib.hacking import translation_checks as tc
|
|
from neutron_lib.tests import _base as base
|
|
|
|
|
|
class HackingTestCase(base.BaseTestCase):
|
|
|
|
def assertLinePasses(self, func, *args):
|
|
with testtools.ExpectedException(StopIteration):
|
|
next(func(*args))
|
|
|
|
def assertLineFails(self, func, *args):
|
|
self.assertIsInstance(next(func(*args)), tuple)
|
|
|
|
def test_use_jsonutils(self):
|
|
def __get_msg(fun):
|
|
msg = ("N521: jsonutils.%(fun)s must be used instead of "
|
|
"json.%(fun)s" % {'fun': fun})
|
|
return [(0, msg)]
|
|
|
|
for method in ('dump', 'dumps', 'load', 'loads'):
|
|
self.assertEqual(
|
|
__get_msg(method),
|
|
list(checks.use_jsonutils("json.%s(" % method,
|
|
"./neutron/common/rpc.py")))
|
|
|
|
self.assertEqual(
|
|
0,
|
|
len(list(checks.use_jsonutils("jsonx.%s(" % method,
|
|
"./neutron/common/rpc.py"))))
|
|
|
|
self.assertEqual(
|
|
0,
|
|
len(list(checks.use_jsonutils("json.%sx(" % method,
|
|
"./neutron/common/rpc.py"))))
|
|
|
|
self.assertEqual(
|
|
0,
|
|
len(list(checks.use_jsonutils(
|
|
"json.%s" % method,
|
|
"./neutron/plugins/ml2/drivers/openvswitch/agent/xenapi/"
|
|
"etc/xapi.d/plugins/netwrap"))))
|
|
|
|
def test_check_oslo_namespace_imports(self):
|
|
f = checks.check_oslo_namespace_imports
|
|
self.assertLinePasses(f, 'from oslo_utils import importutils')
|
|
self.assertLinePasses(f, 'import oslo_messaging')
|
|
self.assertLineFails(f, 'from oslo.utils import importutils')
|
|
self.assertLineFails(f, 'from oslo import messaging')
|
|
self.assertLineFails(f, 'import oslo.messaging')
|
|
|
|
def test_check_python3_xrange(self):
|
|
f = checks.check_python3_xrange
|
|
self.assertLineFails(f, 'a = xrange(1000)')
|
|
self.assertLineFails(f, 'b =xrange ( 42 )')
|
|
self.assertLineFails(f, 'c = xrange(1, 10, 2)')
|
|
self.assertLinePasses(f, 'd = range(1000)')
|
|
self.assertLinePasses(f, 'e = six.moves.range(1337)')
|
|
|
|
def test_no_basestring(self):
|
|
self.assertEqual(
|
|
1,
|
|
len(list(checks.check_no_basestring("isinstance(x, basestring)"))))
|
|
|
|
def test_check_python3_iteritems(self):
|
|
f = checks.check_python3_no_iteritems
|
|
self.assertLineFails(f, "d.iteritems()")
|
|
self.assertLinePasses(f, "six.iteritems(d)")
|
|
|
|
def test_no_mutable_default_args(self):
|
|
self.assertEqual(1, len(list(checks.no_mutable_default_args(
|
|
" def fake_suds_context(calls={}):"))))
|
|
|
|
self.assertEqual(1, len(list(checks.no_mutable_default_args(
|
|
"def get_info_from_bdm(virt_type, bdm, mapping=[])"))))
|
|
|
|
self.assertEqual(0, len(list(checks.no_mutable_default_args(
|
|
"defined = []"))))
|
|
|
|
self.assertEqual(0, len(list(checks.no_mutable_default_args(
|
|
"defined, undefined = [], {}"))))
|
|
|
|
def test_check_neutron_namespace_imports(self):
|
|
f = checks.check_neutron_namespace_imports
|
|
self.assertLinePasses(f, 'from neutron_lib import constants')
|
|
self.assertLinePasses(f, 'import neutron_lib.constants')
|
|
self.assertLineFails(f, 'from neutron.common import rpc')
|
|
self.assertLineFails(f, 'from neutron import context')
|
|
self.assertLineFails(f, 'import neutron.common.config')
|
|
|
|
def test_log_translations(self):
|
|
expected_marks = {
|
|
'error': '_LE',
|
|
'info': '_LI',
|
|
'warning': '_LW',
|
|
'critical': '_LC',
|
|
'exception': '_LE',
|
|
}
|
|
logs = expected_marks.keys()
|
|
debug = "LOG.debug('OK')"
|
|
self.assertEqual(
|
|
0, len(list(tc.validate_log_translations(debug, debug, 'f'))))
|
|
for log in logs:
|
|
bad = 'LOG.%s(_("Bad"))' % log
|
|
self.assertEqual(
|
|
1, len(list(tc.validate_log_translations(bad, bad, 'f'))))
|
|
bad = 'LOG.%s("Bad")' % log
|
|
self.assertEqual(
|
|
1, len(list(tc.validate_log_translations(bad, bad, 'f'))))
|
|
ok = "LOG.%s('OK') # noqa" % log
|
|
self.assertEqual(
|
|
0, len(list(tc.validate_log_translations(ok, ok, 'f'))))
|
|
ok = "LOG.%s(variable)" % log
|
|
self.assertEqual(
|
|
0, len(list(tc.validate_log_translations(ok, ok, 'f'))))
|
|
# Do not do validations in tests
|
|
ok = 'LOG.%s("OK - unit tests")' % log
|
|
self.assertEqual(
|
|
0, len(list(tc.validate_log_translations(ok, ok,
|
|
'f/tests/f'))))
|
|
|
|
for mark in tc._all_hints:
|
|
stmt = "LOG.%s(%s('test'))" % (log, mark)
|
|
self.assertEqual(
|
|
0 if expected_marks[log] == mark else 1,
|
|
len(list(tc.validate_log_translations(stmt, stmt, 'f'))))
|
|
|
|
def test_no_translate_debug_logs(self):
|
|
for hint in tc._all_hints:
|
|
bad = "LOG.debug(%s('bad'))" % hint
|
|
self.assertEqual(
|
|
1, len(list(tc.no_translate_debug_logs(bad, 'f'))))
|
|
|
|
def test_check_log_warn_deprecated(self):
|
|
bad = "LOG.warn(_LW('i am deprecated!'))"
|
|
self.assertEqual(
|
|
1, len(list(tc.check_log_warn_deprecated(bad, 'f'))))
|
|
|
|
def test_check_localized_exception_messages(self):
|
|
f = tc.check_raised_localized_exceptions
|
|
self.assertLineFails(f, " raise KeyError('Error text')", '')
|
|
self.assertLineFails(f, ' raise KeyError("Error text")', '')
|
|
self.assertLinePasses(f, ' raise KeyError(_("Error text"))', '')
|
|
self.assertLinePasses(f, ' raise KeyError(_ERR("Error text"))', '')
|
|
self.assertLinePasses(f, " raise KeyError(translated_msg)", '')
|
|
self.assertLinePasses(f, '# raise KeyError("Not translated")', '')
|
|
self.assertLinePasses(f, 'print("raise KeyError("Not '
|
|
'translated")")', '')
|
|
|
|
def test_check_localized_exception_message_skip_tests(self):
|
|
f = tc.check_raised_localized_exceptions
|
|
self.assertLinePasses(f, "raise KeyError('Error text')",
|
|
'neutron_lib/tests/unit/mytest.py')
|