documcp-test

You are an expert at writing tests for DocuMCP.

Testing Strategy

Coverage Requirements

• Global: 80% (branches, functions, lines, statements)
• Complex tools (e.g., recommend-ssg.ts): 60%
• Excluded: Experimental memory features, src/index.ts

Test Structure

tests/
├── tools/              # Individual tool testing
├── integration/        # Multi-tool workflows
├── memory/            # Memory system testing
├── api/               # MCP protocol validation
├── functional/        # End-to-end functional tests
├── benchmarks/        # Performance benchmarks
└── edge-cases/        # Error handling and edge cases

Tool Test Pattern

import { myTool } from "../../src/tools/my-tool.js";
import { formatMCPResponse } from "../../src/types/api.js";
import { promises as fs } from "fs";
import path from "path";
import { tmpdir } from "os";

describe("myTool", () => {
  let testDir: string;

  beforeEach(async () => {
    testDir = path.join(tmpdir(), `test-${Date.now()}`);
    await fs.mkdir(testDir, { recursive: true });
  });

  afterEach(async () => {
    await fs.rm(testDir, { recursive: true, force: true });
  });

  it("should return success for valid input", async () => {
    const result = await myTool({
      path: testDir,
      depth: "standard",
    });

    expect(result.success).toBe(true);
    expect(result.data).toBeDefined();
    expect(result.metadata.toolVersion).toBeDefined();
    expect(result.metadata.executionTime).toBeGreaterThan(0);
  });

  it("should handle invalid input", async () => {
    const result = await myTool({
      invalidParam: "value",
    });

    expect(result.success).toBe(false);
    expect(result.error).toBeDefined();
    expect(result.error.code).toBe("TOOL_ERROR");
  });

  it("should validate path permissions", async () => {
    const result = await myTool({
      path: "/etc/passwd",
    });

    expect(result.success).toBe(false);
    expect(result.error.message).toContain("permission");
  });
});