From 876d421897a523f25b1680aab28d0703a70d84f0 Mon Sep 17 00:00:00 2001 From: liuqing Date: Tue, 1 Jul 2014 17:59:57 +0800 Subject: [PATCH] Add hacking test There is no test for cinder/hacking/check.py, the patch add test for it. Also update the location in check.py to reference the right path to add test cases. Change-Id: I094e712339e53380ce4ed58b60beda1c4f53d5c1 --- cinder/hacking/checks.py | 2 +- cinder/tests/test_hacking.py | 60 ++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 cinder/tests/test_hacking.py diff --git a/cinder/hacking/checks.py b/cinder/hacking/checks.py index 9a113a28d..324b1d4ad 100644 --- a/cinder/hacking/checks.py +++ b/cinder/hacking/checks.py @@ -24,7 +24,7 @@ Guidelines for writing new hacking checks on the N3xx value. - List the new rule in the top level HACKING.rst file - Add test cases for each new rule to - cinder/tests/unit/test_hacking.py + cinder/tests/test_hacking.py """ diff --git a/cinder/tests/test_hacking.py b/cinder/tests/test_hacking.py new file mode 100644 index 000000000..e7656b79f --- /dev/null +++ b/cinder/tests/test_hacking.py @@ -0,0 +1,60 @@ +# Copyright 2014 Red Hat, Inc. +# +# 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 cinder.hacking import checks +from cinder import test + + +class HackingTestCase(test.TestCase): + """This class tests the hacking checks in cinder.hacking.checks + + This class ensures that Cinder's hacking checks are working 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. + """ + + def test_no_translate_debug_logs(self): + self.assertEqual(len(list(checks.no_translate_debug_logs( + "LOG.debug(_('foo'))", "cinder/scheduler/foo.py"))), 1) + + self.assertEqual(len(list(checks.no_translate_debug_logs( + "LOG.debug('foo')", "cinder/scheduler/foo.py"))), 0) + + self.assertEqual(len(list(checks.no_translate_debug_logs( + "LOG.info(_('foo'))", "cinder/scheduler/foo.py"))), 0) -- 2.45.2