Adds support for JUnit XML uploads

Author: Daverball

.github/workflows/python-tox.yaml

@@ -39,4 +39,4 @@ jobs:
           pip install tox tox-gh-actions
 
       - name: Test with tox and upload coverage results
-        run: tox -- --codecov --codecov-token=${{ secrets.CODECOV_TOKEN }}
+        run: tox -- --codecov --codecov-token=${{ secrets.CODECOV_TOKEN }} --junit-xml=junit.xml -o junit_family=legacy

src/pytest_codecov/__init__.py

@@ -85,16 +85,24 @@ def pytest_addoption(parser, pluginmanager):
         default=True,
         help='Don\'t upload coverage results on test failure'
     )
+    group.addoption(
+        '--codecov-exclude-junit-xml',
+        action='store_false',
+        dest='codecov_junit_xml',
+        default=True,
+        help='Don\'t upload the junit xml file'
+    )
 
 
 class CodecovPlugin:
 
     def upload_report(self, terminalreporter, config, cov):
+        option = config.option
         uploader = codecov.CodecovUploader(
-            config.option.codecov_slug,
-            commit=config.option.codecov_commit,
-            branch=config.option.codecov_branch,
-            token=config.option.codecov_token,
+            option.codecov_slug,
+            commit=option.codecov_commit,
+            branch=option.codecov_branch,
+            token=option.codecov_token,
         )
         uploader.write_network_files(git.ls_files())
         from coverage.misc import CoverageException
@@ -110,14 +118,21 @@ def upload_report(self, terminalreporter, config, cov):
             terminalreporter.line('')
             return
 
-        if config.option.codecov_dump:
+        xmlpath = option.xmlpath if option.codecov_junit_xml else None
+        if xmlpath and os.path.isfile(xmlpath):
+            uploader.add_junit_xml(xmlpath)
+            has_junit_xml = True
+        else:
+            has_junit_xml = False
+
+        if option.codecov_dump:
             terminalreporter.section('Prepared Codecov.io payload')
             terminalreporter.write_line(uploader.get_payload())
             return
 
         terminalreporter.section('Codecov.io upload')
 
-        if not config.option.codecov_slug:
+        if not option.codecov_slug:
             terminalreporter.write_line(
                 'ERROR: Failed to determine git repository slug. '
                 'Cannot upload without a valid slug.',
@@ -126,24 +141,35 @@ def upload_report(self, terminalreporter, config, cov):
             )
             terminalreporter.line('')
             return
-        if not config.option.codecov_branch:
+        if not option.codecov_branch:
             terminalreporter.write_line(
                 'WARNING: Failed to determine git repository branch.',
                 yellow=True,
                 bold=True,
             )
-        if not config.option.codecov_commit:
+        if not option.codecov_commit:
             terminalreporter.write_line(
                 'WARNING: Failed to determine git commit.',
                 yellow=True,
                 bold=True,
             )
+        if has_junit_xml and config.getini('junit_family') != 'legacy':
+            terminalreporter.write_line(
+                'INFO: We recommend using junit_family=legacy with CodeCov.',
+                blue=True,
+                bold=True,
+            )
+
         terminalreporter.write_line(
             'Environment:\n'
-            f'Slug:   {config.option.codecov_slug}\n'
-            f'Branch: {config.option.codecov_branch}\n'
-            f'Commit: {config.option.codecov_commit}\n'
+            f'Slug:   {option.codecov_slug}\n'
+            f'Branch: {option.codecov_branch}\n'
+            f'Commit: {option.codecov_commit}\n'
         )
+        if has_junit_xml:
+            terminalreporter.write_line(
+                'JUnit XML file detected and included in upload.\n'
+            )
         try:
             terminalreporter.write_line('Pinging codecov API...')
             uploader.ping()
@@ -178,6 +204,10 @@ def pytest_terminal_summary(self, terminalreporter, exitstatus, config):
 
 
 def pytest_configure(config):  # pragma: no cover
+    # NOTE: Don't report codecov results on worker nodes
+    if hasattr(config, 'workerinput'):
+        return
+
     # NOTE: if cov is missing we fail silently
     if config.option.codecov and config.pluginmanager.has_plugin('_cov'):
         config.pluginmanager.register(CodecovPlugin())

src/pytest_codecov/codecov.py

@@ -40,6 +40,12 @@ def add_coverage_report(self, cov, filename='coverage.xml', **kwargs):
             self._buffer.write(xml_report.read())
             self._buffer.write('\n<<<<<< EOF')
 
+    def add_junit_xml(self, path):
+        with open(path, 'r') as junit_xml:
+            self._buffer.write('\n# path=./junit.xml\n')
+            self._buffer.write(junit_xml.read())
+            self._buffer.write('\n<<<<<< EOF')
+
     def get_payload(self):
         return self._buffer.getvalue()
 

tests/conftest.py

@@ -113,16 +113,19 @@ class DummyUploader:
     # TODO: Implement some basic behavior, so we can test
     #       more exhaustively.
 
