Merge pull request #38045 from VickyStash/ts-migration/g24-tests

[No QA] [TS migration] Migrate 'test.test.js', 'reviewerChecklist.test.js', 'preDeploy.test.js', 'platformDeploy.test.js', 'lockDeploys.test.js' workflow test to TypeScript
Expensify · Mar 28, 2024 · ff961e4 · ff961e4
2 parents 70b4bc5 + e5f22b5
commit ff961e4
Show file tree

Hide file tree

Showing 11 changed files with 153 additions and 126 deletions.
diff --git a/workflow_tests/assertions/lockDeploysAssertions.ts b/workflow_tests/assertions/lockDeploysAssertions.ts
@@ -71,4 +71,4 @@ function assertlockStagingDeploysJobFailedAfterFirstStep(workflowResult: Step[])
     });
 }
 
-export {assertlockStagingDeploysJobExecuted, assertlockStagingDeploysJobFailedAfterFirstStep};
+export default {assertlockStagingDeploysJobExecuted, assertlockStagingDeploysJobFailedAfterFirstStep};
diff --git a/workflow_tests/assertions/platformDeployAssertions.ts b/workflow_tests/assertions/platformDeployAssertions.ts
@@ -376,7 +376,7 @@ function assertPostGithubCommentJobExecuted(workflowResult: Step[], didExecute =
     });
 }
 
-export {
+export default {
     assertVerifyActorJobExecuted,
     assertDeployChecklistJobExecuted,
     assertAndroidJobExecuted,

diff --git a/workflow_tests/assertions/reviewerChecklistAssertions.ts b/workflow_tests/assertions/reviewerChecklistAssertions.ts
@@ -13,5 +13,4 @@ function assertChecklistJobExecuted(workflowResult: Step[], didExecute = true) {
     });
 }
 
-// eslint-disable-next-line import/prefer-default-export
-export {assertChecklistJobExecuted};
+export default {assertChecklistJobExecuted};
diff --git a/workflow_tests/assertions/testAssertions.ts b/workflow_tests/assertions/testAssertions.ts
@@ -54,4 +54,4 @@ function assertShellTestsJobExecuted(workflowResult: Step[], didExecute = true)
     });
 }
 
-export {assertJestJobExecuted, assertShellTestsJobExecuted};
+export default {assertJestJobExecuted, assertShellTestsJobExecuted};
diff --git a/workflow_tests/lockDeploys.test.js → workflow_tests/lockDeploys.test.ts b/workflow_tests/lockDeploys.test.js → workflow_tests/lockDeploys.test.ts
@@ -1,13 +1,17 @@
-const path = require('path');
-const kieMockGithub = require('@kie/mock-github');
-const utils = require('./utils/utils');
-const assertions = require('./assertions/lockDeploysAssertions');
-const mocks = require('./mocks/lockDeploysMocks').default;
-const ExtendedAct = require('./utils/ExtendedAct').default;
+import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import * as kieMockGithub from '@kie/mock-github';
+import type {CreateRepositoryFile, MockGithub} from '@kie/mock-github';
+import path from 'path';
+import assertions from './assertions/lockDeploysAssertions';
+import mocks from './mocks/lockDeploysMocks';
+import ExtendedAct from './utils/ExtendedAct';
+import * as utils from './utils/utils';
 
 jest.setTimeout(90 * 1000);
