mcp-probe-kit 3.6.9 → 3.6.11

package/build/tools/gentest.js

@@ -1,209 +1,172 @@
 import { parseArgs, getString } from "../utils/parseArgs.js";
-import { okText } from "../lib/response.js";
+import { okStructured } from "../lib/response.js";
 import { renderGuidanceHeader } from "../lib/guidance.js";
 import { handleToolError } from "../utils/error-handler.js";
-// gentest 工具实现
+import { resolveGuidanceCode, trimCodeForPrompt } from "../lib/code-review-input.js";
+import { resolveWorkspaceRoot } from "../lib/workspace-root.js";
 export async function gentest(args) {
     try {
-        // 智能参数解析，支持自然语言输入
         const parsedArgs = parseArgs(args, {
             defaultValues: {
                 code: "",
                 framework: "jest",
+                file_path: "",
+                project_root: "",
             },
-            primaryField: "code", // 纯文本输入默认映射到 code 字段
+            primaryField: "code",
             fieldAliases: {
                 code: ["source", "src", "代码", "function"],
                 framework: ["test_framework", "lib", "框架", "测试框架"],
+                file_path: ["filePath", "filepath", "path", "文件路径"],
+                project_root: ["projectRoot", "project_path", "dir", "directory", "项目路径"],
             },
         });
-        const code = getString(parsedArgs.code);
-        const framework = getString(parsedArgs.framework) || "jest"; // jest, vitest, mocha
+        const framework = getString(parsedArgs.framework) || "jest";
+        const inlineCode = getString(parsedArgs.code) || getString(parsedArgs.input);
+        const filePath = getString(parsedArgs.file_path);
+        const projectRoot = getString(parsedArgs.project_root);
+        const resolved = resolveGuidanceCode({
+            code: inlineCode,
+            filePath: filePath || undefined,
+            projectRoot: projectRoot ? resolveWorkspaceRoot(projectRoot) : undefined,
+        });
+        if (resolved.error) {
+            return okStructured(`❌ gentest 无法读取输入: ${resolved.error}`, {
+                mode: "guidance",
+                gentestInput: {
+                    received: false,
+                    error: resolved.error,
+                    file: filePath || null,
+                    framework,
+                },
+            }, {
+                note: "指南型工具：请修正 file_path / project_root 或传入 code 后，由 Agent 生成完整测试代码",
+            });
+        }
+        const hasCode = Boolean(resolved.code.trim());
+        const promptCode = hasCode ? trimCodeForPrompt(resolved.code, 24000, "gentestInput") : "";
         const header = renderGuidanceHeader({
             tool: "gentest",
-            goal: "生成完整可运行的测试用例。",
-            tasks: ["基于代码生成测试用例", "仅输出测试代码"],
-            outputs: [`${framework} 测试代码（含边界与异常用例）`],
+            goal: "由 Agent 根据下方代码与测试清单生成完整可运行的测试用例。",
+            tasks: [
+                "先阅读本次注入的 gentestInput.code（或 file_path 对应文件）",
+                "按测试策略覆盖正常、边界与异常场景",
+                "在回复中直接输出完整测试代码文件",
+            ],
+            outputs: [`${framework} 测试代码（含边界与异常用例）— 由 Agent 生成，非 MCP 自动生成`],
+            notes: [
+                "本工具为指南型（guidance-only），不在服务端生成或运行测试",
+                hasCode ? `已注入待测代码（${resolved.code.split("\n").length} 行）` : "未收到 code/file_path，请先提供待测内容",
+            ],
         });
-        const message = `${header}请为以下代码生成完整的测试用例：
-
-📝 **代码内容**：
-${code || "请提供需要测试的代码"}
-
-🧪 **测试框架**：${framework}
-
----
-
-## 测试用例生成指南
-
-### 1️⃣ 测试策略
-
-**测试类型**：
-- **单元测试**：测试单个函数/方法
-- **集成测试**：测试模块间交互
-- **边界测试**：测试极端情况
-- **异常测试**：测试错误处理
-
-**覆盖维度**：
-- ✅ 正常情况（Happy Path）
-- ✅ 边界条件（Boundary Conditions）
-- ✅ 异常情况（Error Cases）
-- ✅ 空值/特殊值（Null/Special Values）
-
-### 2️⃣ 测试用例模板
-
-**测试结构（AAA 模式）**：
-\`\`\`typescript
-describe('函数/模块名称', () => {
-  // Arrange - 准备测试数据
-  // Act - 执行被测试的代码
-  // Assert - 验证结果
-  
-  test('描述测试场景', () => {
-    // Arrange
-    const input = ...;
-    const expected = ...;
-    
-    // Act
-    const result = functionUnderTest(input);
-    
-    // Assert
-    expect(result).toBe(expected);
-  });
-});
-\`\`\`
-
-### 3️⃣ 测试用例清单
-
-**正常情况测试**：
-- [ ] 基本功能正常工作
-- [ ] 返回值类型正确
-- [ ] 副作用符合预期
-
-**边界条件测试**：
-- [ ] 空输入（null, undefined, "", [], {}）
-- [ ] 最小值/最大值
-- [ ] 边界临界值
-
-**异常情况测试**：
-- [ ] 无效输入
-- [ ] 类型错误
-- [ ] 超出范围
-- [ ] 异常抛出正确
-
-**性能测试（可选）**：
-- [ ] 大数据量处理
-- [ ] 时间复杂度验证
-
-### 4️⃣ Mock 和 Stub
-
-**需要 Mock 的场景**：
-- API 调用
-- 数据库操作
-- 文件系统操作
-- 时间相关函数
-- 随机数生成
-- 外部依赖
-
-**Mock 示例**：
-\`\`\`typescript
-// Mock 函数
-const mockFetch = jest.fn();
-
-// Mock 模块
-jest.mock('./api', () => ({
-  fetchUser: jest.fn().mockResolvedValue({ id: 1, name: 'Test' })
-}));
-
-// Mock 时间
-jest.useFakeTimers();
-\`\`\`
-
-### 5️⃣ 测试数据
-
-**测试数据原则**：
-- 使用有意义的测试数据
-- 避免硬编码，使用工厂函数
-- 覆盖各种数据类型
-- 准备充分的边界数据
-
-**数据工厂示例**：
-\`\`\`typescript
-const createUser = (overrides = {}) => ({
-  id: 1,
-  name: 'Test User',
-  email: 'test@example.com',
-  ...overrides
-});
-\`\`\`
-
----
-
-## 测试文件命名规范
-
-- **单元测试**：\`functionName.test.ts\` 或 \`functionName.spec.ts\`
-- **集成测试**：\`moduleName.integration.test.ts\`
-- **E2E 测试**：\`feature.e2e.test.ts\`
-
----
-
----
-
-## ⚠️ 边界约束
-
-- ❌ 仅输出测试代码，不自动运行测试
-- ❌ 不修改被测试的源代码
-- ✅ 默认跟随项目现有测试框架与语言
-- ✅ 输出完整可运行的测试文件
-
-现在请生成完整的测试代码，包括：
-1. describe 块组织
-2. 所有必要的测试用例
-3. Mock/Stub 设置
-4. 测试数据准备
-5. 清晰的注释说明
-
----
-
-## 📤 输出格式要求
-
-请直接输出完整的测试代码文件，包含：
-- import 语句（测试框架和被测试代码）
-- describe 块（测试套件）
-- 多个 test/it 块（各种测试用例）
-- 必要的 mock 和 setup/teardown
-
-**示例输出**：
-\`\`\`typescript
-import { functionUnderTest } from '../src/module';
-
-describe('functionUnderTest', () => {
-  test('应该正常处理有效输入', () => {
-    const result = functionUnderTest('valid input');
-    expect(result).toBe('expected output');
-  });
-
-  test('应该处理边界情况：空字符串', () => {
-    const result = functionUnderTest('');
-    expect(result).toBe('');
-  });
-
-  test('应该抛出错误：无效输入', () => {
-    expect(() => functionUnderTest(null)).toThrow('Invalid input');
-  });
-});
-\`\`\`
-
-💡 **提示**：
-- 确保测试代码可以直接运行
-- 包含必要的类型声明（如果使用 TypeScript）
-- 添加适当的注释说明测试意图`;
-        return okText(message, {
-            schema: (await import('../schemas/output/core-tools.js')).TestSuiteSchema,
-            note: "本工具返回测试生成指南，AI 应根据指南和代码生成完整的测试文件"
+        const message = `${header}请为以下代码生成完整的测试用例：
+
+📝 **待测代码**${resolved.file ? `（来源: ${resolved.file}）` : ""}：
+${hasCode ? `\`\`\`\n${promptCode}\n\`\`\`` : "_未提供 code / file_path，请 Agent 先读取目标文件或让用户补充后再生成测试_"}
+
+🧪 **测试框架**：${framework}
+
+---
+
+## 测试用例生成指南
+
+### 1️⃣ 测试策略
+
+**测试类型**：
+- **单元测试**：测试单个函数/方法
+- **集成测试**：测试模块间交互
+- **边界测试**：测试极端情况
+- **异常测试**：测试错误处理
+
+**覆盖维度**：
+- ✅ 正常情况（Happy Path）
+- ✅ 边界条件（Boundary Conditions）
+- ✅ 异常情况（Error Cases）
+- ✅ 空值/特殊值（Null/Special Values）
+
+### 2️⃣ 测试用例模板
+
+**测试结构（AAA 模式）**：
+\`\`\`typescript
+describe('函数/模块名称', () => {
+  test('描述测试场景', () => {
+    // Arrange
+    const input = ...;
+    const expected = ...;
+
+    // Act
+    const result = functionUnderTest(input);
+
+    // Assert
+    expect(result).toBe(expected);
+  });
+});
+\`\`\`
+
+### 3️⃣ 测试用例清单
+
+**正常情况测试**：
+- [ ] 基本功能正常工作
+- [ ] 返回值类型正确
+- [ ] 副作用符合预期
+
+**边界条件测试**：
+- [ ] 空输入（null, undefined, "", [], {}）
+- [ ] 最小值/最大值
+- [ ] 边界临界值
+
+**异常情况测试**：
+- [ ] 无效输入
+- [ ] 类型错误
+- [ ] 超出范围
+- [ ] 异常抛出正确
+
+### 4️⃣ Mock 和 Stub
+
+**需要 Mock 的场景**：API 调用、数据库、文件系统、时间、随机数、外部依赖
+
+---
+
+## 测试文件命名规范
+
+- **单元测试**：\`functionName.test.ts\` 或 \`functionName.spec.ts\`
+- **集成测试**：\`moduleName.integration.test.ts\`
+
+---
+
+## ⚠️ 边界约束
+
+- MCP 仅返回指南 + 注入的待测代码，**测试代码由 Agent 生成**
+- ❌ 不自动运行测试，不修改被测试的源代码
+- ✅ 默认跟随项目现有测试框架与语言
+
+---
+
+## 📤 Agent 必须输出的内容
+
+请直接输出完整的测试代码文件，包含：
+- import 语句（测试框架和被测试代码）
+- describe 块（测试套件）
+- 多个 test/it 块（各种测试用例）
+- 必要的 mock 和 setup/teardown
+
+现在请生成完整的测试代码。`;
+        return okStructured(message, {
+            mode: "guidance",
+            gentestInput: {
+                received: hasCode,
+                framework,
+                file: resolved.file ?? null,
+                lineCount: hasCode ? resolved.code.split("\n").length : 0,
+                code: hasCode ? resolved.code : null,
+                truncatedInPrompt: hasCode && resolved.code.length !== promptCode.length,
+            },
+        }, {
+            schema: (await import("../schemas/output/core-tools.js")).TestSuiteSchema,
+            note: "指南型工具：测试代码须由 Agent 按清单生成；MCP 不返回自动生成的测试文件",
         });
     }
     catch (error) {
-        return handleToolError(error, 'gentest');
+        return handleToolError(error, "gentest");
     }
 }