test: use Vitest for testing (#564)

* test: use Vitest for testing Signed-off-by: Alfi Maulana <[email protected]> * build: remove `esModuleInterop` option in TypeScript configuration Signed-off-by: Alfi Maulana <[email protected]> --------- Signed-off-by: Alfi Maulana <[email protected]>
threeal · Jan 3, 2025 · db9fa0b · db9fa0b
1 parent 878c102
commit db9fa0b
Show file tree

Hide file tree

Showing 8 changed files with 715 additions and 2,346 deletions.
diff --git a/jest.config.json b/jest.config.json
diff --git a/package.json b/package.json
@@ -6,26 +6,24 @@
     "build": "rollup -c",
     "format": "prettier --write --cache . !dist !README.md",
     "lint": "eslint",
-    "test": "jest"
+    "test": "vitest"
   },
   "dependencies": {
     "gha-utils": "^0.4.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.17.0",
-    "@jest/globals": "^29.7.0",
     "@rollup/plugin-node-resolve": "^16.0.0",
     "@rollup/plugin-typescript": "^12.1.2",
-    "@types/jest": "^29.5.14",
     "@types/node": "^22.10.2",
+    "@vitest/coverage-v8": "^2.1.8",
     "eslint": "^9.17.0",
-    "jest": "^29.7.0",
     "prettier": "^3.4.2",
     "rollup": "^4.29.1",
-    "ts-jest": "^29.2.5",
     "tslib": "^2.8.1",
     "typescript": "^5.7.2",
-    "typescript-eslint": "^8.19.0"
+    "typescript-eslint": "^8.19.0",
+    "vitest": "^2.1.8"
   },
   "packageManager": "[email protected]"
 }
diff --git a/src/cmake.test.ts b/src/cmake.test.ts
@@ -1,5 +1,7 @@
-import { jest } from "@jest/globals";
+import { describe, expect, it, vi } from "vitest";
+import { buildProject, configureProject } from "./cmake.js";
 import type { Context } from "./context.js";
+import { exec } from "./exec.js";
 
 interface TestCase {
   name: string;
@@ -21,9 +23,7 @@ const defaultContext: Context = {
   },
 };
 
-jest.unstable_mockModule("./exec.js", () => ({
-  exec: jest.fn(),
-}));
+vi.mock("./exec.js", () => ({ exec: vi.fn() }));
 
 describe("configure a CMake project", () => {
   const testCases: TestCase[] = [
@@ -100,10 +100,7 @@ describe("configure a CMake project", () => {
 
   for (const testCase of testCases) {
     it(`should execute the correct command ${testCase.name}`, async () => {
-      const { configureProject } = await import("./cmake.js");
-      const { exec } = await import("./exec.js");
-
-      jest.mocked(exec).mockReset();
+      vi.mocked(exec).mockReset();
 
       await configureProject({ ...defaultContext, ...testCase.context });
 
@@ -144,10 +141,7 @@ describe("build a CMake project", () => {
 
   for (const testCase of testCases) {
     it(`should execute the correct command ${testCase.name}`, async () => {
-      const { buildProject } = await import("./cmake.js");
-      const { exec } = await import("./exec.js");
-
-      jest.mocked(exec).mockReset();
+      vi.mocked(exec).mockReset();
 
       await buildProject({ ...defaultContext, ...testCase.context });
 

diff --git a/src/context.test.ts b/src/context.test.ts
@@ -1,10 +1,8 @@
-import { jest } from "@jest/globals";
 import path from "node:path";
+import { describe, expect, it, vi } from "vitest";
 import type { Context } from "./context.js";
 
-jest.unstable_mockModule("gha-utils", () => ({
-  getInput: jest.fn(),
-}));
+vi.mock("gha-utils", () => ({ getInput: vi.fn() }));
 
 describe("get action context", () => {
   interface TestCase {
@@ -186,9 +184,7 @@ describe("get action context", () => {
       const { getContext } = await import("./context.js");
 
       const inputs = testCase.inputs || {};
-      jest.mocked(getInput).mockImplementation((name) => {
-        return inputs[name] || "";
-      });
+      vi.mocked(getInput).mockImplementation((name) => inputs[name] ?? "");
 
       expect(getContext()).toStrictEqual({
         sourceDir: "",

diff --git a/src/exec.test.ts b/src/exec.test.ts
@@ -1,25 +1,24 @@
-import { jest } from "@jest/globals";
+import { logCommand } from "gha-utils";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { exec } from "./exec.js";
 
 describe("execute commands", () => {
-  const logCommand = jest.fn<(command: string, ...args: string[]) => void>();
-  jest.unstable_mockModule("gha-utils", () => ({ logCommand }));
+  vi.mock("gha-utils", () => ({
+    logCommand: vi.fn<(command: string, ...args: string[]) => void>(),
+  }));
 
   beforeEach(() => {
-    logCommand.mockClear();
+    vi.mocked(logCommand).mockClear();
   });
 
   it("should successfully execute a command", async () => {
-    const { exec } = await import("./exec.js");
-
     await exec("node", ["--version"]);
 
     expect(logCommand).toHaveBeenCalledTimes(1);
     expect(logCommand).toHaveBeenCalledWith("node", "--version");
   });
 
   it("should fail to execute a command", async () => {
-    const { exec } = await import("./exec.js");
-
     await expect(exec("node", ["--invalid"])).rejects.toThrow(
       "Command exited with status code 9",
     );

diff --git a/tsconfig.json b/tsconfig.json
@@ -6,7 +6,6 @@
     "strict": true,
     "module": "node16",
     "moduleResolution": "node16",
-    "esModuleInterop": true,
     "target": "es2022",
     "skipLibCheck": true
   }

diff --git a/vitest.config.ts b/vitest.config.ts
@@ -0,0 +1,13 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    watch: false,
+    coverage: {
+      all: false,
+      enabled: true,
+      reporter: ["text"],
+      thresholds: { 100: true },
+    },
+  },
+});