Merge pull request #38491 from software-mansion-labs/@szymczak/migrat…

…e-workflow-tests [No QA][TS migration] migrate workflow tests
Expensify · Apr 2, 2024 · 5c3640f · 5c3640f
2 parents d5cf51d + 95c70e8
commit 5c3640f
Show file tree

Hide file tree

Showing 12 changed files with 86 additions and 81 deletions.
diff --git a/workflow_tests/assertions/testBuildAssertions.ts b/workflow_tests/assertions/testBuildAssertions.ts
@@ -397,7 +397,7 @@ function assertPostGithubCommentJobExecuted(
     });
 }
 
-export {
+export default {
     assertValidateActorJobExecuted,
     assertGetBranchRefJobExecuted,
     assertAndroidJobExecuted,

diff --git a/workflow_tests/assertions/validateGithubActionsAssertions.ts b/workflow_tests/assertions/validateGithubActionsAssertions.ts
@@ -18,5 +18,4 @@ function assertVerifyJobExecuted(workflowResult: Step[], didExecute = true) {
     });
 }
 
-// eslint-disable-next-line import/prefer-default-export
-export {assertVerifyJobExecuted};
+export default {assertVerifyJobExecuted};
diff --git a/workflow_tests/assertions/verifyPodfileAssertions.ts b/workflow_tests/assertions/verifyPodfileAssertions.ts
@@ -17,5 +17,4 @@ function assertVerifyJobExecuted(workflowResult: Step[], didExecute = true) {
     });
 }
 
-// eslint-disable-next-line import/prefer-default-export
-export {assertVerifyJobExecuted};
+export default {assertVerifyJobExecuted};
diff --git a/workflow_tests/assertions/verifySignedCommitsAssertions.ts b/workflow_tests/assertions/verifySignedCommitsAssertions.ts
@@ -14,4 +14,4 @@ function assertVerifySignedCommitsJobExecuted(workflowResult: Step[], didExecute
 }
 
 // eslint-disable-next-line import/prefer-default-export
-export {assertVerifySignedCommitsJobExecuted};
+export default {assertVerifySignedCommitsJobExecuted};
diff --git a/workflow_tests/jest.config.js b/workflow_tests/jest.config.js
diff --git a/workflow_tests/jest.config.ts b/workflow_tests/jest.config.ts
@@ -0,0 +1,13 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import type {Config} from 'jest';
+
+const config: Config = {
+    verbose: true,
+    transform: {
+        '^.+\\.(js|jsx|ts|tsx)$': 'ts-jest',
+    },
+    clearMocks: true,
+    resetMocks: true,
+};
+
+export default config;
diff --git a/workflow_tests/mocks/testBuildMocks.ts b/workflow_tests/mocks/testBuildMocks.ts
@@ -247,7 +247,7 @@ const TESTBUILD__POSTGITHUBCOMMENT__STEP_MOCKS = [
     TESTBUILD__POSTGITHUBCOMMENT__PUBLISH_LINKS_TO_APPS_FOR_DOWNLOAD__STEP_MOCK,
 ];
 
