kimi-code/packages/kaos/test/e2e/exec-edge-cases.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

225 lines
8.3 KiB
TypeScript

import { mkdtemp, realpath, rm } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
import { LocalKaos } from '#/local';
// ── E2E: exec edge cases ──────────────────────────────────────────────
//
// Covers exec() scenarios that the other kaos suites do not touch:
//
// - spawning a non-existent command and safely awaiting the error,
// - killing a running child with SIGTERM,
// - closing stdin while the child is still alive,
// - >10MB stdout throughput without dropping or corrupting bytes,
// - proving that each LocalKaos instance carries its OWN cwd into
// concurrent child processes (isolation invariant).
// ── Helpers ───────────────────────────────────────────────────────────
async function streamToString(stream: NodeJS.ReadableStream): Promise<string> {
const chunks: Buffer[] = [];
for await (const chunk of stream) {
chunks.push(Buffer.from(chunk as Buffer));
}
return Buffer.concat(chunks).toString('utf-8');
}
async function streamByteLength(stream: NodeJS.ReadableStream): Promise<number> {
let n = 0;
for await (const chunk of stream) {
n += (chunk as Buffer).length;
}
return n;
}
// ── Tests ─────────────────────────────────────────────────────────────
describe('e2e: exec edge cases', () => {
let kaos: LocalKaos;
let tempDir: string;
let originalCwd: string;
beforeEach(async () => {
kaos = await LocalKaos.create();
originalCwd = process.cwd();
tempDir = await realpath(await mkdtemp(join(tmpdir(), 'kaos-exec-edge-')));
await kaos.chdir(tempDir);
});
afterEach(async () => {
// Restore original cwd in case any test accidentally mutated it
// (though LocalKaos should never touch process.cwd()).
process.chdir(originalCwd);
await rm(tempDir, { recursive: true, force: true });
});
describe('spawning a non-existent command', () => {
it('exec() rejects promptly when the binary does not exist (never hangs)', async () => {
// Contract: LocalKaos.exec() awaits the child's 'spawn' or 'error' event
// before returning, so a missing binary becomes a synchronous rejection
// rather than a ghost process handle.
await expect(kaos.exec('this-binary-does-not-exist-kaos-edge-test-12345')).rejects.toThrow(
/ENOENT|ENOTFOUND|not found|spawn/i,
);
});
});
describe('kill() terminates a running child', () => {
it.skipIf(process.platform === 'win32')('long-running child can be killed with SIGTERM', async () => {
// A node script that sleeps forever.
const proc = await kaos.exec('node', '-e', 'setInterval(() => {}, 1000 * 60);');
expect(proc.pid).toBeGreaterThan(0);
// Give the child a moment to actually start.
await new Promise<void>((r) => setTimeout(r, 20));
await proc.kill('SIGTERM');
const exitCode = await proc.wait();
// SIGTERM typically produces exitCode = null → -1 under our wrapper,
// or 143 (128 + 15). Either way, it must NOT be 0.
expect(exitCode).not.toBe(0);
});
it('kill() after the child has already exited is a no-op (no ESRCH leak)', async () => {
const proc = await kaos.exec('node', '-e', 'process.exit(0);');
const exitCode = await proc.wait();
expect(exitCode).toBe(0);
// Killing an already-exited process must not throw.
await expect(proc.kill('SIGTERM')).resolves.toBeUndefined();
});
});
describe('stdin lifecycle', () => {
it('closing stdin while the child keeps running does not corrupt stdout', async () => {
// Child reads stdin until EOF, then emits "done:<bytes>".
const proc = await kaos.exec(
'node',
'-e',
`
let total = 0;
process.stdin.on('data', (chunk) => { total += chunk.length; });
process.stdin.on('end', () => {
// Intentionally wait before writing, simulating child work
// continuing after stdin EOF.
setTimeout(() => {
process.stdout.write('done:' + total);
process.exit(0);
}, 20);
});
`,
);
proc.stdin.write('abc');
proc.stdin.write('def');
proc.stdin.end();
const stdout = await streamToString(proc.stdout);
const exitCode = await proc.wait();
expect(exitCode).toBe(0);
expect(stdout).toBe('done:6');
});
});
describe('large stdout throughput', () => {
it('>10MB of stdout streams through without byte loss', async () => {
// 10.5MB: 10500 writes of a 1KB payload. Using a tight loop in the
// child guarantees the OS pipe buffer gets exercised and we exit
// the BufferedReadable backpressure path.
const targetKB = 10500;
const proc = await kaos.exec(
'node',
'-e',
`
const chunk = Buffer.alloc(1024, 0x61); // 1KB of 'a'
let written = 0;
function tick() {
while (written < ${targetKB} - 1) {
const ok = process.stdout.write(chunk);
written++;
if (!ok) {
process.stdout.once('drain', tick);
return;
}
}
// Final write with callback guarantees bytes are flushed to the
// pipe before we exit. Without this, process.exit() races with
// the internal libuv write queue and drops the tail.
process.stdout.write(chunk, () => process.exit(0));
}
tick();
`,
);
// Read stream and wait concurrently to avoid races where wait() resolves
// before the stream pipe has flushed (BufferedReadable continues to
// accumulate after the child exits, but the consumer must be drained
// explicitly before checking length).
const [stdoutLen, exitCode] = await Promise.all([streamByteLength(proc.stdout), proc.wait()]);
expect(exitCode).toBe(0);
expect(stdoutLen).toBe(targetKB * 1024);
});
});
describe('cwd isolation for concurrent instances', () => {
it('two LocalKaos instances with different cwds run concurrent child processes that each see their own cwd', async () => {
const subA = join(tempDir, 'A');
const subB = join(tempDir, 'B');
await kaos.mkdir(subA);
await kaos.mkdir(subB);
const kaosA = await LocalKaos.create();
const kaosB = await LocalKaos.create();
await kaosA.chdir(subA);
await kaosB.chdir(subB);
// Verify process.cwd() is NOT mutated by chdir.
expect(process.cwd()).not.toBe(subA);
expect(process.cwd()).not.toBe(subB);
// Run concurrently: each child prints its cwd to stdout.
const [procA, procB] = await Promise.all([
kaosA.exec('node', '-e', 'process.stdout.write(process.cwd())'),
kaosB.exec('node', '-e', 'process.stdout.write(process.cwd())'),
]);
const [outA, outB, exitA, exitB] = await Promise.all([
streamToString(procA.stdout),
streamToString(procB.stdout),
procA.wait(),
procB.wait(),
]);
expect(exitA).toBe(0);
expect(exitB).toBe(0);
// Each child's cwd MUST equal its kaos instance's cwd.
// On macOS `tmpdir()` can be either `/var/folders/...` or
// `/private/var/folders/...`. We already realpath'd tempDir so
// string equality should hold.
expect(outA).toBe(subA);
expect(outB).toBe(subB);
});
it('execWithEnv honors the per-instance cwd and injects env vars', async () => {
const proc = await kaos.execWithEnv(
['node', '-e', 'process.stdout.write(process.env.KAOS_TEST_MARKER + "|" + process.cwd())'],
{ KAOS_TEST_MARKER: 'beacon42', PATH: process.env['PATH'] ?? '' },
);
const stdout = await streamToString(proc.stdout);
const exitCode = await proc.wait();
expect(exitCode).toBe(0);
expect(stdout.startsWith('beacon42|')).toBe(true);
expect(stdout.endsWith(tempDir)).toBe(true);
});
});
});