2026-05-10 23:12:26 +02:00
|
|
|
import { describe, expect, it, vi } from 'vitest';
|
test: split cli tests from source tree (#216)
* feat(cli): define full warehouse dialect contract
* test(cli): keep dialect edge tests focused
* fix(cli): stabilize dialect contract foundation
* refactor(connectors): own read-only query preparation
* refactor(connectors): resolve dialects through registry
* refactor(connectors): keep concrete dialect classes internal
* chore(workspace): enforce dialect import boundary
* refactor(cli): resolve relationship dialect at scan boundary
* refactor(cli): use dialect display parsing for entity details
* refactor(cli): use dialect display parsing for warehouse catalog
* refactor(cli): use dialect SQL in relationship workflows
* test(cli): verify solid dialect scan workflow closure
* test: split cli tests from source tree
* refactor(cli): standardize BigQuery scope listing
* feat(sqlite): implement connector scope listing
* test(connectors): cover required table listing
* feat(cli): add warehouse driver registry
* refactor(setup): route scope discovery through driver registry
* refactor(cli): route local query execution through driver registry
* refactor(historic-sql): route dialect support through driver registry
* refactor(cli): test warehouse connections through driver registry
* fix(cli): close driver registry type export gaps
* Improve setup daemon diagnostics
* refactor(setup): centralize rail-prefixed diagnostics + query-history fallback
Extract errorMessage, writePrefixedLines, and flushPrefixedBufferedCommandOutput
into clack.ts so the setup wizard, managed daemons, and embedding/agent steps
share one rail-formatted writer. setup-databases.ts also adds a
"disable query history and retry" option when the schema-context build fails
and query history is the likely culprit, surfaced via a new
failed-query-history-unavailable status.
* fix(cli): carry catalog through the picker so BigQuery/Snowflake/SQL Server scope filters match
The setup picker's KtxTableListEntry was a 2-level { schema, name }, so
qualifiedTableId always wrote db.name into enabled_tables. When BigQuery,
Snowflake, or SQL Server later ran fast ingest, their introspect step filtered
the scope set with scopedTableNames(scope, { catalog: projectId|database, db })
— catalog was non-null on the introspect side but null in the scope refs, so
every entry was rejected, the live-database adapter staged zero table files,
and detect() failed with 'Adapter "live-database" did not recognize fetched
source output'.
Align the picker boundary with the canonical 3-level KtxTableRef:
- Add catalog: string | null to KtxTableListEntry.
- BigQuery/Snowflake/SQL Server listTables populate catalog from the
resolved projectId / database; Postgres/MySQL/ClickHouse/SQLite set null.
- qualifiedTableId emits catalog.schema.name when catalog is non-null
(resolveEnabledTables already accepts the 3-part shape) and
schemasFromEnabledTables now goes through parseDottedTableEntry so it
recovers the schema correctly from both 2-part and 3-part entries.
- Export parseDottedTableEntry from enabled-tables.ts (@internal) for picker
reuse.
Update listTables expectations in all seven connector tests and the setup /
picker test fixtures. Add a picker regression test that covers the
catalog-bearing round-trip (save + refine).
* fix(cli): allow debug telemetry under opt-out env
2026-05-26 08:49:05 +02:00
|
|
|
import { runKtxCli } from '../src/index.js';
|
2026-05-10 23:12:26 +02:00
|
|
|
|
|
|
|
|
function makeIo() {
|
|
|
|
|
let stdout = '';
|
|
|
|
|
let stderr = '';
|
|
|
|
|
return {
|
|
|
|
|
io: {
|
|
|
|
|
stdout: {
|
|
|
|
|
write: (chunk: string) => {
|
|
|
|
|
stdout += chunk;
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
stderr: {
|
|
|
|
|
write: (chunk: string) => {
|
|
|
|
|
stderr += chunk;
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
stdout: () => stdout,
|
|
|
|
|
stderr: () => stderr,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-20 01:36:54 +02:00
|
|
|
describe('admin Commander tree', () => {
|
|
|
|
|
it('prints visible admin help with supported low-level command groups', async () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
const testIo = makeIo();
|
|
|
|
|
|
2026-05-20 01:36:54 +02:00
|
|
|
await expect(runKtxCli(['admin', '--help'], testIo.io)).resolves.toBe(0);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-20 01:36:54 +02:00
|
|
|
expect(testIo.stdout()).toContain('Usage: ktx admin [options] [command]');
|
|
|
|
|
for (const command of ['init', 'runtime', 'reindex']) {
|
2026-05-10 23:12:26 +02:00
|
|
|
expect(testIo.stdout()).toContain(command);
|
|
|
|
|
}
|
|
|
|
|
for (const removed of [
|
2026-05-12 23:51:46 +02:00
|
|
|
'doctor',
|
2026-05-13 12:00:08 +02:00
|
|
|
'scan',
|
|
|
|
|
'ingest',
|
|
|
|
|
'mapping',
|
2026-05-10 23:12:26 +02:00
|
|
|
'knowledge',
|
|
|
|
|
'model',
|
|
|
|
|
'replay',
|
|
|
|
|
'report',
|
|
|
|
|
'status',
|
|
|
|
|
'artifacts',
|
|
|
|
|
'config',
|
|
|
|
|
'tools',
|
|
|
|
|
'daemon',
|
|
|
|
|
]) {
|
|
|
|
|
expect(testIo.stdout()).not.toContain(`${removed} `);
|
|
|
|
|
}
|
|
|
|
|
expect(testIo.stderr()).toBe('');
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-20 01:36:54 +02:00
|
|
|
it('lists admin in root command rows', async () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
const testIo = makeIo();
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
await expect(runKtxCli(['--help'], testIo.io)).resolves.toBe(0);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
expect(testIo.stdout()).not.toContain('Advanced:');
|
2026-05-20 01:36:54 +02:00
|
|
|
expect(testIo.stdout()).toContain('admin');
|
|
|
|
|
expect(testIo.stdout()).toMatch(/Low-level project initialization,\s+runtime,\s+and index management/);
|
2026-05-10 23:12:26 +02:00
|
|
|
expect(testIo.stderr()).toBe('');
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-20 01:36:54 +02:00
|
|
|
it('does not keep a dev alias', async () => {
|
|
|
|
|
const testIo = makeIo();
|
|
|
|
|
|
|
|
|
|
await expect(runKtxCli(['dev', '--help'], testIo.io)).resolves.toBe(1);
|
|
|
|
|
|
|
|
|
|
expect(testIo.stderr()).toContain("unknown command 'dev'");
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('keeps project scaffolding under admin init', async () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
const { mkdtemp, readFile, rm } = await import('node:fs/promises');
|
|
|
|
|
const { tmpdir } = await import('node:os');
|
|
|
|
|
const { join } = await import('node:path');
|
2026-05-20 01:36:54 +02:00
|
|
|
const tempDir = await mkdtemp(join(tmpdir(), 'ktx-admin-init-'));
|
2026-05-10 23:12:26 +02:00
|
|
|
const projectDir = join(tempDir, 'warehouse');
|
|
|
|
|
const testIo = makeIo();
|
|
|
|
|
|
|
|
|
|
try {
|
2026-05-20 01:36:54 +02:00
|
|
|
await expect(runKtxCli(['admin', 'init', projectDir], testIo.io)).resolves.toBe(0);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
expect(testIo.stdout()).toContain(`Initialized KTX project at ${projectDir}`);
|
2026-05-14 17:39:31 +02:00
|
|
|
await expect(readFile(join(projectDir, 'ktx.yaml'), 'utf-8')).resolves.not.toContain('project:');
|
2026-05-10 23:12:26 +02:00
|
|
|
expect(testIo.stderr()).toBe('');
|
|
|
|
|
} finally {
|
|
|
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-20 01:36:54 +02:00
|
|
|
it('uses global project-dir for admin init when the positional directory is omitted', async () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
const { mkdtemp, rm } = await import('node:fs/promises');
|
|
|
|
|
const { tmpdir } = await import('node:os');
|
|
|
|
|
const { join } = await import('node:path');
|
2026-05-20 01:36:54 +02:00
|
|
|
const tempDir = await mkdtemp(join(tmpdir(), 'ktx-admin-init-global-'));
|
2026-05-10 23:12:26 +02:00
|
|
|
const projectDir = join(tempDir, 'global-init');
|
|
|
|
|
const testIo = makeIo();
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
await expect(
|
2026-05-20 01:36:54 +02:00
|
|
|
runKtxCli(['--project-dir', projectDir, 'admin', 'init'], testIo.io),
|
2026-05-10 23:12:26 +02:00
|
|
|
).resolves.toBe(0);
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
expect(testIo.stdout()).toContain(`Initialized KTX project at ${projectDir}`);
|
2026-05-10 23:12:26 +02:00
|
|
|
expect(testIo.stderr()).toBe('');
|
|
|
|
|
} finally {
|
|
|
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-17 19:15:09 +02:00
|
|
|
it('prints config schema without requiring a KTX project directory', async () => {
|
|
|
|
|
const { mkdtemp, rm } = await import('node:fs/promises');
|
|
|
|
|
const { tmpdir } = await import('node:os');
|
|
|
|
|
const { join } = await import('node:path');
|
2026-05-20 01:36:54 +02:00
|
|
|
const tempDir = await mkdtemp(join(tmpdir(), 'ktx-admin-schema-'));
|
2026-05-17 19:15:09 +02:00
|
|
|
const missingProjectDir = join(tempDir, 'missing-project');
|
|
|
|
|
const originalProjectDir = process.env.KTX_PROJECT_DIR;
|
|
|
|
|
const testIo = makeIo();
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
process.env.KTX_PROJECT_DIR = missingProjectDir;
|
|
|
|
|
|
2026-05-20 01:36:54 +02:00
|
|
|
await expect(runKtxCli(['admin', 'schema'], testIo.io)).resolves.toBe(0);
|
2026-05-17 19:15:09 +02:00
|
|
|
|
|
|
|
|
expect(JSON.parse(testIo.stdout())).toMatchObject({
|
|
|
|
|
title: 'ktx.yaml',
|
|
|
|
|
type: 'object',
|
|
|
|
|
});
|
|
|
|
|
expect(testIo.stderr()).toBe('');
|
|
|
|
|
} finally {
|
|
|
|
|
if (originalProjectDir === undefined) {
|
|
|
|
|
delete process.env.KTX_PROJECT_DIR;
|
|
|
|
|
} else {
|
|
|
|
|
process.env.KTX_PROJECT_DIR = originalProjectDir;
|
|
|
|
|
}
|
|
|
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-20 01:36:54 +02:00
|
|
|
it('rejects removed admin command groups', async () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
for (const argv of [
|
2026-05-20 01:36:54 +02:00
|
|
|
['admin', 'doctor', 'setup'],
|
|
|
|
|
['admin', 'runtime', 'doctor'],
|
|
|
|
|
['admin', 'runtime', 'prune', '--dry-run'],
|
|
|
|
|
['admin', 'scan', 'warehouse'],
|
|
|
|
|
['admin', 'ingest', 'run'],
|
|
|
|
|
['admin', 'mapping', 'list'],
|
|
|
|
|
['admin', 'completion', 'zsh'],
|
|
|
|
|
['admin', '__complete', '--shell', 'zsh', '--position', '2', '--', 'ktx', ''],
|
|
|
|
|
['admin', 'knowledge', 'list'],
|
|
|
|
|
['admin', 'model', 'list'],
|
|
|
|
|
['admin', 'artifacts'],
|
2026-05-10 23:12:26 +02:00
|
|
|
]) {
|
|
|
|
|
const testIo = makeIo();
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
await expect(runKtxCli(argv, testIo.io)).resolves.toBe(1);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
|
|
|
|
expect(testIo.stderr()).toMatch(/unknown command|error:/);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it.each([
|
|
|
|
|
{
|
2026-05-20 01:36:54 +02:00
|
|
|
argv: ['admin', 'runtime', '--help'],
|
|
|
|
|
expected: ['Usage: ktx admin runtime', 'install', 'start', 'stop', 'status'],
|
2026-05-10 23:12:26 +02:00
|
|
|
},
|
|
|
|
|
])('prints generated nested help for $argv', async ({ argv, expected }) => {
|
|
|
|
|
const io = makeIo();
|
|
|
|
|
const doctor = vi.fn(async () => 0);
|
|
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
await expect(runKtxCli(argv, io.io, { doctor })).resolves.toBe(0);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
|
|
|
|
for (const text of expected) {
|
|
|
|
|
expect(io.stdout()).toContain(text);
|
|
|
|
|
}
|
2026-05-20 01:36:54 +02:00
|
|
|
if (argv.join(' ') === 'admin runtime --help') {
|
2026-05-13 12:28:24 +02:00
|
|
|
expect(io.stdout()).not.toContain('prune');
|
|
|
|
|
expect(io.stdout()).not.toContain('doctor');
|
|
|
|
|
}
|
2026-05-10 23:12:26 +02:00
|
|
|
expect(io.stderr()).toBe('');
|
|
|
|
|
expect(doctor).not.toHaveBeenCalled();
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
it('rejects old adapter-backed ingest flags through public option parsing and keeps run out of ingest help', async () => {
|
|
|
|
|
const helpIo = makeIo();
|
|
|
|
|
const runIo = makeIo();
|
|
|
|
|
const publicIngest = vi.fn(async () => 0);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
await expect(runKtxCli(['ingest', '--help'], helpIo.io, { publicIngest })).resolves.toBe(0);
|
2026-05-10 23:12:26 +02:00
|
|
|
await expect(
|
2026-05-14 01:43:06 +02:00
|
|
|
runKtxCli(
|
|
|
|
|
['ingest', 'run', '--connection-id', 'warehouse', '--adapter', 'metabase', '--project-dir', '/tmp/project'],
|
|
|
|
|
runIo.io,
|
|
|
|
|
{ publicIngest },
|
|
|
|
|
),
|
|
|
|
|
).resolves.toBe(1);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
expect(helpIo.stdout()).not.toMatch(/^ run\s/m);
|
|
|
|
|
expect(runIo.stderr()).toMatch(/unknown option '--connection-id'|error:/);
|
|
|
|
|
expect(publicIngest).not.toHaveBeenCalled();
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
|
2026-05-13 12:00:08 +02:00
|
|
|
it.each([
|
2026-05-14 01:43:06 +02:00
|
|
|
{ argv: ['scan'] },
|
|
|
|
|
{ argv: ['scan', '--help'] },
|
|
|
|
|
{ argv: ['scan', 'warehouse'] },
|
|
|
|
|
{ argv: ['scan', 'warehouse', '--project-dir', '/tmp/project', '--dry-run'] },
|
|
|
|
|
{ argv: ['scan', 'warehouse', '--project-dir', '/tmp/project', '--mode', 'relationships'] },
|
|
|
|
|
])('rejects removed top-level scan command $argv', async ({ argv }) => {
|
2026-05-10 23:12:26 +02:00
|
|
|
const io = makeIo();
|
2026-05-14 01:43:06 +02:00
|
|
|
const publicIngest = vi.fn(async () => 0);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
await expect(runKtxCli(argv, io.io, { publicIngest })).resolves.toBe(1);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
expect(publicIngest).not.toHaveBeenCalled();
|
|
|
|
|
expect(io.stderr()).toMatch(/unknown command|error:/);
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
it('rejects old adapter-backed top-level ingest flags without low-level ingest registration', async () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
const io = makeIo();
|
2026-05-14 01:43:06 +02:00
|
|
|
const publicIngest = vi.fn(async () => 0);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
|
|
|
|
await expect(
|
2026-05-10 23:51:24 +02:00
|
|
|
runKtxCli(
|
2026-05-10 23:12:26 +02:00
|
|
|
[
|
|
|
|
|
'ingest',
|
|
|
|
|
'run',
|
|
|
|
|
'--connection-id',
|
|
|
|
|
'warehouse',
|
|
|
|
|
'--adapter',
|
|
|
|
|
'metabase',
|
|
|
|
|
'--project-dir',
|
|
|
|
|
'/tmp/project',
|
|
|
|
|
'--json',
|
|
|
|
|
],
|
|
|
|
|
io.io,
|
2026-05-14 01:43:06 +02:00
|
|
|
{ publicIngest },
|
2026-05-10 23:12:26 +02:00
|
|
|
),
|
2026-05-14 01:43:06 +02:00
|
|
|
).resolves.toBe(1);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-14 01:43:06 +02:00
|
|
|
expect(publicIngest).not.toHaveBeenCalled();
|
|
|
|
|
expect(io.stderr()).toMatch(/unknown option '--connection-id'|error:/);
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
});
|