Merge branch 'pytest-dev:master' into feat/enable-pytest-cov_toml_

stdedos · web-flow · commit ffab7be1a852 · 2022-09-29T07:55:49.000+03:00
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.0.0
+current_version = 4.0.0
 commit = True
 tag = True
 
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -51,3 +51,9 @@ Authors
 * Danilo Šegan - https://github.com/dsegan
 * Michał Bielawski - https://github.com/D3X
 * Zac Hatfield-Dodds - https://github.com/Zac-HD
+* Ben Greiner - https://github.com/bnavigator
+* Delgan - https://github.com/Delgan
+* Andre Brisco - https://github.com/abrisco
+* Colin O'Dell - https://github.com/colinodell
+* Ronny Pfannschmidt - https://github.com/RonnyPfannschmidt
+* Christian Fetzer - https://github.com/fetzerch
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,25 +2,36 @@ Changelog
 =========
 
 
-4.0.0 (future)
--------------------
+4.0.0 (2022-09-28)
+------------------
 
 **Note that this release drops support for multiprocessing.**
 
 
 * `--cov-fail-under` no longer causes `pytest --collect-only` to fail
-  Contributed by Zac Hatfield-Dodds in
-  `#511 <https://github.com/pytest-dev/pytest-cov/pull/511>`_.
+  Contributed by Zac Hatfield-Dodds in `#511 <https://github.com/pytest-dev/pytest-cov/pull/511>`_.
 * Dropped support for multiprocessing (mostly because `issue 82408 <https://github.com/python/cpython/issues/82408>`_). This feature was
-  mostly working but made out test suite very flaky and slow.
+  mostly working but very broken in certain scenarios and made the test suite very flaky and slow.
 
-  There is builtin multiprocessing support in coverage and you can switch to that if you feel lucky. All you need is this in your
+  There is builtin multiprocessing support in coverage and you can migrate to that. All you need is this in your
   ``.coveragerc``::
 
     [run]
     concurrency = multiprocessing
     parallel = true
     sigterm = true
+* Fixed deprecation in ``setup.py`` by trying to import setuptools before distutils.
+  Contributed by Ben Greiner in `#545 <https://github.com/pytest-dev/pytest-cov/pull/545>`_.
+* Removed undesirable new lines that were displayed while reporting was disabled.
+  Contributed by Delgan in `#540 <https://github.com/pytest-dev/pytest-cov/pull/540>`_.
+* Documentation fixes.
+  Contributed by Andre Brisco in `#543 <https://github.com/pytest-dev/pytest-cov/pull/543>`_
+  and Colin O'Dell in `#525 <https://github.com/pytest-dev/pytest-cov/pull/525>`_.
+* Added support for LCOV output format via `--cov-report=lcov`. Only works with coverage 6.3+.
+  Contributed by Christian Fetzer in `#536 <https://github.com/pytest-dev/pytest-cov/issues/536>`_.
+* Modernized pytest hook implementation.
+  Contributed by Bruno Oliveira in `#549 <https://github.com/pytest-dev/pytest-cov/pull/549>`_
+  and Ronny Pfannschmidt in `#550 <https://github.com/pytest-dev/pytest-cov/pull/550>`_.
 
 
 3.0.0 (2021-10-04)
diff --git a/README.rst b/README.rst
@@ -39,9 +39,9 @@ Overview
 .. |conda-forge| image:: https://img.shields.io/conda/vn/conda-forge/pytest-cov.svg
     :target: https://anaconda.org/conda-forge/pytest-cov
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/pytest-dev/pytest-cov/v3.0.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/pytest-dev/pytest-cov/v4.0.0.svg
     :alt: Commits since latest release
-    :target: https://github.com/pytest-dev/pytest-cov/compare/v3.0.0...master
+    :target: https://github.com/pytest-dev/pytest-cov/compare/v4.0.0...master
 
 .. |wheel| image:: https://img.shields.io/pypi/wheel/pytest-cov.svg
     :alt: PyPI Wheel
