[TS migration] Migrate 'utils' workflow test to TypeScript

package.json

@@ -56,7 +56,7 @@
     "test:e2e:dev": "ts-node tests/e2e/testRunner.ts --config ./config.dev.ts",
     "gh-actions-unused-styles": "./.github/scripts/findUnusedKeys.sh",
     "workflow-test": "./workflow_tests/scripts/runWorkflowTests.sh",
-    "workflow-test:generate": "ts-node workflow_tests/utils/preGenerateTest.js",
+    "workflow-test:generate": "ts-node workflow_tests/utils/preGenerateTest.ts",
     "setup-https": "mkcert -install && mkcert -cert-file config/webpack/certificate.pem -key-file config/webpack/key.pem dev.new.expensify.com localhost 127.0.0.1",
     "e2e-test-runner-build": "ncc build tests/e2e/testRunner.ts -o tests/e2e/dist/"
   },
@@ -286,6 +286,7 @@
     "shellcheck": "^1.1.0",
     "style-loader": "^2.0.0",
     "time-analytics-webpack-plugin": "^0.1.17",
+    "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "type-fest": "^4.10.2",
     "typescript": "^5.3.2",

tsconfig.json

@@ -48,6 +48,6 @@
         }
     },
     "exclude": ["**/node_modules/*", "**/dist/*", ".github/actions/**/index.js", "**/docs/*"],
-    "include": ["src", "desktop", "web", "website", "docs", "assets", "config", "tests", "jest", "__mocks__", ".github/**/*", ".storybook/**/*"],
+    "include": ["src", "desktop", "web", "website", "docs", "assets", "config", "tests", "jest", "__mocks__", ".github/**/*", ".storybook/**/*", "workflow_tests"],
     "extends": "expo/tsconfig.base"
 }

workflow_tests/jest.config.js