-    def __init__(self, slug, **kwargs):
-        self.fail_report_generation = False
+    def __init__(self, factory, slug, **kwargs):
+        self.factory = factory
 
     def write_network_files(self, files):
         pass
 
     def add_coverage_report(self, cov, **kwargs):
-        if self.fail_report_generation:
+        if self.factory.fail_report_generation:
             raise CoverageException('test exception')
 
+    def add_junit_xml(self, path):
+        self.factory.junit_xml = path
+
     def get_payload(self):
         return 'stub'
 
@@ -135,12 +138,15 @@ def upload(self):
 
 class DummyUploaderFactory:
 
-    fail_report_generation = False
+    def __init__(self):
+        self.fail_report_generation = False
+        self.junit_xml = None
 
     def __call__(self, slug, **kwargs):
-        inst = DummyUploader(slug, **kwargs)
-        inst.fail_report_generation = self.fail_report_generation
-        return inst
+        return DummyUploader(self, slug, **kwargs)
+
+    def clear(self):
+        self.junit_xml = None
 
 
 @pytest.fixture

tests/test_plugin.py

@@ -113,6 +113,98 @@ def test_upload_report(pytester, dummy_reporter, dummy_uploader,
     ) in dummy_reporter.text
 
 
+def test_upload_report_junit(pytester, dummy_reporter, dummy_uploader,
+                             dummy_cov, no_gitpython, tmp_path):
+
+    # create a junit xml
+    junit_xml = tmp_path / 'junit.xml'
+    junit_xml.write_text('foo')
+    config = pytester.parseconfig(
+        f'--junit-xml={junit_xml}',
+        '-o',
+        'junit_family=legacy',
+        '--codecov',
+        '--codecov-token=12345678-1234-1234-1234-1234567890ab',
+        '--codecov-slug=foo/bar',
+        '--codecov-branch=master',
+        '--codecov-commit=deadbeef'
+    )
+    plugin = CodecovPlugin()
+    plugin.upload_report(dummy_reporter, config, dummy_cov)
+    assert (
+        'Environment:\n'
+        'Slug:   foo/bar\n'
+        'Branch: master\n'
+        'Commit: deadbeef\n'
+        '\n'
+        'JUnit XML file detected and included in upload.\n'
+    ) in dummy_reporter.text
+    assert (
+        'INFO: We recommend using junit_family=legacy with CodeCov.'
+    ) not in dummy_reporter.text
+    assert dummy_uploader.junit_xml == str(junit_xml)
+
+
+def test_upload_report_junit_info(pytester, dummy_reporter, dummy_uploader,
+                                  dummy_cov, no_gitpython, tmp_path):
+
+    # create a junit xml
+    junit_xml = tmp_path / 'junit.xml'
+    junit_xml.write_text('foo')
+    config = pytester.parseconfig(
+        f'--junit-xml={junit_xml}',
+        '--codecov',
+        '--codecov-token=12345678-1234-1234-1234-1234567890ab',
+        '--codecov-slug=foo/bar',
+        '--codecov-branch=master',
+        '--codecov-commit=deadbeef'
+    )
+    plugin = CodecovPlugin()
+    plugin.upload_report(dummy_reporter, config, dummy_cov)
+    assert (
+        'INFO: We recommend using junit_family=legacy with CodeCov.\n'
+        'Environment:\n'
+        'Slug:   foo/bar\n'
+        'Branch: master\n'
+        'Commit: deadbeef\n'
+        '\n'
+        'JUnit XML file detected and included in upload.\n'
+    ) in dummy_reporter.text
+    assert dummy_uploader.junit_xml == str(junit_xml)
+
+
+def test_no_upload_report_junit(pytester, dummy_reporter, dummy_uploader,
+                                dummy_cov, no_gitpython, tmp_path):
+
+    # create a junit xml
+    junit_xml = tmp_path / 'junit.xml'
+    junit_xml.write_text('foo')
+    config = pytester.parseconfig(
+        f'--junit-xml={junit_xml}',
+        '--codecov',
+        '--codecov-token=12345678-1234-1234-1234-1234567890ab',
+        '--codecov-slug=foo/bar',
+        '--codecov-branch=master',
+        '--codecov-commit=deadbeef',
+        '--codecov-exclude-junit-xml'
+    )
+    plugin = CodecovPlugin()
+    plugin.upload_report(dummy_reporter, config, dummy_cov)
+    assert (
+        'Environment:\n'
+        'Slug:   foo/bar\n'
+        'Branch: master\n'
+        'Commit: deadbeef\n'
+    ) in dummy_reporter.text
+    assert (
+        'JUnit XML file detected and included in upload.'
+    ) not in dummy_reporter.text
+    assert (
+        'INFO: We recommend using junit_family=legacy with CodeCov.'
+    ) not in dummy_reporter.text
+    assert dummy_uploader.junit_xml is None
+
+
 def test_upload_report_generation_failure(
     pytester, dummy_reporter, dummy_uploader,
     dummy_cov, no_gitpython