mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
* docs: add npm managed python runtime design * build: add bundled python runtime wheel builder * build: make local embedding dependencies optional * build: bundle python runtime wheel in cli artifacts * build: track bundled python runtime release artifact * test: verify bundled python runtime wheel * docs: add plan for bundled python runtime wheel * test: cover managed python runtime lifecycle * feat: add managed python runtime installer * feat: add runtime command runner * feat: expose runtime management commands * test: verify managed python runtime commands * docs: add plan for managed python runtime installer * feat: add managed python command helper * feat: use managed runtime for sl query compute * feat: route sl query managed runtime policy * docs: add plan for managed runtime sl query integration * feat: add managed runtime daemon metadata * feat: manage python daemon lifecycle * feat: add runtime daemon start stop commands * fix: verify managed runtime daemon lifecycle * docs: add plan for managed runtime daemon lifecycle * feat: add managed local embeddings config marker * feat: add managed local embeddings daemon helper * feat: use managed runtime for local embedding setup * feat: pass managed runtime policy through setup * docs: add plan for managed local embeddings runtime * feat: read CLI package metadata dynamically * feat: assemble public kaelio ktx npm package * feat: release one public kaelio ktx npm artifact * test: cover public kaelio ktx package invocations * chore: verify public kaelio ktx package artifacts * docs: add plan for public kaelio ktx npm package * test: verify managed runtime in public package smoke * test: finalize managed runtime release smoke * docs: add plan for managed runtime release smoke * test: specify local embeddings release smoke * feat: add local embeddings runtime smoke * chore: register local embeddings smoke * fix: verify local embeddings smoke * fix: restore artifact smoke python env helper * docs: add plan for managed local embeddings release smoke * refactor: share managed runtime install policy parsing * feat: use managed runtime for agent semantic queries * feat: use managed runtime for MCP semantic compute * docs: add plan for managed agent and MCP semantic runtime * feat(cli): add managed daemon HTTP helpers * feat(cli): route local adapters through managed daemon * feat(cli): use managed daemon for ingest helpers * feat(cli): pass managed daemon options to scan * feat(context): pass MCP ingest pull config options * feat(cli): pass managed daemon options to serve ingest * test: verify managed local ingest daemon runtime * docs: add plan for managed local ingest daemon runtime * docs: align managed runtime examples * docs: add plan for managed runtime docs cleanup * test: cover published package runtime smoke commands * test: validate published package smoke outputs * docs: add plan for published package runtime smoke * build: stamp public npm package version * release: add npm public release policy * release: add guarded npm publish script * release: document public npm release handoff * docs: add plan for public npm release handoff * test: cover managed runtime prune in package smoke * docs: document managed runtime prune * docs: add plan for managed runtime prune smoke and docs * chore: encode uv runtime prerequisite policy * fix: clarify missing uv runtime error * docs: document uv runtime prerequisite * docs: add plan for uv runtime prerequisite contract * refactor: limit release artifacts to public package runtime * chore: align release policy with bundled runtime wheel * docs: describe single public runtime artifact surface * test: verify single public runtime artifact contract * docs: add plan for single public runtime artifact cleanup * fix: align local embeddings smoke with public version * docs: add plan for local embeddings smoke public version * release: soft-launch as @kaelio/ktx@0.1.0-rc.0 on next tag Publish target moves to the pre-release version 0.1.0-rc.0 under the next dist-tag so npm install @kaelio/ktx (which resolves to latest) does not pick up the soft-launch build. Users opt in via @kaelio/ktx@next. * Fix release script boundary checks * Remove PostHog from public package bundle
315 lines
11 KiB
TypeScript
315 lines
11 KiB
TypeScript
import { describe, expect, it, vi } from 'vitest';
|
|
import type {
|
|
ManagedPythonDaemonStartResult,
|
|
ManagedPythonDaemonStopResult,
|
|
} from './managed-python-daemon.js';
|
|
import type {
|
|
ManagedPythonRuntimeDoctorCheck,
|
|
ManagedPythonRuntimeInstallResult,
|
|
ManagedPythonRuntimeStatus,
|
|
} from './managed-python-runtime.js';
|
|
import { runKtxRuntime, type KtxRuntimeDeps } from './runtime.js';
|
|
|
|
function makeIo() {
|
|
let stdout = '';
|
|
let stderr = '';
|
|
return {
|
|
io: {
|
|
stdout: {
|
|
write: (chunk: string) => {
|
|
stdout += chunk;
|
|
},
|
|
},
|
|
stderr: {
|
|
write: (chunk: string) => {
|
|
stderr += chunk;
|
|
},
|
|
},
|
|
},
|
|
stdout: () => stdout,
|
|
stderr: () => stderr,
|
|
};
|
|
}
|
|
|
|
describe('runKtxRuntime', () => {
|
|
it('installs the requested runtime feature and prints the manifest path', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
installRuntime: vi.fn(async (): Promise<ManagedPythonRuntimeInstallResult> => ({
|
|
status: 'installed',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
daemonStatePath: '/runtime/0.2.0/daemon.json',
|
|
daemonStdoutPath: '/runtime/0.2.0/daemon.stdout.log',
|
|
daemonStderrPath: '/runtime/0.2.0/daemon.stderr.log',
|
|
},
|
|
asset: {
|
|
wheelPath: '/assets/python/kaelio_ktx-0.1.0-py3-none-any.whl',
|
|
manifest: {
|
|
schemaVersion: 1,
|
|
distributionName: 'kaelio-ktx',
|
|
normalizedName: 'kaelio_ktx',
|
|
version: '0.1.0',
|
|
wheel: {
|
|
file: 'kaelio_ktx-0.1.0-py3-none-any.whl',
|
|
sha256: 'a'.repeat(64),
|
|
bytes: 10,
|
|
},
|
|
},
|
|
},
|
|
manifest: {
|
|
schemaVersion: 1,
|
|
cliVersion: '0.2.0',
|
|
installedAt: '2026-05-11T00:00:00.000Z',
|
|
asset: {
|
|
schemaVersion: 1,
|
|
distributionName: 'kaelio-ktx',
|
|
normalizedName: 'kaelio_ktx',
|
|
version: '0.1.0',
|
|
wheel: {
|
|
file: 'kaelio_ktx-0.1.0-py3-none-any.whl',
|
|
sha256: 'a'.repeat(64),
|
|
bytes: 10,
|
|
},
|
|
},
|
|
features: ['core', 'local-embeddings'],
|
|
python: {
|
|
executable: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonExecutable: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
},
|
|
installLog: '/runtime/0.2.0/install.log',
|
|
},
|
|
})),
|
|
};
|
|
|
|
await expect(
|
|
runKtxRuntime(
|
|
{ command: 'install', cliVersion: '0.2.0', feature: 'local-embeddings', force: true },
|
|
io.io,
|
|
deps,
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(deps.installRuntime).toHaveBeenCalledWith({
|
|
cliVersion: '0.2.0',
|
|
features: ['local-embeddings'],
|
|
force: true,
|
|
});
|
|
expect(io.stdout()).toContain('Installed KTX Python runtime');
|
|
expect(io.stdout()).toContain('features: core, local-embeddings');
|
|
expect(io.stdout()).toContain('manifest: /runtime/0.2.0/manifest.json');
|
|
expect(io.stderr()).toBe('');
|
|
});
|
|
|
|
it('starts the managed Python daemon and prints the base URL', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
startDaemon: vi.fn(async (): Promise<ManagedPythonDaemonStartResult> => ({
|
|
status: 'started',
|
|
baseUrl: 'http://127.0.0.1:61234',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
daemonStatePath: '/runtime/0.2.0/daemon.json',
|
|
daemonStdoutPath: '/runtime/0.2.0/daemon.stdout.log',
|
|
daemonStderrPath: '/runtime/0.2.0/daemon.stderr.log',
|
|
},
|
|
state: {
|
|
schemaVersion: 1,
|
|
pid: 4242,
|
|
host: '127.0.0.1',
|
|
port: 61234,
|
|
version: '0.2.0',
|
|
features: ['core', 'local-embeddings'],
|
|
startedAt: '2026-05-11T00:00:00.000Z',
|
|
stdoutLog: '/runtime/0.2.0/daemon.stdout.log',
|
|
stderrLog: '/runtime/0.2.0/daemon.stderr.log',
|
|
},
|
|
})),
|
|
};
|
|
|
|
await expect(
|
|
runKtxRuntime(
|
|
{ command: 'start', cliVersion: '0.2.0', feature: 'local-embeddings', force: true },
|
|
io.io,
|
|
deps,
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(deps.startDaemon).toHaveBeenCalledWith({
|
|
cliVersion: '0.2.0',
|
|
features: ['local-embeddings'],
|
|
force: true,
|
|
});
|
|
expect(io.stdout()).toContain('Started KTX Python daemon');
|
|
expect(io.stdout()).toContain('url: http://127.0.0.1:61234');
|
|
expect(io.stdout()).toContain('pid: 4242');
|
|
expect(io.stdout()).toContain('features: core, local-embeddings');
|
|
expect(io.stdout()).toContain('stderr: /runtime/0.2.0/daemon.stderr.log');
|
|
});
|
|
|
|
it('stops the managed Python daemon', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
stopDaemon: vi.fn(async (): Promise<ManagedPythonDaemonStopResult> => ({
|
|
status: 'stopped',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
daemonStatePath: '/runtime/0.2.0/daemon.json',
|
|
daemonStdoutPath: '/runtime/0.2.0/daemon.stdout.log',
|
|
daemonStderrPath: '/runtime/0.2.0/daemon.stderr.log',
|
|
},
|
|
state: {
|
|
schemaVersion: 1,
|
|
pid: 4242,
|
|
host: '127.0.0.1',
|
|
port: 61234,
|
|
version: '0.2.0',
|
|
features: ['core'],
|
|
startedAt: '2026-05-11T00:00:00.000Z',
|
|
stdoutLog: '/runtime/0.2.0/daemon.stdout.log',
|
|
stderrLog: '/runtime/0.2.0/daemon.stderr.log',
|
|
},
|
|
})),
|
|
};
|
|
|
|
await expect(runKtxRuntime({ command: 'stop', cliVersion: '0.2.0' }, io.io, deps)).resolves.toBe(0);
|
|
|
|
expect(deps.stopDaemon).toHaveBeenCalledWith({ cliVersion: '0.2.0' });
|
|
expect(io.stdout()).toContain('Stopped KTX Python daemon');
|
|
expect(io.stdout()).toContain('pid: 4242');
|
|
});
|
|
|
|
it('prints runtime status as JSON', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
readStatus: vi.fn(async (): Promise<ManagedPythonRuntimeStatus> => ({
|
|
kind: 'missing',
|
|
detail: 'No runtime manifest at /runtime/0.2.0/manifest.json',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
daemonStatePath: '/runtime/0.2.0/daemon.json',
|
|
daemonStdoutPath: '/runtime/0.2.0/daemon.stdout.log',
|
|
daemonStderrPath: '/runtime/0.2.0/daemon.stderr.log',
|
|
},
|
|
})),
|
|
};
|
|
|
|
await expect(runKtxRuntime({ command: 'status', cliVersion: '0.2.0', json: true }, io.io, deps)).resolves.toBe(0);
|
|
|
|
expect(JSON.parse(io.stdout())).toMatchObject({
|
|
kind: 'missing',
|
|
detail: 'No runtime manifest at /runtime/0.2.0/manifest.json',
|
|
layout: { runtimeRoot: '/runtime' },
|
|
});
|
|
});
|
|
|
|
it('returns failure for doctor when any check fails', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
doctorRuntime: vi.fn(async (): Promise<ManagedPythonRuntimeDoctorCheck[]> => [
|
|
{ id: 'uv', label: 'uv', status: 'pass', detail: 'uv 0.9.5' },
|
|
{
|
|
id: 'runtime',
|
|
label: 'Managed Python runtime',
|
|
status: 'fail',
|
|
detail: 'No runtime manifest',
|
|
fix: 'Run: ktx runtime install --yes',
|
|
},
|
|
]),
|
|
};
|
|
|
|
await expect(runKtxRuntime({ command: 'doctor', cliVersion: '0.2.0', json: false }, io.io, deps)).resolves.toBe(1);
|
|
|
|
expect(io.stdout()).toContain('PASS uv: uv 0.9.5');
|
|
expect(io.stdout()).toContain('FAIL Managed Python runtime: No runtime manifest');
|
|
expect(io.stdout()).toContain('Fix: Run: ktx runtime install --yes');
|
|
});
|
|
|
|
it('requires --yes before pruning stale runtime directories', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
pruneRuntime: vi.fn(async () => {
|
|
throw new Error('should not prune without --yes');
|
|
}),
|
|
};
|
|
|
|
await expect(runKtxRuntime({ command: 'prune', cliVersion: '0.2.0', dryRun: false, yes: false }, io.io, deps))
|
|
.resolves.toBe(1);
|
|
|
|
expect(io.stderr()).toContain('Refusing to prune without --yes');
|
|
expect(deps.pruneRuntime).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it('prints stale directories during prune dry-run', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
readStatus: vi.fn(async (): Promise<ManagedPythonRuntimeStatus> => ({
|
|
kind: 'missing',
|
|
detail: 'No runtime manifest at /runtime/0.2.0/manifest.json',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
daemonStatePath: '/runtime/0.2.0/daemon.json',
|
|
daemonStdoutPath: '/runtime/0.2.0/daemon.stdout.log',
|
|
daemonStderrPath: '/runtime/0.2.0/daemon.stderr.log',
|
|
},
|
|
})),
|
|
pruneRuntime: vi.fn(async () => ({
|
|
runtimeRoot: '/runtime',
|
|
stale: ['/runtime/0.1.0'],
|
|
kept: ['/runtime/0.2.0'],
|
|
removed: [],
|
|
})),
|
|
};
|
|
|
|
await expect(runKtxRuntime({ command: 'prune', cliVersion: '0.2.0', dryRun: true, yes: false }, io.io, deps))
|
|
.resolves.toBe(0);
|
|
|
|
expect(io.stdout()).toContain('Stale KTX Python runtimes');
|
|
expect(io.stdout()).toContain('/runtime/0.1.0');
|
|
});
|
|
});
|