mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
* 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
1452 lines
45 KiB
TypeScript
1452 lines
45 KiB
TypeScript
import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
|
|
import { tmpdir } from 'node:os';
|
|
import { join } from 'node:path';
|
|
import type { SourceAdapter } from '../src/context/ingest/types.js';
|
|
import { initKtxProject } from '../src/context/project/project.js';
|
|
import type { KtxScanReport } from '../src/context/scan/types.js';
|
|
import type { LocalScanRunResult, RunLocalScanOptions } from '../src/context/scan/local-scan.js';
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import { createCliScanProgress, runKtxScan, type KtxScanDeps } from '../src/scan.js';
|
|
|
|
const sqlServerExtractSchema = vi.hoisted(() =>
|
|
vi.fn(async (connectionId: string) => ({
|
|
connectionId,
|
|
extractedAt: '2026-04-29T16:00:00.000Z',
|
|
metadata: { database: 'analytics' },
|
|
tables: [
|
|
{
|
|
catalog: 'analytics',
|
|
db: 'dbo',
|
|
name: 'orders',
|
|
columns: [{ name: 'id', type: 'int', nullable: false, primaryKey: true }],
|
|
foreignKeys: [],
|
|
},
|
|
],
|
|
})),
|
|
);
|
|
const createSqlServerLiveDatabaseIntrospection = vi.hoisted(() =>
|
|
vi.fn(() => ({ extractSchema: sqlServerExtractSchema })),
|
|
);
|
|
const isKtxSqlServerConnectionConfig = vi.hoisted(() =>
|
|
vi.fn((connection: { driver?: string } | undefined) => connection?.driver === 'sqlserver'),
|
|
);
|
|
const KtxSqlServerScanConnector = vi.hoisted(
|
|
() =>
|
|
class {
|
|
readonly id: string;
|
|
readonly driver = 'sqlserver';
|
|
|
|
constructor(options: { connectionId: string }) {
|
|
this.id = `sqlserver:${options.connectionId}`;
|
|
}
|
|
},
|
|
);
|
|
const bigQueryExtractSchema = vi.hoisted(() =>
|
|
vi.fn(async (connectionId: string) => ({
|
|
connectionId,
|
|
extractedAt: '2026-04-29T17:00:00.000Z',
|
|
metadata: { project_id: 'project-1', datasets: ['analytics'] },
|
|
tables: [
|
|
{
|
|
catalog: 'project-1',
|
|
db: 'analytics',
|
|
name: 'orders',
|
|
columns: [{ name: 'id', type: 'INT64', nullable: false, primaryKey: true }],
|
|
foreignKeys: [],
|
|
},
|
|
],
|
|
})),
|
|
);
|
|
const createBigQueryLiveDatabaseIntrospection = vi.hoisted(() =>
|
|
vi.fn(() => ({ extractSchema: bigQueryExtractSchema })),
|
|
);
|
|
const isKtxBigQueryConnectionConfig = vi.hoisted(() =>
|
|
vi.fn((connection: { driver?: string } | undefined) => connection?.driver === 'bigquery'),
|
|
);
|
|
const KtxBigQueryScanConnector = vi.hoisted(
|
|
() =>
|
|
class {
|
|
readonly id: string;
|
|
readonly driver = 'bigquery';
|
|
|
|
constructor(options: { connectionId: string }) {
|
|
this.id = `bigquery:${options.connectionId}`;
|
|
}
|
|
},
|
|
);
|
|
const snowflakeExtractSchema = vi.hoisted(() =>
|
|
vi.fn(async (connectionId: string) => ({
|
|
connectionId,
|
|
extractedAt: '2026-04-29T18:00:00.000Z',
|
|
metadata: { database: 'ANALYTICS', schemas: ['PUBLIC'] },
|
|
tables: [
|
|
{
|
|
catalog: 'ANALYTICS',
|
|
db: 'PUBLIC',
|
|
name: 'ORDERS',
|
|
columns: [{ name: 'ID', type: 'NUMBER', nullable: false, primaryKey: true }],
|
|
foreignKeys: [],
|
|
},
|
|
],
|
|
})),
|
|
);
|
|
const createSnowflakeLiveDatabaseIntrospection = vi.hoisted(() =>
|
|
vi.fn(() => ({ extractSchema: snowflakeExtractSchema })),
|
|
);
|
|
const isKtxSnowflakeConnectionConfig = vi.hoisted(() =>
|
|
vi.fn((connection: { driver?: string } | undefined) => connection?.driver === 'snowflake'),
|
|
);
|
|
const snowflakeConnectorInstances = vi.hoisted(() => [] as Array<{ cleanup: ReturnType<typeof vi.fn> }>);
|
|
const KtxSnowflakeScanConnector = vi.hoisted(
|
|
() =>
|
|
class {
|
|
readonly id: string;
|
|
readonly driver = 'snowflake';
|
|
readonly cleanup = vi.fn(async () => undefined);
|
|
|
|
constructor(options: { connectionId: string }) {
|
|
this.id = `snowflake:${options.connectionId}`;
|
|
snowflakeConnectorInstances.push(this);
|
|
}
|
|
},
|
|
);
|
|
const postgresExtractSchema = vi.hoisted(() =>
|
|
vi.fn(async (connectionId: string) => ({
|
|
connectionId,
|
|
extractedAt: '2026-04-29T12:00:00.000Z',
|
|
metadata: { database: 'analytics' },
|
|
tables: [],
|
|
})),
|
|
);
|
|
const createPostgresLiveDatabaseIntrospection = vi.hoisted(() =>
|
|
vi.fn(() => ({ extractSchema: postgresExtractSchema })),
|
|
);
|
|
const isKtxPostgresConnectionConfig = vi.hoisted(() =>
|
|
vi.fn((connection: { driver?: string } | undefined) =>
|
|
String(connection?.driver ?? '').toLowerCase() === 'postgres',
|
|
),
|
|
);
|
|
const KtxPostgresScanConnector = vi.hoisted(
|
|
() =>
|
|
class {
|
|
readonly id: string;
|
|
readonly driver = 'postgres';
|
|
|
|
constructor(options: { connectionId: string }) {
|
|
this.id = `postgres:${options.connectionId}`;
|
|
}
|
|
},
|
|
);
|
|
|
|
vi.mock('../src/connectors/sqlserver/connector.js', () => ({
|
|
isKtxSqlServerConnectionConfig,
|
|
KtxSqlServerScanConnector,
|
|
}));
|
|
vi.mock('../src/connectors/sqlserver/live-database-introspection.js', () => ({
|
|
createSqlServerLiveDatabaseIntrospection,
|
|
}));
|
|
|
|
vi.mock('../src/connectors/bigquery/connector.js', () => ({
|
|
isKtxBigQueryConnectionConfig,
|
|
KtxBigQueryScanConnector,
|
|
}));
|
|
vi.mock('../src/connectors/bigquery/live-database-introspection.js', () => ({
|
|
createBigQueryLiveDatabaseIntrospection,
|
|
}));
|
|
|
|
vi.mock('../src/connectors/snowflake/connector.js', () => ({
|
|
isKtxSnowflakeConnectionConfig,
|
|
KtxSnowflakeScanConnector,
|
|
}));
|
|
vi.mock('../src/connectors/snowflake/live-database-introspection.js', () => ({
|
|
createSnowflakeLiveDatabaseIntrospection,
|
|
}));
|
|
|
|
vi.mock('../src/connectors/postgres/connector.js', () => ({
|
|
isKtxPostgresConnectionConfig,
|
|
KtxPostgresScanConnector,
|
|
}));
|
|
vi.mock('../src/connectors/postgres/live-database-introspection.js', () => ({
|
|
createPostgresLiveDatabaseIntrospection,
|
|
}));
|
|
|
|
function makeIo(options: { isTTY?: boolean } = {}) {
|
|
let stdout = '';
|
|
let stderr = '';
|
|
return {
|
|
io: {
|
|
stdout: {
|
|
isTTY: options.isTTY,
|
|
write: (chunk: string) => {
|
|
stdout += chunk;
|
|
},
|
|
},
|
|
stderr: {
|
|
write: (chunk: string) => {
|
|
stderr += chunk;
|
|
},
|
|
},
|
|
},
|
|
stdout: () => stdout,
|
|
stderr: () => stderr,
|
|
};
|
|
}
|
|
|
|
function fakeLiveDatabaseAdapter(
|
|
createIntrospection: (options: { connections: unknown }) => {
|
|
extractSchema: (connectionId: string) => Promise<unknown>;
|
|
},
|
|
): SourceAdapter {
|
|
return {
|
|
source: 'live-database',
|
|
skillNames: [],
|
|
async detect() {
|
|
return true;
|
|
},
|
|
async fetch(_pullConfig: unknown, stagedDir: string, ctx: { connectionId: string }) {
|
|
await mkdir(stagedDir, { recursive: true });
|
|
const schema = await createIntrospection({ connections: {} }).extractSchema(ctx.connectionId);
|
|
await writeFile(
|
|
join(stagedDir, 'connection.json'),
|
|
JSON.stringify({ connectionId: ctx.connectionId, schema }, null, 2),
|
|
'utf-8',
|
|
);
|
|
},
|
|
async chunk() {
|
|
return { workUnits: [] };
|
|
},
|
|
};
|
|
}
|
|
|
|
const report: KtxScanReport = {
|
|
connectionId: 'warehouse',
|
|
driver: 'postgres',
|
|
syncId: 'sync-1',
|
|
runId: 'scan-run-1',
|
|
trigger: 'cli',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
artifactPaths: {
|
|
rawSourcesDir: 'raw-sources/warehouse/live-database/sync-1',
|
|
reportPath: 'raw-sources/warehouse/live-database/sync-1/scan-report.json',
|
|
manifestShards: [],
|
|
enrichmentArtifacts: [],
|
|
},
|
|
diffSummary: {
|
|
tablesAdded: 1,
|
|
tablesModified: 0,
|
|
tablesDeleted: 0,
|
|
tablesUnchanged: 0,
|
|
columnsAdded: 0,
|
|
columnsModified: 0,
|
|
columnsDeleted: 0,
|
|
},
|
|
manifestShardsWritten: 0,
|
|
structuralSyncStats: {
|
|
tablesCreated: 0,
|
|
tablesUpdated: 0,
|
|
tablesDeleted: 0,
|
|
columnsCreated: 0,
|
|
columnsUpdated: 0,
|
|
columnsDeleted: 0,
|
|
},
|
|
enrichment: {
|
|
dataDictionary: 'skipped',
|
|
tableDescriptions: 'skipped',
|
|
columnDescriptions: 'skipped',
|
|
embeddings: 'skipped',
|
|
deterministicRelationships: 'skipped',
|
|
llmRelationshipValidation: 'skipped',
|
|
statisticalValidation: 'skipped',
|
|
},
|
|
capabilityGaps: [],
|
|
warnings: [],
|
|
relationships: { accepted: 0, review: 0, rejected: 0, skipped: 0 },
|
|
enrichmentState: {
|
|
resumedStages: [],
|
|
completedStages: [],
|
|
failedStages: [],
|
|
},
|
|
createdAt: '2026-04-29T09:00:00.000Z',
|
|
};
|
|
|
|
const reportWithAttention: KtxScanReport = {
|
|
...report,
|
|
mode: 'relationships',
|
|
diffSummary: {
|
|
tablesAdded: 3,
|
|
tablesModified: 2,
|
|
tablesDeleted: 0,
|
|
tablesUnchanged: 13,
|
|
columnsAdded: 18,
|
|
columnsModified: 5,
|
|
columnsDeleted: 0,
|
|
},
|
|
capabilityGaps: ['columnStats'],
|
|
warnings: [
|
|
{
|
|
code: 'connector_capability_missing',
|
|
message: 'KTX scan connector is missing optional capability: columnStats',
|
|
recoverable: true,
|
|
metadata: { capability: 'columnStats' },
|
|
},
|
|
{
|
|
code: 'relationship_validation_failed',
|
|
message: 'Could not validate relationship orders.customer_id -> customers.id',
|
|
table: 'orders',
|
|
column: 'customer_id',
|
|
recoverable: true,
|
|
},
|
|
],
|
|
relationships: { accepted: 7, review: 3, rejected: 2, skipped: 4 },
|
|
enrichmentState: {
|
|
resumedStages: ['relationships'],
|
|
completedStages: ['descriptions', 'relationships'],
|
|
failedStages: [],
|
|
},
|
|
artifactPaths: {
|
|
...report.artifactPaths,
|
|
manifestShards: ['raw-sources/warehouse/live-database/sync-1/_schema/shard-000.json'],
|
|
enrichmentArtifacts: ['raw-sources/warehouse/live-database/sync-1/_enrichment/relationships.json'],
|
|
},
|
|
};
|
|
|
|
describe('runKtxScan', () => {
|
|
let tempDir: string;
|
|
const noLocalIngestAdapters = () => [];
|
|
|
|
beforeEach(async () => {
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-cli-scan-'));
|
|
});
|
|
|
|
afterEach(async () => {
|
|
vi.unstubAllEnvs();
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('runs structural scans and prints a dev-friendly plain summary', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
}),
|
|
);
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
databaseIntrospectionUrl: 'http://127.0.0.1:8765',
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(runLocalScan).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
databaseIntrospectionUrl: 'http://127.0.0.1:8765',
|
|
connector: undefined,
|
|
}),
|
|
);
|
|
expect(io.stdout()).toContain('KTX scan completed\n');
|
|
expect(io.stdout()).toContain('Run: scan-run-1');
|
|
expect(io.stdout()).toContain('Mode: structural');
|
|
expect(io.stdout()).toContain('What changed\n');
|
|
expect(io.stdout()).toContain('New tables: 1\n');
|
|
expect(io.stdout()).toContain('Changed tables: 0\n');
|
|
expect(io.stdout()).toContain('Removed tables: 0\n');
|
|
expect(io.stdout()).toContain('Unchanged tables: 0\n');
|
|
expect(io.stdout()).toContain('Needs attention\n None\n');
|
|
expect(io.stdout()).toContain('Artifacts\n');
|
|
expect(io.stdout()).toContain('Report: raw-sources/warehouse/live-database/sync-1/scan-report.json');
|
|
expect(io.stdout()).toContain('Next:\n');
|
|
expect(io.stdout()).toContain('ktx status --project-dir ');
|
|
expect(io.stdout()).not.toContain('ktx admin scan status');
|
|
expect(io.stdout()).not.toContain('ktx admin scan report');
|
|
expect(io.stdout()).not.toContain('\u001b[');
|
|
expect(io.stdout()).not.toContain('✓');
|
|
expect(io.stdout()).not.toContain('+1');
|
|
expect(io.stdout()).not.toContain('/~');
|
|
});
|
|
|
|
it('emits debug telemetry for completed scans without project paths', async () => {
|
|
vi.stubEnv('KTX_TELEMETRY_DEBUG', '1');
|
|
vi.stubEnv('CI', '');
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(
|
|
async (): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
}),
|
|
);
|
|
const io = makeIo({ isTTY: true });
|
|
|
|
const code = await runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
databaseIntrospectionUrl: 'http://127.0.0.1:8765',
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
);
|
|
|
|
expect(code).toBe(0);
|
|
expect(io.stderr()).toContain('"event":"scan_completed"');
|
|
expect(io.stderr()).toContain('"tableCount"');
|
|
expect(io.stderr()).not.toContain(tempDir);
|
|
});
|
|
|
|
it('passes KTX daemon options to local ingest adapters when no explicit daemon URL is set', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const createLocalIngestAdapters = vi.fn(() => []);
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
}),
|
|
);
|
|
const io = makeIo();
|
|
const runtimeIo = makeIo({ isTTY: true });
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
cliVersion: '0.2.0',
|
|
runtimeInstallPolicy: 'auto',
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters, runtimeIo: runtimeIo.io } as KtxScanDeps & {
|
|
runtimeIo: typeof runtimeIo.io;
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(createLocalIngestAdapters).toHaveBeenCalledWith(expect.objectContaining({ projectDir: tempDir }), {
|
|
managedDaemon: {
|
|
cliVersion: '0.2.0',
|
|
projectDir: tempDir,
|
|
installPolicy: 'auto',
|
|
io: runtimeIo.io,
|
|
},
|
|
});
|
|
});
|
|
|
|
it('uses runtime IO when resolving managed embedding runtime', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
}),
|
|
);
|
|
const resolveEmbeddingProvider = vi.fn(async () => ({ kind: 'disabled' as const }));
|
|
const io = makeIo();
|
|
const runtimeIo = makeIo({ isTTY: true });
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
cliVersion: '0.2.0',
|
|
runtimeInstallPolicy: 'auto',
|
|
},
|
|
io.io,
|
|
{
|
|
runLocalScan,
|
|
createLocalIngestAdapters: noLocalIngestAdapters,
|
|
runtimeIo: runtimeIo.io,
|
|
resolveEmbeddingProvider,
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(resolveEmbeddingProvider).toHaveBeenCalledWith(
|
|
expect.anything(),
|
|
expect.objectContaining({
|
|
installPolicy: 'auto',
|
|
io: runtimeIo.io,
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('explains warnings, capability gaps, and relationships in human scan summaries', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'relationships',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report: reportWithAttention,
|
|
}),
|
|
);
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(io.stdout()).toContain('Semantic layer comparison found 5 changes across 18 tables');
|
|
expect(io.stdout()).toContain('New columns: 18');
|
|
expect(io.stdout()).toContain('Changed columns: 5');
|
|
expect(io.stdout()).toContain('Relationships\n');
|
|
expect(io.stdout()).toContain('Accepted: 7');
|
|
expect(io.stdout()).toContain('Review: 3');
|
|
expect(io.stdout()).toContain('Rejected: 2');
|
|
expect(io.stdout()).toContain('Skipped: 4');
|
|
expect(io.stdout()).toContain('Needs attention\n');
|
|
expect(io.stdout()).toContain('2 warnings');
|
|
expect(io.stdout()).toContain('1 capability gap');
|
|
expect(io.stdout()).toContain('columnStats is unavailable; relationship confidence may be lower.');
|
|
expect(io.stdout()).toContain(
|
|
'relationship_validation_failed: orders.customer_id: Could not validate relationship orders.customer_id -> customers.id',
|
|
);
|
|
expect(io.stdout()).not.toContain('+3');
|
|
expect(io.stdout()).not.toContain('~2');
|
|
expect(io.stdout()).not.toContain('=13');
|
|
});
|
|
|
|
it('prints review-only relationship summaries and validation capability warnings', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const reviewOnlyReport: KtxScanReport = {
|
|
...reportWithAttention,
|
|
capabilityGaps: [],
|
|
warnings: [
|
|
{
|
|
code: 'connector_capability_missing',
|
|
message: 'KTX scan connector cannot run read-only SQL relationship validation',
|
|
recoverable: true,
|
|
metadata: { capability: 'readOnlySql' },
|
|
},
|
|
],
|
|
relationships: { accepted: 0, review: 12, rejected: 44, skipped: 0 },
|
|
};
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-review',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'relationships',
|
|
dryRun: false,
|
|
syncId: 'sync-review',
|
|
report: reviewOnlyReport,
|
|
}),
|
|
);
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(io.stdout()).toContain('Relationships');
|
|
expect(io.stdout()).toContain('Accepted: 0');
|
|
expect(io.stdout()).toContain('Review: 12');
|
|
expect(io.stdout()).toContain('Rejected: 44');
|
|
expect(io.stdout()).toContain(
|
|
'connector_capability_missing: KTX scan connector cannot run read-only SQL relationship validation',
|
|
);
|
|
});
|
|
|
|
it('passes a scan progress port and prints TTY progress messages', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(async (input: RunLocalScanOptions): Promise<LocalScanRunResult> => {
|
|
await input.progress?.update(0.15, 'Inspecting database schema');
|
|
await input.progress?.update(0.55, 'Semantic layer comparison found 5 changes across 18 tables');
|
|
return {
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'relationships',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report: reportWithAttention,
|
|
};
|
|
});
|
|
const io = makeIo({ isTTY: true });
|
|
const previousCi = process.env.CI;
|
|
delete process.env.CI;
|
|
|
|
try {
|
|
const exitCode = await runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
);
|
|
expect({ exitCode, stderr: io.stderr() }).toEqual({ exitCode: 0, stderr: '' });
|
|
} finally {
|
|
if (previousCi === undefined) {
|
|
delete process.env.CI;
|
|
} else {
|
|
process.env.CI = previousCi;
|
|
}
|
|
}
|
|
|
|
expect(runLocalScan.mock.calls[0]?.[0].progress).toBeDefined();
|
|
expect(io.stdout()).toContain('[15%] Inspecting database schema');
|
|
expect(io.stdout()).toContain('[55%] Semantic layer comparison found 5 changes across 18 tables');
|
|
});
|
|
|
|
it('uses injected structured progress without requiring TTY progress output', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const progressEvents: Array<{ progress: number; message?: string; transient?: boolean }> = [];
|
|
const structuredProgress = {
|
|
async update(progress: number, message?: string, options?: { transient?: boolean }) {
|
|
progressEvents.push({
|
|
progress,
|
|
...(message !== undefined ? { message } : {}),
|
|
...(options?.transient !== undefined ? { transient: options.transient } : {}),
|
|
});
|
|
},
|
|
startPhase() {
|
|
return structuredProgress;
|
|
},
|
|
};
|
|
const runLocalScan = vi.fn(async (input: RunLocalScanOptions): Promise<LocalScanRunResult> => {
|
|
await input.progress?.update(0.42, 'Generating descriptions 4/10 tables', { transient: true });
|
|
return {
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
};
|
|
});
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters, progress: structuredProgress },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(progressEvents).toContainEqual({
|
|
progress: 0.42,
|
|
message: 'Generating descriptions 4/10 tables',
|
|
transient: true,
|
|
});
|
|
expect(io.stdout()).not.toContain('[42%] Generating descriptions 4/10 tables');
|
|
});
|
|
|
|
it('updates transient TTY progress messages in place', async () => {
|
|
const io = makeIo({ isTTY: true });
|
|
const previousCi = process.env.CI;
|
|
delete process.env.CI;
|
|
|
|
try {
|
|
const progress = createCliScanProgress(io.io);
|
|
await progress.update(0.84, 'Generating descriptions 1/35 tables', { transient: true });
|
|
await progress.update(0.85, 'Generating descriptions 2/35 tables', { transient: true });
|
|
await progress.update(0.9, 'Building embeddings 1/4 batches');
|
|
} finally {
|
|
if (previousCi === undefined) {
|
|
delete process.env.CI;
|
|
} else {
|
|
process.env.CI = previousCi;
|
|
}
|
|
}
|
|
|
|
expect(io.stdout()).toContain('\r[84%] Generating descriptions 1/35 tables');
|
|
expect(io.stdout()).toContain('\r[85%] Generating descriptions 2/35 tables');
|
|
expect(io.stdout()).toContain('\n[90%] Building embeddings 1/4 batches\n');
|
|
});
|
|
|
|
it('scales nested progress phases by the parent phase weight', async () => {
|
|
const io = makeIo({ isTTY: true });
|
|
const previousCi = process.env.CI;
|
|
delete process.env.CI;
|
|
|
|
try {
|
|
const progress = createCliScanProgress(io.io);
|
|
await progress.update(0.82, 'Enriching schema metadata');
|
|
const enrichmentProgress = progress.startPhase(0.18);
|
|
await enrichmentProgress.update(0.05, 'Loaded schema snapshot with 56 tables');
|
|
const descriptionProgress = enrichmentProgress.startPhase(0.45);
|
|
await descriptionProgress.update(37 / 56, 'Generating descriptions 37/56 tables', { transient: true });
|
|
await descriptionProgress.update(1, 'Generated descriptions for 56 tables');
|
|
} finally {
|
|
if (previousCi === undefined) {
|
|
delete process.env.CI;
|
|
} else {
|
|
process.env.CI = previousCi;
|
|
}
|
|
}
|
|
|
|
expect(io.stdout()).toContain('\r[88%] Generating descriptions 37/56 tables');
|
|
expect(io.stdout()).toContain('\n[91%] Generated descriptions for 56 tables\n');
|
|
expect(io.stdout()).not.toContain('[100%] Generating descriptions 37/56 tables');
|
|
});
|
|
|
|
it('flushes transient TTY progress messages before printing scan failures', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(async (input: RunLocalScanOptions): Promise<LocalScanRunResult> => {
|
|
await input.progress?.update(0.42, 'Generating descriptions 3/35 tables', { transient: true });
|
|
throw new Error('scan failed');
|
|
});
|
|
const io = makeIo({ isTTY: true });
|
|
const previousCi = process.env.CI;
|
|
delete process.env.CI;
|
|
|
|
try {
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: () => [] },
|
|
),
|
|
).resolves.toBe(1);
|
|
} finally {
|
|
if (previousCi === undefined) {
|
|
delete process.env.CI;
|
|
} else {
|
|
process.env.CI = previousCi;
|
|
}
|
|
}
|
|
|
|
expect(io.stdout()).toContain('\r[42%] Generating descriptions 3/35 tables\u001b[K\n');
|
|
expect(io.stderr()).toBe('scan failed\n');
|
|
});
|
|
|
|
it('does not print live progress messages for non-TTY output', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(async (input: RunLocalScanOptions): Promise<LocalScanRunResult> => {
|
|
await input.progress?.update(0.15, 'Inspecting database schema');
|
|
return {
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
};
|
|
});
|
|
const io = makeIo();
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(io.stdout()).not.toContain('[15%]');
|
|
expect(io.stdout()).not.toContain('Inspecting database schema');
|
|
});
|
|
|
|
it('uses terminal-aware visual styling only for TTY output', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
}),
|
|
);
|
|
const io = makeIo({ isTTY: true });
|
|
const previousNoColor = process.env.NO_COLOR;
|
|
const previousCi = process.env.CI;
|
|
const previousTerm = process.env.TERM;
|
|
delete process.env.NO_COLOR;
|
|
delete process.env.CI;
|
|
process.env.TERM = 'xterm-256color';
|
|
|
|
try {
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
} finally {
|
|
if (previousNoColor === undefined) {
|
|
delete process.env.NO_COLOR;
|
|
} else {
|
|
process.env.NO_COLOR = previousNoColor;
|
|
}
|
|
if (previousCi === undefined) {
|
|
delete process.env.CI;
|
|
} else {
|
|
process.env.CI = previousCi;
|
|
}
|
|
if (previousTerm === undefined) {
|
|
delete process.env.TERM;
|
|
} else {
|
|
process.env.TERM = previousTerm;
|
|
}
|
|
}
|
|
|
|
expect(io.stdout()).toContain('✓');
|
|
expect(io.stdout()).toContain('KTX scan completed');
|
|
expect(io.stdout()).toContain('\u001b[');
|
|
});
|
|
|
|
it('honors NO_COLOR for TTY scan summaries', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
}),
|
|
);
|
|
const io = makeIo({ isTTY: true });
|
|
const previousNoColor = process.env.NO_COLOR;
|
|
process.env.NO_COLOR = '1';
|
|
|
|
try {
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
} finally {
|
|
if (previousNoColor === undefined) {
|
|
delete process.env.NO_COLOR;
|
|
} else {
|
|
process.env.NO_COLOR = previousNoColor;
|
|
}
|
|
}
|
|
|
|
expect(io.stdout()).toContain('KTX scan completed');
|
|
expect(io.stdout()).not.toContain('\u001b[');
|
|
});
|
|
|
|
it('passes native CLI adapters into local scan runs for mysql configs', async () => {
|
|
const tempProject = await mkdtemp(join(tmpdir(), 'ktx-scan-cli-native-'));
|
|
await initKtxProject({ projectDir: tempProject });
|
|
await writeFile(
|
|
join(tempProject, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: mysql',
|
|
' url: env:MYSQL_URL',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
const io = makeIo();
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
}),
|
|
);
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempProject,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(runLocalScan).toHaveBeenCalledWith(expect.objectContaining({ adapters: expect.any(Array) }));
|
|
await rm(tempProject, { recursive: true, force: true });
|
|
});
|
|
|
|
it('creates a native connector for standalone relationship scans', async () => {
|
|
const tempProject = await mkdtemp(join(tmpdir(), 'ktx-scan-cli-relationships-'));
|
|
await initKtxProject({ projectDir: tempProject });
|
|
await writeFile(
|
|
join(tempProject, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: sqlite',
|
|
' path: warehouse.db',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
const io = makeIo();
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'relationships',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report: { ...report, mode: 'relationships' },
|
|
}),
|
|
);
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempProject,
|
|
connectionId: 'warehouse',
|
|
mode: 'relationships',
|
|
detectRelationships: true,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(runLocalScan).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
mode: 'relationships',
|
|
detectRelationships: true,
|
|
connector: expect.objectContaining({ driver: 'sqlite' }),
|
|
}),
|
|
);
|
|
await rm(tempProject, { recursive: true, force: true });
|
|
});
|
|
|
|
it('cleans up a constructed scan connector after an enriched scan succeeds', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
await writeFile(
|
|
join(tempDir, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: snowflake',
|
|
' account: acct',
|
|
' warehouse: WH',
|
|
' database: ANALYTICS',
|
|
' schema_name: PUBLIC',
|
|
' username: reader',
|
|
' password: env:SNOWFLAKE_PASSWORD',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
snowflakeConnectorInstances.length = 0;
|
|
const runLocalScan = vi.fn(async (): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-cleanup',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'enriched',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report: { ...report, mode: 'enriched' },
|
|
}));
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'enriched',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
makeIo().io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(snowflakeConnectorInstances[0]?.cleanup).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it('cleans up a constructed scan connector after runLocalScan throws', async () => {
|
|
await initKtxProject({ projectDir: tempDir });
|
|
await writeFile(
|
|
join(tempDir, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: snowflake',
|
|
' account: acct',
|
|
' warehouse: WH',
|
|
' database: ANALYTICS',
|
|
' schema_name: PUBLIC',
|
|
' username: reader',
|
|
' password: env:SNOWFLAKE_PASSWORD',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
snowflakeConnectorInstances.length = 0;
|
|
const runLocalScan = vi.fn(async () => {
|
|
throw new Error('scan failed');
|
|
});
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempDir,
|
|
connectionId: 'warehouse',
|
|
mode: 'relationships',
|
|
detectRelationships: true,
|
|
dryRun: false,
|
|
},
|
|
makeIo().io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(1);
|
|
|
|
expect(snowflakeConnectorInstances[0]?.cleanup).toHaveBeenCalledTimes(1);
|
|
});
|
|
|
|
it('routes standalone postgres scans through the native connector before daemon fallback', async () => {
|
|
const tempProject = await mkdtemp(join(tmpdir(), 'ktx-scan-cli-native-postgres-'));
|
|
await initKtxProject({ projectDir: tempProject });
|
|
await writeFile(
|
|
join(tempProject, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: postgres',
|
|
' host: db.example.test',
|
|
' database: analytics',
|
|
' username: reader',
|
|
' password: env:POSTGRES_PASSWORD',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
const io = makeIo();
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report,
|
|
}),
|
|
);
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempProject,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{
|
|
runLocalScan,
|
|
createLocalIngestAdapters: () => [fakeLiveDatabaseAdapter(createPostgresLiveDatabaseIntrospection)],
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(runLocalScan).toHaveBeenCalledWith(expect.objectContaining({ adapters: expect.any(Array) }));
|
|
const scanOptions = runLocalScan.mock.calls[0]?.[0];
|
|
const liveDatabase = scanOptions?.adapters?.find((adapter) => adapter.source === 'live-database');
|
|
if (!liveDatabase?.fetch) {
|
|
throw new Error('Expected scan adapters to include a fetch-capable live-database adapter');
|
|
}
|
|
const stagedDir = join(tempProject, 'postgres-staged');
|
|
await liveDatabase.fetch(undefined, stagedDir, { connectionId: 'warehouse', sourceKey: 'live-database' });
|
|
expect(createPostgresLiveDatabaseIntrospection).toHaveBeenCalledWith({ connections: expect.any(Object) });
|
|
expect(postgresExtractSchema).toHaveBeenCalledWith('warehouse');
|
|
await expect(readFile(join(stagedDir, 'connection.json'), 'utf-8')).resolves.toContain(
|
|
'"connectionId": "warehouse"',
|
|
);
|
|
await rm(tempProject, { recursive: true, force: true });
|
|
});
|
|
|
|
it('passes native CLI adapters into local scan runs for clickhouse configs', async () => {
|
|
const tempProject = await mkdtemp(join(tmpdir(), 'ktx-scan-cli-native-clickhouse-'));
|
|
await initKtxProject({ projectDir: tempProject });
|
|
await writeFile(
|
|
join(tempProject, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: clickhouse',
|
|
' host: env:CLICKHOUSE_HOST',
|
|
' database: analytics',
|
|
' username: reader',
|
|
' password: env:CLICKHOUSE_PASSWORD',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
const io = makeIo();
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report: { ...report, driver: 'clickhouse' },
|
|
}),
|
|
);
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempProject,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{ runLocalScan, createLocalIngestAdapters: noLocalIngestAdapters },
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(runLocalScan).toHaveBeenCalledWith(expect.objectContaining({ adapters: expect.any(Array) }));
|
|
await rm(tempProject, { recursive: true, force: true });
|
|
});
|
|
|
|
it('passes native CLI adapters into local scan runs for sqlserver configs', async () => {
|
|
const tempProject = await mkdtemp(join(tmpdir(), 'ktx-scan-cli-native-sqlserver-'));
|
|
await initKtxProject({ projectDir: tempProject });
|
|
await writeFile(
|
|
join(tempProject, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: sqlserver',
|
|
' host: env:SQLSERVER_HOST',
|
|
' database: analytics',
|
|
' username: reader',
|
|
' schema: dbo',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
const io = makeIo();
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report: { ...report, driver: 'sqlserver' },
|
|
}),
|
|
);
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempProject,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{
|
|
runLocalScan,
|
|
createLocalIngestAdapters: () => [fakeLiveDatabaseAdapter(createSqlServerLiveDatabaseIntrospection)],
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(runLocalScan).toHaveBeenCalledWith(expect.objectContaining({ adapters: expect.any(Array) }));
|
|
const scanOptions = runLocalScan.mock.calls[0]?.[0];
|
|
const liveDatabase = scanOptions?.adapters?.find((adapter) => adapter.source === 'live-database');
|
|
if (!liveDatabase?.fetch) {
|
|
throw new Error('Expected scan adapters to include a fetch-capable live-database adapter');
|
|
}
|
|
const stagedDir = join(tempProject, 'sqlserver-staged');
|
|
await liveDatabase.fetch(undefined, stagedDir, { connectionId: 'warehouse', sourceKey: 'live-database' });
|
|
expect(createSqlServerLiveDatabaseIntrospection).toHaveBeenCalledWith({ connections: expect.any(Object) });
|
|
expect(sqlServerExtractSchema).toHaveBeenCalledWith('warehouse');
|
|
await expect(readFile(join(stagedDir, 'connection.json'), 'utf-8')).resolves.toContain(
|
|
'"connectionId": "warehouse"',
|
|
);
|
|
await rm(tempProject, { recursive: true, force: true });
|
|
});
|
|
|
|
it('passes native CLI adapters into local scan runs for bigquery configs', async () => {
|
|
const tempProject = await mkdtemp(join(tmpdir(), 'ktx-scan-cli-native-bigquery-'));
|
|
await initKtxProject({ projectDir: tempProject });
|
|
await writeFile(
|
|
join(tempProject, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: bigquery',
|
|
' dataset_id: analytics',
|
|
' credentials_json: env:BIGQUERY_CREDENTIALS_JSON',
|
|
' location: US',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
const io = makeIo();
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report: { ...report, driver: 'bigquery' },
|
|
}),
|
|
);
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempProject,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{
|
|
runLocalScan,
|
|
createLocalIngestAdapters: () => [fakeLiveDatabaseAdapter(createBigQueryLiveDatabaseIntrospection)],
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(runLocalScan).toHaveBeenCalledWith(expect.objectContaining({ adapters: expect.any(Array) }));
|
|
const scanOptions = runLocalScan.mock.calls[0]?.[0];
|
|
const liveDatabase = scanOptions?.adapters?.find((adapter) => adapter.source === 'live-database');
|
|
if (!liveDatabase?.fetch) {
|
|
throw new Error('Expected scan adapters to include a fetch-capable live-database adapter');
|
|
}
|
|
const stagedDir = join(tempProject, 'bigquery-staged');
|
|
await liveDatabase.fetch(undefined, stagedDir, { connectionId: 'warehouse', sourceKey: 'live-database' });
|
|
expect(createBigQueryLiveDatabaseIntrospection).toHaveBeenCalledWith({ connections: expect.any(Object) });
|
|
expect(bigQueryExtractSchema).toHaveBeenCalledWith('warehouse');
|
|
await expect(readFile(join(stagedDir, 'connection.json'), 'utf-8')).resolves.toContain(
|
|
'"connectionId": "warehouse"',
|
|
);
|
|
await rm(tempProject, { recursive: true, force: true });
|
|
});
|
|
|
|
it('passes native CLI adapters into local scan runs for snowflake configs', async () => {
|
|
const tempProject = await mkdtemp(join(tmpdir(), 'ktx-scan-cli-native-snowflake-'));
|
|
await initKtxProject({ projectDir: tempProject });
|
|
await writeFile(
|
|
join(tempProject, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: snowflake',
|
|
' authMethod: password',
|
|
' account: env:SNOWFLAKE_ACCOUNT',
|
|
' warehouse: WH',
|
|
' database: ANALYTICS',
|
|
' schema_name: PUBLIC',
|
|
' username: reader',
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
const io = makeIo();
|
|
const runLocalScan = vi.fn(
|
|
async (_input: RunLocalScanOptions): Promise<LocalScanRunResult> => ({
|
|
runId: 'scan-run-1',
|
|
status: 'done',
|
|
done: true,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
dryRun: false,
|
|
syncId: 'sync-1',
|
|
report: { ...report, driver: 'snowflake' },
|
|
}),
|
|
);
|
|
|
|
await expect(
|
|
runKtxScan(
|
|
{
|
|
command: 'run',
|
|
projectDir: tempProject,
|
|
connectionId: 'warehouse',
|
|
mode: 'structural',
|
|
detectRelationships: false,
|
|
dryRun: false,
|
|
},
|
|
io.io,
|
|
{
|
|
runLocalScan,
|
|
createLocalIngestAdapters: () => [fakeLiveDatabaseAdapter(createSnowflakeLiveDatabaseIntrospection)],
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(runLocalScan).toHaveBeenCalledWith(expect.objectContaining({ adapters: expect.any(Array) }));
|
|
const scanOptions = runLocalScan.mock.calls[0]?.[0];
|
|
const liveDatabase = scanOptions?.adapters?.find((adapter) => adapter.source === 'live-database');
|
|
if (!liveDatabase?.fetch) {
|
|
throw new Error('Expected scan adapters to include a fetch-capable live-database adapter');
|
|
}
|
|
const stagedDir = join(tempProject, 'snowflake-staged');
|
|
await liveDatabase.fetch(undefined, stagedDir, { connectionId: 'warehouse', sourceKey: 'live-database' });
|
|
expect(createSnowflakeLiveDatabaseIntrospection).toHaveBeenCalledWith({ connections: expect.any(Object) });
|
|
expect(snowflakeExtractSchema).toHaveBeenCalledWith('warehouse');
|
|
await expect(readFile(join(stagedDir, 'connection.json'), 'utf-8')).resolves.toContain(
|
|
'"connectionId": "warehouse"',
|
|
);
|
|
await rm(tempProject, { recursive: true, force: true });
|
|
});
|
|
});
|