feat(github): add service_number for github actions

Required for supporting parallel builds. Co-Authored-By: Kevin James <KevinJames@thekev.in>
TheKevJames · Feb 12, 2020 · 9f93bd8 · 9f93bd8
1 parent 6064a81
commit 9f93bd8
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 12 deletions.
diff --git a/coveralls/api.py b/coveralls/api.py
@@ -51,7 +51,13 @@ def __init__(self, token_required=True, service_name=None, **kwargs):
         name, job, pr = self.load_config_from_ci_environment()
         self.config['service_name'] = self.config.get('service_name', name)
         if job:
-            self.config['service_job_id'] = job
+            # N.B. Github Actions uses a different chunk of the Coveralls
+            # config when running parallel builds, ie. `service_number` instead
+            # of `service_job_id`.
+            if name.startswith('github'):
+                self.config['service_number'] = job
+            else:
+                self.config['service_job_id'] = job
         if pr:
             self.config['service_pull_request'] = pr
 
@@ -85,10 +91,12 @@ def load_config_from_circle():
 
     @staticmethod
     def load_config_from_github():
+        service_number = os.environ.get('GITHUB_SHA')
         pr = None
         if os.environ.get('GITHUB_REF', '').startswith('refs/pull/'):
             pr = os.environ.get('GITHUB_REF', '//').split('/')[2]
-        return 'github-actions', None, pr
+            service_number += "-PR-{0}".format(pr)
+        return 'github', service_number, pr
 
     @staticmethod
     def load_config_from_jenkins():

diff --git a/docs/usage/tox.rst b/docs/usage/tox.rst
@@ -66,6 +66,7 @@ All variables:
 
 - ``GITHUB_ACTIONS``
 - ``GITHUB_REF``
+- ``GITHUB_SHA``
 - ``GITHUB_HEAD_REF``
 
 Jenkins

diff --git a/tests/api/configuration_test.py b/tests/api/configuration_test.py
@@ -110,23 +110,29 @@ def test_circleci_no_config(self):
         assert cover.config['service_job_id'] == '888'
         assert cover.config['service_pull_request'] == '9999'
 
-    @mock.patch.dict(os.environ, {'GITHUB_ACTIONS': 'true',
-                                  'GITHUB_REF': 'refs/pull/1234/merge',
-                                  'GITHUB_HEAD_REF': 'fixup-branch'},
-                     clear=True)
+    @mock.patch.dict(
+        os.environ,
+        {'GITHUB_ACTIONS': 'true',
+         'GITHUB_REF': 'refs/pull/1234/merge',
+         'GITHUB_SHA': 'bb0e00166b28f49db04d6a8b8cb4bddb5afa529f',
+         'GITHUB_HEAD_REF': 'fixup-branch'},
+        clear=True)
     def test_github_no_config(self):
         cover = Coveralls(repo_token='xxx')
-        assert cover.config['service_name'] == 'github-actions'
+        assert cover.config['service_name'] == 'github'
         assert cover.config['service_pull_request'] == '1234'
         assert 'service_job_id' not in cover.config
 
-    @mock.patch.dict(os.environ, {'GITHUB_ACTIONS': 'true',
-                                  'GITHUB_REF': 'refs/heads/master',
-                                  'GITHUB_HEAD_REF': ''},
-                     clear=True)
+    @mock.patch.dict(
+        os.environ,
+        {'GITHUB_ACTIONS': 'true',
+         'GITHUB_REF': 'refs/heads/master',
+         'GITHUB_SHA': 'bb0e00166b28f49db04d6a8b8cb4bddb5afa529f',
+         'GITHUB_HEAD_REF': ''},
+        clear=True)
     def test_github_no_config_no_pr(self):
         cover = Coveralls(repo_token='xxx')
-        assert cover.config['service_name'] == 'github-actions'
+        assert cover.config['service_name'] == 'github'
         assert 'service_pull_request' not in cover.config
         assert 'service_job_id' not in cover.config
 

diff --git a/tests/git_test.py b/tests/git_test.py
@@ -124,6 +124,7 @@ class GitInfoTestBranch(GitTest):
     @mock.patch.dict(os.environ, {
         'GITHUB_ACTIONS': 'true',
         'GITHUB_REF': 'refs/pull/1234/merge',
+        'GITHUB_SHA': 'bb0e00166b28f49db04d6a8b8cb4bddb5afa529f',
         'GITHUB_HEAD_REF': 'fixup-branch'
     }, clear=True)
     def test_gitinfo_github_pr(self):
@@ -133,6 +134,7 @@ def test_gitinfo_github_pr(self):
     @mock.patch.dict(os.environ, {
         'GITHUB_ACTIONS': 'true',
         'GITHUB_REF': 'refs/heads/master',
+        'GITHUB_SHA': 'bb0e00166b28f49db04d6a8b8cb4bddb5afa529f',
         'GITHUB_HEAD_REF': ''
     }, clear=True)
     def test_gitinfo_github_nopr(self):