Fixes JUnit XML upload

Author: Daverball

pyproject.toml

@@ -83,11 +83,14 @@ legacy_tox_ini = """
     [testenv]
     setenv =
         py{38,39,310,311,312,313}: COVERAGE_FILE = .coverage.{envname}
-    commands = pytest --cov --cov-report= {posargs:tests}
+    commands =
+        pytest --cov --cov-report= {posargs:tests}
+        pytest -n2 --cov --cov-report= {posargs:tests}
     deps =
         pytest
         coverage
         pytest-cov
+        pytest-xdist
         .
         GitPython
 

src/pytest_codecov/__init__.py

@@ -104,7 +104,7 @@ def upload_report(self, terminalreporter, config, cov):
             branch=option.codecov_branch,
             token=option.codecov_token,
         )
-        uploader.write_network_files(git.ls_files())
+        uploader.add_network_files(git.ls_files())
         from coverage.misc import CoverageException
         try:
             uploader.add_coverage_report(cov)
@@ -155,7 +155,7 @@ def upload_report(self, terminalreporter, config, cov):
             )
         if has_junit_xml and config.getini('junit_family') != 'legacy':
             terminalreporter.write_line(
-                'INFO: We recommend using junit_family=legacy with CodeCov.',
+                'INFO: We recommend using junit_family=legacy with Codecov.',
                 blue=True,
                 bold=True,
             )

src/pytest_codecov/codecov.py

@@ -1,7 +1,10 @@
 import gzip
 import io
+import json
 import requests
 import tempfile
+import zlib
+from base64 import b64encode
 from urllib.parse import urljoin
 
 
@@ -23,31 +26,38 @@ def __init__(self, slug, commit=None, branch=None, token=None):
         self.commit = commit
         self.branch = branch
         self.token = token
-        self.store_url = None
-        self._buffer = io.StringIO()
+        self._coverage_store_url = None
+        self._coverage_buffer = io.StringIO()
+        self._test_result_store_url = None
+        self._test_result_files = []
 
-    def write_network_files(self, files):
-        self._buffer.write(
+    def add_network_files(self, files):
+        self._coverage_buffer.write(
             '\n'.join(files + ['<<<<<< network'])
         )
 
     def add_coverage_report(self, cov, filename='coverage.xml', **kwargs):
         with tempfile.NamedTemporaryFile(mode='r') as xml_report:
             # embed xml report
-            self._buffer.write(f'\n# path=./{filename}\n')
+            self._coverage_buffer.write(f'\n# path=./{filename}\n')
             cov.xml_report(outfile=xml_report.name)
             xml_report.seek(0)
-            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')
+            self._coverage_buffer.write(xml_report.read())
+            self._coverage_buffer.write('\n<<<<<< EOF')
+
+    def add_junit_xml(self, path, filename='junit.xml'):
+        with open(path, 'rb') as junit_xml:
+            self._test_result_files.append({
+                'filename': filename,
+                'format': 'base64+compressed',
+                'data': b64encode(
+                    zlib.compress(junit_xml.read())
+                ).decode('ascii'),
+                'labels': '',
+            })
 
     def get_payload(self):
-        return self._buffer.getvalue()
+        return self._coverage_buffer.getvalue()
 
     def ping(self):
         if not self.slug:
@@ -83,10 +93,30 @@ def ping(self):
             raise CodecovError(
                 f'Invalid response from codecov API:\n{response.text}'
             )
-        self.store_url = lines[1]
+        self._coverage_store_url = lines[1]
+
+        if not self._test_result_files:
+            return
+
+        headers = {} if self.token is None else {
+            'Authorization': f'token {self.token}',
+            'User-Agent': package()
+        }
+        data = {
+            'slug': self.slug,
+            'branch': self.branch or '',
+            'commit': self.commit or '',
+        }
+        api_url = urljoin(self.api_endpoint, '/upload/test_results/v1')
+        response = requests.post(api_url, headers=headers, json=data)
+        if response.ok:
+            # TODO: Fail more loudly?
+            url = response.json()['raw_upload_location']
+            if url.startswith(self.storage_endpoint):
+                self._test_result_store_url = url
 
     def upload(self):
-        if not self.store_url:
+        if not self._coverage_store_url:
             raise CodecovError('Need to ping API before upload.')
 
         headers = {
@@ -98,10 +128,20 @@ def upload(self):
             payload.write(self.get_payload().encode('utf-8'))
         gz_payload.seek(0)
         response = requests.put(
-            self.store_url, headers=headers, data=gz_payload
+            self._coverage_store_url, headers=headers, data=gz_payload
         )
 
         if not response.ok:
             raise CodecovError('Failed to upload report to storage endpoint.')
 
-        self.store_url = None  # NOTE: Invalidate store url after upload
+        self._coverage_store_url = None
+
+        if not self._test_result_store_url or not self._test_result_files:
+            return
+
+        json_payload = json.dumps({
+            'test_result_files': self._test_result_files
+        }).encode('ascii')
+        # TODO: Fail more loudly?
+        requests.put(self._test_result_store_url, data=json_payload)
+        self._test_result_store_url = None

tests/conftest.py

@@ -116,7 +116,7 @@ class DummyUploader:
     def __init__(self, factory, slug, **kwargs):
         self.factory = factory
 
-    def write_network_files(self, files):
+    def add_network_files(self, files):
         pass
 
     def add_coverage_report(self, cov, **kwargs):

tests/test_codecov.py

@@ -15,7 +15,7 @@ def test_init():
 
 def test_write_network_files():
     uploader = CodecovUploader('seantis/pytest-codecov')
-    uploader.write_network_files(['foo.py'])
+    uploader.add_network_files(['foo.py'])
     assert uploader.get_payload() == (
         'foo.py\n'
         '<<<<<< network'
@@ -24,7 +24,7 @@ def test_write_network_files():
 
 def test_add_coverage_report(dummy_cov):
     uploader = CodecovUploader('seantis/pytest-codecov')
-    uploader.write_network_files(['foo.py'])
+    uploader.add_network_files(['foo.py'])
     uploader.add_coverage_report(dummy_cov)
     assert uploader.get_payload() == (
         'foo.py\n'
@@ -55,7 +55,7 @@ def test_ping(dummy_cov, mock_requests):
 
     mock_requests.set_response(f'codecov.io\n{uploader.storage_endpoint}')
     uploader.ping()
-    assert uploader.store_url == uploader.storage_endpoint
+    assert uploader._coverage_store_url == uploader.storage_endpoint
 
     # TODO: Verify correct url/headers/params
 
@@ -80,6 +80,6 @@ def test_upload(dummy_cov, mock_requests):
 
     mock_requests.set_response('')
     uploader.upload()
-    assert uploader.store_url is None
+    assert uploader._coverage_store_url is None
 
     # TODO: Verify correct url/headers/params

tests/test_plugin.py

@@ -140,7 +140,7 @@ def test_upload_report_junit(pytester, dummy_reporter, dummy_uploader,
         'JUnit XML file detected and included in upload.\n'
     ) in dummy_reporter.text
     assert (
-        'INFO: We recommend using junit_family=legacy with CodeCov.'
+        'INFO: We recommend using junit_family=legacy with Codecov.'
     ) not in dummy_reporter.text
     assert dummy_uploader.junit_xml == str(junit_xml)
 
@@ -162,7 +162,7 @@ def test_upload_report_junit_info(pytester, dummy_reporter, dummy_uploader,
     plugin = CodecovPlugin()
     plugin.upload_report(dummy_reporter, config, dummy_cov)
     assert (
-        'INFO: We recommend using junit_family=legacy with CodeCov.\n'
+        'INFO: We recommend using junit_family=legacy with Codecov.\n'
         'Environment:\n'
         'Slug:   foo/bar\n'
         'Branch: master\n'
@@ -200,7 +200,7 @@ def test_no_upload_report_junit(pytester, dummy_reporter, dummy_uploader,
         'JUnit XML file detected and included in upload.'
     ) not in dummy_reporter.text
     assert (
-        'INFO: We recommend using junit_family=legacy with CodeCov.'
+        'INFO: We recommend using junit_family=legacy with Codecov.'
     ) not in dummy_reporter.text
     assert dummy_uploader.junit_xml is None