dsh-api-runner 0.0.0-stage → 0.2.0

package/test/plugin.mjs

@@ -0,0 +1,467 @@
+/**
+ * 插件入口形态自测：用桩 ctx 模拟 cordis 宿主，验证 apply() 注册了工具、HTTP 路由、
+ * 提示段与清理回调，并走一遍工具 execute（含会话 cwd 解析与错误兜底）。
+ * 这一层不依赖 DSH 运行时，只验证契约形状。
+ */
+import assert from 'node:assert/strict';
+import fs from 'node:fs';
+import http from 'node:http';
+import os from 'node:os';
+import path from 'node:path';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+
+const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
+const load = (rel) => import(pathToFileURL(path.join(root, rel)).href);
+const { normalizeProjectKey } = await load('src/util.js');
+
+const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'api-runner-plugin-'));
+const homeDir = path.join(tmp, 'home');
+const projectDir = path.join(tmp, 'project');
+fs.mkdirSync(homeDir, { recursive: true });
+fs.mkdirSync(projectDir, { recursive: true });
+fs.writeFileSync(path.join(projectDir, 'app.log'), 'hello\nworld\n');
+
+const server = http.createServer((req, res) => {
+    res.setHeader('Content-Type', 'application/json');
+    res.end(JSON.stringify({ ok: true, path: req.url }));
+});
+await new Promise((r) => server.listen(0, '127.0.0.1', r));
+const base = `http://127.0.0.1:${server.address().port}`;
+
+fs.writeFileSync(
+    path.join(homeDir, 'api-runner.yml'),
+    `apis:
+  - id: ping
+    method: GET
+    url: ${base}/ping
+logs:
+  - id: app-log
+    path: ./app.log
+`,
+    'utf8',
+);
+
+process.env.DSH_HOME = homeDir;
+
+const mod = await load('src/main.js');
+let passed = 0;
+async function ok(name, fn) {
+    try {
+        await fn();
+        passed += 1;
+        console.log(`  ✓ ${name}`);
+    } catch (error) {
+        console.error(`  ✗ ${name}\n    ${error?.stack || error}`);
+        process.exitCode = 1;
+    }
+}
+
+// ---- 桩 ctx ----
+const registered = { tools: [], routes: [], sections: [], effects: [] };
+const ctx = {
+    logger: { info: () => {}, error: () => {} },
+    config: {},
+    sessions: { get: (id) => (id === 's1' ? { header: { cwd: projectDir } } : undefined) },
+    connection: { requestRejection: () => undefined },
+    webServer: {
+        register: (route) => {
+            registered.routes.push(route);
+            return () => {};
+        },
+    },
+    systemPrompt: {
+        section: (section) => {
+            registered.sections.push(section);
+            return () => {};
+        },
+    },
+    tools: {
+        register: (definition) => {
+            registered.tools.push(definition);
+            return () => {};
+        },
+    },
+    effect: (factory, id) => {
+        registered.effects.push({ id, dispose: factory() });
+        return () => {};
+    },
+    get: (name) => (name === 'systemPrompt' ? ctx.systemPrompt : undefined),
+};
+
+console.log('plugin shape:');
+await ok('导出 inject 且没有 default export', () => {
+    assert.deepEqual(mod.inject, ['webServer', 'sessions', 'tools', 'connection', 'systemPrompt']);
+    assert.equal(mod.default, undefined);
+    assert.equal(typeof mod.apply, 'function');
+});
+await ok('apply 注册 1 个工具 / 1 条路由 / 1 个提示段 / 3 个 effect', () => {
+    mod.apply(ctx);
+    assert.equal(registered.tools.length, 1);
+    assert.equal(registered.routes.length, 1);
+    assert.equal(registered.sections.length, 1);
+    assert.equal(registered.effects.length, 3);
+});
+await ok('工具定义符合 ToolDefinition 契约', () => {
+    const tool = registered.tools[0];
+    assert.equal(tool.name, 'ApiRunner');
+    assert.equal(typeof tool.timeoutMs, 'number');
+    assert.equal(tool.parameters.type, 'object');
+    assert.ok(tool.parameters.properties.action.enum.includes('verify'));
+    assert.equal(typeof tool.output.render, 'function');
+    assert.equal(typeof tool.execute, 'function');
+});
+await ok('路由是 prefix /dsh-api-runner/api', () => {
+    const route = registered.routes[0];
+    assert.equal(route.kind, 'prefix');
+    assert.equal(route.path, '/dsh-api-runner/api');
+});
+await ok('提示段返回配置摘要且无配置时为空串', () => {
+    const section = registered.sections[0];
+    const text = section.text({});
+    assert.match(text, /ping/);
+    assert.match(text, /app-log/);
+});
+
+console.log('tool execute:');
+const tool = registered.tools[0];
+await ok('describe 通过会话 cwd 读到项目配置', async () => {
+    const result = await tool.execute({ action: 'describe' }, { agent: { session: { id: 's1' } } });
+    assert.equal(result.isError, false);
+    const payload = JSON.parse(result.text);
+    assert.equal(payload.apis[0].id, 'ping');
+});
+await ok('call 成功返回 isError=false', async () => {
+    const result = await tool.execute({ action: 'call', api_id: 'ping' }, { agent: { session: { id: 's1' } } });
+    assert.equal(result.isError, false, result.text);
+    assert.match(result.text, /"ok": true/);
+});
+await ok('readLog 默认取第一个日志', async () => {
+    const result = await tool.execute({ action: 'log', reset: true }, { agent: { session: { id: 's1' } } });
+    assert.equal(result.isError, false, result.text);
+    assert.match(result.text, /hello/);
+});
+await ok('未知 action 返回 isError=true 且不抛异常', async () => {
+    const result = await tool.execute({ action: 'nope' }, { agent: { session: { id: 's1' } } });
+    assert.equal(result.isError, true);
+    assert.match(result.text, /BAD_ACTION/);
+});
+await ok('缺参数时返回明确错误而不是崩溃', async () => {
+    const result = await tool.execute({ action: 'call' }, { agent: { session: { id: 's1' } } });
+    assert.equal(result.isError, true);
+    assert.match(result.text, /MISSING_ARGUMENT/);
+});
+await ok('无会话时不会崩（退化为空 cwd）', async () => {
+    const result = await tool.execute({ action: 'describe' }, { agent: {} });
+    assert.equal(result.isError, false);
+});
+
+console.log('http route:');
+await ok('GET /config 返回配置摘要', async () => {
+    const route = registered.routes[0];
+    const req = { url: '/dsh-api-runner/api/config', method: 'GET', headers: {} };
+    const res = createMockResponse();
+    await route.handler(req, res);
+    const payload = JSON.parse(res.body);
+    assert.equal(payload.ok, true);
+    assert.equal(payload.apis[0].id, 'ping');
+});
+await ok('请求被 connection 拒绝时返回 401 JSON', async () => {
+    const route = registered.routes[0];
+    const ctx2 = { ...ctx, connection: { requestRejection: () => 401 } };
+    // 重新 apply 到新桩上以拿到打了拒绝逻辑的 handler
+    const local = { tools: [], routes: [], sections: [], effects: [] };
+    mod.apply({
+        ...ctx2,
+        webServer: { register: (r) => (local.routes.push(r), () => {}) },
+        systemPrompt: { section: () => () => {} },
+        tools: { register: () => () => {} },
+        effect: (factory) => (factory(), () => {}),
+    });
+    const res = createMockResponse();
+    await local.routes[0].handler({ url: '/dsh-api-runner/api/config', method: 'GET', headers: {} }, res);
+    assert.equal(res.statusCode, 401);
+    assert.equal(JSON.parse(res.body).code, 'UNAUTHORIZED');
+});
+await ok('未知路由返回 404', async () => {
+    const route = registered.routes[0];
+    const res = createMockResponse();
+    await route.handler({ url: '/dsh-api-runner/api/nope', method: 'GET', headers: {} }, res);
+    assert.equal(res.statusCode, 404);
+});
+
+console.log('panel api:');
+await ok('GET /ui 返回面板数据（含来源与接口）', async () => {
+    const route = registered.routes[0];
+    const res = createMockResponse();
+    await route.handler({ url: `/dsh-api-runner/api/ui?cwd=${encodeURIComponent(projectDir)}`, method: 'GET', headers: {} }, res);
+    const payload = JSON.parse(res.body);
+    assert.equal(payload.ok, true);
+    assert.equal(payload.apis[0].id, 'ping');
+    assert.equal(payload.apis[0].source, 'file');
+});
+await ok('POST /ui/api 保存面板接口后能在 /ui 里看到（source=ui）', async () => {
+    const route = registered.routes[0];
+    const res2 = createMockResponse();
+    const body = JSON.stringify({
+        cwd: projectDir,
+        api: { id: 'panel-api', method: 'GET', url: '/panel', baseUrl: base, description: '面板加的' },
+    });
+    const req = {
+        url: '/dsh-api-runner/api/ui/api',
+        method: 'POST',
+        headers: {},
+        async *[Symbol.asyncIterator]() {
+            yield Buffer.from(body, 'utf8');
+        },
+    };
+    await route.handler(req, res2);
+    const saved = JSON.parse(res2.body);
+    assert.equal(saved.ok, true, res2.body);
+
+    const listRes = createMockResponse();
+    await route.handler({ url: `/dsh-api-runner/api/ui?cwd=${encodeURIComponent(projectDir)}`, method: 'GET', headers: {} }, listRes);
+    const list = JSON.parse(listRes.body);
+    const created = list.apis.find((item) => item.id === 'panel-api');
+    assert.ok(created, '保存后应出现在接口列表');
+    assert.equal(created.source, 'ui');
+    assert.equal(created.url, `${base}/panel`, '应展示完整地址');
+});
+await ok('GET /ui?project=<key> 切到别的项目（优先于会话 cwd）', async () => {
+    const route = registered.routes[0];
+    const otherDir = path.join(tmp, 'another');
+    fs.mkdirSync(otherDir, { recursive: true });
+    // 先在另一个项目里存一个接口
+    const saveBody = JSON.stringify({
+        cwd: otherDir,
+        api: { id: 'from-other', method: 'GET', url: '/other', baseUrl: base },
+    });
+    const saveReq = {
+        url: '/dsh-api-runner/api/ui/api',
+        method: 'POST',
+        headers: {},
+        async *[Symbol.asyncIterator]() { yield Buffer.from(saveBody, 'utf8'); },
+    };
+    const saveRes = createMockResponse();
+    await route.handler(saveReq, saveRes);
+    assert.equal(JSON.parse(saveRes.body).ok, true, saveRes.body);
+
+    const otherKey = normalizeProjectKey(otherDir);
+    const res = createMockResponse();
+    // 带会话 id（cwd=projectDir）同时也带 project：必须以后者为准，否则页签点了没反应
+    await route.handler({
+        url: `/dsh-api-runner/api/ui?project=${encodeURIComponent(otherKey)}`,
+        method: 'GET',
+        headers: { 'x-dsh-session-id': 's1' },
+    }, res);
+    const payload = JSON.parse(res.body);
+    assert.equal(payload.ok, true);
+    assert.equal(payload.projectKey, otherKey);
+    assert.equal(payload.cwdProjectKey, normalizeProjectKey(projectDir));
+    assert.ok(payload.apis.some((api) => api.id === 'from-other'), JSON.stringify(payload.apis.map((api) => api.id)));
+
+    // 清单里会话工作区排第一
+    assert.equal(payload.projects[0].key, payload.cwdProjectKey);
+    assert.ok(payload.projects.some((item) => item.key === otherKey));
+
+    // 不在 store 里、也不是绝对路径的 project 应被忽略，退回会话 cwd
+    const bad = createMockResponse();
+    await route.handler({
+        url: '/dsh-api-runner/api/ui?project=nonsense',
+        method: 'GET',
+        headers: { 'x-dsh-session-id': 's1' },
+    }, bad);
+    assert.equal(JSON.parse(bad.body).projectKey, normalizeProjectKey(projectDir));
+});
+
+await ok('GET /java 返回进程列表结构', async () => {
+    const route = registered.routes[0];
+    const res = createMockResponse();
+    await route.handler({ url: `/dsh-api-runner/api/java?cwd=${encodeURIComponent(projectDir)}`, method: 'GET', headers: {} }, res);
+    const payload = JSON.parse(res.body);
+    assert.equal(typeof payload.ok, 'boolean');
+    assert.ok(Array.isArray(payload.processes));
+    // profiles 必须是数组，前端会直接 .map；曾因返回字符串导致崩溃
+    for (const item of payload.processes) assert.ok(Array.isArray(item.profiles), `pid ${item.pid} 的 profiles 应为数组`);
+    // 每个端口都带角色，前端靠它区分 HTTP 业务端口与 Sentinel 规则端口
+    for (const item of payload.processes) {
+        const list = Array.isArray(item.portList) ? item.portList : [];
+        // portList 是「除调试端口外的监听端口」，每个都带角色
+        const raw = (Array.isArray(item.ports) ? item.ports : []).filter((port) => port !== item.debugPort);
+        assert.equal(list.length, raw.length, `pid ${item.pid} 的 portList 应覆盖所有非调试端口`);
+        for (const port of list) {
+            assert.ok(['http', 'sentinel', 'debug', 'unknown'].includes(port.role), `端口 ${port.port} 的 role 不合法`);
+            assert.equal(typeof port.label, 'string');
+        }
+        assert.equal(typeof item.ignored, 'boolean');
+    }
+    assert.ok(Array.isArray(payload.ignored), '应返回已忽略清单');
+});
+await ok('忽略/取消忽略只在配置里记一笔，不动进程', async () => {
+    const route = registered.routes[0];
+    const item = { mainClass: 'com.example.DemoApplication', name: 'Demo', kind: 'spring' };
+    const post = (path, payload) => ({
+        url: `${path}?cwd=${encodeURIComponent(projectDir)}`,
+        method: 'POST',
+        headers: {},
+        async *[Symbol.asyncIterator]() {
+            yield Buffer.from(JSON.stringify(payload), 'utf8');
+        },
+    });
+
+    const ignored = createMockResponse();
+    await route.handler(post('/dsh-api-runner/api/java/ignore', { item }), ignored);
+    assert.equal(JSON.parse(ignored.body).ok, true, ignored.body);
+
+    const listRes = createMockResponse();
+    await route.handler({ url: `/dsh-api-runner/api/java?cwd=${encodeURIComponent(projectDir)}`, method: 'GET', headers: {} }, listRes);
+    const list = JSON.parse(listRes.body);
+    assert.ok(list.ignored.some((entry) => entry.mainClass === item.mainClass), '被忽略的服务应出现在 ignored 里');
+
+    const unignored = createMockResponse();
+    await route.handler(post('/dsh-api-runner/api/java/unignore', { item }), unignored);
+    assert.equal(JSON.parse(unignored.body).ok, true, unignored.body);
+
+    const after = createMockResponse();
+    await route.handler({ url: `/dsh-api-runner/api/java?cwd=${encodeURIComponent(projectDir)}`, method: 'GET', headers: {} }, after);
+    assert.equal(JSON.parse(after.body).ignored.some((entry) => entry.mainClass === item.mainClass), false);
+});
+await ok('GET /java/detail 返回日志与可选来源', async () => {
+    const route = registered.routes[0];
+    const res = createMockResponse();
+    await route.handler({ url: `/dsh-api-runner/api/java/detail?cwd=${encodeURIComponent(projectDir)}&id=999999`, method: 'GET', headers: {} }, res);
+    const payload = JSON.parse(res.body);
+    // 不存在的 pid 要给出可读错误，而不是抛异常
+    assert.equal(payload.ok, false);
+    assert.equal(typeof payload.message, 'string');
+});
+await ok('GET/POST /settings 能读能写，并拒绝相对路径的数据目录', async () => {
+    const route = registered.routes[0];
+    const read = createMockResponse();
+    await route.handler({ url: '/dsh-api-runner/api/settings', method: 'GET', headers: {} }, read);
+    const before = JSON.parse(read.body);
+    assert.equal(before.ok, true, read.body);
+    assert.equal(typeof before.effectiveDataDir, 'string');
+    assert.equal(before.dataDir, '');
+
+    const post = (payload) => ({
+        url: '/dsh-api-runner/api/settings',
+        method: 'POST',
+        headers: {},
+        async *[Symbol.asyncIterator]() {
+            yield Buffer.from(JSON.stringify(payload), 'utf8');
+        },
+    });
+
+    const bad = createMockResponse();
+    await route.handler(post({ dataDir: 'relative/dir' }), bad);
+    const badPayload = JSON.parse(bad.body);
+    assert.equal(badPayload.ok, false, '相对路径应被拒绝');
+    assert.match(badPayload.message, /绝对路径/);
+
+    const good = createMockResponse();
+    await route.handler(post({ workspace: projectDir }), good);
+    const goodPayload = JSON.parse(good.body);
+    assert.equal(goodPayload.ok, true, good.body);
+    assert.equal(goodPayload.workspace, projectDir);
+});
+await ok('java/save、java/unsave、java/start-saved 都能给出可读结果', async () => {
+    const route = registered.routes[0];
+    const post = (path, payload) => ({
+        url: `${path}?cwd=${encodeURIComponent(projectDir)}`,
+        method: 'POST',
+        headers: {},
+        async *[Symbol.asyncIterator]() {
+            yield Buffer.from(JSON.stringify(payload), 'utf8');
+        },
+    });
+
+    // 保存一个不存在的服务：必须报错，不能抛异常
+    const save = createMockResponse();
+    await route.handler(post('/dsh-api-runner/api/java/save', { id: 'not-running' }), save);
+    const savePayload = JSON.parse(save.body);
+    assert.equal(savePayload.ok, false, save.body);
+    assert.equal(typeof savePayload.message, 'string');
+
+    // 没保存过的服务启动：给出 NOT_SAVED
+    const start = createMockResponse();
+    await route.handler(post('/dsh-api-runner/api/java/start-saved', { id: 'not-saved' }), start);
+    const startPayload = JSON.parse(start.body);
+    assert.equal(startPayload.ok, false, start.body);
+    assert.equal(startPayload.code, 'NOT_SAVED');
+
+    // 删除一个不存在的配方：不报错（幂等），返回 saved 列表
+    const unsave = createMockResponse();
+    await route.handler(post('/dsh-api-runner/api/java/unsave', { id: 'not-saved' }), unsave);
+    const unsavePayload = JSON.parse(unsave.body);
+    assert.equal(unsavePayload.ok, true, unsave.body);
+    assert.ok(Array.isArray(unsavePayload.saved));
+});
+await ok('java/start-all 与状态轮询路由都已挂载', async () => {
+    const route = registered.routes[0];
+    const post = (path, payload) => ({
+        url: `${path}?cwd=${encodeURIComponent(projectDir)}`,
+        method: 'POST',
+        headers: {},
+        async *[Symbol.asyncIterator]() {
+            yield Buffer.from(JSON.stringify(payload), 'utf8');
+        },
+    });
+    const get = (path) => ({
+        url: `${path}?cwd=${encodeURIComponent(projectDir)}`,
+        method: 'GET',
+        headers: {},
+        async *[Symbol.asyncIterator]() {},
+    });
+
+    // 一个配方都没保存：一键启动要说清楚，不能 404 也不能抛
+    const empty = createMockResponse();
+    await route.handler(post('/dsh-api-runner/api/java/start-all', {}), empty);
+    const emptyPayload = JSON.parse(empty.body);
+    assert.equal(emptyPayload.ok, false, empty.body);
+    assert.equal(emptyPayload.code, 'NOTHING_SAVED');
+
+    // 状态路由：查不存在的批次给 NO_BATCH（证明路由存在且不崩）
+    const status = createMockResponse();
+    await route.handler(get('/dsh-api-runner/api/java/start-all/status?batch=nope'), status);
+    const statusPayload = JSON.parse(status.body);
+    assert.equal(statusPayload.ok, false, status.body);
+    assert.equal(statusPayload.code, 'NO_BATCH');
+});
+
+await ok('工具 action 里有 login 与 java', () => {
+    const tool = registered.tools[0];
+    const actions = tool.parameters.properties.action.enum;
+    assert.ok(actions.includes('login'));
+    assert.ok(actions.includes('java'));
+    assert.ok(tool.parameters.properties.token_from, '应有 token_from 参数');
+    assert.ok(tool.parameters.properties.java_action.enum.includes('start_all'), 'java_action 应有 start_all');
+    assert.ok(tool.parameters.properties.java_ids, '应有 java_ids 参数');
+});
+
+// ---- 清理 ----
+for (const effect of registered.effects) effect.dispose?.();
+server.close();
+fs.rmSync(tmp, { recursive: true, force: true });
+
+console.log(`\n${process.exitCode ? 'FAILED' : 'PASSED'}: ${passed} checks`);
+
+function createMockResponse() {
+    const res = {
+        statusCode: 200,
+        headers: {},
+        body: '',
+        headersSent: false,
+        setHeader(key, value) {
+            this.headers[key.toLowerCase()] = value;
+        },
+        end(text) {
+            this.body = text;
+            this.headersSent = true;
+        },
+        status(code) {
+            this.statusCode = code;
+            return this;
+        },
+    };
+    return res;
+}