20534c78c6
Rules:
N311 - Validate that debug level logs are not translated
N320 - Ensure that ``assertTrue(isinstance(A, B))`` is not used
N321 - Ensure that ``assertEqual(type(A), B)`` is not used
N322 - Ensure that ``assertEqual(A, None)`` and ``assertEqual(None, A)``
are not used
N323 - Ensure that ``assertTrue/assertFalse(A in/not in B)`` are not
used with collection contents
Also, small bug related to logging in verification was fixed.
Change-Id: Ieabe1b23d0c02cc13bb6cad106ab855507359ddc
166 lines
6.8 KiB
Python
166 lines
6.8 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.
|
|
|
|
from tests.hacking import checks
|
|
from tests.unit import test
|
|
|
|
|
|
class HackingTestCase(test.TestCase):
|
|
|
|
def test__parse_assert_mock_str(self):
|
|
pos, method, obj = checks._parse_assert_mock_str(
|
|
"mock_clients.fake().quotas.delete.assert_called_once()")
|
|
self.assertEqual("assert_called_once", method)
|
|
self.assertEqual("mock_clients.fake().quotas.delete", obj)
|
|
|
|
def test__parse_assert_mock_str_no_assert(self):
|
|
pos, method, obj = checks._parse_assert_mock_str(
|
|
"mock_clients.fake().quotas.delete.")
|
|
self.assertIsNone(pos)
|
|
self.assertIsNone(method)
|
|
self.assertIsNone(obj)
|
|
|
|
def test_correct_usage_of_assert_from_mock(self):
|
|
correct_method_names = ["assert_any_call", "assert_called_once_with",
|
|
"assert_called_with", "assert_has_calls"]
|
|
for name in correct_method_names:
|
|
self.assertEqual(0, len(
|
|
list(checks.check_assert_methods_from_mock(
|
|
'some_mock.%s(asd)' % name, './tests/fake/test'))))
|
|
|
|
def test_wrong_usage_of_broad_assert_from_mock(self):
|
|
fake_method = 'rtfm.assert_something()'
|
|
|
|
actual_number, actual_msg = next(checks.check_assert_methods_from_mock(
|
|
fake_method, './tests/fake/test'))
|
|
self.assertEqual(4, actual_number)
|
|
self.assertTrue(actual_msg.startswith('N301'))
|
|
|
|
def test_wrong_usage_of_assert_called_from_mock(self):
|
|
fake_method = 'rtfm.assert_called()'
|
|
|
|
actual_number, actual_msg = next(checks.check_assert_methods_from_mock(
|
|
fake_method, './tests/fake/test'))
|
|
self.assertEqual(4, actual_number)
|
|
self.assertTrue(actual_msg.startswith('N302'))
|
|
|
|
def test_wrong_usage_of_assert_called_once_from_mock(self):
|
|
fake_method = 'rtfm.assert_called_once()'
|
|
|
|
actual_number, actual_msg = next(checks.check_assert_methods_from_mock(
|
|
fake_method, './tests/fake/test'))
|
|
self.assertEqual(4, actual_number)
|
|
self.assertTrue(actual_msg.startswith('N303'))
|
|
|
|
def test_check_wrong_logging_import(self):
|
|
fake_imports = ["from rally.openstack.common import log",
|
|
"import rally.openstack.common.log"
|
|
"import logging"]
|
|
good_imports = ["from rally import log",
|
|
"from rally.log",
|
|
"import rally.log"]
|
|
|
|
for fake_import in fake_imports:
|
|
checkres = checks.check_import_of_logging(fake_import, "fakefile")
|
|
self.assertIsNotNone(next(checkres))
|
|
|
|
for fake_import in fake_imports:
|
|
checkres = checks.check_import_of_logging(fake_import,
|
|
"./rally/log.py")
|
|
self.assertEqual([], list(checkres))
|
|
|
|
for fake_import in good_imports:
|
|
checkres = checks.check_import_of_logging(fake_import,
|
|
"fakefile")
|
|
self.assertEqual([], list(checkres))
|
|
|
|
def test_no_translate_debug_logs(self):
|
|
self.assertEqual(len(list(checks.no_translate_debug_logs(
|
|
"LOG.debug(_('foo'))"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.no_translate_debug_logs(
|
|
"LOG.debug('foo')"))), 0)
|
|
|
|
self.assertEqual(len(list(checks.no_translate_debug_logs(
|
|
"LOG.info(_('foo'))"))), 0)
|
|
|
|
def test_assert_true_instance(self):
|
|
self.assertEqual(len(list(checks.assert_true_instance(
|
|
"self.assertTrue(isinstance(e, "
|
|
"exception.BuildAbortException))"))), 1)
|
|
|
|
self.assertEqual(
|
|
len(list(checks.assert_true_instance("self.assertTrue()"))), 0)
|
|
|
|
def test_assert_equal_type(self):
|
|
self.assertEqual(len(list(checks.assert_equal_type(
|
|
"self.assertEqual(type(als['QuicAssist']), list)"))), 1)
|
|
|
|
self.assertEqual(
|
|
len(list(checks.assert_equal_type("self.assertTrue()"))), 0)
|
|
|
|
def test_assert_equal_none(self):
|
|
self.assertEqual(len(list(checks.assert_equal_none(
|
|
"self.assertEqual(A, None)"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_equal_none(
|
|
"self.assertEqual(None, A)"))), 1)
|
|
|
|
self.assertEqual(
|
|
len(list(checks.assert_equal_none("self.assertIsNone()"))), 0)
|
|
|
|
def test_assert_true_or_false_with_in_or_not_in(self):
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(A in B)"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertFalse(A in B)"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(A not in B)"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertFalse(A not in B)"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(A in B, 'some message')"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertFalse(A in B, 'some message')"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(A not in B, 'some message')"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertFalse(A not in B, 'some message')"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(A in 'some string with spaces')"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(A in 'some string with spaces')"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(A in ['1', '2', '3'])"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(A in [1, 2, 3])"))), 1)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(any(A > 5 for A in B))"))), 0)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertTrue(any(A > 5 for A in B), 'some message')"))), 0)
|
|
|
|
self.assertEqual(len(list(checks.assert_true_or_false_with_in(
|
|
"self.assertFalse(some in list1 and some2 in list2)"))), 0)
|