Merge pull request #2884 from olaservo/update-test-framework-to-vitest

Update test framework to vitest

AGENTS.md

@@ -0,0 +1,9 @@
+# MCP Reference Server Development Guide
+
+## Contributing Guidelines
+
+Before making updates to this repo, thoroughly review the CONTRIBUTING.md guide at the root of this repo.
+
+## Testing
+
+Use vitest when configuring or adding tests for servers implemented in typescript.

CLAUDE.md

@@ -0,0 +1,2 @@
+@./AGENTS.md
+

src/filesystem/__tests__/directory-tree.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect, beforeEach, afterEach } from '@jest/globals';
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
 import * as fs from 'fs/promises';
 import * as path from 'path';
 import * as os from 'os';

src/filesystem/__tests__/lib.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect, beforeEach, afterEach, jest } from '@jest/globals';
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
 import fs from 'fs/promises';
 import path from 'path';
 import os from 'os';
@@ -23,19 +23,19 @@ import {
 } from '../lib.js';
 
 // Mock fs module
-jest.mock('fs/promises');
-const mockFs = fs as jest.Mocked<typeof fs>;
+vi.mock('fs/promises');
+const mockFs = fs as any;
 
 describe('Lib Functions', () => {
   beforeEach(() => {
-    jest.clearAllMocks();
+    vi.clearAllMocks();
     // Set up allowed directories for tests
     const allowedDirs = process.platform === 'win32' ? ['C:\\Users\\test', 'C:\\temp', 'C:\\allowed'] : ['/home/user', '/tmp', '/allowed'];
     setAllowedDirectories(allowedDirs);
   });
 
   afterEach(() => {
-    jest.restoreAllMocks();
+    vi.restoreAllMocks();
     // Clear allowed directories after tests
     setAllowedDirectories([]);
   });
@@ -567,8 +567,8 @@ describe('Lib Functions', () => {
         
         // Mock file handle with proper typing
         const mockFileHandle = {
-          read: jest.fn(),
-          close: jest.fn()
+          read: vi.fn(),
+          close: vi.fn()
         } as any;
         
         mockFileHandle.read.mockResolvedValue({ bytesRead: 0 });
@@ -586,8 +586,8 @@ describe('Lib Functions', () => {
         mockFs.stat.mockResolvedValue({ size: 50 } as any);
         
         const mockFileHandle = {
-          read: jest.fn(),
-          close: jest.fn()
+          read: vi.fn(),
+          close: vi.fn()
         } as any;
         
         // Simulate reading file content in chunks
@@ -607,8 +607,8 @@ describe('Lib Functions', () => {
         mockFs.stat.mockResolvedValue({ size: 100 } as any);
         
         const mockFileHandle = {
-          read: jest.fn(),
-          close: jest.fn()
+          read: vi.fn(),
+          close: vi.fn()
         } as any;
         
         mockFileHandle.read.mockResolvedValue({ bytesRead: 0 });
@@ -626,8 +626,8 @@ describe('Lib Functions', () => {
       it('opens file for reading', async () => {
         // Mock file handle with proper typing
         const mockFileHandle = {
-          read: jest.fn(),
-          close: jest.fn()
+          read: vi.fn(),
+          close: vi.fn()
         } as any;
         
         mockFileHandle.read.mockResolvedValue({ bytesRead: 0 });
@@ -642,8 +642,8 @@ describe('Lib Functions', () => {
 
       it('handles files with content and returns first lines', async () => {
         const mockFileHandle = {
-          read: jest.fn(),
-          close: jest.fn()
+          read: vi.fn(),
+          close: vi.fn()
         } as any;
         
         // Simulate reading file content with newlines
@@ -661,8 +661,8 @@ describe('Lib Functions', () => {
 
       it('handles files with leftover content', async () => {
         const mockFileHandle = {
-          read: jest.fn(),
-          close: jest.fn()
+          read: vi.fn(),
+          close: vi.fn()
         } as any;
         
         // Simulate reading file content without final newline
@@ -680,8 +680,8 @@ describe('Lib Functions', () => {
 
       it('handles reaching requested line count', async () => {
         const mockFileHandle = {
-          read: jest.fn(),
-          close: jest.fn()
+          read: vi.fn(),
+          close: vi.fn()
         } as any;
         
         // Simulate reading exactly the requested number of lines

src/filesystem/__tests__/path-utils.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect } from '@jest/globals';
+import { describe, it, expect } from 'vitest';
 import { normalizePath, expandHome, convertToWindowsPath } from '../path-utils.js';
 
 describe('Path Utilities', () => {

src/filesystem/__tests__/path-validation.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect, beforeEach, afterEach } from '@jest/globals';
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
 import * as path from 'path';
 import * as fs from 'fs/promises';
 import * as os from 'os';

src/filesystem/__tests__/roots-utils.test.ts

@@ -1,4 +1,4 @@
-import { describe, it, expect, beforeEach, afterEach } from '@jest/globals';
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
 import { getValidRootDirectories } from '../roots-utils.js';
 import { mkdtempSync, rmSync, mkdirSync, writeFileSync, realpathSync } from 'fs';
 import { tmpdir } from 'os';

src/filesystem/jest.config.cjs

@@ -1,23 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  extensionsToTreatAsEsm: ['.ts'],
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-  },
-  transform: {
-    '^.+\\.tsx?$': [
-      'ts-jest',
-      {
-        useESM: true,
-      },
-    ],
-  },
-  testMatch: ['**/__tests__/**/*.test.ts'],
-  collectCoverageFrom: [
-    '**/*.ts',
-    '!**/__tests__/**',
-    '!**/dist/**',
-  ],
-}

src/filesystem/package.json

@@ -17,7 +17,7 @@
     "build": "tsc && shx chmod +x dist/*.js",
     "prepare": "npm run build",
     "watch": "tsc --watch",
-    "test": "jest --config=jest.config.cjs --coverage"
+    "test": "vitest run --coverage"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.19.1",
@@ -27,15 +27,12 @@
     "zod-to-json-schema": "^3.23.5"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
     "@types/diff": "^5.0.9",
-    "@types/jest": "^29.5.14",
     "@types/minimatch": "^5.1.2",
     "@types/node": "^22",
-    "jest": "^29.7.0",
+    "@vitest/coverage-v8": "^2.1.8",
     "shx": "^0.3.4",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.2",
+    "vitest": "^2.1.8"
   }
 }

src/filesystem/vitest.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    include: ['**/__tests__/**/*.test.ts'],
+    coverage: {
+      provider: 'v8',
+      include: ['**/*.ts'],
+      exclude: ['**/__tests__/**', '**/dist/**'],
+    },
+  },
+});

src/sequentialthinking/__tests__/lib.test.ts

@@ -1,8 +1,8 @@
-import { describe, it, expect, beforeEach, jest } from '@jest/globals';
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
 import { SequentialThinkingServer, ThoughtData } from '../lib.js';
 
-// Mock chalk to avoid ESM issues in Jest
-jest.mock('chalk', () => {
+// Mock chalk to avoid ESM issues
+vi.mock('chalk', () => {
   const chalkMock = {
     yellow: (str: string) => str,
     green: (str: string) => str,
@@ -10,7 +10,6 @@ jest.mock('chalk', () => {
   };
   return {
     default: chalkMock,
-    __esModule: true,
   };
 });
 

src/sequentialthinking/jest.config.cjs

@@ -1,26 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  extensionsToTreatAsEsm: ['.ts'],
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1',
-  },
-  transform: {
-    '^.+\\.tsx?$': [
-      'ts-jest',
-      {
-        useESM: true,
-      },
-    ],
-  },
-  transformIgnorePatterns: [
-    'node_modules/(?!(chalk)/)',
-  ],
-  testMatch: ['**/__tests__/**/*.test.ts'],
-  collectCoverageFrom: [
-    '**/*.ts',
-    '!**/__tests__/**',
-    '!**/dist/**',
-  ],
-}

src/sequentialthinking/package.json

@@ -17,7 +17,7 @@
     "build": "tsc && shx chmod +x dist/*.js",
     "prepare": "npm run build",
     "watch": "tsc --watch",
-    "test": "jest --config=jest.config.cjs --coverage"
+    "test": "vitest run --coverage"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.19.1",
@@ -25,14 +25,11 @@
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@types/jest": "^29.5.14",
     "@types/node": "^22",
     "@types/yargs": "^17.0.32",
-    "jest": "^29.7.0",
+    "@vitest/coverage-v8": "^2.1.8",
     "shx": "^0.3.4",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vitest": "^2.1.8"
   }
 }

src/sequentialthinking/vitest.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    include: ['**/__tests__/**/*.test.ts'],
+    coverage: {
+      provider: 'v8',
+      include: ['**/*.ts'],
+      exclude: ['**/__tests__/**', '**/dist/**'],
+    },
+  },
+});