Merge pull request #1174 from PyCQA/testsuite-pytest

port --testsuite to pytest

Author: asottile

CONTRIBUTING.rst

@@ -70,32 +70,28 @@ GitHub has an excellent `guide`_.
 
 The current tests are written in 2 styles:
 
-* standard xUnit based only on stdlib unittest
-* functional test using a custom framework and executed by the
-  pycodestyle itself when installed in dev mode.
+* pytest tests
+* functional test using a custom framework
 
 
-Running unittest
-~~~~~~~~~~~~~~~~
+Running tests
+~~~~~~~~~~~~~
 
-The tests are written using stdlib ``unittest`` module, the existing tests
+The tests are written using ``pytest``, the existing tests
 include unit, integration and functional tests.
 
 To run the tests::
 
-    $ python setup.py test
+    $ pytest testsuite
 
 Running functional
 ~~~~~~~~~~~~~~~~~~
 
-When installed in dev mode, pycodestyle will have the ``--testsuite`` option
-which can be used to run the tests::
-
     $ pip install -e .
     $ # Run all tests.
-    $ pycodestyle --testsuite testsuite
+    $ pytest testsuite
     $ # Run a subset of the tests.
-    $ pycodestyle --testsuite testsuite/E30.py
+    $ pytest testsuite -k testing/data/E30.py
 
 
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/

docs/developer.rst

@@ -97,8 +97,7 @@ the docstring, you can use ``\n`` for newline and ``\t`` for tab.
 
 Then be sure to pass the tests::
 
-  $ python pycodestyle.py --testsuite testsuite
-  $ pytest testsuite/test_self_doctest.py
+  $ pytest testsuite
   $ python pycodestyle.py --verbose pycodestyle.py
 
 When contributing to pycodestyle, please observe our `Code of Conduct`_.

pycodestyle.py

@@ -84,7 +84,6 @@
     USER_CONFIG = None
 
 PROJECT_CONFIG = ('setup.cfg', 'tox.ini')
-TESTSUITE_PATH = os.path.join(os.path.dirname(__file__), 'testsuite')
 MAX_LINE_LENGTH = 79
 # Number of blank lines between various code parts.
 BLANK_LINES_CONFIG = {
@@ -2301,8 +2300,7 @@ def __init__(self, *args, **kwargs):
             options.reporter = BaseReport if options.quiet else StandardReport
 
         options.select = tuple(options.select or ())
-        if not (options.select or options.ignore or
-                options.testsuite) and DEFAULT_IGNORE:
+        if not (options.select or options.ignore) and DEFAULT_IGNORE:
             # The default choice: ignore controversial checks
             options.ignore = tuple(DEFAULT_IGNORE.split(','))
         else:
@@ -2472,9 +2470,6 @@ def get_parser(prog='pycodestyle', version=__version__):
                       help="report changes only within line number ranges in "
                            "the unified diff received on STDIN")
     group = parser.add_option_group("Testing Options")
-    if os.path.exists(TESTSUITE_PATH):
-        group.add_option('--testsuite', metavar='dir',
-                         help="run regression tests from dir")
     group.add_option('--benchmark', action='store_true',
                      help="measure processing speed")
     return parser
@@ -2551,7 +2546,6 @@ def read_config(options, args, arglist, parser):
 
         # Third, overwrite with the command-line options
         (options, __) = parser.parse_args(arglist, values=new_options)
-    options.testsuite = False
     return options
 
 