-let mockGithub;
-const FILES_TO_COPY_INTO_TEST_REPO = [
+
+let mockGithub: MockGithub;
+
+const FILES_TO_COPY_INTO_TEST_REPO: CreateRepositoryFile[] = [
     ...utils.deepCopy(utils.FILES_TO_COPY_INTO_TEST_REPO),
     {
         src: path.resolve(__dirname, '..', '.github', 'workflows', 'lockDeploys.yml'),
@@ -16,7 +20,7 @@ const FILES_TO_COPY_INTO_TEST_REPO = [
 ];
 
 describe('test workflow lockDeploys', () => {
-    beforeAll(async () => {
+    beforeAll(() => {
         // in case of the tests being interrupted without cleanup the mock repo directory may be left behind
         // which breaks the next test run, this removes any possible leftovers
         utils.removeMockRepoDir();
@@ -43,7 +47,7 @@ describe('test workflow lockDeploys', () => {
             describe('issue has StagingDeployCash', () => {
                 describe('actor is not OSBotify', () => {
                     it('job triggered, comment left in StagingDeployCash', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -71,7 +75,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         const result = await act.runEvent('issues', {
@@ -85,7 +89,7 @@ describe('test workflow lockDeploys', () => {
                     });
 
                     it('one step fails, comment not left in StagingDeployCash, announced failure in Slack', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -113,7 +117,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         testMockSteps.lockStagingDeploys[1] = utils.createMockStep(
@@ -139,7 +143,7 @@ describe('test workflow lockDeploys', () => {
 
                 describe('actor is OSBotify', () => {
                     it('job not triggered, comment not left in StagingDeployCash', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -167,7 +171,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         const result = await act.runEvent('issues', {
@@ -185,7 +189,7 @@ describe('test workflow lockDeploys', () => {
             describe('issue does not have StagingDeployCash', () => {
                 describe('actor is not OSBotify', () => {
                     it('job not triggered, comment not left in StagingDeployCash', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -213,7 +217,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         const result = await act.runEvent('issues', {
@@ -229,7 +233,7 @@ describe('test workflow lockDeploys', () => {
 
                 describe('actor is OSBotify', () => {
                     it('job not triggered, comment not left in StagingDeployCash', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -257,7 +261,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         const result = await act.runEvent('issues', {
@@ -277,7 +281,7 @@ describe('test workflow lockDeploys', () => {
             describe('issue has StagingDeployCash', () => {
                 describe('actor is not OSBotify', () => {
                     it('job not triggered, comment not left in StagingDeployCash', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -305,7 +309,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         const result = await act.runEvent('issues', {
@@ -321,7 +325,7 @@ describe('test workflow lockDeploys', () => {
 
                 describe('actor is OSBotify', () => {
                     it('job not triggered, comment not left in StagingDeployCash', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -349,7 +353,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         const result = await act.runEvent('issues', {
@@ -367,7 +371,7 @@ describe('test workflow lockDeploys', () => {
             describe('issue does not have StagingDeployCash', () => {
                 describe('actor is not OSBotify', () => {
                     it('job not triggered, comment not left in StagingDeployCash', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -395,7 +399,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         const result = await act.runEvent('issues', {
@@ -411,7 +415,7 @@ describe('test workflow lockDeploys', () => {
 
                 describe('actor is OSBotify', () => {
                     it('job not triggered, comment not left in StagingDeployCash', async () => {
-                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') || '';
+                        const repoPath = mockGithub.repo.getPath('testLockDeploysWorkflowRepo') ?? '';
                         const workflowPath = path.join(repoPath, '.github', 'workflows', 'lockDeploys.yml');
                         let act = new ExtendedAct(repoPath, workflowPath);
                         act = utils.setUpActParams(
@@ -439,7 +443,7 @@ describe('test workflow lockDeploys', () => {
                             },
                             workflowPath,
                         );
-                        const testMockSteps = {
+                        const testMockSteps: MockStep = {
                             lockStagingDeploys: mocks.LOCKDEPLOYS__LOCKSTAGINGDEPLOYS__STEP_MOCKS,
                         };
                         const result = await act.runEvent('issues', {

diff --git a/workflow_tests/mocks/platformDeployMocks.ts b/workflow_tests/mocks/platformDeployMocks.ts
@@ -269,7 +269,7 @@ const PLATFORM_DEPLOY__POST_GITHUB_COMMENT__STEP_MOCKS = [
     PLATFORM_DEPLOY__POST_GIHUB_COMMENT__COMMENT__STEP_MOCK,
 ];
 
-export {
+export default {
     PLATFORM_DEPLOY__VALIDATE_ACTOR__TEAM_MEMBER__STEP_MOCKS,
     PLATFORM_DEPLOY__VALIDATE_ACTOR__OUTSIDER__STEP_MOCKS,
     PLATFORM_DEPLOY__ANDROID__STEP_MOCKS,

diff --git a/workflow_tests/mocks/testMocks.ts b/workflow_tests/mocks/testMocks.ts
@@ -21,4 +21,4 @@ const TEST__SHELLTESTS__SETUP_NODE__STEP_MOCK = createMockStep('Setup Node', 'Se
 const TEST__SHELLTESTS__TEST_CI_GIT_LOGIC__STEP_MOCK = createMockStep('Test CI git logic', 'Test CI git logic', 'SHELLTESTS', [], []);
 const TEST__SHELLTESTS__STEP_MOCKS = [TEST__SHELLTESTS__CHECKOUT__STEP_MOCK, TEST__SHELLTESTS__SETUP_NODE__STEP_MOCK, TEST__SHELLTESTS__TEST_CI_GIT_LOGIC__STEP_MOCK];
 
-export {TEST__JEST__STEP_MOCKS, TEST__SHELLTESTS__STEP_MOCKS};
+export default {TEST__JEST__STEP_MOCKS, TEST__SHELLTESTS__STEP_MOCKS};
-Original file line number
+Diff line change
@@ Expand Up @@
         });
     }
-    export {assertlockStagingDeploysJobExecuted, assertlockStagingDeploysJobFailedAfterFirstStep};
+    export default {assertlockStagingDeploysJobExecuted, assertlockStagingDeploysJobFailedAfterFirstStep};