ktx/packages/cli/test/project-resolver.test.ts

71 lines
2.5 KiB
TypeScript
Raw Permalink Normal View History

2026-05-10 23:12:26 +02:00
import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join, resolve } from 'node:path';
import { afterEach, beforeEach, describe, expect, it } 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 { findNearestKtxProjectDir, resolveKtxProjectDir } from '../src/project-resolver.js';
2026-05-10 23:12:26 +02:00
2026-05-10 23:51:24 +02:00
describe('resolveKtxProjectDir', () => {
2026-05-10 23:12:26 +02:00
let tempDir: string;
beforeEach(async () => {
2026-05-10 23:51:24 +02:00
tempDir = await mkdtemp(join(tmpdir(), 'ktx-project-resolver-'));
2026-05-10 23:12:26 +02:00
});
afterEach(async () => {
await rm(tempDir, { recursive: true, force: true });
});
it('prefers an explicit project directory', async () => {
const explicit = join(tempDir, 'explicit');
const envProject = join(tempDir, 'env');
await mkdir(explicit, { recursive: true });
await mkdir(envProject, { recursive: true });
expect(
2026-05-10 23:51:24 +02:00
resolveKtxProjectDir({
2026-05-10 23:12:26 +02:00
explicitProjectDir: explicit,
2026-05-10 23:51:24 +02:00
env: { KTX_PROJECT_DIR: envProject },
2026-05-10 23:12:26 +02:00
cwd: tempDir,
}),
).toBe(resolve(explicit));
});
2026-05-10 23:51:24 +02:00
it('uses KTX_PROJECT_DIR when no explicit project directory is set', async () => {
2026-05-10 23:12:26 +02:00
const envProject = join(tempDir, 'env-project');
await mkdir(envProject, { recursive: true });
2026-05-10 23:51:24 +02:00
expect(resolveKtxProjectDir({ env: { KTX_PROJECT_DIR: envProject }, cwd: tempDir })).toBe(resolve(envProject));
2026-05-10 23:12:26 +02:00
});
2026-05-10 23:51:24 +02:00
it('resolves a relative KTX_PROJECT_DIR value from cwd', () => {
expect(resolveKtxProjectDir({ env: { KTX_PROJECT_DIR: 'env-project' }, cwd: tempDir })).toBe(
2026-05-10 23:12:26 +02:00
resolve(tempDir, 'env-project'),
);
});
2026-05-10 23:51:24 +02:00
it('uses the nearest ancestor containing ktx.yaml', async () => {
2026-05-10 23:12:26 +02:00
const project = join(tempDir, 'warehouse');
const nested = join(project, 'nested', 'deeper');
await mkdir(nested, { recursive: true });
await writeFile(join(project, 'ktx.yaml'), '{}\n', 'utf-8');
2026-05-10 23:12:26 +02:00
2026-05-10 23:51:24 +02:00
expect(resolveKtxProjectDir({ env: {}, cwd: nested })).toBe(resolve(project));
expect(findNearestKtxProjectDir(nested)).toBe(resolve(project));
2026-05-10 23:12:26 +02:00
});
it('falls back to the current directory when no project marker exists', () => {
2026-05-10 23:51:24 +02:00
expect(resolveKtxProjectDir({ env: {}, cwd: tempDir })).toBe(resolve(tempDir));
expect(findNearestKtxProjectDir(tempDir)).toBeUndefined();
2026-05-10 23:12:26 +02:00
});
it('rejects empty explicit and environment project directory values', () => {
2026-05-10 23:51:24 +02:00
expect(() => resolveKtxProjectDir({ explicitProjectDir: ' ', cwd: tempDir })).toThrow(
2026-05-10 23:12:26 +02:00
'--project-dir requires a value',
);
2026-05-10 23:51:24 +02:00
expect(() => resolveKtxProjectDir({ env: { KTX_PROJECT_DIR: ' ' }, cwd: tempDir })).toThrow(
'KTX_PROJECT_DIR must not be empty',
2026-05-10 23:12:26 +02:00
);
});
});