mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-13 08:15:14 +02:00
00cdf2de90
Align the tree with AGENTS.md/CLAUDE.md conventions: - Rewrite user-facing strings, docs, and tests to lowercase `ktx` (no bare uppercase `KTX` tokens remain outside literal identifiers). - Drop the legacy `historicSql` migration path and its now-unused helpers, per the no-backward-compat rule. - Remove `as unknown as` / `any` casts: narrow `BaseTool` generics to `z.ZodObject`, add a typed `createLookerClient`, and delete the dead `getParametersSchema`/`toAnthropicFormat` pre-AI-SDK helpers. - Use `InvalidArgumentError` for Commander parse failures. - Finish the adapter→connector prose conversion in the `ktx.yaml` docs while keeping the literal `adapters` config key.
98 lines
4.1 KiB
TypeScript
98 lines
4.1 KiB
TypeScript
import { execFileSync } from 'node:child_process';
|
|
import { mkdir, mkdtemp, readFile, realpath, rm, stat } from 'node:fs/promises';
|
|
import { tmpdir } from 'node:os';
|
|
import { join } from 'node:path';
|
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
import { initKtxProject, loadKtxProject } from '../../../src/context/project/project.js';
|
|
|
|
describe('ktx local project runtime', () => {
|
|
let tempDir: string;
|
|
|
|
beforeEach(async () => {
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-project-runtime-'));
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('initializes the standalone project layout and commits it', async () => {
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
|
|
const result = await initKtxProject({
|
|
projectDir,
|
|
authorName: 'Agent',
|
|
authorEmail: 'agent@example.com',
|
|
});
|
|
|
|
expect(result.projectDir).toBe(projectDir);
|
|
expect(result.commitHash).toMatch(/^[0-9a-f]{40}$/);
|
|
await expect(readFile(join(projectDir, 'ktx.yaml'), 'utf-8')).resolves.not.toContain('project:');
|
|
const gitignore = await readFile(join(projectDir, '.ktx/.gitignore'), 'utf-8');
|
|
expect(gitignore).toContain('cache/');
|
|
expect(gitignore).toContain('db.sqlite');
|
|
expect(gitignore).toContain('db.sqlite-*');
|
|
expect(gitignore).toContain('ingest-transcripts/');
|
|
expect(gitignore).toContain('secrets/');
|
|
expect(gitignore).toContain('setup/');
|
|
expect(gitignore).toContain('agents/');
|
|
await expect(stat(join(projectDir, 'wiki/global/.gitkeep'))).resolves.toBeDefined();
|
|
await expect(stat(join(projectDir, 'semantic-layer/.gitkeep'))).resolves.toBeDefined();
|
|
await expect(stat(join(projectDir, '_schema/.gitkeep'))).rejects.toMatchObject({ code: 'ENOENT' });
|
|
await expect(stat(join(projectDir, 'raw-sources/.gitkeep'))).resolves.toBeDefined();
|
|
await expect(stat(join(projectDir, '.git'))).resolves.toBeDefined();
|
|
});
|
|
|
|
it('loads an initialized project with a working file store', async () => {
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
await initKtxProject({ projectDir });
|
|
|
|
const loaded = await loadKtxProject({ projectDir });
|
|
await loaded.fileStore.writeFile(
|
|
'wiki/global/revenue.md',
|
|
'# Revenue\n',
|
|
'Agent',
|
|
'agent@example.com',
|
|
'Add revenue page',
|
|
);
|
|
|
|
await expect(loaded.fileStore.readFile('wiki/global/revenue.md')).resolves.toMatchObject({
|
|
content: '# Revenue\n',
|
|
});
|
|
});
|
|
|
|
it('initializes a dedicated git repo at the project dir even when nested inside an enclosing repo', async () => {
|
|
// A ktx project dir living below an existing git working tree (e.g. an analytics
|
|
// subfolder of an app repo). ktx must own its own repo rooted at the project dir,
|
|
// not silently adopt the enclosing repo — otherwise worktree writes resolve against
|
|
// the enclosing root and land outside the project dir.
|
|
const enclosing = join(tempDir, 'enclosing');
|
|
await mkdir(enclosing, { recursive: true });
|
|
execFileSync('git', ['init', '-q'], { cwd: enclosing });
|
|
|
|
const projectDir = join(enclosing, 'analytics');
|
|
await initKtxProject({ projectDir, authorName: 'Agent', authorEmail: 'agent@example.com' });
|
|
|
|
await expect(stat(join(projectDir, '.git'))).resolves.toBeDefined();
|
|
const toplevel = execFileSync('git', ['rev-parse', '--show-toplevel'], {
|
|
cwd: projectDir,
|
|
encoding: 'utf-8',
|
|
}).trim();
|
|
expect(await realpath(toplevel)).toBe(await realpath(projectDir));
|
|
|
|
// ktx must not write its scaffold commits into the user's enclosing repo.
|
|
const enclosingTracked = execFileSync('git', ['ls-files'], { cwd: enclosing, encoding: 'utf-8' });
|
|
expect(enclosingTracked).not.toContain('ktx.yaml');
|
|
});
|
|
|
|
it('rejects reinitializing an existing project unless force is set', async () => {
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
await initKtxProject({ projectDir });
|
|
|
|
await expect(initKtxProject({ projectDir })).rejects.toThrow('Project already contains ktx.yaml');
|
|
|
|
await expect(initKtxProject({ projectDir, force: true })).resolves.toMatchObject({
|
|
configPath: join(projectDir, 'ktx.yaml'),
|
|
});
|
|
});
|
|
});
|