feat: Overide context variables with input values

ArtiomTr · Mar 15, 2024 · f78d0c0 · f78d0c0
1 parent ca026cd
commit f78d0c0
Show file tree

Hide file tree

Showing 18 changed files with 78 additions and 62 deletions.
diff --git a/src/format/annotations/formatCoverageAnnotations.ts b/src/format/annotations/formatCoverageAnnotations.ts
@@ -1,5 +1,3 @@
-import { context } from '@actions/github';
-
 import { CreateCheckOptions } from './CreateCheckOptions';
 import { Annotation } from '../../annotations/Annotation';
 import { Options } from '../../typings/Options';
@@ -9,9 +7,10 @@ export const formatCoverageAnnotations = (
     annotations: Array<Annotation>,
     options: Options
 ): CreateCheckOptions => ({
-    ...context.repo,
+    repo: options.repo,
+    owner: options.owner,
     status: 'completed',
-    head_sha: options?.pullRequest?.head?.sha ?? context.sha,
+    head_sha: options.sha,
     conclusion: 'success',
     name: i18n('coveredCheckName'),
     output: {

diff --git a/src/format/annotations/formatFailedTestsAnnotations.ts b/src/format/annotations/formatFailedTestsAnnotations.ts
@@ -1,5 +1,3 @@
-import { context } from '@actions/github';
-
 import { CreateCheckOptions } from './CreateCheckOptions';
 import { Annotation } from '../../annotations/Annotation';
 import { Options } from '../../typings/Options';
@@ -11,9 +9,10 @@ export const formatFailedTestsAnnotations = (
     annotations: Array<Annotation>,
     options: Options
 ): CreateCheckOptions => ({
-    ...context.repo,
+    repo: options.repo,
+    owner: options.owner,
     status: 'completed',
-    head_sha: options?.pullRequest?.head?.sha ?? context.sha,
+    head_sha: options.sha,
     conclusion: runReport.success ? 'success' : 'failure',
     name: i18n('testRunCheckName'),
     output: {

diff --git a/src/report/generateCommitReport.ts b/src/report/generateCommitReport.ts
@@ -1,13 +1,14 @@
-import { context, getOctokit } from '@actions/github';
+import { getOctokit } from '@actions/github';
 
 export const generateCommitReport = async (
     report: string,
     repo: { owner: string; repo: string },
-    octokit: ReturnType<typeof getOctokit>
+    octokit: ReturnType<typeof getOctokit>,
+    sha: string
 ) => {
     await octokit.rest.repos.createCommitComment({
         ...repo,
-        commit_sha: context.sha,
+        commit_sha: sha,
         body: report,
     });
 };
diff --git a/src/run.ts b/src/run.ts
@@ -1,5 +1,5 @@
 import { setFailed, setOutput } from '@actions/core';
-import { context, getOctokit } from '@actions/github';
+import { getOctokit } from '@actions/github';
 
 import { createCoverageAnnotations } from './annotations/createCoverageAnnotations';
 import { createFailedTestsAnnotations } from './annotations/createFailedTestsAnnotations';
@@ -250,15 +250,16 @@ export const run = async (
             await generatePRReport(
                 summaryReport!.text,
                 options,
-                context.repo,
+                { repo: options.repo, owner: options.owner },
                 options.pullRequest as { number: number },
                 octokit
             );
         } else {
             await generateCommitReport(
                 summaryReport!.text,
-                context.repo,
-                octokit
+                { repo: options.repo, owner: options.owner },
+                octokit,
+                options.sha
             );
         }
     });

diff --git a/src/stages/createReport.ts b/src/stages/createReport.ts
@@ -14,11 +14,6 @@ import { DataCollector } from '../utils/DataCollector';
 import { i18n } from '../utils/i18n';
 import { insertArgs } from '../utils/insertArgs';
 
-export const getSha = () =>
-    context.payload.after ??
-    context.payload.pull_request?.head.sha ??
-    context.sha;
-
 export const createReport = (
     dataCollector: DataCollector<JsonReport>,
     runReport: TestRunReport | undefined,
@@ -47,7 +42,7 @@ export const createReport = (
         title: insertArgs(customTitle || i18n('summaryTitle'), {
             dir: workingDirectory ? `for \`${workingDirectory}\`` : '',
         }),
-        sha: getSha(),
+        sha: context.payload.after ?? options.sha,
     });
 
     if (templateText.length > GITHUB_MESSAGE_SIZE_LIMIT) {
@@ -67,7 +62,7 @@ export const createReport = (
             title: insertArgs(customTitle || i18n('summaryTitle'), {
                 dir: workingDirectory ? `for \`${workingDirectory}\`` : '',
             }),
-            sha: getSha(),
+            sha: context.payload.after ?? options.sha,
         });
 
         if (templateText.length > GITHUB_MESSAGE_SIZE_LIMIT) {
@@ -80,7 +75,7 @@ export const createReport = (
                 title: insertArgs(customTitle || i18n('summaryTitle'), {
                     dir: workingDirectory ? `for \`${workingDirectory}\`` : '',
                 }),
-                sha: getSha(),
+                sha: context.payload.after ?? options.sha,
             });
         }
     }

diff --git a/src/typings/Options.ts b/src/typings/Options.ts
@@ -41,6 +41,9 @@ export type Options = {
     prNumber: null | number;
     pullRequest: null | PullRequest;
     output: Array<OutputType>;
+    owner: string;
+    repo: string;
+    sha: string;
 };
 
 const validAnnotationOptions: Array<AnnotationType> = [
@@ -84,6 +87,9 @@ const optionSchema = yup.object().shape({
     baseCoverageFile: yup.string(),
     prNumber: yup.number().nullable(),
     pullRequest: yup.object().nullable(),
+    owner: yup.string(),
+    repo: yup.string(),
+    sha: yup.string(),
     output: yup
         .array()
         .required()
@@ -116,16 +122,22 @@ export const getOptions = async (): Promise<Options> => {
         getInput('prnumber') || context?.payload?.pull_request?.number
     );
     const output = getInput('output');
+    const owner = getInput('owner') || context.repo.owner;
+    const repo = getInput('repo') || context.repo.repo;
+
     let pullRequest = context?.payload?.pull_request || null;
 
     if (!pullRequest && !Number.isNaN(prNumber)) {
         const { data: pr } = await octokit.rest.pulls.get({
-            owner: context.repo.owner,
-            repo: context.repo.repo,
+            owner: owner,
+            repo: repo,
             pull_number: prNumber,
         });
         pullRequest = pr as PullRequest;
     }
+
+    const sha = pullRequest?.head.sha ?? context.sha;
+
     try {
         const options: Options = (await optionSchema.validate({
             token,
@@ -142,6 +154,9 @@ export const getOptions = async (): Promise<Options> => {
             prNumber: prNumber || null,
             pullRequest,
             output,
+            owner,
+            repo,
+            sha,
         })) as Options;
 
         return options;

diff --git a/src/utils/getPrPatch.ts b/src/utils/getPrPatch.ts
@@ -1,4 +1,4 @@
-import { context, getOctokit } from '@actions/github';
+import { getOctokit } from '@actions/github';
 
 import { Options } from '../typings/Options';
 
@@ -7,7 +7,8 @@ export async function getPrPatch(
     options: Options
 ): Promise<string> {
     const response: { data: string } = ((await octokit.rest.pulls.get({
-        ...context.repo,
+        repo: options.repo,
+        owner: options.owner,
         pull_number: options.pullRequest!.number,
         headers: {
             accept: 'application/vnd.github.v3.patch',

diff --git a/tests/format/annotations/__snapshots__/formatCoverageAnnotations.test.ts.snap b/tests/format/annotations/__snapshots__/formatCoverageAnnotations.test.ts.snap
@@ -52,14 +52,16 @@ Object {
     "text": "Created coverage report annotations. To disable them, see [documentation](https://github.com/ArtiomTr/jest-coverage-report-action#jest-coverage-report-).",
     "title": "Coverage report annotations",
   },
+  "owner": "test-bot",
+  "repo": "test",
   "status": "completed",
 }
 `;
 
 exports[`formatCoverageAnnotations should format annotations for commit 1`] = `
 Object {
   "conclusion": "success",
-  "head_sha": "111111",
+  "head_sha": "123456",
   "name": "Coverage annotations (🧪 jest-coverage-report-action)",
   "output": Object {
     "annotations": Array [
@@ -108,14 +110,16 @@ Object {
     "text": "Created coverage report annotations. To disable them, see [documentation](https://github.com/ArtiomTr/jest-coverage-report-action#jest-coverage-report-).",
     "title": "Coverage report annotations",
   },
+  "owner": "test-bot",
+  "repo": "test",
   "status": "completed",
 }
 `;
 
 exports[`formatCoverageAnnotations should leave only 50 annotations 1`] = `
 Object {
   "conclusion": "success",
-  "head_sha": "111111",
+  "head_sha": "123456",
   "name": "Coverage annotations (🧪 jest-coverage-report-action)",
   "output": Object {
     "annotations": Array [
@@ -615,6 +619,8 @@ Object {
 2 annotations hidden. Only 50 can be displayed at once.",
     "title": "Coverage report annotations",
   },
+  "owner": "test-bot",
+  "repo": "test",
   "status": "completed",
 }
 `;
diff --git a/tests/format/annotations/__snapshots__/formatFailedTestsAnnotations.test.ts.snap b/tests/format/annotations/__snapshots__/formatFailedTestsAnnotations.test.ts.snap
@@ -3,7 +3,7 @@
 exports[`formatFailedTestsAnnotations should format failed tests annotations for PR 1`] = `
 Object {
   "conclusion": "failure",
-  "head_sha": "987654",
+  "head_sha": "as12d1",
   "name": "Tests annotations (🧪 jest-coverage-report-action)",
   "output": Object {
     "annotations": Array [

diff --git a/tests/format/annotations/formatCoverageAnnotations.test.ts b/tests/format/annotations/formatCoverageAnnotations.test.ts
@@ -28,6 +28,9 @@ const DEFAULT_OPTIONS: Options = {
         },
     },
     output: ['comment'],
+    owner: 'test-bot',
+    repo: 'test',
+    sha: '123456',
 };
 
 const annotations: Annotation[] = [
@@ -95,7 +98,6 @@ describe('formatCoverageAnnotations', () => {
     it('should format annotations for commit', () => {
         mockContext({
             payload: {},
-            sha: '111111',
         });
 
         expect(
@@ -110,7 +112,6 @@ describe('formatCoverageAnnotations', () => {
     it('should leave only 50 annotations', () => {
         mockContext({
             payload: {},
-            sha: '111111',
         });
 
         expect(

diff --git a/tests/format/annotations/formatFailedTestsAnnotations.test.ts b/tests/format/annotations/formatFailedTestsAnnotations.test.ts
@@ -28,6 +28,9 @@ const DEFAULT_OPTIONS: Options = {
         },
     },
     output: ['comment'],
+    owner: 'test-bot',
+    repo: 'test',
+    sha: 'as12d1',
 };
 
 const annotations: Annotation[] = [
@@ -58,13 +61,7 @@ describe('formatFailedTestsAnnotations', () => {
                 owner: 'test-bot',
                 repo: 'test',
             },
-            payload: {
-                pull_request: {
-                    head: {
-                        sha: '987654',
-                    },
-                },
-            },
+            payload: {},
         });
 
         expect(
@@ -88,7 +85,6 @@ describe('formatFailedTestsAnnotations', () => {
                 repo: 'test',
             },
             payload: {},
-            sha: 'as12d1',
         });
 
         expect(
@@ -112,7 +108,6 @@ describe('formatFailedTestsAnnotations', () => {
                 repo: 'test',
             },
             payload: {},
-            sha: 'as12d1',
         });
 
         expect(

diff --git a/tests/report/fetchPreviousReport.test.ts b/tests/report/fetchPreviousReport.test.ts
@@ -26,6 +26,9 @@ const DEFAULT_OPTIONS: Options = {
         },
     },
     output: ['comment'],
+    owner: 'bot',
+    repo: 'test-repo',
+    sha: '123',
 };
 
 describe('fetchPreviousReport', () => {

diff --git a/tests/report/generateCommitReport.test.ts b/tests/report/generateCommitReport.test.ts
@@ -3,16 +3,12 @@ import * as all from '@actions/github';
 
 import { generateCommitReport } from '../../src/report/generateCommitReport';
 
-const { mockContext, clearContextMock } = all as any;
+const { clearContextMock } = all as any;
 
 describe('generateCommitReport', () => {
     it('should generate commit report', async () => {
         const createCommitComment = jest.fn();
 
-        mockContext({
-            sha: '123456',
-        });
-
         await generateCommitReport(
             'Report body',
             {
@@ -25,7 +21,8 @@ describe('generateCommitReport', () => {
                         createCommitComment,
                     },
                 },
-            } as unknown) as ReturnType<typeof getOctokit>
+            } as unknown) as ReturnType<typeof getOctokit>,
+            '123456'
         );
 
         expect(createCommitComment).toBeCalledWith({

diff --git a/tests/report/generatePRReport.test.ts b/tests/report/generatePRReport.test.ts
@@ -26,6 +26,9 @@ const DEFAULT_OPTIONS: Options = {
         },
     },
     output: ['comment'],
+    owner: 'bot',
+    repo: 'test-repository',
+    sha: '123456',
 };
 
 describe('generatePRReport', () => {

diff --git a/tests/run.test.ts b/tests/run.test.ts
@@ -210,6 +210,9 @@ const defaultOptions: Options = {
         },
     },
     output: ['comment'],
+    owner: 'bot',
+    repo: 'test-repo',
+    sha: '123',
 };
 
 jest.mock('../src/typings/Options.ts');