diff --git a/docs/conf.py b/docs/conf.py
@@ -23,7 +23,7 @@
 year = '2016'
 author = 'pytest-cov contributors'
 copyright = f'{year}, {author}'
-version = release = '3.0.0'
+version = release = '4.0.0'
 
 pygments_style = 'trac'
 templates_path = ['.']
diff --git a/docs/config.rst b/docs/config.rst
@@ -56,9 +56,9 @@ The complete list of command line options is:
 
   --cov=PATH            Measure coverage for filesystem path. (multi-allowed)
   --cov-report=type     Type of report to generate: term, term-missing,
-                        annotate, html, xml (multi-allowed). term, term-
+                        annotate, html, xml, lcov (multi-allowed). term, term-
                         missing may be followed by ":skip-covered". annotate,
-                        html and xml may be followed by ":DEST" where DEST
+                        html, xml and lcov may be followed by ":DEST" where DEST
                         specifies the output location. Use --cov-report= to
                         not generate any output.
   --cov-config=path     Config file for coverage. Default: .coveragerc
diff --git a/docs/reporting.rst b/docs/reporting.rst
@@ -3,7 +3,7 @@ Reporting
 
 It is possible to generate any combination of the reports for a single test run.
 
-The available reports are terminal (with or without missing line numbers shown), HTML, XML and
+The available reports are terminal (with or without missing line numbers shown), HTML, XML, LCOV and
 annotated source code.
 
 The terminal report without line numbers (default)::
@@ -49,19 +49,21 @@ The terminal report with skip covered::
 
 You can use ``skip-covered`` with ``term-missing`` as well. e.g. ``--cov-report term-missing:skip-covered``
 
-These three report options output to files without showing anything on the terminal::
+These four report options output to files without showing anything on the terminal::
 
     pytest --cov-report html
             --cov-report xml
+            --cov-report lcov
             --cov-report annotate
             --cov=myproj tests/
 
-The output location for each of these reports can be specified. The output location for the XML
+The output location for each of these reports can be specified. The output location for the XML and LCOV
 report is a file. Where as the output location for the HTML and annotated source code reports are
 directories::
 
     pytest --cov-report html:cov_html
             --cov-report xml:cov.xml
+            --cov-report lcov:cov.info
             --cov-report annotate:cov_annotate
             --cov=myproj tests/
 
