Add coverage report to PR for push event (#144)

* Get PR number for push event * Setting prNumber from 0 to undefined * Setting prNumber from 0 to undefined * Adapt tests * Add tests for push event to publish pr comment * Update version
Madrapps · Sep 19, 2024 · 960061c · 960061c
1 parent ad47d82
commit 960061c
Show file tree

Hide file tree

Showing 19 changed files with 188 additions and 14 deletions.
diff --git a/__tests__/action_aggregate.test.ts b/__tests__/action_aggregate.test.ts
@@ -49,6 +49,9 @@ describe('Aggregate report', function () {
             compareCommits: jest.fn(() => {
               return compareCommitsResponse
             }),
+            listPullRequestsAssociatedWithCommit: jest.fn(() => {
+              return {data: []}
+            }),
           },
           issues: {
             createComment,

diff --git a/__tests__/action_empty_aggregate.test.ts b/__tests__/action_empty_aggregate.test.ts
@@ -49,6 +49,9 @@ describe('Aggregate Empty report', function () {
             compareCommits: jest.fn(() => {
               return compareCommitsResponse
             }),
+            listPullRequestsAssociatedWithCommit: jest.fn(() => {
+              return {data: []}
+            }),
           },
           issues: {
             createComment,

diff --git a/__tests__/action_empty_multiple.test.ts b/__tests__/action_empty_multiple.test.ts
@@ -78,6 +78,9 @@ describe('Multiple Empty reports', function () {
           compareCommits: jest.fn(() => {
             return compareCommitsResponse
           }),
+          listPullRequestsAssociatedWithCommit: jest.fn(() => {
+            return {data: []}
+          }),
         },
         issues: {
           createComment: comment,

diff --git a/__tests__/action_empty_report.test.ts b/__tests__/action_empty_report.test.ts
@@ -49,6 +49,9 @@ describe('Single Empty report', function () {
             compareCommits: jest.fn(() => {
               return compareCommitsResponse
             }),
+            listPullRequestsAssociatedWithCommit: jest.fn(() => {
+              return {data: []}
+            }),
           },
           issues: {
             createComment,

diff --git a/__tests__/action_multiple.test.ts b/__tests__/action_multiple.test.ts
@@ -78,6 +78,9 @@ describe('Multiple reports', function () {
           compareCommits: jest.fn(() => {
             return compareCommitsResponse
           }),
+          listPullRequestsAssociatedWithCommit: jest.fn(() => {
+            return {data: []}
+          }),
         },
         issues: {
           createComment: comment,

diff --git a/__tests__/action_single.test.ts b/__tests__/action_single.test.ts
@@ -53,6 +53,9 @@ describe('Single report', function () {
             compareCommits: jest.fn(() => {
               return compareCommitsResponse
             }),
+            listPullRequestsAssociatedWithCommit: jest.fn(() => {
+              return {data: []}
+            }),
           },
           issues: {
             createComment,
@@ -473,6 +476,54 @@ describe('Single report', function () {
         expect(createComment).toHaveBeenCalledTimes(0)
       })
     })
+
+    it('when pr-number present, add the comment in pr', async () => {
+      core.getInput = jest.fn(c => {
+        switch (c) {
+          case 'pr-number':
+            return '45'
+          default:
+            return getInput(c)
+        }
+      })
+      initContext(eventName, payload)
+
+      await action.action()
+      expect(createComment.mock.calls[0][0].body).toEqual(PROPER_COMMENT)
+    })
+
+    it('when pr-number not present and associated PR available from commit, add the comment in pr', async () => {
+      core.getInput = jest.fn(c => {
+        switch (c) {
+          case 'pr-number':
+            return ''
+          default:
+            return getInput(c)
+        }
+      })
+      github.getOctokit = jest.fn(() => {
+        return {
+          rest: {
+            repos: {
+              compareCommits: jest.fn(() => {
+                return compareCommitsResponse
+              }),
+              listPullRequestsAssociatedWithCommit: jest.fn(() => {
+                return {data: [{number: 45}]}
+              }),
+            },
+            issues: {
+              createComment,
+              listComments,
+              updateComment,
+            },
+          },
+        }
+      })
+      initContext(eventName, payload)
+      await action.action()
+      expect(createComment.mock.calls[0][0].body).toEqual(PROPER_COMMENT)
+    })
   })
 
   describe('Other than push or pull_request or pull_request_target event', function () {

diff --git a/action.yml b/action.yml
@@ -30,6 +30,9 @@ inputs:
       - 'pr_comment'
       - 'summary'
       - 'both'
+  pr-number:
+    description: 'The PR number to add the comment to. If not provided, the action will try to get it from the environment.'
+    required: false
   skip-if-no-changes:
     description: "Comment won't be added if there is no coverage information present for the files changed"
     required: false

diff --git a/dist/index.js b/dist/index.js
@@ -81,27 +81,30 @@ async function action() {
         if (!isValidCommentType(commentType)) {
             core.setFailed(`'comment-type' ${commentType} is invalid`);
         }
+        let prNumber = Number(core.getInput('pr-number')) || undefined;
+        const client = github.getOctokit(token);
         let base;
         let head;
-        let prNumber;
         switch (event) {
             case 'pull_request':
             case 'pull_request_target':
                 base = github.context.payload.pull_request?.base.sha;
                 head = github.context.payload.pull_request?.head.sha;
-                prNumber = github.context.payload.pull_request?.number;
+                prNumber = prNumber ?? github.context.payload.pull_request?.number;
                 break;
             case 'push':
                 base = github.context.payload.before;
                 head = github.context.payload.after;
+                prNumber =
+                    prNumber ??
+                        (await getPrNumberAssociatedWithCommit(client, github.context.sha));
                 break;
             default:
                 core.setFailed(`Only pull requests and pushes are supported, ${github.context.eventName} not supported.`);
                 return;
         }
         core.info(`base sha: ${base}`);
         core.info(`head sha: ${head}`);
-        const client = github.getOctokit(token);
         if (debugMode)
             core.info(`reportPaths: ${reportPaths}`);
         const changedFiles = await getChangedFiles(base, head, client, debugMode);
@@ -234,6 +237,14 @@ const validCommentTypes = ['pr_comment', 'summary', 'both'];
 const isValidCommentType = (value) => {
     return validCommentTypes.includes(value);
 };
+async function getPrNumberAssociatedWithCommit(client, commitSha) {
+    const response = await client.rest.repos.listPullRequestsAssociatedWithCommit({
+        commit_sha: commitSha,
+        owner: github.context.repo.owner,
+        repo: github.context.repo.repo,
+    });
+    return response.data.length > 0 ? response.data[0].number : undefined;
+}
 
 
 /***/ }),

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/lib/__tests__/action_aggregate.test.js b/lib/__tests__/action_aggregate.test.js
@@ -69,6 +69,9 @@ describe('Aggregate report', function () {
                         compareCommits: jest.fn(() => {
                             return compareCommitsResponse;
                         }),
+                        listPullRequestsAssociatedWithCommit: jest.fn(() => {
+                            return { data: [] };
+                        }),
                     },
                     issues: {
                         createComment,

diff --git a/lib/__tests__/action_empty_aggregate.test.js b/lib/__tests__/action_empty_aggregate.test.js
@@ -69,6 +69,9 @@ describe('Aggregate Empty report', function () {
                         compareCommits: jest.fn(() => {
                             return compareCommitsResponse;
                         }),
+                        listPullRequestsAssociatedWithCommit: jest.fn(() => {
+                            return { data: [] };
+                        }),
                     },
                     issues: {
                         createComment,

diff --git a/lib/__tests__/action_empty_multiple.test.js b/lib/__tests__/action_empty_multiple.test.js
@@ -92,6 +92,9 @@ describe('Multiple Empty reports', function () {
                     compareCommits: jest.fn(() => {
                         return compareCommitsResponse;
                     }),
+                    listPullRequestsAssociatedWithCommit: jest.fn(() => {
+                        return { data: [] };
+                    }),
                 },
                 issues: {
                     createComment: comment,

diff --git a/lib/__tests__/action_empty_report.test.js b/lib/__tests__/action_empty_report.test.js
@@ -69,6 +69,9 @@ describe('Single Empty report', function () {
                         compareCommits: jest.fn(() => {
                             return compareCommitsResponse;
                         }),
+                        listPullRequestsAssociatedWithCommit: jest.fn(() => {
+                            return { data: [] };
+                        }),
                     },
                     issues: {
                         createComment,

diff --git a/lib/__tests__/action_multiple.test.js b/lib/__tests__/action_multiple.test.js
@@ -92,6 +92,9 @@ describe('Multiple reports', function () {
                     compareCommits: jest.fn(() => {
                         return compareCommitsResponse;
                     }),
+                    listPullRequestsAssociatedWithCommit: jest.fn(() => {
+                        return { data: [] };
+                    }),
                 },
                 issues: {
                     createComment: comment,

diff --git a/lib/__tests__/action_single.test.js b/lib/__tests__/action_single.test.js
@@ -73,6 +73,9 @@ describe('Single report', function () {
                         compareCommits: jest.fn(() => {
                             return compareCommitsResponse;
                         }),
+                        listPullRequestsAssociatedWithCommit: jest.fn(() => {
+                            return { data: [] };
+                        }),
                     },
                     issues: {
                         createComment,
@@ -429,6 +432,51 @@ describe('Single report', function () {
                 expect(createComment).toHaveBeenCalledTimes(0);
             });
         });
+        it('when pr-number present, add the comment in pr', async () => {
+            core.getInput = jest.fn(c => {
+                switch (c) {
+                    case 'pr-number':
+                        return '45';
+                    default:
+                        return getInput(c);
+                }
+            });
+            initContext(eventName, payload);
+            await action.action();
+            expect(createComment.mock.calls[0][0].body).toEqual(PROPER_COMMENT);
+        });
+        it('when pr-number not present and associated PR available from commit, add the comment in pr', async () => {
+            core.getInput = jest.fn(c => {
+                switch (c) {
+                    case 'pr-number':
+                        return '';
+                    default:
+                        return getInput(c);
+                }
+            });
+            github.getOctokit = jest.fn(() => {
+                return {
+                    rest: {
+                        repos: {
+                            compareCommits: jest.fn(() => {
+                                return compareCommitsResponse;
+                            }),
+                            listPullRequestsAssociatedWithCommit: jest.fn(() => {
+                                return { data: [{ number: 45 }] };
+                            }),
+                        },
+                        issues: {
+                            createComment,
+                            listComments,
+                            updateComment,
+                        },
+                    },
+                };
+            });
+            initContext(eventName, payload);
+            await action.action();
+            expect(createComment.mock.calls[0][0].body).toEqual(PROPER_COMMENT);
+        });
     });
     describe('Other than push or pull_request or pull_request_target event', function () {
         it('Fail by throwing appropriate error', async () => {

diff --git a/lib/src/action.js b/lib/src/action.js
@@ -74,27 +74,30 @@ async function action() {
         if (!isValidCommentType(commentType)) {
             core.setFailed(`'comment-type' ${commentType} is invalid`);
         }
+        let prNumber = Number(core.getInput('pr-number')) || undefined;
+        const client = github.getOctokit(token);
         let base;
         let head;
-        let prNumber;
         switch (event) {
             case 'pull_request':
             case 'pull_request_target':
                 base = github.context.payload.pull_request?.base.sha;
                 head = github.context.payload.pull_request?.head.sha;
-                prNumber = github.context.payload.pull_request?.number;
+                prNumber = prNumber ?? github.context.payload.pull_request?.number;
                 break;
             case 'push':
                 base = github.context.payload.before;
                 head = github.context.payload.after;
+                prNumber =
+                    prNumber ??
+                        (await getPrNumberAssociatedWithCommit(client, github.context.sha));
                 break;
             default:
                 core.setFailed(`Only pull requests and pushes are supported, ${github.context.eventName} not supported.`);
                 return;
         }
         core.info(`base sha: ${base}`);
         core.info(`head sha: ${head}`);
-        const client = github.getOctokit(token);
         if (debugMode)
             core.info(`reportPaths: ${reportPaths}`);
         const changedFiles = await getChangedFiles(base, head, client, debugMode);
@@ -227,3 +230,11 @@ const validCommentTypes = ['pr_comment', 'summary', 'both'];
 const isValidCommentType = (value) => {
     return validCommentTypes.includes(value);
 };
+async function getPrNumberAssociatedWithCommit(client, commitSha) {
+    const response = await client.rest.repos.listPullRequestsAssociatedWithCommit({
+        commit_sha: commitSha,
+        owner: github.context.repo.owner,
+        repo: github.context.repo.repo,
+    });
+    return response.data.length > 0 ? response.data[0].number : undefined;
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jacoco-report",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "description": "Github action that publishes the JaCoCo report as a comment in the Pull Request",
   "main": "lib/src/index.js",
   "scripts": {