kimi-code/packages/node-sdk/test/config.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

414 lines
13 KiB
TypeScript

import { mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { createKimiConfigRpc, createKimiHarness, KimiError } from '#/index';
import {
parseConfigString,
readConfigFile,
writeConfigFile,
} from '../../agent-core/src/config';
import { TEST_IDENTITY } from './test-identity';
// node-sdk/agent-core normalize paths to forward slashes (pathe). Mirror that
// in path assertions so they hold on Windows, where node:path produces
// backslashes.
const toPosix = (p: string): string => p.replaceAll('\\', '/');
const tempDirs: string[] = [];
afterEach(async () => {
vi.unstubAllEnvs();
for (const dir of tempDirs.splice(0)) {
await rm(dir, { recursive: true, force: true });
}
});
async function makeTempDir(): Promise<string> {
const dir = await mkdtemp(join(tmpdir(), 'kimi-sdk-config-'));
tempDirs.push(dir);
return dir;
}
const COMPLETE_TOML = `
default_model = "kimi-for-coding"
default_thinking = false
default_permission_mode = "auto"
skip_afk_prompt_injection = false
default_plan_mode = false
default_editor = ""
theme = "dark"
show_thinking_stream = true
merge_all_available_skills = true
extra_skill_dirs = ["~/team-skills", ".agents/team-skills"]
[providers.kimi-for-coding]
type = "kimi"
base_url = "https://api.kimi.com/coding/v1"
api_key = "sk-xxx"
custom_headers = { "X-Custom-Header" = "value" }
[providers.kimi-for-coding.env]
GOOGLE_CLOUD_PROJECT = "project-1"
[models.kimi-for-coding]
provider = "kimi-for-coding"
model = "kimi-for-coding"
max_context_size = 262144
capabilities = ["image_in", "thinking", "video_in"]
display_name = "Kimi for Coding"
[loop_control]
max_retries_per_step = 3
max_ralph_iterations = 0
reserved_context_size = 50000
compaction_trigger_ratio = 0.85
[background]
max_running_tasks = 4
keep_alive_on_exit = false
kill_grace_period_ms = 2000
print_wait_ceiling_s = 3600
[services.moonshot_search]
base_url = "https://api.kimi.com/coding/v1/search"
api_key = "sk-search"
custom_headers = { "X-Search" = "1" }
[services.moonshot_fetch]
base_url = "https://api.kimi.com/coding/v1/fetch"
api_key = "sk-fetch"
[notifications]
claim_stale_after_ms = 15000
`;
describe('SDK config TOML', () => {
it('resolves config paths through the config RPC wrapper', async () => {
const dir = await makeTempDir();
const rpc = createKimiConfigRpc();
await expect(rpc.resolveConfigPath({ homeDir: dir })).resolves.toBe(toPosix(join(dir, 'config.toml')));
});
it('returns structured validation issues through the config RPC wrapper', async () => {
const rpc = createKimiConfigRpc();
await expect(
rpc.validateConfigToml({
text: `
[providers.kimi]
type = "kimi"
[models.kimi]
provider = "kimi"
model = "kimi"
max_context_size = "large"
`,
filePath: 'broken.toml',
}),
).rejects.toMatchObject({
details: {
validationIssues: [
{
path: ['models', 'kimi', 'maxContextSize'],
},
],
},
});
});
it('parses the documented config shape and keeps TUI-only fields in raw', () => {
const config = parseConfigString(COMPLETE_TOML, 'complete.toml');
expect(config.defaultModel).toBe('kimi-for-coding');
expect(config.defaultThinking).toBe(false);
expect(config.defaultPermissionMode).toBe('auto');
expect(config.defaultPlanMode).toBe(false);
expect(config.mergeAllAvailableSkills).toBe(true);
expect(config.extraSkillDirs).toEqual(['~/team-skills', '.agents/team-skills']);
const provider = config.providers['kimi-for-coding'];
expect(provider).toMatchObject({
type: 'kimi',
baseUrl: 'https://api.kimi.com/coding/v1',
apiKey: 'sk-xxx',
customHeaders: { 'X-Custom-Header': 'value' },
env: { GOOGLE_CLOUD_PROJECT: 'project-1' },
});
expect(config.models?.['kimi-for-coding']).toMatchObject({
provider: 'kimi-for-coding',
model: 'kimi-for-coding',
maxContextSize: 262144,
capabilities: ['image_in', 'thinking', 'video_in'],
displayName: 'Kimi for Coding',
});
expect(config.loopControl).toEqual({
maxRetriesPerStep: 3,
maxRalphIterations: 0,
reservedContextSize: 50000,
compactionTriggerRatio: 0.85,
});
expect(config.background).toEqual({
maxRunningTasks: 4,
keepAliveOnExit: false,
killGracePeriodMs: 2000,
printWaitCeilingS: 3600,
});
expect(config.services?.moonshotSearch?.customHeaders).toEqual({ 'X-Search': '1' });
expect(config.services?.moonshotFetch?.apiKey).toBe('sk-fetch');
expect('theme' in config).toBe(false);
expect(config.raw?.['theme']).toBe('dark');
expect(config.raw?.['skip_afk_prompt_injection']).toBe(false);
expect(config.raw?.['show_thinking_stream']).toBe(true);
expect(config.raw?.['notifications']).toEqual({ claim_stale_after_ms: 15000 });
});
it('writes typed fields in snake_case and preserves unknown raw sections', async () => {
const dir = await makeTempDir();
const configPath = join(dir, 'config.toml');
const config = parseConfigString(COMPLETE_TOML, configPath);
await writeConfigFile(configPath, {
...config,
defaultModel: 'kimi-for-coding',
loopControl: {
...config.loopControl,
maxStepsPerTurn: 42,
},
});
const text = await readFile(configPath, 'utf-8');
expect(text).toContain('default_model = "kimi-for-coding"');
expect(text).toContain('default_permission_mode = "auto"');
expect(text).toContain('extra_skill_dirs = [ "~/team-skills", ".agents/team-skills" ]');
expect(text).not.toContain('default_yolo');
expect(text).toContain('max_steps_per_turn = 42');
expect(text).toContain('display_name = "Kimi for Coding"');
expect(text).toContain('GOOGLE_CLOUD_PROJECT = "project-1"');
expect(text).toContain('claim_stale_after_ms = 15000');
expect(text).toContain('theme = "dark"');
const reloaded = readConfigFile(configPath);
expect(reloaded.loopControl?.maxStepsPerTurn).toBe(42);
expect(reloaded.raw?.['theme']).toBe('dark');
});
it('accepts camelCase aliases without keeping unknown fields in typed config', () => {
const config = parseConfigString(`
defaultModel = "camel-model"
[providers.local]
type = "openai"
baseUrl = "https://example.test/v1"
apiKey = "sk-test"
unsupported_provider_field = "raw-only"
[models.camel-model]
provider = "local"
model = "gpt-test"
maxContextSize = 128000
displayName = "Camel Model"
custom_model_field = "raw-only"
[services.moonshotSearch]
baseUrl = "https://example.test/search"
apiKey = "sk-search"
[loopControl]
maxStepsPerRun = 7
[background]
maxRunningTasks = 2
`);
expect(config.defaultModel).toBe('camel-model');
expect(config.providers['local']).toMatchObject({
type: 'openai',
baseUrl: 'https://example.test/v1',
apiKey: 'sk-test',
});
expect(config.models?.['camel-model']).toMatchObject({
maxContextSize: 128000,
displayName: 'Camel Model',
});
expect(config.services?.moonshotSearch).toMatchObject({
baseUrl: 'https://example.test/search',
apiKey: 'sk-search',
});
expect(config.loopControl?.maxStepsPerTurn).toBe(7);
expect(config.background?.maxRunningTasks).toBe(2);
expect('unsupportedProviderField' in config.providers['local']!).toBe(false);
expect('customModelField' in config.models!['camel-model']!).toBe(false);
const rawProviders = config.raw?.['providers'] as Record<string, Record<string, unknown>>;
const rawModels = config.raw?.['models'] as Record<string, Record<string, unknown>>;
expect(rawProviders['local']?.['unsupported_provider_field']).toBe('raw-only');
expect(rawModels['camel-model']?.['custom_model_field']).toBe('raw-only');
});
});
describe('KimiHarness config API', () => {
it('loads default config when missing and deep-merges setConfig patches from disk', async () => {
const homeDir = await makeTempDir();
const configPath = join(homeDir, 'config.toml');
await writeFile(configPath, COMPLETE_TOML, 'utf-8');
const harness = createKimiHarness({ homeDir, identity: TEST_IDENTITY });
await harness.setConfig({
providers: {
'kimi-for-coding': {
apiKey: 'sk-updated',
},
},
services: {
moonshotSearch: {
apiKey: 'sk-search-updated',
},
},
});
const config = await harness.getConfig({ reload: true });
expect(config.providers['kimi-for-coding']).toMatchObject({
type: 'kimi',
baseUrl: 'https://api.kimi.com/coding/v1',
apiKey: 'sk-updated',
env: { GOOGLE_CLOUD_PROJECT: 'project-1' },
});
expect(config.services?.moonshotSearch?.apiKey).toBe('sk-search-updated');
expect(config.raw?.['theme']).toBe('dark');
const text = await readFile(configPath, 'utf-8');
expect(text).toContain('theme = "dark"');
expect(text).toContain('GOOGLE_CLOUD_PROJECT = "project-1"');
expect(text).toContain('claim_stale_after_ms = 15000');
});
it('does not write invalid config patches', async () => {
const homeDir = await makeTempDir();
const configPath = join(homeDir, 'config.toml');
await writeFile(configPath, COMPLETE_TOML, 'utf-8');
const before = await readFile(configPath, 'utf-8');
const harness = createKimiHarness({ homeDir, identity: TEST_IDENTITY });
const setInvalidConfig = harness.setConfig({
providers: {
bad: {
type: 'not-a-provider',
},
},
} as never);
await expect(setInvalidConfig).rejects.toBeInstanceOf(KimiError);
await expect(setInvalidConfig).rejects.toMatchObject({
code: 'config.invalid',
} satisfies Partial<KimiError>);
await expect(readFile(configPath, 'utf-8')).resolves.toBe(before);
});
it('uses default config when the config file is absent', async () => {
const homeDir = await makeTempDir();
const harness = createKimiHarness({ homeDir, identity: TEST_IDENTITY });
await expect(harness.getConfig()).resolves.toEqual({ providers: {} });
});
it('returns experimental feature metadata through the harness', async () => {
vi.stubEnv('KIMI_CODE_EXPERIMENTAL_FLAG', '0');
vi.stubEnv('KIMI_CODE_EXPERIMENTAL_MICRO_COMPACTION', '');
const homeDir = await makeTempDir();
await writeFile(
join(homeDir, 'config.toml'),
`
[experimental]
micro_compaction = false
`,
'utf-8',
);
const harness = createKimiHarness({ homeDir, identity: TEST_IDENTITY });
const features = await harness.getExperimentalFeatures();
const microCompaction = features.find((feature) => feature.id === 'micro_compaction');
expect(microCompaction).toMatchObject({
id: 'micro_compaction',
title: 'Micro compaction',
enabled: false,
source: 'config',
configValue: false,
env: 'KIMI_CODE_EXPERIMENTAL_MICRO_COMPACTION',
});
expect(features).toEqual([
expect.objectContaining({ id: 'micro_compaction', enabled: false }),
]);
});
it('can create the default config scaffold without selecting a model', async () => {
const homeDir = await makeTempDir();
const configPath = join(homeDir, 'config.toml');
const harness = createKimiHarness({ homeDir, identity: TEST_IDENTITY });
await harness.ensureConfigFile();
const text = await readFile(configPath, 'utf-8');
expect(text).toContain('Runtime settings for Kimi Code.');
expect(text).not.toMatch(/^default_thinking =/m);
expect(text).not.toMatch(/^default_model =/m);
const config = await harness.getConfig({ reload: true });
expect(config.providers).toEqual({});
expect(config.defaultModel).toBeUndefined();
expect(config.defaultThinking).toBeUndefined();
});
it('reloads an active session without closing the SDK session wrapper', async () => {
const homeDir = await makeTempDir();
const workDir = join(homeDir, 'work');
const configPath = join(homeDir, 'config.toml');
await writeFile(configPath, COMPLETE_TOML, 'utf-8');
const harness = createKimiHarness({ homeDir, identity: TEST_IDENTITY });
const session = await harness.createSession({
id: 'session-sdk-reload',
workDir,
model: 'kimi-for-coding',
});
expect(session.getResumeState()).toBeUndefined();
const reloaded = await harness.reloadSession({ id: session.id });
expect(reloaded).toBe(session);
expect(harness.getSession(session.id)).toBe(session);
expect(session.getResumeState()?.agents['main']).toBeDefined();
await expect(session.getStatus()).resolves.toMatchObject({ model: 'kimi-for-coding' });
});
it('forwards forcePluginSessionStartReminder to the active session reload', async () => {
const homeDir = await makeTempDir();
const workDir = join(homeDir, 'work');
const configPath = join(homeDir, 'config.toml');
await writeFile(configPath, COMPLETE_TOML, 'utf-8');
const harness = createKimiHarness({ homeDir, identity: TEST_IDENTITY });
const session = await harness.createSession({
id: 'session-sdk-reload-forward',
workDir,
model: 'kimi-for-coding',
});
const reloadSpy = vi.spyOn(session, 'reloadSession').mockResolvedValue({} as never);
await harness.reloadSession({ id: session.id, forcePluginSessionStartReminder: true });
expect(reloadSpy).toHaveBeenCalledWith({ forcePluginSessionStartReminder: true });
});
});