fix(notify-pipeline-complete): merge queue statuses (#684)

ExpediaGroup · Jan 10, 2025 · 208bb6d · 208bb6d
1 parent fb42cce
commit 208bb6d
Show file tree

Hide file tree

Showing 8 changed files with 72 additions and 76 deletions.
diff --git a/dist/264.index.js b/dist/264.index.js
diff --git a/dist/264.index.js.map b/dist/264.index.js.map
diff --git a/dist/467.index.js b/dist/467.index.js
diff --git a/dist/467.index.js.map b/dist/467.index.js.map
diff --git a/src/helpers/initiate-deployment.ts b/src/helpers/initiate-deployment.ts
@@ -58,19 +58,17 @@ export const initiateDeployment = async ({
     ...GITHUB_OPTIONS
   });
 
-  if (githubContext.eventName === 'merge_group') {
-    const commitHashesForMergeQueueBranches = await getMergeQueueCommitHashes();
-    await map(commitHashesForMergeQueueBranches, async sha =>
-      octokit.repos.createCommitStatus({
-        sha,
-        context,
-        state: 'pending',
-        description,
-        target_url,
-        ...githubContext.repo
-      })
-    );
-  }
+  const commitHashesForMergeQueueBranches = await getMergeQueueCommitHashes();
+  await map(commitHashesForMergeQueueBranches, async sha =>
+    octokit.repos.createCommitStatus({
+      sha,
+      context,
+      state: 'pending',
+      description,
+      target_url,
+      ...githubContext.repo
+    })
+  );
 
   return deployment_id;
 };
diff --git a/src/helpers/notify-pipeline-complete.ts b/src/helpers/notify-pipeline-complete.ts
@@ -37,7 +37,8 @@ export const notifyPipelineComplete = async ({
     ...githubContext.repo
   });
   const commitHashesForOpenPullRequests = pullRequests.map(pullRequest => pullRequest.head.sha);
-  const commitHashes = githubContext.eventName === 'merge_group' ? await getMergeQueueCommitHashes() : commitHashesForOpenPullRequests;
+  const mergeQueueCommitHashes = await getMergeQueueCommitHashes();
+  const commitHashes = mergeQueueCommitHashes.length ? mergeQueueCommitHashes : commitHashesForOpenPullRequests;
   await map(commitHashes, async sha =>
     octokit.repos.createCommitStatus({
       sha,

diff --git a/test/helpers/initiate-deployment.test.ts b/test/helpers/initiate-deployment.test.ts
@@ -26,26 +26,7 @@ jest.mock('@actions/github', () => ({
         createCommitStatus: jest.fn(),
         createDeployment: jest.fn(),
         createDeploymentStatus: jest.fn(),
-        listBranches: jest.fn(({ page }) =>
-          page > 1
-            ? { data: [] }
-            : {
-                data: [
-                  {
-                    name: 'some-branch',
-                    commit: { sha: 'normal sha 1' }
-                  },
-                  {
-                    name: 'gh-readonly-queue/merge-queue/pr-123-79a5ad2b1a46f6b5d77e02573937667979635f27',
-                    commit: { sha: 'merge queue sha 1' }
-                  },
-                  {
-                    name: 'gh-readonly-queue/merge-queue/pr-456-79a5ad2b1a46f6b5d77e02573937667979635f27',
-                    commit: { sha: 'merge queue sha 2' }
-                  }
-                ]
-              }
-        )
+        listBranches: jest.fn(() => ({ data: [] }))
       }
     }
   }))
@@ -100,8 +81,7 @@ describe('initiateDeployment', () => {
     });
   });
 
-  it('should call createCommitStatus with correct params on non merge_group event', async () => {
-    context.eventName = 'some_event';
+  it('should call createCommitStatus with correct params', async () => {
     await initiateDeployment({
       sha,
       environment,
@@ -134,8 +114,27 @@ describe('initiateDeployment', () => {
     });
   });
 
-  it('should call createCommitStatus with correct params on merge_group event', async () => {
-    context.eventName = 'merge_group';
+  it('should call createCommitStatus with correct params when merge queue branches are present', async () => {
+    (octokit.repos.listBranches as unknown as Mocktokit).mockImplementation(async ({ page }) =>
+      page > 1
+        ? { data: [] }
+        : {
+            data: [
+              {
+                name: 'some-branch',
+                commit: { sha: 'normal sha 1' }
+              },
+              {
+                name: 'gh-readonly-queue/merge-queue/pr-123-79a5ad2b1a46f6b5d77e02573937667979635f27',
+                commit: { sha: 'merge queue sha 1' }
+              },
+              {
+                name: 'gh-readonly-queue/merge-queue/pr-456-79a5ad2b1a46f6b5d77e02573937667979635f27',
+                commit: { sha: 'merge queue sha 2' }
+              }
+            ]
+          }
+    );
     await initiateDeployment({
       sha,
       environment,

diff --git a/test/helpers/notify-pipeline-complete.test.ts b/test/helpers/notify-pipeline-complete.test.ts
@@ -27,26 +27,7 @@ jest.mock('@actions/github', () => ({
         createCommitStatus: jest.fn(),
         createDeploymentStatus: jest.fn(),
         listDeployments: jest.fn(() => ({ data: [{ id: 123 }] })),
-        listBranches: jest.fn(({ page }) =>
-          page > 1
-            ? { data: [] }
-            : {
-                data: [
-                  {
-                    name: 'some-branch',
-                    commit: { sha: 'normal sha 1' }
-                  },
-                  {
-                    name: 'gh-readonly-queue/merge-queue/pr-123-79a5ad2b1a46f6b5d77e02573937667979635f27',
-                    commit: { sha: 'merge queue sha 1' }
-                  },
-                  {
-                    name: 'gh-readonly-queue/merge-queue/pr-456-79a5ad2b1a46f6b5d77e02573937667979635f27',
-                    commit: { sha: 'merge queue sha 2' }
-                  }
-                ]
-              }
-        )
+        listBranches: jest.fn(() => ({ data: [] }))
       }
     }
   }))
@@ -60,8 +41,7 @@ jest.mock('../../src/helpers/set-deployment-status');
 describe('notify-pipeline-complete', () => {
   const description = 'Pipeline clear.';
 
-  it('should notify that the pipeline is clear on non merge_group event', async () => {
-    context.eventName = 'some_event';
+  it('should notify that the pipeline is clear', async () => {
     await notifyPipelineComplete({});
 
     expect(octokit.pulls.list).toHaveBeenCalledWith({
@@ -123,8 +103,27 @@ describe('notify-pipeline-complete', () => {
     });
   });
 
-  it('should notify that the pipeline is clear on merge_group event', async () => {
-    context.eventName = 'merge_group';
+  it('should notify that the pipeline is clear when merge queue branches are present', async () => {
+    (octokit.repos.listBranches as unknown as Mocktokit).mockImplementation(async ({ page }) =>
+      page > 1
+        ? { data: [] }
+        : {
+            data: [
+              {
+                name: 'some-branch',
+                commit: { sha: 'normal sha 1' }
+              },
+              {
+                name: 'gh-readonly-queue/merge-queue/pr-123-79a5ad2b1a46f6b5d77e02573937667979635f27',
+                commit: { sha: 'merge queue sha 1' }
+              },
+              {
+                name: 'gh-readonly-queue/merge-queue/pr-456-79a5ad2b1a46f6b5d77e02573937667979635f27',
+                commit: { sha: 'merge queue sha 2' }
+              }
+            ]
+          }
+    );
     await notifyPipelineComplete({});
 
     expect(octokit.pulls.list).toHaveBeenCalledWith({