Add more tests for the CLI; issue #162

Author: florentx

CHANGES.txt

@@ -20,7 +20,8 @@ Changelog
 * Do not report false E302 when the source file has a coding cookie or a
   comment on the first line. (Issue #174)
 
-* Reorganize the tests and add basic tests for the API. (Issue #161)
+* Reorganize the tests and add tests for the API and for the command line
+  usage and options. (Issues #161 and #162)
 
 
 1.4.4 (2013-02-24)

pep8.py

@@ -1845,7 +1845,7 @@ def _main():
     options = pep8style.options
     if options.doctest or options.testsuite:
         from testsuite.support import run_tests
-        report = run_tests(pep8style, options.doctest, options.testsuite)
+        report = run_tests(pep8style)
     else:
         report = pep8style.check_files()
     if options.statistics:

testsuite/support.py

@@ -1,10 +1,12 @@
 # -*- coding: utf-8 -*-
+import os.path
 import re
 import sys
 
 from pep8 import Checker, BaseReport, StandardReport, readlines
 
 SELFTEST_REGEX = re.compile(r'\b(Okay|[EW]\d{3}):\s(.*)')
+ROOT_DIR = os.path.dirname(os.path.dirname(__file__))
 
 
 class TestReport(StandardReport):
@@ -141,9 +143,9 @@ def run_tests(filename):
 init_tests.__test__ = False
 
 
-def run_tests(style, doctest=True, testsuite=False):
+def run_tests(style):
     options = style.options
-    if doctest:
+    if options.doctest:
         import doctest
         fail_d, done_d = doctest.testmod(report=False, verbose=options.verbose)
         fail_s, done_s = selftest(options)
@@ -154,7 +156,7 @@ def run_tests(style, doctest=True, testsuite=False):
             print("Test failed." if count_failed else "Test passed.")
         if count_failed:
             sys.exit(1)
-    if testsuite:
+    if options.testsuite:
         init_tests(style)
     return style.check_files()
 run_tests.__test__ = False

testsuite/test_all.py

@@ -5,9 +5,7 @@
 import unittest
 
 import pep8
-from testsuite.support import init_tests, selftest
-
-ROOT_DIR = os.path.dirname(os.path.dirname(__file__))
+from testsuite.support import init_tests, selftest, ROOT_DIR
 
 # Note: please only use a subset of unittest methods which were present
 # in Python 2.5: assert(True|False|Equal|NotEqual|Raises)
@@ -18,7 +16,7 @@ class Pep8TestCase(unittest.TestCase):
 
     def setUp(self):
         self._style = pep8.StyleGuide(
-            paths=[os.path.dirname(__file__)],
+            paths=[os.path.join(ROOT_DIR, 'testsuite')],
             ignore=None, quiet=True)
 
     def test_doctest(self):
@@ -47,81 +45,14 @@ def test_own_dog_food(self):
                          msg='Failures: %s' % report.messages)
 
 
-class APITestCase(unittest.TestCase):
-    """Test the public methods."""
-
-    def setUp(self):
-        self._saved_checks = pep8._checks
-        pep8._checks = dict((k, dict((f, (vals[0][:], vals[1]))
-                                     for (f, vals) in v.items()))
-                            for (k, v) in self._saved_checks.items())
-
-    def tearDown(self):
-        pep8._checks = self._saved_checks
-
-    def test_register_physical_check(self):
-        def check_dummy(physical_line, line_number):
-            if False:
-                yield
-        pep8.register_check(check_dummy, ['Z001'])
-
-        self.assertTrue(check_dummy in pep8._checks['physical_line'])
-        codes, args = pep8._checks['physical_line'][check_dummy]
-        self.assertTrue('Z001' in codes)
-        self.assertEqual(args, ['physical_line', 'line_number'])
-
-    def test_register_logical_check(self):
-        def check_dummy(logical_line, tokens):
-            if False:
-                yield
-        pep8.register_check(check_dummy, ['Z401'])
-
-        self.assertTrue(check_dummy in pep8._checks['logical_line'])
-        codes, args = pep8._checks['logical_line'][check_dummy]
-        self.assertTrue('Z401' in codes)
-        self.assertEqual(args, ['logical_line', 'tokens'])
-
-    def test_register_ast_check(self):
-        class DummyChecker(object):
-            def __init__(self, tree, filename):
-                pass
-
-            def run(self):
-                if False:
-                    yield
-        pep8.register_check(DummyChecker, ['Z701'])
-
-        self.assertTrue(DummyChecker in pep8._checks['tree'])
-        codes, args = pep8._checks['tree'][DummyChecker]
-        self.assertTrue('Z701' in codes)
-        self.assertTrue(args is None)
-
-    def test_register_invalid_check(self):
-        class DummyChecker(object):
-            def __init__(self, filename):
-                pass
-
-            def run(self):
-                if False:
-                    yield
-        pep8.register_check(DummyChecker, ['Z741'])
-
-        def check_dummy(logical, tokens):
-            if False:
-                yield
-        pep8.register_check(check_dummy, ['Z441'])
-
-        for checkers in pep8._checks.values():
-            self.assertTrue(DummyChecker not in checkers)
-            self.assertTrue(check_dummy not in checkers)
-
-        self.assertRaises(TypeError, pep8.register_check)
-
-
 def _main():
+    from testsuite.test_api import APITestCase
+    from testsuite.test_shell import ShellTestCase
+
     suite = unittest.TestSuite()
     suite.addTest(unittest.makeSuite(Pep8TestCase))
     suite.addTest(unittest.makeSuite(APITestCase))
+    suite.addTest(unittest.makeSuite(ShellTestCase))
     runner = unittest.TextTestRunner(verbosity=2)
     return runner.run(suite)
 

testsuite/test_api.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+import unittest
+
+import pep8
+
+
+class APITestCase(unittest.TestCase):
+    """Test the public methods."""
+
+    def setUp(self):
+        self._saved_checks = pep8._checks
+        pep8._checks = dict((k, dict((f, (vals[0][:], vals[1]))
+                                     for (f, vals) in v.items()))
+                            for (k, v) in self._saved_checks.items())
+
+    def tearDown(self):
+        pep8._checks = self._saved_checks
+
+    def test_register_physical_check(self):
+        def check_dummy(physical_line, line_number):
+            if False:
+                yield
+        pep8.register_check(check_dummy, ['Z001'])
+
+        self.assertTrue(check_dummy in pep8._checks['physical_line'])
+        codes, args = pep8._checks['physical_line'][check_dummy]
+        self.assertTrue('Z001' in codes)
+        self.assertEqual(args, ['physical_line', 'line_number'])
+
+    def test_register_logical_check(self):
+        def check_dummy(logical_line, tokens):
+            if False:
+                yield
+        pep8.register_check(check_dummy, ['Z401'])
+
+        self.assertTrue(check_dummy in pep8._checks['logical_line'])
+        codes, args = pep8._checks['logical_line'][check_dummy]
+        self.assertTrue('Z401' in codes)
+        self.assertEqual(args, ['logical_line', 'tokens'])
+
+        pep8.register_check(check_dummy, [])
+        pep8.register_check(check_dummy, ['Z402', 'Z403'])
+        codes, args = pep8._checks['logical_line'][check_dummy]
+        self.assertEqual(codes, ['Z401', 'Z402', 'Z403'])
+        self.assertEqual(args, ['logical_line', 'tokens'])
+
+    def test_register_ast_check(self):
+        class DummyChecker(object):
+            def __init__(self, tree, filename):
+                pass
+
+            def run(self):
+                if False:
+                    yield
+        pep8.register_check(DummyChecker, ['Z701'])
+
+        self.assertTrue(DummyChecker in pep8._checks['tree'])
+        codes, args = pep8._checks['tree'][DummyChecker]
+        self.assertTrue('Z701' in codes)
+        self.assertTrue(args is None)
+
+    def test_register_invalid_check(self):
+        class DummyChecker(object):
+            def __init__(self, filename):
+                pass
+
+            def run(self):
+                if False:
+                    yield
+        pep8.register_check(DummyChecker, ['Z741'])
+
+        def check_dummy(logical, tokens):
+            if False:
+                yield
+        pep8.register_check(check_dummy, ['Z441'])
+
+        for checkers in pep8._checks.values():
+            self.assertTrue(DummyChecker not in checkers)
+            self.assertTrue(check_dummy not in checkers)
+
+        self.assertRaises(TypeError, pep8.register_check)