kimi-code/packages/agent-core/test/hooks/integration.test.ts
liruifengv b51e13538d
ci: run unit tests on windows (#1037)
* ci: run unit tests on windows

* fix(migration-legacy): align workdir bucket key with agent-core

computeWorkdirBucket used a local node:path-based resolve that yields backslash-separated paths on Windows, while agent-core's encodeWorkDirKey uses pathe (forward slashes on every platform). The SHA-256 inputs diverged, so migrated sessions were written to a bucket that the session picker never reads, making them invisible on Windows.

Alias computeWorkdirBucket to encodeWorkDirKey so both sides stay byte-identical, drop the local slugify copy, and update the workdir-bucket test reference accordingly.

* test(acp-adapter): expect platform-native separators in e2e-fs path

The e2e-fs test asserted the fs/readTextFile wire path as the raw POSIX targetPath, but AcpKaos.toClientPath converts '/' to '\' when the inner LocalKaos reports pathClass 'win32' (Windows). On Windows the wire path became '\Users\test\x.ts' and the assertion failed.

Mirror toClientPath in the test: expect backslash separators on win32 and the raw path otherwise. Implementation is unchanged.

* test(sdk): normalize workDir and skillDir paths in session tests

SessionStore.create/list and the skill loader normalize paths through pathe (forward slashes). The SDK tests compared the resulting workDir and skill loaded-dir against raw mkdtemp / node:path strings, which use backslashes on Windows (and node:fs realpath also returns backslashes for the skill dir), failing three toMatchObject assertions.

Build the expected paths with agent-core's normalizeWorkDir so they match the internal pathe representation on every platform. The skill dir keeps its realpath() (the loader realpaths the root) and only normalizes separators.

* test(skill): normalize realpath to forward slashes in scanner tests

resolveSkillRoots normalizes every root.path through fs.realpath followed by replacing backslashes with forward slashes (scanner.ts). The scanner tests compared root.path against node:fs realpath directly, which returns backslashes on Windows, so twenty assertions failed (toEqual / toContain / toHaveLength) even though the resolved paths were identical.

Wrap realpath at the top of the test file to mirror the implementation's normalization, so every comparison uses the same forward-slash form on every platform.

* test: skip Unix-only permission tests on Windows

The Unix file-permission assertions (mode bits like 0o600 / 0o700 and chmod 000 making a path unreadable) have no equivalent on Windows, which uses ACLs; fs.chmod there can only toggle the read-only bit. These six tests failed on Windows with mismatched mode values or a missing 40411.

Skip them on win32 via it.skipIf(process.platform === 'win32'): oauth FileTokenStorage (0600 file, 0700 dir), agent-core BackgroundTaskPersistence (0700 tasks dir), agent-core createPerIdJsonStore (0700 subdir), migration-legacy atomicWrite (0600 file), and server fs:browse (chmod 000 -> 40411).

* test(tui): make platform-sensitive assertions cross-platform

The TUI implementations are already platform-aware (pathe-style paths, pathToFileURL, quoteShellArg cmd/POSIX quoting, Alt+V on Windows for paste expansion), but the tests hard-coded POSIX expectations and failed on Windows.

Align the assertions with the implementation's platform behavior: footer-goal-badge matches the '[goal' badge prefix instead of /goal/ (toolbar tips contain '/goal'); tool-call expects backslash relative paths on win32; plan-box builds the file:// URL via pathToFileURL; custom-editor sends Alt+V on win32 for paste expansion; file-mention-provider normalizes the expected description to forward slashes; kimi-tui-startup builds the resume command with quoteShellArg; kimi-tui-message-flow builds the expected install path with resolve().

* test: align path assertions with pathe on Windows

Several test suites asserted paths produced by node:path/node:os/node:fs against values that agent-core, node-sdk and kaos normalize through pathe (forward slashes). On Windows the two forms diverge (backslashes vs forward slashes), failing about 19 assertions.

Mirror the implementation's normalization in the assertions via a local toPosix helper (or agent-core's normalizeWorkDir), so expected paths use forward slashes on every platform: kaos LocalKaos, node-sdk export/list/resume/config/transport sessions, cli FileMentionProvider, and agent-core skill-session.

* test(native): build path expectations with node:path.resolve

paths.mjs builds every path with node:path.resolve, which yields backslash-separated absolute paths on Windows. The path-helpers tests asserted against template strings that mixed the backslash appRoot with forward-slash segments, so Object.is failed on Windows even though the strings looked identical.

Build the expectations with the same resolve(appRoot, ...) helper so the separators match on every platform.

* fix: make Windows CI tests pass across all packages

Fix the remaining Windows CI failures so the Windows test job can go green. The changes fall into a few categories:

- Path separators: agent-core/node-sdk/kaos normalize paths via pathe (forward slashes); align test expectations and a couple of implementations (native cache base, workspace registry) with that.

- Platform-only services: skip launchd/systemd manager suites on win32 (Windows uses schtasks).

- Process/signal lifecycle: skip or relax tests that rely on POSIX signals / SIGTERM semantics that Windows does not support.

- Hook shell syntax: rewrite hook test commands from POSIX shell (single quotes, semicolons, stderr redirects, if/then/fi) to node -e / .cjs files that run under cmd.exe.

- CRLF: make Bash tool description stripping tolerate CRLF line endings.

- Misc: realpath short-name divergence, port-retry timing, telemetry spawn, fs-watch timing, snapshot path normalization, etc.

* fix: remove unused basename import in workspaceRegistryService

Fix lint error (no-unused-vars): basename from node:path is no longer used after switching to posixBasename from pathe.

* fix: align resume harness pathClass and wait for banner state on Windows

Two more Windows CI fixes:

- createResumeNoSideEffectKaos now reports pathClass 'win32' on Windows so tool descriptions (e.g. Glob's Windows note) match the live agent in expectResumeMatches, fixing usage/description deep-equal drift.

- kimi-tui-startup once-banner test now waits for writeBannerDisplayState to land before asserting, since the atomic write can lag behind the render on Windows.

* fix: resolve remaining Windows unit test failures

Make the new Windows CI job green across agent-core, kaos, node-sdk and server:

- Align the resume harness kaos pathClass with the live agent so platform-conditional tool descriptions (Glob's Windows note) match in expectResumeMatches instead of drifting on win32.
- Rewrite hook commands in agent-core tests as cross-platform node one-liners; single-quote echo, >&2 and ';' do not work under cmd.exe.
- Add .gitattributes enforcing LF so raw-imported templates (e.g. the compaction instruction) produce byte-identical token counts on Windows and POSIX.
- Terminate the full process tree on Windows in both the hook runner and kaos (taskkill /T /F) so grandchildren cannot outlive their parent and keep the cwd locked.
- Normalize workDir path separators in two kimi-sdk session tests to match the stored canonical form.
- Avoid cmd.exe arg-quoting pitfalls in the kaos cmd.exe test, and run the Windows process-tree kill test from a script file with the pid path passed via argv.
- Give the first fs-git e2e test more time on Windows and retry the temp-dir cleanup; skip the fs-watch overflow-burst assertion on Windows where fs-event coalescing prevents the single-window spike.

* ci: retrigger checks

* fix: resolve remaining Windows failures after merging main

- Terminate the spawned git/gh process tree on Windows in FsGitService (taskkill /T /F on timeout) so a timed-out 'gh pr view' cannot leave a grandchild holding the workspace cwd, which made the fs-git e2e cleanup fail with EPERM.

- Give the fs:git_status e2e suite a longer timeout on Windows and retry the temp-dir cleanup longer to ride out the slower child-process teardown.

- Make the third-party plugin install trust test assert the resolved install path via node:path so it matches the Windows-resolved path (D:\tmp\...) as well as the POSIX one.

* fix: align workspace registry roots and harden fs-git cleanup on Windows

- workspace-registry test: compare normalized (forward-slash) roots, since the registry and session index both store workDir via pathe.resolve (forward slashes on every platform). realpath() yields backslashes on Windows and diverged from the stored root.

- fs-git e2e: bump the temp-dir cleanup retries and the afterEach timeout, since Windows child-process teardown after server.close() is asynchronous and can keep the workspace cwd locked for several seconds.

* test: stub openUrl in kimi-tui-message-flow feedback tests

The /feedback command falls back to openUrl(FEEDBACK_ISSUE_URL) when submission fails, which spawned a real browser window on every test run. Mock #/utils/open-url (matching the existing login/message-replay/server test convention) so the suite never opens a browser.

* test: harden fs-git e2e cleanup against Windows cwd locks

On Windows, git/gh child processes and the session core process can outlive server.close() and keep the temp workspace as their cwd, so rmSync fails with EPERM even after a long retry. Add rmSyncRobust that retries and, if the cwd is still locked, swallows EPERM/EBUSY on Windows — the OS reclaims the temp dir and a cleanup hiccup must not fail an otherwise-passing test.

* test: harden server e2e cleanup against async teardown races

server.close() does not fully await the server's asynchronous teardown, so on a loaded CI runner the temp home/workspace dirs can still be held or written to when the afterEach rmSync runs, failing with EPERM (Windows) or ENOTEMPTY (Linux). Use a rmSyncRobust helper (retry + swallow EPERM/EBUSY/ENOTEMPTY) in the fs-git and question e2e cleanup. Also fix a leftover `throw err` (renamed to `throw error`) that broke the typecheck.
2026-06-26 11:56:41 +08:00

336 lines
12 KiB
TypeScript

import { mkdtempSync, writeFileSync, chmodSync } from 'node:fs';
import { tmpdir } from 'node:os';
import { join } from 'pathe';
import type { ContentPart } from '@moonshot-ai/kosong';
import { describe, expect, it } from 'vitest';
// Dynamic-import contract: locks the Agent <-> HookEngine integration shape
// (engine ctor, trigger surface, summary, wire callbacks, event helpers,
// config round-trip) before the implementation lands.
const ENGINE_MODULE = '../../src/session/hooks/engine' as string;
const CONFIG_MODULE = '../../src/config' as string;
type HookDef = {
event: string;
matcher?: string;
command: string;
timeout?: number;
};
interface HookResult {
action: 'allow' | 'block';
reason?: string;
stdout?: string;
stderr?: string;
}
type HookMatcherValue = string | readonly ContentPart[];
interface HookEngineInstance {
trigger: (
event: string,
args?: { matcherValue?: HookMatcherValue; inputData?: Record<string, unknown> },
) => Promise<HookResult[]>;
summary: Record<string, number>;
}
interface HookEngineCtor {
new (
hooks: HookDef[],
options?: {
cwd?: string;
onTriggered?: (event: string, target: string, count: number) => void;
onResolved?: (
event: string,
target: string,
action: string,
reason: string | undefined,
durationMs: number,
) => void;
},
): HookEngineInstance;
}
async function importEngine(): Promise<HookEngineCtor> {
const mod = (await import(ENGINE_MODULE)) as { HookEngine: HookEngineCtor };
return mod.HookEngine;
}
describe('HookEngine integration', () => {
it('blocks a dangerous Shell command and allows a safe one via a PreToolUse script hook', async () => {
const dir = mkdtempSync(join(tmpdir(), 'kimi-hooks-int-'));
const script = join(dir, 'block-rm.cjs');
// Node script body (avoids bash-only syntax so the test runs on Windows).
writeFileSync(
script,
[
"let s='';",
"process.stdin.on('data',d=>s+=d);",
"process.stdin.on('end',()=>{try{const o=JSON.parse(s);const c=(o.tool_input&&o.tool_input.command)||'';if(/rm -rf/.test(c)){process.stderr.write('Blocked: rm -rf');process.exit(2);}process.exit(0);}catch(e){}});",
].join('\n'),
'utf-8',
);
const HookEngine = await importEngine();
const engine = new HookEngine(
[{ event: 'PreToolUse', matcher: 'Shell', command: `${process.execPath} ${script}`, timeout: 5 }],
{ cwd: dir },
);
const safe = await engine.trigger('PreToolUse', {
matcherValue: 'Shell',
inputData: { tool_name: 'Shell', tool_input: { command: 'ls -la' } },
});
expect(safe.every((r) => r.action === 'allow')).toBe(true);
const dangerous = await engine.trigger('PreToolUse', {
matcherValue: 'Shell',
inputData: { tool_name: 'Shell', tool_input: { command: 'rm -rf /' } },
});
expect(dangerous.some((r) => r.action === 'block')).toBe(true);
expect(dangerous[0]?.reason).toContain('rm -rf');
});
it('honors a Stop hook returning permissionDecision=deny by producing a block result with reason', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{
event: 'Stop',
command:
"node -e \"process.stdout.write(JSON.stringify({hookSpecificOutput:{permissionDecision:'deny',permissionDecisionReason:'tests not written'}}))\"",
timeout: 5,
},
]);
const results = await engine.trigger('Stop', { inputData: { stop_hook_active: false } });
expect(results).toHaveLength(1);
expect(results[0]?.action).toBe('block');
expect(results[0]?.reason).toContain('tests not written');
});
it('fires a Notification hook only when its matcher equals the notification matcher value', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{ event: 'Notification', matcher: 'task_completed', command: 'echo notified', timeout: 5 },
{ event: 'Notification', matcher: 'other_type', command: 'echo other', timeout: 5 },
]);
const results = await engine.trigger('Notification', {
matcherValue: 'task_completed',
inputData: { notification_type: 'task_completed', title: 'Done' },
});
expect(results).toHaveLength(1);
expect(results[0]?.stdout?.trim()).toBe('notified');
});
it('runs multiple hooks for the same event in parallel and collects every result', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{ event: 'PostToolUse', matcher: 'WriteFile', command: 'echo hook1', timeout: 5 },
{ event: 'PostToolUse', matcher: 'WriteFile', command: 'echo hook2', timeout: 5 },
]);
const results = await engine.trigger('PostToolUse', {
matcherValue: 'WriteFile',
inputData: { tool_name: 'WriteFile' },
});
expect(results).toHaveLength(2);
const outputs = new Set(results.map((r) => r.stdout?.trim()));
expect(outputs).toEqual(new Set(['hook1', 'hook2']));
});
it('round-trips hook definitions through the TOML config loader', async () => {
const config = (await import(CONFIG_MODULE)) as {
parseConfigString: (text: string, source?: string) => { hooks?: HookDef[] };
};
const toml = `
[[hooks]]
event = "PreToolUse"
matcher = "Shell"
command = "echo ok"
[[hooks]]
event = "Notification"
matcher = "permission_prompt"
command = "notify-send Kimi"
timeout = 5
`;
const parsed = config.parseConfigString(toml, 'hooks.toml');
expect(parsed.hooks).toHaveLength(2);
expect(parsed.hooks?.[0]?.event).toBe('PreToolUse');
expect(parsed.hooks?.[1]?.event).toBe('Notification');
expect(parsed.hooks?.[1]?.timeout).toBe(5);
});
it('exposes a summary map of event name to registered hook count', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{ event: 'PreToolUse', matcher: 'Shell', command: 'echo 1' },
{ event: 'PreToolUse', matcher: 'WriteFile', command: 'echo 2' },
{ event: 'Stop', command: 'echo 3' },
]);
expect(engine.summary).toEqual({ PreToolUse: 2, Stop: 1 });
});
it('feeds the SessionStart source field through stdin and filters by the startup matcher', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{
event: 'SessionStart',
matcher: 'startup',
command:
'node -e "let s=\\"\\";process.stdin.on(\\"data\\",d=>s+=d);process.stdin.on(\\"end\\",()=>{const o=JSON.parse(s);process.stdout.write(o.source||\\"\\");})"',
timeout: 5,
},
]);
const matched = await engine.trigger('SessionStart', {
matcherValue: 'startup',
inputData: { sessionId: 'test-123', cwd: '/tmp', source: 'startup' },
});
expect(matched).toHaveLength(1);
expect(matched[0]?.stdout?.trim()).toBe('startup');
const unmatched = await engine.trigger('SessionStart', {
matcherValue: 'resume',
inputData: { sessionId: 'test-123', cwd: '/tmp', source: 'resume' },
});
expect(unmatched).toHaveLength(0);
});
it('fires a PostToolUseFailure hook with the tool error in the payload', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{
event: 'PostToolUseFailure',
matcher: 'Shell',
command: 'echo failure_caught',
timeout: 5,
},
]);
const results = await engine.trigger('PostToolUseFailure', {
matcherValue: 'Shell',
inputData: { tool_name: 'Shell', tool_input: {}, error: 'command not found' },
});
expect(results).toHaveLength(1);
expect(results[0]?.action).toBe('allow');
expect(results[0]?.stdout).toContain('failure_caught');
});
it('blocks a UserPromptSubmit prompt when the hook exits 2 and returns the reason to the user', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{
event: 'UserPromptSubmit',
command: "node -e \"process.stderr.write('no profanity');process.exit(2)\"",
timeout: 5,
},
]);
const results = await engine.trigger('UserPromptSubmit', {
inputData: { prompt: 'bad words here' },
});
expect(results).toHaveLength(1);
expect(results[0]?.action).toBe('block');
expect(results[0]?.reason).toContain('no profanity');
});
it('fires a StopFailure hook on chat provider errors with the error_type field present', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{ event: 'StopFailure', command: 'echo error_logged', timeout: 5 },
]);
const results = await engine.trigger('StopFailure', {
inputData: { error_type: 'ChatProviderError', error_message: 'rate limited' },
});
expect(results).toHaveLength(1);
expect(results[0]?.stdout).toContain('error_logged');
});
it('fires a SessionEnd hook only for the matching reason matcher', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{ event: 'SessionEnd', matcher: 'exit', command: 'echo goodbye', timeout: 5 },
]);
const matched = await engine.trigger('SessionEnd', {
matcherValue: 'exit',
inputData: { session_id: 's1', reason: 'exit' },
});
expect(matched).toHaveLength(1);
const unmatched = await engine.trigger('SessionEnd', {
matcherValue: 'clear',
inputData: { session_id: 's1', reason: 'clear' },
});
expect(unmatched).toHaveLength(0);
});
it('fires a SubagentStart hook with the agent_name payload field', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{
event: 'SubagentStart',
matcher: 'coder',
command: 'echo agent_starting',
timeout: 5,
},
]);
const results = await engine.trigger('SubagentStart', {
matcherValue: 'coder',
inputData: { agent_name: 'coder', prompt: 'Fix the bug' },
});
expect(results).toHaveLength(1);
expect(results[0]?.stdout).toContain('agent_starting');
});
it('fires a SubagentStop hook on subagent completion', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{ event: 'SubagentStop', matcher: 'coder', command: 'echo agent_done', timeout: 5 },
]);
const results = await engine.trigger('SubagentStop', {
matcherValue: 'coder',
inputData: { agent_name: 'coder', response: 'Bug fixed' },
});
expect(results).toHaveLength(1);
expect(results[0]?.stdout).toContain('agent_done');
});
it('fires PreCompact and PostCompact hooks around compaction with trigger and token payloads', async () => {
const HookEngine = await importEngine();
const engine = new HookEngine([
{ event: 'PreCompact', matcher: 'auto', command: 'echo pre_compact', timeout: 5 },
{ event: 'PostCompact', matcher: 'auto', command: 'echo post_compact', timeout: 5 },
]);
const pre = await engine.trigger('PreCompact', {
matcherValue: 'auto',
inputData: { trigger: 'auto', token_count: 150000 },
});
expect(pre).toHaveLength(1);
expect(pre[0]?.stdout).toContain('pre_compact');
const post = await engine.trigger('PostCompact', {
matcherValue: 'auto',
inputData: { trigger: 'auto', estimated_token_count: 50000 },
});
expect(post).toHaveLength(1);
expect(post[0]?.stdout).toContain('post_compact');
});
it('invokes onTriggered with (event,target,count) and onResolved with (event,target,action)', async () => {
const HookEngine = await importEngine();
const triggered: Array<[string, string, number]> = [];
const resolved: Array<[string, string, string]> = [];
const engine = new HookEngine(
[{ event: 'PreToolUse', matcher: 'Shell', command: 'exit 0', timeout: 5 }],
{
onTriggered: (e, t, c) => triggered.push([e, t, c]),
onResolved: (e, t, a) => resolved.push([e, t, a]),
},
);
await engine.trigger('PreToolUse', { matcherValue: 'Shell', inputData: {} });
expect(triggered).toEqual([['PreToolUse', 'Shell', 1]]);
expect(resolved).toEqual([['PreToolUse', 'Shell', 'allow']]);
});
});