@@ -2584,17 +2578,14 @@ def process_options(arglist=None, parse_argv=False, config_file=None,
     if verbose is not None:
         options.verbose = verbose
 
-    if options.ensure_value('testsuite', False):
-        args.append(options.testsuite)
-    else:
-        if parse_argv and not args:
-            if options.diff or any(os.path.exists(name)
-                                   for name in PROJECT_CONFIG):
-                args = ['.']
-            else:
-                parser.error('input not specified')
-        options = read_config(options, args, arglist, parser)
-        options.reporter = parse_argv and options.quiet == 1 and FileReport
+    if parse_argv and not args:
+        if options.diff or any(os.path.exists(name)
+                               for name in PROJECT_CONFIG):
+            args = ['.']
+        else:
+            parser.error('input not specified')
+    options = read_config(options, args, arglist, parser)
+    options.reporter = parse_argv and options.quiet == 1 and FileReport
 
     options.filename = _parse_multi_options(options.filename)
     options.exclude = normalize_paths(options.exclude)
@@ -2639,21 +2630,14 @@ def _main():
     style_guide = StyleGuide(parse_argv=True)
     options = style_guide.options
 
-    if options.testsuite:
-        from testsuite.support import run_tests
-        report = run_tests(style_guide)
-    else:
-        report = style_guide.check_files()
+    report = style_guide.check_files()
 
     if options.statistics:
         report.print_statistics()
 
     if options.benchmark:
         report.print_benchmark()
 
-    if options.testsuite and not options.quiet:
-        report.print_results()
-
     if report.total_errors:
         if options.count:
             sys.stderr.write(str(report.total_errors) + '\n')

setup.cfg

@@ -48,7 +48,6 @@ max_doc_length = 72
 [coverage:run]
 plugins = covdefaults
 omit = testsuite/data
-parallel = true
 
 [coverage:report]
 fail_under = 93

testing/data/W29.py

@@ -14,8 +14,6 @@ class Foo(object):
 #: W191 W292 noeol
 if False:
 	pass  # indented with tabs
-#: W292:1:36 noeol
-# This line doesn't have a linefeed
 #: W292:1:5 E225:1:2 noeol
 1+ 1
 #: W292:1:27 E261:1:12 noeol

testing/data/python39.py

@@ -0,0 +1,2 @@
+#: W292:1:70 noeol
+# This line doesn't have a linefeed (in 3.8 this is reported thrice!)

testing/support.py

@@ -1,8 +1,12 @@
 from __future__ import annotations
 
+import os.path
+
 from pycodestyle import BaseReport
 from pycodestyle import StyleGuide
 
+ROOT = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+
 
 class InMemoryReport(BaseReport):
     """
@@ -23,7 +27,7 @@ def error(self, line_number, offset, text, check):
 
 
 def errors_from_src(src: str) -> list[str]:
-    guide = StyleGuide(select=('E', 'W'))
+    guide = StyleGuide(select=('E', 'W'), max_doc_length=72)
     reporter = guide.init_report(InMemoryReport)
     guide.input_file(
         filename='in-memory-test-file.py',

testsuite/support.py

@@ -1,29 +1,12 @@
 import os.path
-import unittest
 
 import pycodestyle
-from testsuite.support import init_tests
-from testsuite.support import ROOT_DIR
+from testing.support import ROOT
 
 
-class PycodestyleTestCase(unittest.TestCase):
-    """Test the standard errors and warnings (E and W)."""
-
-    def setUp(self):
-        self._style = pycodestyle.StyleGuide(
-            paths=[os.path.join(ROOT_DIR, 'testsuite')],
-            select='E,W', quiet=True)
-
-    def test_checkers_testsuite(self):
-        init_tests(self._style)
-        report = self._style.check_files()
-        self.assertFalse(report.total_errors,
-                         msg='%s failure(s)' % report.total_errors)
-
-    def test_own_dog_food(self):
-        files = [pycodestyle.__file__.rstrip('oc'), __file__.rstrip('oc'),
-                 os.path.join(ROOT_DIR, 'setup.py')]
-        report = self._style.init_report(pycodestyle.StandardReport)
-        report = self._style.check_files(files)
-        self.assertEqual(list(report.messages.keys()), ['W504'],
-                         msg='Failures: %s' % report.messages)
+def test_own_dog_food():
+    style = pycodestyle.StyleGuide(select='E,W', quiet=True)
+    files = [pycodestyle.__file__, __file__, os.path.join(ROOT, 'setup.py')]
+    report = style.init_report(pycodestyle.StandardReport)
+    report = style.check_files(files)
+    assert list(report.messages) == ['W504'], f'Failures: {report.messages}'