-export {
+export default {
     TESTBUILD__VALIDATEACTOR__TEAM_MEMBER_HAS_FLAG__STEP_MOCKS,
     TESTBUILD__VALIDATEACTOR__TEAM_MEMBER_NO_FLAG__STEP_MOCKS,
     TESTBUILD__VALIDATEACTOR__NO_TEAM_MEMBER_HAS_FLAG__STEP_MOCKS,

diff --git a/workflow_tests/scripts/runWorkflowTests.sh b/workflow_tests/scripts/runWorkflowTests.sh
@@ -60,4 +60,4 @@ info 'ACT_BINARY environment variable set to an Act executable'
 success 'Environment setup properly - running tests'
 
 # Run tests
-npm test -- --config=workflow_tests/jest.config.js --runInBand "$@"
+npm test -- --config=workflow_tests/jest.config.ts --runInBand "$@"
diff --git a/workflow_tests/testBuild.test.js → workflow_tests/testBuild.test.ts b/workflow_tests/testBuild.test.js → workflow_tests/testBuild.test.ts
@@ -1,12 +1,13 @@
-const path = require('path');
-const kieMockGithub = require('@kie/mock-github');
-const utils = require('./utils/utils');
-const assertions = require('./assertions/testBuildAssertions');
-const mocks = require('./mocks/testBuildMocks');
-const ExtendedAct = require('./utils/ExtendedAct').default;
+/* eslint-disable @typescript-eslint/naming-convention */
+import {MockGithub} from '@kie/mock-github';
+import path from 'path';
+import assertions from './assertions/testBuildAssertions';
+import mocks from './mocks/testBuildMocks';
+import ExtendedAct from './utils/ExtendedAct';
+import * as utils from './utils/utils';
 
 jest.setTimeout(90 * 1000);
-let mockGithub;
+let mockGithub: MockGithub;
 const FILES_TO_COPY_INTO_TEST_REPO = [
     ...utils.deepCopy(utils.FILES_TO_COPY_INTO_TEST_REPO),
     {
@@ -32,15 +33,15 @@ describe('test workflow testBuild', () => {
         MYAPP_UPLOAD_KEY_PASSWORD: 'dummy_myapp_upload_key_password',
     };
 
-    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();
     });
 
     beforeEach(async () => {
         // create a local repository and copy required files
-        mockGithub = new kieMockGithub.MockGithub({
+        mockGithub = new MockGithub({
             repo: {
                 testTestBuildWorkflowRepo: {
                     files: FILES_TO_COPY_INTO_TEST_REPO,
@@ -60,7 +61,7 @@ describe('test workflow testBuild', () => {
             PULL_REQUEST_NUMBER: '1234',
         };
         it('executes workflow', async () => {
-            const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+            const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
             const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
             let act = new ExtendedAct(repoPath, workflowPath);
             act = utils.setUpActParams(act, event, {}, secrets, githubToken, {}, inputs);
@@ -91,7 +92,7 @@ describe('test workflow testBuild', () => {
         });
         describe('actor is not a team member', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, {}, secrets, githubToken, {}, inputs);
@@ -123,7 +124,7 @@ describe('test workflow testBuild', () => {
         });
         describe('PR does not have READY_TO_BUILD label', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, {}, secrets, githubToken, {}, inputs);
@@ -155,7 +156,7 @@ describe('test workflow testBuild', () => {
         });
         describe('actor is not a team member and PR does not have READY_TO_BUILD label', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, {}, secrets, githubToken, {}, inputs);
@@ -187,7 +188,7 @@ describe('test workflow testBuild', () => {
         });
         describe('android fails', () => {
             it('executes workflow, failure reflected', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, {}, secrets, githubToken, {}, inputs);
@@ -220,7 +221,7 @@ describe('test workflow testBuild', () => {
         });
         describe('iOS fails', () => {
             it('executes workflow, failure reflected', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, {}, secrets, githubToken, {}, inputs);
@@ -253,7 +254,7 @@ describe('test workflow testBuild', () => {
         });
         describe('desktop fails', () => {
             it('executes workflow, failure reflected', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, {}, secrets, githubToken, {}, inputs);
@@ -295,7 +296,7 @@ describe('test workflow testBuild', () => {
         });
         describe('web fails', () => {
             it('executes workflow, failure reflected', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, {}, secrets, githubToken, {}, inputs);
@@ -348,7 +349,7 @@ describe('test workflow testBuild', () => {
             },
         };
         it('executes workflow, without getBranchRef', async () => {
-            const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+            const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
             const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
             let act = new ExtendedAct(repoPath, workflowPath);
             act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -379,7 +380,7 @@ describe('test workflow testBuild', () => {
         });
         describe('actor is not a team member', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -411,7 +412,7 @@ describe('test workflow testBuild', () => {
         });
         describe('PR does not have READY_TO_BUILD label', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -443,7 +444,7 @@ describe('test workflow testBuild', () => {
         });
         describe('actor is not a team member and PR does not have READY_TO_BUILD label', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -486,7 +487,7 @@ describe('test workflow testBuild', () => {
             },
         };
         it('executes workflow, without getBranchRef', async () => {
-            const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+            const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
             const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
             let act = new ExtendedAct(repoPath, workflowPath);
             act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -517,7 +518,7 @@ describe('test workflow testBuild', () => {
         });
         describe('actor is not a team member', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -549,7 +550,7 @@ describe('test workflow testBuild', () => {
         });
         describe('PR does not have READY_TO_BUILD label', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -581,7 +582,7 @@ describe('test workflow testBuild', () => {
         });
         describe('actor is not a team member and PR does not have READY_TO_BUILD label', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -624,7 +625,7 @@ describe('test workflow testBuild', () => {
             },
         };
         it('executes workflow, withuout getBranchRef', async () => {
-            const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+            const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
             const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
             let act = new ExtendedAct(repoPath, workflowPath);
             act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -655,7 +656,7 @@ describe('test workflow testBuild', () => {
         });
         describe('actor is not a team member', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -687,7 +688,7 @@ describe('test workflow testBuild', () => {
         });
         describe('PR does not have READY_TO_BUILD label', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});
@@ -719,7 +720,7 @@ describe('test workflow testBuild', () => {
         });
         describe('actor is not a team member and PR does not have READY_TO_BUILD label', () => {
             it('stops the workflow after validation', async () => {
-                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') || '';
+                const repoPath = mockGithub.repo.getPath('testTestBuildWorkflowRepo') ?? '';
                 const workflowPath = path.join(repoPath, '.github', 'workflows', 'testBuild.yml');
                 let act = new ExtendedAct(repoPath, workflowPath);
                 act = utils.setUpActParams(act, event, eventOptions, secrets, githubToken, {});

diff --git a/workflow_tests/validateGithubActions.test.js → workflow_tests/validateGithubActions.test.ts b/workflow_tests/validateGithubActions.test.js → workflow_tests/validateGithubActions.test.ts
@@ -1,12 +1,12 @@
-const path = require('path');
-const kieMockGithub = require('@kie/mock-github');
-const utils = require('./utils/utils');
-const assertions = require('./assertions/validateGithubActionsAssertions');
-const mocks = require('./mocks/validateGithubActionsMocks').default;
-const ExtendedAct = require('./utils/ExtendedAct').default;
+import {MockGithub} from '@kie/mock-github';
+import path from 'path';
+import assertions from './assertions/validateGithubActionsAssertions';
+import mocks from './mocks/validateGithubActionsMocks';
+import ExtendedAct from './utils/ExtendedAct';
+import * as utils from './utils/utils';
 
 jest.setTimeout(90 * 1000);
-let mockGithub;
+let mockGithub: MockGithub;
 const FILES_TO_COPY_INTO_TEST_REPO = [
     ...utils.deepCopy(utils.FILES_TO_COPY_INTO_TEST_REPO),
     {
@@ -19,15 +19,15 @@ describe('test workflow validateGithubActions', () => {
     const githubToken = 'dummy_github_token';
     const actor = 'Dummy Actor';
 
-    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();
     });
 
     beforeEach(async () => {
         // create a local repository and copy required files
-        mockGithub = new kieMockGithub.MockGithub({
+        mockGithub = new MockGithub({
             repo: {
                 testValidateGithubActionsWorkflowRepo: {
                     files: FILES_TO_COPY_INTO_TEST_REPO,
@@ -47,7 +47,7 @@ describe('test workflow validateGithubActions', () => {
             action: 'opened',
         };
         it('executes verification', async () => {
-            const repoPath = mockGithub.repo.getPath('testValidateGithubActionsWorkflowRepo') || '';
+            const repoPath = mockGithub.repo.getPath('testValidateGithubActionsWorkflowRepo') ?? '';
             const workflowPath = path.join(repoPath, '.github', 'workflows', 'validateGithubActions.yml');
             let act = new ExtendedAct(repoPath, workflowPath);
             act = utils.setUpActParams(act, event, eventOptions, {}, githubToken);
@@ -70,7 +70,7 @@ describe('test workflow validateGithubActions', () => {
             action: 'synchronize',
         };
         it('executes verification', async () => {
-            const repoPath = mockGithub.repo.getPath('testValidateGithubActionsWorkflowRepo') || '';
+            const repoPath = mockGithub.repo.getPath('testValidateGithubActionsWorkflowRepo') ?? '';
             const workflowPath = path.join(repoPath, '.github', 'workflows', 'validateGithubActions.yml');
             let act = new ExtendedAct(repoPath, workflowPath);
             act = utils.setUpActParams(act, event, eventOptions, {}, githubToken);