diff --git a/setup.py b/setup.py
@@ -87,7 +87,7 @@ def run(self):
 
 setup(
     name='pytest-cov',
-    version='3.0.0',
+    version='4.0.0',
     license='MIT',
     description='Pytest plugin for measuring coverage.',
     long_description='{}\n{}'.format(read('README.rst'), re.sub(':[a-z]+:`~?(.*?)`', r'``\1``', read('CHANGELOG.rst'))),
diff --git a/src/pytest_cov/__init__.py b/src/pytest_cov/__init__.py
@@ -1,2 +1,2 @@
 """pytest-cov: avoid already-imported warning: PYTEST_DONT_REWRITE."""
-__version__ = '3.0.0'
+__version__ = '4.0.0'
diff --git a/src/pytest_cov/compat.py b/src/pytest_cov/compat.py
@@ -3,17 +3,10 @@
 except ImportError:
     from io import StringIO
 
-import pytest
 
 StringIO  # pyflakes, this is for re-export
 
 
-if hasattr(pytest, 'hookimpl'):
-    hookwrapper = pytest.hookimpl(hookwrapper=True)
-else:
-    hookwrapper = pytest.mark.hookwrapper
-
-
 class SessionWrapper:
     def __init__(self, session):
         self._session = session
diff --git a/src/pytest_cov/engine.py b/src/pytest_cov/engine.py
@@ -196,6 +196,18 @@ def summary(self, stream):
                 total = self.cov.xml_report(ignore_errors=True, outfile=output)
             stream.write('Coverage XML written to file %s\n' % (self.cov.config.xml_output if output is None else output))
 
+        # Produce lcov report if wanted.
+        if 'lcov' in self.cov_report:
+            output = self.cov_report['lcov']
+            with _backup(self.cov, "config"):
+                self.cov.lcov_report(ignore_errors=True, outfile=output)
+
+                # We need to call Coverage.report here, just to get the total
+                # Coverage.lcov_report doesn't return any total and we need it for --cov-fail-under.
+                total = self.cov.report(ignore_errors=True, file=_NullFile)
+
+            stream.write('Coverage LCOV written to file %s\n' % (self.cov.config.lcov_output if output is None else output))
+
         return total
 
 
diff --git a/src/pytest_cov/plugin.py b/src/pytest_cov/plugin.py
@@ -29,7 +29,7 @@ class CovReportWarning(PytestCovWarning):
 
 
 def validate_report(arg):
-    file_choices = ['annotate', 'html', 'xml']
+    file_choices = ['annotate', 'html', 'xml', 'lcov']
     term_choices = ['term', 'term-missing']
     term_modifier_choices = ['skip-covered']
     all_choices = term_choices + file_choices
@@ -39,6 +39,9 @@ def validate_report(arg):
         msg = f'invalid choice: "{arg}" (choose from "{all_choices}")'
         raise argparse.ArgumentTypeError(msg)
 
+    if report_type == 'lcov' and coverage.version_info <= (6, 3):
+        raise argparse.ArgumentTypeError('LCOV output is only supported with coverage.py >= 6.3')
+
     if len(values) == 1:
         return report_type, None
 
@@ -96,9 +99,9 @@ def pytest_addoption(parser):
     group.addoption('--cov-report', action=StoreReport, default={},
                     metavar='TYPE', type=validate_report,
                     help='Type of report to generate: term, term-missing, '
-                         'annotate, html, xml (multi-allowed). '
+                         'annotate, html, xml, lcov (multi-allowed). '
                          'term, term-missing may be followed by ":skip-covered". '
-                         'annotate, html and xml may be followed by ":DEST" '
+                         'annotate, html, xml and lcov may be followed by ":DEST" '
                          'where DEST specifies the output location. '
                          'Use --cov-report= to not generate any output.')
     group.addoption('--cov-config', action='store', default='.coveragerc',
@@ -133,7 +136,7 @@ def _prepare_cov_source(cov_source):
     return None if True in cov_source else [path for path in cov_source if path is not True]
 
 
-@pytest.mark.tryfirst
+@pytest.hookimpl(tryfirst=True)
 def pytest_load_initial_conftests(early_config, parser, args):
     options = early_config.known_args_namespace
     no_cov = options.no_cov_should_warn = False
@@ -253,23 +256,23 @@ def pytest_sessionstart(self, session):
         if self.options.cov_context == 'test':
             session.config.pluginmanager.register(TestContextPlugin(self.cov_controller.cov), '_cov_contexts')
 
+    @pytest.hookimpl(optionalhook=True)
     def pytest_configure_node(self, node):
         """Delegate to our implementation.
 
         Mark this hook as optional in case xdist is not installed.
         """
         if not self._disabled:
             self.cov_controller.configure_node(node)
-    pytest_configure_node.optionalhook = True
 
+    @pytest.hookimpl(optionalhook=True)
     def pytest_testnodedown(self, node, error):
         """Delegate to our implementation.
 
         Mark this hook as optional in case xdist is not installed.
         """
         if not self._disabled:
             self.cov_controller.testnodedown(node, error)
-    pytest_testnodedown.optionalhook = True
 
     def _should_report(self):
         return not (self.failed and self.options.no_cov_on_fail)
@@ -280,7 +283,7 @@ def _failed_cov_total(self):
 
     # we need to wrap pytest_runtestloop. by the time pytest_sessionfinish
     # runs, it's too late to set testsfailed
-    @compat.hookwrapper
+    @pytest.hookimpl(hookwrapper=True)
     def pytest_runtestloop(self, session):
         yield
 
@@ -356,7 +359,7 @@ def pytest_runtest_setup(self, item):
     def pytest_runtest_teardown(self, item):
         embed.cleanup()
 
-    @compat.hookwrapper
+    @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_call(self, item):
         if (item.get_closest_marker('no_cover')
                 or 'no_cover' in getattr(item, 'fixturenames', ())):
diff --git a/tests/test_pytest_cov.py b/tests/test_pytest_cov.py
@@ -150,7 +150,8 @@ def test_foo(cov):
 CHILD_SCRIPT_RESULT = '[56] * 100%'
 PARENT_SCRIPT_RESULT = '9 * 100%'
 DEST_DIR = 'cov_dest'
-REPORT_NAME = 'cov.xml'
+XML_REPORT_NAME = 'cov.xml'
+LCOV_REPORT_NAME = 'cov.info'
 
 xdist_params = pytest.mark.parametrize('opts', [
     '',
@@ -333,18 +334,50 @@ def test_xml_output_dir(testdir):
 
     result = testdir.runpytest('-v',
                                '--cov=%s' % script.dirpath(),
-                               '--cov-report=xml:' + REPORT_NAME,
+                               '--cov-report=xml:' + XML_REPORT_NAME,
                                script)
 
     result.stdout.fnmatch_lines([
         '*- coverage: platform *, python * -*',
-        'Coverage XML written to file ' + REPORT_NAME,
+        'Coverage XML written to file ' + XML_REPORT_NAME,
         '*10 passed*',
     ])
-    assert testdir.tmpdir.join(REPORT_NAME).check()
+    assert testdir.tmpdir.join(XML_REPORT_NAME).check()
     assert result.ret == 0
 
 
+@pytest.mark.skipif("coverage.version_info < (6, 3)")
+def test_lcov_output_dir(testdir):
+    script = testdir.makepyfile(SCRIPT)
+
+    result = testdir.runpytest('-v',
+                               '--cov=%s' % script.dirpath(),
+                               '--cov-report=lcov:' + LCOV_REPORT_NAME,
+                               script)
+
+    result.stdout.fnmatch_lines([
+        '*- coverage: platform *, python * -*',
+        'Coverage LCOV written to file ' + LCOV_REPORT_NAME,
+        '*10 passed*',
+    ])
+    assert testdir.tmpdir.join(LCOV_REPORT_NAME).check()
+    assert result.ret == 0
+
+
+@pytest.mark.skipif("coverage.version_info >= (6, 3)")
+def test_lcov_not_supported(testdir):
+    script = testdir.makepyfile("a = 1")
+    result = testdir.runpytest('-v',
+                               '--cov=%s' % script.dirpath(),
+                               '--cov-report=lcov',
+                               script,
+                               )
+    result.stderr.fnmatch_lines([
+        '*argument --cov-report: LCOV output is only supported with coverage.py >= 6.3',
+    ])
+    assert result.ret != 0
+
+
 def test_term_output_dir(testdir):
     script = testdir.makepyfile(SCRIPT)
 
@@ -1761,8 +1794,11 @@ def bad_init():
     monkeypatch.setattr(sys, 'stderr', buff)
     monkeypatch.setitem(os.environ, 'COV_CORE_SOURCE', 'foobar')
     exec(payload)
-    assert buff.getvalue() == '''pytest-cov: Failed to setup subprocess coverage. Environ: {'COV_CORE_SOURCE': 'foobar'} Exception: SpecificError()
-'''
+    expected = (
+        "pytest-cov: Failed to setup subprocess coverage. "
+        "Environ: {'COV_CORE_SOURCE': 'foobar'} Exception: SpecificError()\n"
+    )
+    assert buff.getvalue() == expected
 
 
 def test_double_cov(testdir):

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`"""pytest-cov: avoid already-imported warning: PYTEST_DONT_REWRITE."""`
`2`		`-__version__ = '3.0.0'`
	`2`	`+__version__ = '4.0.0'`