@@ -2,6 +2,7 @@ module.exports = {
     verbose: true,
     transform: {
         '^.+\\.jsx?$': 'babel-jest',
+        '^.+\\.tsx?$': 'ts-jest',
     },
     clearMocks: true,
     resetMocks: true,

workflow_tests/utils/ExtendedAct.ts

@@ -0,0 +1,50 @@
+/* eslint-disable @typescript-eslint/dot-notation */
+// This eslint-disable comment is here to allow accessing private properties in the Act class
+import type {RunOpts, Workflow} from '@kie/act-js';
+import * as kieActJs from '@kie/act-js';
+import path from 'path';
+import {JobMocker} from './JobMocker';
+import type {MockJob} from './JobMocker';
+
+type ExtendedActOpts = RunOpts & {actor?: string; workflowFile?: string; mockJobs?: Record<string, MockJob>};
+
+// @ts-expect-error Override shouldn't be done on private methods wait until https://github.com/kiegroup/act-js/issues/77 is resolved or try to create a params workaround
+class ExtendedAct extends kieActJs.Act {
+    async parseRunOpts(opts?: ExtendedActOpts) {
+        const {cwd, actArguments, proxy} = await super['parseRunOpts'](opts);
+        if (opts?.actor) {
+            actArguments.push('--actor', opts.actor);
+        }
+        return {cwd, actArguments, proxy};
+    }
+
+    async runEvent(event: string, opts?: ExtendedActOpts) {
+        const {mockJobs, ...vanillaOpts} = opts ?? {};
+
+        if (mockJobs) {
+            await this.handleJobMocking((workflow) => workflow.events.includes(event), {mockJobs, workflowFile: opts?.workflowFile, cwd: opts?.cwd});
+        }
+        return super.runEvent(event, vanillaOpts);
+    }
+
+    async handleJobMocking(filter: (workflow: Workflow) => boolean, opts?: ExtendedActOpts) {
+        let workflowFiles: string[];
+        if (opts?.workflowFile) {
+            workflowFiles = [path.basename(opts.workflowFile)];
+        } else if (this['workflowFile'] !== this['cwd']) {
+            workflowFiles = [path.basename(this['workflowFile'])];
+        } else {
+            const availableWorkflows = await this.list(undefined, opts?.cwd, opts?.workflowFile);
+            workflowFiles = availableWorkflows.filter(filter).map((workflow: Workflow) => workflow.workflowFile);
+        }
+        return Promise.all(
+            workflowFiles.map((workflowFile) => {
+                const jobMocker = new JobMocker(workflowFile, opts?.cwd ?? this['cwd']);
+                return jobMocker.mock(opts?.mockJobs);
+            }),
+        );
+    }
+}
+
+// eslint-disable-next-line import/prefer-default-export
+export {ExtendedAct};

workflow_tests/utils/JobMocker.js → workflow_tests/utils/JobMocker.ts

@@ -1,17 +1,48 @@
-const fs = require('fs');
-const path = require('path');
-const yaml = require('yaml');
-const _ = require('underscore');
+import type {PathOrFileDescriptor} from 'fs';
+import fs from 'fs';
+import path from 'path';
+import yaml from 'yaml';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+type YamlMockJob = Omit<MockJob, 'runsOn'> & {'runs-on'?: string};
+
+type YamlWorkflow = {
+    jobs: Record<string, YamlMockJob>;
+};
+
+type MockJob = {
+    steps: MockJobStep[];
+    uses?: string;
+    secrets?: string[];
+    with?: string;
+    outputs?: string[];
+    runsOn: string;
+};
+
+type MockJobStep = {
+    id?: string;
+    name: string;
+    run?: string;
+    mockWith?: string;
+    with?: string;
+    envs?: string[];
+    inputs?: string[];
+};
 
 class JobMocker {
-    constructor(workflowFile, cwd) {
+    workflowFile: string;
+
+    cwd: string;
+
+    constructor(workflowFile: string, cwd: string) {
         this.workflowFile = workflowFile;
         this.cwd = cwd;
     }
 
-    async mock(mockJobs) {
+    mock(mockJobs: Record<string, MockJob> = {}) {
         const filePath = this.getWorkflowPath();
-        const workflow = await this.readWorkflowFile(filePath);
+        const workflow = this.readWorkflowFile(filePath);
+
         Object.entries(mockJobs).forEach(([jobId, mockJob]) => {
             const job = this.locateJob(workflow, jobId);
             if (job) {
@@ -21,13 +52,13 @@ class JobMocker {
                 if (job.secrets) {
                     delete job.secrets;
                 }
-                let jobWith;
+                let jobWith: string | undefined;
                 if (job.with) {
                     jobWith = job.with;
                     delete job.with;
                 }
-                job.steps = _(mockJob.steps).map((step) => {
-                    const mockStep = {
+                job.steps = mockJob.steps.map((step) => {
+                    const mockStep: MockJobStep = {
                         name: step.name,
                         run: step.mockWith,
                     };
@@ -52,7 +83,7 @@ class JobMocker {
         return this.writeWorkflowFile(filePath, workflow);
     }
 
-    locateJob(workflow, jobId) {
+    locateJob(workflow: YamlWorkflow, jobId: string) {
         return workflow.jobs[jobId];
     }
 
@@ -69,15 +100,17 @@ class JobMocker {
         throw new Error(`Could not locate ${this.workflowFile}`);
     }
 
-    async readWorkflowFile(location) {
-        return yaml.parse(fs.readFileSync(location, 'utf8'));
+    readWorkflowFile(location: PathOrFileDescriptor) {
+        const test: YamlWorkflow = yaml.parse(fs.readFileSync(location, 'utf8'));
+
+        return test;
     }
 
-    async writeWorkflowFile(location, data) {
+    writeWorkflowFile(location: PathOrFileDescriptor, data: YamlWorkflow) {
         return fs.writeFileSync(location, yaml.stringify(data), 'utf8');
     }
 }
 
-module.exports = {
-    JobMocker,
-};
+// eslint-disable-next-line import/prefer-default-export
+export {JobMocker};
+export type {MockJob, YamlWorkflow, YamlMockJob, MockJobStep};