test: migrate to Rstest (#55)

Co-authored-by: 9aoy <9aoyuao@gmail.com>

Author: chenjiahan

package.json

@@ -26,7 +26,7 @@
     "dev": "rslib build -w",
     "lint": "echo lint",
     "test": "pnpm build && pnpm test:unit && pnpm test:e2e",
-    "test:unit": "cross-env jest --config=test/unit/jest.config.js",
+    "test:unit": "rstest --config=test/unit/rstest.config.ts",
     "test:e2e": "cd test/e2e && pnpm test",
     "test:e2e:setup": "cd test/e2e && pnpm run setup",
     "precommit": "pnpm build && pnpm test:unit",
@@ -52,24 +52,18 @@
     }
   },
   "devDependencies": {
-    "@jest/console": "^27.5.1",
     "@rslib/core": "^0.18.2",
     "@rspack/core": "^1.6.5",
+    "@rstest/core": "^0.7.5",
     "@types/babel__code-frame": "^7.0.6",
     "@types/is-glob": "^4.0.4",
-    "@types/jest": "^27.5.2",
     "@types/mock-fs": "^4.13.4",
     "@types/node": "^16.18.126",
     "cross-env": "^10.1.0",
     "husky": "^9.1.7",
-    "jest": "^27.5.1",
-    "jest-circus": "^27.5.1",
-    "jest-environment-node": "^27.5.1",
-    "jest-runner": "^27.5.1",
     "mock-fs": "^5.5.0",
     "prettier": "^3.7.3",
     "strip-ansi": "^6.0.1",
-    "ts-jest": "^27.1.5",
     "typescript": "^5.9.3"
   },
   "publishConfig": {

pnpm-lock.yaml

@@ -1,15 +1,19 @@
 {
-  "compilerOptions": {
-    "target": "es6",
-    "module": "commonjs",
-    "lib": ["ES6"],
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "skipDefaultLibCheck": true,
-    "resolveJsonModule": true,
-    "baseUrl": "../"
-  },
-  "include": ["../src", "**/*.spec.ts"],
-  "exclude": ["node_modules"]
+	"compilerOptions": {
+		"target": "es6",
+		"module": "ESNext",
+		"lib": ["ES6"],
+		"moduleResolution": "Bundler",
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"skipDefaultLibCheck": true,
+		"resolveJsonModule": true,
+		"types": ["@rstest/core/globals"],
+		"paths": {
+			"src": ["../src"]
+		},
+		"baseUrl": "../"
+	},
+	"include": ["../src", "**/*.spec.ts"],
+	"exclude": ["node_modules"]
 }

test/tsconfig.json

@@ -13,17 +13,17 @@ describe('wrapRpc', () => {
     childProcessMock = {
       connected: true,
       pid: 1234,
-      send: jest.fn((message, callback) => {
+      send: rs.fn((message, callback) => {
         messageIds.push(message?.id);
         callback();
       }),
-      on: jest.fn((name, handlerToAdd) => {
+      on: rs.fn((name, handlerToAdd) => {
         if (!eventHandlers[name]) {
           eventHandlers[name] = [];
         }
         eventHandlers[name].push(handlerToAdd);
       }),
-      off: jest.fn((name, handlerToRemove) => {
+      off: rs.fn((name, handlerToRemove) => {
         if (!eventHandlers[name]) {
           return;
         }
@@ -105,7 +105,7 @@ describe('wrapRpc', () => {
       value: 41,
     });
 
-    expect(promise).resolves.toEqual(41);
+    await expect(promise).resolves.toEqual(41);
     expect(eventHandlers).toEqual({
       message: [],
       close: [],
@@ -126,20 +126,20 @@ describe('wrapRpc', () => {
       error: 'sad error',
     });
 
-    expect(promise).rejects.toEqual('sad error');
+    await expect(promise).rejects.toEqual('sad error');
     expect(eventHandlers).toEqual({
       message: [],
       close: [],
     });
   });
 
   it('rejects on send error', async () => {
-    (childProcessMock.send as jest.Mock).mockImplementation((message, callback) =>
+    (childProcessMock.send as rs.Mock).mockImplementation((message, callback) =>
       callback(new Error('cannot send'))
     );
     const wrapped = wrapRpc<() => void>(childProcessMock);
 
-    expect(wrapped()).rejects.toEqual(new Error('cannot send'));
+    await expect(wrapped()).rejects.toEqual(new Error('cannot send'));
     expect(eventHandlers).toEqual({
       message: [],
       close: [],
@@ -158,7 +158,7 @@ describe('wrapRpc', () => {
 
     triggerClose(code, signal);
 
-    expect(promise).rejects.toEqual(new RpcExitError(message, code, signal));
+    await expect(promise).rejects.toEqual(new RpcExitError(message, code, signal));
     expect(eventHandlers).toEqual({
       message: [],
       close: [],

test/unit/rpc/wrap-rpc.spec.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from '@rstest/core';
+
+// Disable color in test
+process.env.NO_COLOR = '1';
+process.env.FORCE_COLOR = '0';
+
+export default defineConfig({
+  root: __dirname,
+  globals: true,
+  source: {
+    tsconfigPath: '../tsconfig.json',
+  },
+  output: {
+    module: true,
+  }
+});

test/unit/rstest.config.ts

@@ -1,12 +1,12 @@
 import os from 'node:os';
-
+import fs from 'node:fs';
 import type { TypeScriptWorkerConfig } from 'src/typescript/type-script-worker-config';
 
 describe('typescript/type-script-support', () => {
   let configuration: TypeScriptWorkerConfig;
 
   beforeEach(() => {
-    jest.resetModules();
+    rs.resetModules();
 
     configuration = {
       configFile: './tsconfig.json',
@@ -28,18 +28,20 @@ describe('typescript/type-script-support', () => {
   });
 
   it('throws error if typescript is not installed', async () => {
-    jest.setMock('typescript', undefined);
-
     const { assertTypeScriptSupport } = await import('src/typescript/type-script-support');
 
-    expect(() => assertTypeScriptSupport(configuration)).toThrowError(
+    expect(() => assertTypeScriptSupport({
+      ...configuration,
+      typescriptPath: 'typescript-404',
+    })).toThrowError(
       'When you use TsCheckerRspackPlugin with typescript reporter enabled, you must install `typescript` package.'
     );
   });
 
   it('throws error if there is no tsconfig.json file', async () => {
-    jest.setMock('typescript', { version: '3.8.0' });
-    jest.setMock('node:fs', { existsSync: () => false });
+    rs.mock('typescript', () => ({ version: '3.8.0' }));
+
+    rs.spyOn(fs, 'existsSync').mockImplementation(() => false);
 
     const { assertTypeScriptSupport } = await import('src/typescript/type-script-support');
 

test/unit/typescript/type-script-support.spec.ts

@@ -34,7 +34,7 @@ describe('typescript/type-scripts-worker-config', () => {
     } as rspack.Compiler;
   });
   afterEach(() => {
-    jest.resetModules();
+    rs.resetModules();
   });
 
   it.each([

test/unit/typescript/type-script-worker-config.spec.ts

@@ -15,8 +15,8 @@ describe('createPool', () => {
 
   it('limits concurrency', async () => {
     const pool = createPool(2);
-    const shortTask = jest.fn(() => wait(10));
-    const longTask = jest.fn(() => wait(500));
+    const shortTask = rs.fn(() => wait(10));
+    const longTask = rs.fn(() => wait(500));
 
     pool.submit(shortTask);
     pool.submit(shortTask);
@@ -37,7 +37,7 @@ describe('createPool', () => {
 
   it('works after draining', async () => {
     const pool = createPool(2);
-    const shortTask = jest.fn(() => wait(10));
+    const shortTask = rs.fn(() => wait(10));
 
     pool.submit(shortTask);
     pool.submit(shortTask);

test/unit/utils/async/pool.spec.ts

@@ -1,6 +1,11 @@
 import { isInsideAnotherPath } from '../../../../src/utils/path/is-inside-another-path';
 
-jest.mock('node:path', () => jest.requireActual('node:path').posix);
+const mockedPath = rs.hoisted(() => {
+  const path = rs.requireActual('node:path');
+  return path.posix;
+});
+
+rs.mock('node:path', () => mockedPath);
 
 const unixTests: [string, string, boolean][] = [
   // Identical

test/unit/utils/path/is-inside-another-path-unix.spec.ts

@@ -1,6 +1,12 @@
 import { isInsideAnotherPath } from '../../../../src/utils/path/is-inside-another-path';
 
-jest.mock('node:path', () => jest.requireActual('node:path').win32);
+// fixed https://github.com/web-infra-dev/rstest/issues/785
+const mockedPath = rs.hoisted(() => {
+  const path = rs.requireActual('node:path');
+  return path.win32;
+});
+
+rs.mock('node:path', () => mockedPath);
 
 const windowsTests: [string, string, boolean][] = [
   // subfolder