implement cherry-pick filtering test

Author: Julesssss

tests/unit/createOrUpdateStagingDeployTest.ts

@@ -3,6 +3,19 @@
  */
 
 /* eslint-disable @typescript-eslint/naming-convention */
+
+// Mock fs
+jest.mock('fs');
+
+// Mock @actions/core for input handling and logging in tests
+jest.mock('@actions/core', () => ({
+    getInput: jest.fn(),
+    info: jest.fn(),
+    startGroup: jest.fn(),
+    endGroup: jest.fn(),
+    setFailed: jest.fn(),
+}));
+
 import * as fns from 'date-fns';
 import {vol} from 'memfs';
 import path from 'path';
@@ -12,23 +25,21 @@ import type {InternalOctokit} from '@github/libs/GithubUtils';
 import GithubUtils from '@github/libs/GithubUtils';
 import GitUtils from '@github/libs/GitUtils';
 
+import * as core from '@actions/core';
+
+const mockGetInput = core.getInput as jest.MockedFunction<typeof core.getInput>;
+
 type Arguments = {
     issue_number?: number;
     labels?: string;
 };
 
 const PATH_TO_PACKAGE_JSON = path.resolve(__dirname, '../../package.json');
 
-jest.mock('fs');
-const mockGetInput = jest.fn();
 const mockListIssues = jest.fn();
 const mockGetPullRequestsDeployedBetween = jest.fn();
 
 beforeAll(() => {
-    // Mock core module
-    jest.mock('@actions/core', () => ({
-        getInput: mockGetInput,
-    }));
 
     // Mock octokit module
     const mockOctokit = {
@@ -66,6 +77,7 @@ beforeAll(() => {
 
     // Mock GitUtils
     GitUtils.getPullRequestsDeployedBetween = mockGetPullRequestsDeployedBetween;
+    mockGetInput.mockImplementation((arg) => (arg === 'GITHUB_TOKEN' ? 'fake_token' : ''));
 
     vol.reset();
     vol.fromJSON({
@@ -122,7 +134,7 @@ const basePRList = [
 const baseIssueList = [`https://github.com/${process.env.GITHUB_REPOSITORY}/issues/11`, `https://github.com/${process.env.GITHUB_REPOSITORY}/issues/12`];
 // eslint-disable-next-line max-len
 const baseExpectedOutput = (version = '1.0.2-1') =>
-    `**Release Version:** \`${version}\`\r\n**Compare Changes:** https://github.com/${process.env.GITHUB_REPOSITORY}/compare/production...staging\r\n\r\n**This release contains changes from the following pull requests:**\r\n`;
+    `**Release Version:** \`${version}\`\r\n**Compare Changes:** https://github.com/${process.env.GITHUB_REPOSITORY}/compare/production...staging\r\n\r\n> 💡 **Deployer FYI:** This checklist was generated using a new process. PR listfrom original method and detail logging can be found in the most recent [deploy workflow](https://github.com/Expensify/App/actions/workflows/deploy.yml) labeled \`staging\`, in the \`createChecklist\` action. Please tag @Julesssss with any issues.\r\n\r\n\r\n**This release contains changes from the following pull requests:**\r\n`;
 const openCheckbox = '- [ ] ';
 const closedCheckbox = '- [x] ';
 const deployerVerificationsHeader = '**Deployer verifications:**';
@@ -166,12 +178,6 @@ describe('createOrUpdateStagingDeployCash', () => {
         vol.fromJSON({
             [PATH_TO_PACKAGE_JSON]: JSON.stringify({version: '1.0.2-1'}),
         });
-        mockGetInput.mockImplementation((arg) => {
-            if (arg !== 'GITHUB_TOKEN') {
-                return;
-            }
-            return 'fake_token';
-        });
 
         mockGetPullRequestsDeployedBetween.mockImplementation((fromRef, toRef) => {
             if (fromRef === '1.0.1-0-staging' && toRef === '1.0.2-1-staging') {
@@ -259,12 +265,6 @@ describe('createOrUpdateStagingDeployCash', () => {
             vol.fromJSON({
                 [PATH_TO_PACKAGE_JSON]: JSON.stringify({version: '1.0.2-2'}),
             });
-            mockGetInput.mockImplementation((arg) => {
-                if (arg !== 'GITHUB_TOKEN') {
-                    return;
-                }
-                return 'fake_token';
-            });
 
             // New pull requests to add to open StagingDeployCash
             const newPullRequests = [9, 10];
@@ -338,12 +338,6 @@ describe('createOrUpdateStagingDeployCash', () => {
             vol.fromJSON({
                 [PATH_TO_PACKAGE_JSON]: JSON.stringify({version: '1.0.2-1'}),
             });
-            mockGetInput.mockImplementation((arg) => {
-                if (arg !== 'GITHUB_TOKEN') {
-                    return;
-                }
-                return 'fake_token';
-            });
             mockGetPullRequestsDeployedBetween.mockImplementation((fromRef, toRef) => {
                 if (fromRef === '1.0.1-0-staging' && toRef === '1.0.2-1-staging') {
                     return [...baseNewPullRequests];
@@ -406,4 +400,65 @@ describe('createOrUpdateStagingDeployCash', () => {
             });
         });
     });
+
+    describe('cherry-pick filtering', () => {
+        test('filters out PRs that were already included in previous checklist', async () => {
+            vol.reset();
+            vol.fromJSON({
+                [PATH_TO_PACKAGE_JSON]: JSON.stringify({version: '1.0.3-0'}),
+            });
+            
+            mockGetInput.mockImplementation((arg) => arg === 'GITHUB_TOKEN' ? 'fake_token' : '');
+            mockGetPullRequestsDeployedBetween.mockImplementation((fromRef, toRef) => {
+                if (fromRef === '1.0.2-1-staging' && toRef === '1.0.3-0-staging') {
+                    return [6, 8, 10, 11];
+                }
+                return [];
+            });
+
+            // Mock previous checklist containing PRs 6,8
+            const mockGetStagingDeployCashData = jest.spyOn(GithubUtils, 'getStagingDeployCashData');
+            mockGetStagingDeployCashData.mockImplementation(() => ({
+                title: 'Previous Checklist',
+                url: `https://github.com/${process.env.GITHUB_REPOSITORY}/issues/29`,
+                number: 29,
+                labels: [LABELS.STAGING_DEPLOY_CASH],
+                PRList: [
+                    {url: `https://github.com/${process.env.GITHUB_REPOSITORY}/pull/6`, number: 6, isVerified: true},
+                    {url: `https://github.com/${process.env.GITHUB_REPOSITORY}/pull/8`, number: 8, isVerified: true},
+                ],
+                deployBlockers: [],
+                internalQAPRList: [],
+                isTimingDashboardChecked: true,
+                isFirebaseChecked: true,
+                isGHStatusChecked: true,
+                version: '1.0.2-1',
+                tag: '1.0.2-1-staging',
+            }));
+
+            // Mock list of issues to return a closed previous checklist
+            mockListIssues.mockImplementation((args: Arguments) => {
+                if (args.labels === CONST.LABELS.STAGING_DEPLOY) {
+                    return Promise.resolve({
+                        data: [{
+                            number: 29,
+                            state: 'closed',
+                            labels: [LABELS.STAGING_DEPLOY_CASH],
+                        }]
+                    });
+                }
+                return Promise.resolve({data: []});
+            });
+
+            const result = await run();
+
+            // Verify that only new PRs (10, 11) are included, not the previously included ones (6, 8)
+            expect(result?.body).toContain('https://github.com/Expensify/App/pull/10');
+            expect(result?.body).toContain('https://github.com/Expensify/App/pull/11');
+            expect(result?.body).not.toContain('https://github.com/Expensify/App/pull/6');
+            expect(result?.body).not.toContain('https://github.com/Expensify/App/pull/8');
+
+            mockGetStagingDeployCashData.mockRestore();
+        });
+    });
 });