Files
openclaw/extensions/migrate-claude/provider.test.ts
Vincent Koc 600df95c8c feat(migrate): add Claude importer
Add a bundled Claude migration provider for Claude Code and Claude Desktop imports.\n\nIncludes source discovery, preview/apply behavior for instructions, MCP servers, skills and command prompts, archive/manual handling for unsafe Claude state, docs, labeler, and tests.
2026-04-27 02:35:44 -07:00

157 lines
5.6 KiB
TypeScript

import fs from "node:fs/promises";
import path from "node:path";
import { redactMigrationPlan } from "openclaw/plugin-sdk/migration";
import { afterEach, describe, expect, it } from "vitest";
import { buildClaudeMigrationProvider } from "./provider.js";
import {
cleanupTempRoots,
makeConfigRuntime,
makeContext,
makeTempRoot,
writeFile,
} from "./test/provider-helpers.js";
describe("Claude migration provider", () => {
afterEach(async () => {
await cleanupTempRoots();
});
it("registers a Claude migration provider", async () => {
const provider = buildClaudeMigrationProvider();
expect(provider.id).toBe("claude");
expect(provider.label).toBe("Claude");
});
it("rejects missing Claude sources before planning", async () => {
const root = await makeTempRoot();
const source = path.join(root, "missing");
const provider = buildClaudeMigrationProvider();
await expect(
provider.plan(
makeContext({ source, stateDir: path.join(root, "state"), workspaceDir: root }),
),
).rejects.toThrow("Claude state was not found");
});
it("plans project memory, MCP servers, commands, skills, and manual review items", async () => {
const root = await makeTempRoot();
const source = path.join(root, "project");
const workspaceDir = path.join(root, "workspace");
await writeFile(path.join(source, "CLAUDE.md"), "# Project instructions\n");
await writeFile(path.join(source, "CLAUDE.local.md"), "local-only\n");
await writeFile(
path.join(source, ".mcp.json"),
JSON.stringify({
mcpServers: {
filesystem: {
command: "npx",
args: ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"],
env: { ANTHROPIC_API_KEY: "short-dev-key" },
},
},
}),
);
await writeFile(
path.join(source, ".claude", "settings.json"),
JSON.stringify({
hooks: { PreToolUse: [] },
permissions: { allow: ["Bash(*)"] },
env: { FOO: "bar" },
}),
);
await writeFile(path.join(source, ".claude", "commands", "commit.md"), "Commit $ARGUMENTS\n");
await writeFile(path.join(source, ".claude", "skills", "Review", "SKILL.md"), "# Review\n");
await writeFile(path.join(source, ".claude", "agents", "reviewer.md"), "# Reviewer\n");
const provider = buildClaudeMigrationProvider();
const plan = await provider.plan(
makeContext({ source, stateDir: path.join(root, "state"), workspaceDir }),
);
expect(plan.summary.total).toBeGreaterThan(0);
expect(plan.items).toEqual(
expect.arrayContaining([
expect.objectContaining({ id: "workspace:CLAUDE.md", kind: "workspace" }),
expect.objectContaining({
id: "config:mcp-server:project-mcp:filesystem",
kind: "config",
}),
expect.objectContaining({ id: "skill:claude-command-commit", action: "create" }),
expect.objectContaining({ id: "skill:review", action: "copy" }),
expect.objectContaining({ id: "archive:CLAUDE.local.md", action: "archive" }),
expect.objectContaining({ id: "archive:project-agents", action: "archive" }),
expect.objectContaining({ id: expect.stringMatching(/^manual:hooks:/u), kind: "manual" }),
]),
);
const redacted = JSON.stringify(redactMigrationPlan(plan));
expect(redacted).not.toContain("short-dev-key");
expect(redacted).toContain("[redacted]");
});
it("applies project imports without reading global Claude state", async () => {
const root = await makeTempRoot();
const source = path.join(root, "project");
const workspaceDir = path.join(root, "workspace");
const stateDir = path.join(root, "state");
const reportDir = path.join(root, "report");
await writeFile(path.join(source, "CLAUDE.md"), "# Project instructions\n");
await writeFile(path.join(workspaceDir, "AGENTS.md"), "# Existing agents\n");
await writeFile(
path.join(source, ".mcp.json"),
JSON.stringify({
mcpServers: {
filesystem: {
command: "npx",
args: ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"],
},
},
}),
);
await writeFile(path.join(source, ".claude", "commands", "ship.md"), "Ship $ARGUMENTS\n");
await writeFile(path.join(source, ".claude", "skills", "Review", "SKILL.md"), "# Review\n");
const config = {
agents: {
defaults: {
workspace: workspaceDir,
},
},
} as never;
const provider = buildClaudeMigrationProvider();
const result = await provider.apply(
makeContext({
source,
stateDir,
workspaceDir,
reportDir,
runtime: makeConfigRuntime(config),
config,
}),
);
expect(result.summary.errors).toBe(0);
const mcpItem = result.items.find(
(item) => item.id === "config:mcp-server:project-mcp:filesystem",
);
expect(mcpItem?.status).toBe("migrated");
expect((config as { mcp?: { servers?: Record<string, unknown> } }).mcp?.servers).toEqual({
filesystem: {
command: "npx",
args: ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"],
},
});
expect(await fs.readFile(path.join(workspaceDir, "AGENTS.md"), "utf8")).toContain(
"Imported from Claude: project CLAUDE.md",
);
await expect(
fs.access(path.join(workspaceDir, "skills", "claude-command-ship", "SKILL.md")),
).resolves.toBeUndefined();
await expect(
fs.access(path.join(workspaceDir, "skills", "review", "SKILL.md")),
).resolves.toBeUndefined();
await expect(fs.access(path.join(reportDir, "summary.md"))).resolves.toBeUndefined();
});
});