Fix @kie/act-js types

Expensify · Jun 17, 2024 · c708fe4 · c708fe4
1 parent ba0b925
commit c708fe4
Show file tree

Hide file tree

Showing 20 changed files with 50 additions and 52 deletions.
diff --git a/src/types/modules/act.d.ts b/src/types/modules/act.d.ts
@@ -0,0 +1,17 @@
+import type {MockStep as ActMockStep, StepIdentifier as ActStepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+
+declare module '@kie/act-js' {
+    type StepIdentifier = ActStepIdentifier & {
+        id?: string;
+        name: string;
+        run?: string;
+        mockWith?: string;
+        with?: string;
+        envs?: string[];
+        inputs?: string[];
+    };
+
+    type MockStep = ActMockStep;
+
+    export type {StepIdentifier, MockStep};
+}
diff --git a/workflow_tests/authorChecklist.test.ts b/workflow_tests/authorChecklist.test.ts
@@ -1,4 +1,4 @@
-import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {MockStep} from '@kie/act-js';
 import {MockGithub} from '@kie/mock-github';
 import type {CreateRepositoryFile} from '@kie/mock-github';
 import path from 'path';

diff --git a/workflow_tests/cherryPick.test.ts b/workflow_tests/cherryPick.test.ts
@@ -1,4 +1,4 @@
-import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {MockStep} from '@kie/act-js';
 import {MockGithub} from '@kie/mock-github';
 import type {CreateRepositoryFile} from '@kie/mock-github';
 import path from 'path';

diff --git a/workflow_tests/failureNotifier.test.ts b/workflow_tests/failureNotifier.test.ts
@@ -1,4 +1,4 @@
-import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {MockStep} from '@kie/act-js';
 import {MockGithub} from '@kie/mock-github';
 import type {CreateRepositoryFile} from '@kie/mock-github';
 import path from 'path';

diff --git a/workflow_tests/lockDeploys.test.ts b/workflow_tests/lockDeploys.test.ts
@@ -1,4 +1,4 @@
-import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {MockStep} from '@kie/act-js';
 import {MockGithub} from '@kie/mock-github';
 import type {CreateRepositoryFile} from '@kie/mock-github';
 import path from 'path';

diff --git a/workflow_tests/mocks/authorChecklistMocks.ts b/workflow_tests/mocks/authorChecklistMocks.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import {createMockStep} from '../utils/utils';
 
 // checklist

diff --git a/workflow_tests/mocks/cherryPickMocks.ts b/workflow_tests/mocks/cherryPickMocks.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import {createMockStep} from '../utils/utils';
 
 // validateactor

diff --git a/workflow_tests/mocks/createNewVersionMocks.ts b/workflow_tests/mocks/createNewVersionMocks.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import {createMockStep} from '../utils/utils';
 
 // validateactor

diff --git a/workflow_tests/mocks/deployBlockerMocks.ts b/workflow_tests/mocks/deployBlockerMocks.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import {createMockStep} from '../utils/utils';
 
 // updateChecklist

diff --git a/workflow_tests/mocks/deployMocks.ts b/workflow_tests/mocks/deployMocks.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import {createMockStep} from '../utils/utils';
 
 const DEPLOY_STAGING__CHECKOUT__STEP_MOCK = createMockStep('Checkout staging branch', 'Checking out staging branch', 'DEPLOY_STAGING', ['ref', 'token']);

diff --git a/workflow_tests/mocks/finishReleaseCycleMocks.ts b/workflow_tests/mocks/finishReleaseCycleMocks.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import {createMockStep} from '../utils/utils';
 
 // validate

diff --git a/workflow_tests/mocks/lintMocks.ts b/workflow_tests/mocks/lintMocks.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import {createMockStep} from '../utils/utils';
 
 // lint

diff --git a/workflow_tests/platformDeploy.test.ts b/workflow_tests/platformDeploy.test.ts
@@ -1,4 +1,4 @@
-import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {MockStep} from '@kie/act-js';
 import {MockGithub} from '@kie/mock-github';
 import type {CreateRepositoryFile} from '@kie/mock-github';
 import path from 'path';

diff --git a/workflow_tests/preDeploy.test.ts b/workflow_tests/preDeploy.test.ts
@@ -1,4 +1,4 @@
-import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {MockStep} from '@kie/act-js';
 import {MockGithub} from '@kie/mock-github';
 import type {CreateRepositoryFile} from '@kie/mock-github';
 import path from 'path';

diff --git a/workflow_tests/reviewerChecklist.test.ts b/workflow_tests/reviewerChecklist.test.ts
@@ -1,4 +1,4 @@
-import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {MockStep} from '@kie/act-js';
 import {MockGithub} from '@kie/mock-github';
 import type {CreateRepositoryFile} from '@kie/mock-github';
 import path from 'path';

diff --git a/workflow_tests/test.test.ts b/workflow_tests/test.test.ts
@@ -1,4 +1,4 @@
-import type {MockStep} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {MockStep} from '@kie/act-js';
 import {MockGithub} from '@kie/mock-github';
 import type {CreateRepositoryFile} from '@kie/mock-github';
 import path from 'path';

diff --git a/workflow_tests/utils/JobMocker.ts b/workflow_tests/utils/JobMocker.ts
@@ -1,9 +1,8 @@
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import type {PathOrFileDescriptor} from 'fs';
 import fs from 'fs';
 import path from 'path';
 import yaml from 'yaml';
-import type CustemStepIdentifier from './types';
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
 type YamlMockJob = Omit<MockJob, 'runsOn'> & {'runs-on'?: string};
@@ -13,7 +12,7 @@ type YamlWorkflow = {
 };
 
 type MockJob = {
-    steps: Array<CustemStepIdentifier | StepIdentifier>;
+    steps: StepIdentifier[];
     uses?: string;
     secrets?: string[];
     with?: string;
@@ -52,13 +51,12 @@ class JobMocker {
                     delete job.with;
                 }
                 job.steps = mockJob.steps.map((step) => {
-                    const customStep = step as CustemStepIdentifier;
-                    const mockStep: CustemStepIdentifier = {
-                        name: customStep.name,
+                    const mockStep = {
+                        name: step.name,
                         run: step.mockWith,
-                    };
-                    if (customStep.id) {
-                        mockStep.id = customStep.id;
+                    } as StepIdentifier;
+                    if (step.id) {
+                        mockStep.id = step.id;
                     }
                     if (jobWith) {
                         mockStep.with = jobWith;

diff --git a/workflow_tests/utils/preGenerateTest.ts b/workflow_tests/utils/preGenerateTest.ts
@@ -1,12 +1,11 @@
 /* eslint no-console: ["error", { allow: ["warn", "log"] }] */
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
+import type {StepIdentifier} from '@kie/act-js';
 import type {PathLike} from 'fs';
 import fs from 'fs';
 import path from 'path';
 import {exit} from 'process';
 import yaml from 'yaml';
 import type {YamlMockJob, YamlWorkflow} from './JobMocker';
-import type CustemStepIdentifier from './types';
 
 const workflowsDirectory = path.resolve(__dirname, '..', '..', '.github', 'workflows');
 const workflowTestsDirectory = path.resolve(__dirname, '..');
@@ -93,7 +92,7 @@ describe('test workflow ${workflowName}', () => {
 });
 `;
 
-const mockStepTemplate = (stepMockName: string, step: CustemStepIdentifier, jobId: string | undefined) => `
+const mockStepTemplate = (stepMockName: string, step: StepIdentifier, jobId: string | undefined) => `
 const ${stepMockName} = utils.createMockStep(
     '${step.name ?? ''}',
     '${step.name ?? ''}',
@@ -201,12 +200,11 @@ const parseWorkflowFile = (workflow: YamlWorkflow) => {
             steps: [],
         };
         job.steps.forEach((step) => {
-            const step2 = step as CustemStepIdentifier;
             const workflowStep = {
-                name: step2.name ?? '',
-                inputs: Object.keys(step2.with ?? {}),
-                envs: step2.envs ?? [],
-            };
+                name: step.name ?? '',
+                inputs: Object.keys(step.with ?? {}),
+                envs: step.envs ?? [],
+            } as StepIdentifier;
             workflowJobs[jobId].steps.push(workflowStep);
         });
     });
@@ -219,8 +217,7 @@ const getMockFileContent = (workflowName: string, jobs: Record<string, YamlMockJ
         let mockStepsContent = `\n// ${jobId.toLowerCase()}`;
         const stepMocks: string[] = [];
         job.steps.forEach((step) => {
-            const customStep = step as CustemStepIdentifier;
-            const stepMockName = `${workflowName.toUpperCase()}__${jobId.toUpperCase()}__${customStep.name
+            const stepMockName = `${workflowName.toUpperCase()}__${jobId.toUpperCase()}__${step.name
                 .replaceAll(' ', '_')
                 .replaceAll('-', '_')
                 .replaceAll(',', '')
@@ -229,7 +226,7 @@ const getMockFileContent = (workflowName: string, jobs: Record<string, YamlMockJ
                 .replaceAll('.js', '')
                 .toUpperCase()}__STEP_MOCK`;
             stepMocks.push(stepMockName);
-            mockStepsContent += mockStepTemplate(stepMockName, customStep, jobId);
+            mockStepsContent += mockStepTemplate(stepMockName, step, jobId);
         });
 
         const jobMocksName = `${workflowName.toUpperCase()}__${jobId.toUpperCase()}__STEP_MOCKS`;
@@ -246,9 +243,8 @@ const getAssertionsFileContent = (jobs: Record<string, YamlMockJob>): string =>
 
     Object.entries(jobs).forEach(([jobId, job]) => {
         let stepAssertionsContent = '';
-        job.steps.forEach((step: CustemStepIdentifier | StepIdentifier) => {
-            const customStep = step as CustemStepIdentifier;
-            stepAssertionsContent += stepAssertionTemplate(customStep.name, jobId.toUpperCase(), customStep.name, customStep.inputs, customStep.envs);
+        job.steps.forEach((step: StepIdentifier) => {
+            stepAssertionsContent += stepAssertionTemplate(step.name, jobId.toUpperCase(), step.name, step.inputs, step.envs);
         });
         const jobAssertionName = `assert${jobId.charAt(0).toUpperCase() + jobId.slice(1)}JobExecuted`;
         jobAssertions.push(jobAssertionName);

diff --git a/workflow_tests/utils/types.ts b/workflow_tests/utils/types.ts
diff --git a/workflow_tests/utils/utils.ts b/workflow_tests/utils/utils.ts
@@ -1,5 +1,5 @@
+import type {StepIdentifier} from '@kie/act-js';
 import type {EventJSON} from '@kie/act-js/build/src/action-event/action-event.types';
-import type {StepIdentifier} from '@kie/act-js/build/src/step-mocker/step-mocker.types';
 import fs from 'fs';
 import path from 'path';
 import yaml from 'yaml';