File size: 10,114 Bytes
6a2bc3b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | /**
* Scenario: maintainers package and inspect the VS Code extension on any host OS.
* Responsibilities: six-target argument handling, actionable failures, isolated
* dev state, manifest/resource hygiene, unresolved imports, and entry loading.
* Wiring: real Node packaging/verifier CLIs and filesystem; VSIX directory
* fixtures replace only the external Marketplace archive producer.
* Run: pnpm --filter kimi-code exec vitest run --config vitest.config.ts test/vsix-package.test.ts
*/
import { spawnSync } from 'node:child_process';
import { mkdtemp, mkdir, readFile, rm, stat, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join, resolve } from 'node:path';
import { afterEach, describe, expect, it } from 'vitest';
const appRoot = resolve(import.meta.dirname, '..');
const packageScript = join(appRoot, 'scripts', 'vsix-package.mjs');
const verifierScript = join(appRoot, 'scripts', 'vsix-verify.mjs');
const prepareDevScript = join(appRoot, 'scripts', 'prepare-dev.mjs');
const tempDirs: string[] = [];
afterEach(async () => {
await Promise.all(tempDirs.splice(0).map((dir) => rm(dir, { recursive: true, force: true })));
});
describe('VSIX package CLI (target planning and validation)', () => {
it('plans all six supported targets when no target is supplied', async () => {
const outputDir = await makeTempDir('kimi-package-plan-');
const result = runNode(packageScript, ['--dry-run', '--out-dir', outputDir]);
expect(result.status).toBe(0);
expect(result.stdout.match(/Would package /g)).toHaveLength(6);
expect(result.stdout).toContain('kimi-code-darwin-x64.vsix');
expect(result.stdout).toContain('kimi-code-darwin-arm64.vsix');
expect(result.stdout).toContain('kimi-code-linux-x64.vsix');
expect(result.stdout).toContain('kimi-code-linux-arm64.vsix');
expect(result.stdout).toContain('kimi-code-win32-x64.vsix');
expect(result.stdout).toContain('kimi-code-win32-arm64.vsix');
});
it('accepts a Windows ARM target when the output path contains spaces', async () => {
const root = await makeTempDir('kimi-package-windows-');
const outputDir = join(root, 'output with spaces');
const result = runNode(packageScript, [
'--',
'--dry-run',
'--target',
'win32-arm64',
'--out-dir',
outputDir,
]);
expect(result.status).toBe(0);
expect(result.stdout.match(/Would package /g)).toHaveLength(1);
expect(result.stdout).toContain('kimi-code-win32-arm64.vsix');
});
it('rejects an unknown target before a build starts', () => {
const result = runNode(packageScript, ['plan9-x64', '--dry-run']);
expect(result.status).toBe(1);
expect(result.stderr).toContain('Unknown VSIX target "plan9-x64"');
expect(result.stderr).toContain('win32-arm64');
});
});
describe('VSIX verifier CLI (package contract and failure details)', () => {
it('passes an unpacked Windows package when the entry is self-contained', async () => {
const fixture = await makeVsixFixture('win32-x64');
const result = runNode(verifierScript, [
'--target',
'win32-x64',
'--directory',
fixture,
]);
expect(result.status).toBe(0);
expect(result.stdout).toContain('static audit and entry import smoke passed (package-only)');
});
it('reports the expected target when the VSIX manifest has a different target', async () => {
const fixture = await makeVsixFixture('darwin-arm64');
const result = runNode(verifierScript, [
'--target',
'linux-x64',
'--directory',
fixture,
]);
expect(result.status).toBe(1);
expect(result.stderr).toContain('VSIX manifest target is darwin-arm64, expected linux-x64');
});
it('names a missing required Webview resource', async () => {
const fixture = await makeVsixFixture('darwin-x64');
await rm(join(fixture, 'extension', 'dist', 'webview.js'));
const result = runNode(verifierScript, [
'--target',
'darwin-x64',
'--directory',
fixture,
]);
expect(result.status).toBe(1);
expect(result.stderr).toContain('Required VSIX resource is missing: extension/dist/webview.js');
});
it('reports a bare runtime dependency left in the extension bundle', async () => {
const fixture = await makeVsixFixture('linux-arm64');
await writeFile(
join(fixture, 'extension', 'dist', 'extension.js'),
"import leftPad from 'left-pad';\nexport function activate() { return leftPad; }\n",
);
const result = runNode(verifierScript, [
'--target',
'linux-arm64',
'--directory',
fixture,
]);
expect(result.status).toBe(1);
expect(result.stderr).toContain('Bare runtime dependency "left-pad"');
});
it('does not mistake a bundled this.require(...) method call for a runtime dependency', async () => {
const fixture = await makeVsixFixture('darwin-arm64');
await writeFile(
join(fixture, 'extension', 'dist', 'extension.js'),
'class HostEnvironment {\n' +
' require(field) { return this.info[field]; }\n' +
' get osKind() { return this.require("osKind"); }\n' +
'}\n' +
'export function activate() { return new HostEnvironment(); }\n',
);
const result = runNode(verifierScript, [
'--target',
'darwin-arm64',
'--directory',
fixture,
]);
expect(result.status).toBe(0);
});
it('rejects generated session state inside the package', async () => {
const fixture = await makeVsixFixture('win32-arm64');
const stateDir = join(fixture, 'extension', 'runtime', 'profile');
await mkdir(stateDir, { recursive: true });
await writeFile(join(stateDir, 'session.json'), '{}');
const result = runNode(verifierScript, [
'--target',
'win32-arm64',
'--directory',
fixture,
]);
expect(result.status).toBe(1);
expect(result.stderr).toContain('Forbidden package path segment "runtime"');
});
it('rejects a persisted state directory inside the package', async () => {
const fixture = await makeVsixFixture('win32-x64');
const stateDir = join(fixture, 'extension', 'state');
await mkdir(stateDir, { recursive: true });
await writeFile(join(stateDir, 'extension.json'), '{}');
const result = runNode(verifierScript, [
'--target',
'win32-x64',
'--directory',
fixture,
]);
expect(result.status).toBe(1);
expect(result.stderr).toContain('Forbidden package path segment "state"');
});
});
describe('Extension Development Host setup (isolated local state)', () => {
it('creates the complete isolated directory layout for a debug launch', async () => {
const parent = await makeTempDir('kimi-dev-profile-');
const baseDir = join(parent, 'vscode-extension-dev');
const result = runNode(prepareDevScript, ['--base-dir', baseDir]);
expect(result.status).toBe(0);
await expect(readFile(join(baseDir, 'workspace', 'README.md'), 'utf8')).resolves.toContain(
'Isolated Kimi Code extension development workspace',
);
await expect(directoryExists(join(baseDir, 'user-data'))).resolves.toBe(true);
await expect(directoryExists(join(baseDir, 'extensions'))).resolves.toBe(true);
await expect(directoryExists(join(baseDir, 'kimi-home'))).resolves.toBe(true);
});
it('refuses to clear a directory without the dedicated safety suffix', async () => {
const unsafeDir = await makeTempDir('kimi-dev-unsafe-');
await writeFile(join(unsafeDir, 'keep.txt'), 'keep');
const result = runNode(prepareDevScript, ['--base-dir', unsafeDir]);
expect(result.status).toBe(1);
expect(result.stderr).toContain('Refusing to reset unsafe development directory');
await expect(readFile(join(unsafeDir, 'keep.txt'), 'utf8')).resolves.toBe('keep');
});
});
async function makeTempDir(prefix: string): Promise<string> {
const dir = await mkdtemp(join(tmpdir(), prefix));
tempDirs.push(dir);
return dir;
}
async function makeVsixFixture(target: string): Promise<string> {
const root = await makeTempDir('kimi-vsix-fixture-');
const extensionDir = join(root, 'extension');
const distDir = join(extensionDir, 'dist');
const resourcesDir = join(extensionDir, 'resources');
await Promise.all([
mkdir(distDir, { recursive: true }),
mkdir(resourcesDir, { recursive: true }),
]);
const packageJson = await readFile(join(appRoot, 'package.json'), 'utf8');
await Promise.all([
writeFile(join(root, '[Content_Types].xml'), '<Types />'),
writeFile(
join(root, 'extension.vsixmanifest'),
`<PackageManifest><Metadata><Identity TargetPlatform="${target}" /></Metadata></PackageManifest>`,
),
writeFile(join(extensionDir, 'package.json'), packageJson),
writeFile(join(extensionDir, 'readme.md'), '# Fixture\n'),
writeFile(join(extensionDir, 'LICENSE.txt'), 'fixture license\n'),
writeFile(
join(distDir, 'extension.js'),
"/** @type {import('../types/index').Extension} */\nimport * as vscode from 'vscode';\nexport function activate() { return vscode; }\n",
),
writeFile(join(distDir, 'webview.js'), 'globalThis.__kimiWebview = true;\n'),
writeFile(join(distDir, 'kimi-banner-dark.svg'), '<svg />'),
writeFile(join(distDir, 'kimi-banner-light.svg'), '<svg />'),
writeFile(join(distDir, 'kimi-logo.png'), 'fixture'),
writeFile(join(resourcesDir, 'kimi-icon-storefront.png'), 'fixture'),
writeFile(join(resourcesDir, 'kimi-icon.svg'), '<svg />'),
]);
return root;
}
function runNode(script: string, args: string[]) {
const result = spawnSync(process.execPath, [script, ...args], {
cwd: appRoot,
encoding: 'utf8',
env: { ...process.env, VSCE_PAT: '', OVSX_PAT: '' },
});
if (result.error !== undefined) throw result.error;
return {
status: result.status,
stdout: result.stdout ?? '',
stderr: result.stderr ?? '',
};
}
async function directoryExists(path: string): Promise<boolean> {
try {
return (await stat(path)).isDirectory();
} catch {
return false;
}
}
|