2026-05-15 02:35:09 +02:00
|
|
|
import { Command } from '@commander-js/extra-typings';
|
|
|
|
|
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 type { KtxCliCommandContext } from '../../src/cli-program.js';
|
|
|
|
|
import { registerMcpCommands } from '../../src/commands/mcp-commands.js';
|
2026-05-15 02:35:09 +02:00
|
|
|
|
|
|
|
|
function makeContext(overrides: Partial<KtxCliCommandContext> = {}): KtxCliCommandContext {
|
|
|
|
|
let exitCode = 0;
|
|
|
|
|
return {
|
|
|
|
|
io: {
|
|
|
|
|
stdout: { write: vi.fn() },
|
|
|
|
|
stderr: { write: vi.fn() },
|
|
|
|
|
},
|
|
|
|
|
deps: {},
|
chore(workspace): gate dead-code with knip production mode (#196)
* refactor(workspace): relocate @ktx/llm source into packages/cli/src/llm
* refactor(workspace): rewrite @ktx/llm imports to relative paths
* refactor(workspace): fold internal packages into cli
* chore(workspace): gate dead-code with knip production mode
Turn on production-mode knip plus an autofix run in pre-commit and the
`pnpm dead-code` script, document the `/** @internal */` convention for
test-only exports in AGENTS.md, annotate test-only exports across the
CLI with that JSDoc, and drop dead exports/wrappers the new gate
surfaced (e.g. `cli-project.ts`, `lookerRuntimeSourceToFileAdapterSource`,
`createLocalScanEnrichmentProvidersFromConfig`,
`PGLITE_OWNER_PROCESS_BACKEND_CAPABILITIES`, stale type re-exports).
Replace the loose `ignoreIssues` allowlist in `knip.json` with explicit
production entries so cross-package barrel leaks are caught.
* refactor(cli): delete internal barrel index.ts files
The 34 `index.ts` re-export barrels inside `packages/cli/src/` were
holdovers from the pre-fold multi-workspace structure. Post-fold-in they
served no production purpose: external consumers go through the single
package main entry, and in-repo callers mostly imported through them
only because the path was short. Internally, knip flagged most barrel
re-exports as production-dead (only reached via tests).
This change:
- Deletes every internal barrel except `packages/cli/src/index.ts`
(the published package entry).
- Rewrites ~270 source/test files to import each name directly from
the file that defines it.
- Moves `tools/warehouse-verification/index.ts` to
`create-warehouse-verification-tools.ts` (the function it defined
locally) and updates its single consumer.
- Renames `search/backend-conformance.ts` → `.test-utils.ts` to match
the existing test-helper file convention.
- Deletes 13 dead test-only chains (dbt-descriptions/*,
live-database/extracted-schema, live-database/structural-sync,
relationship-* feedback/review chain) plus their tests and a
cascading orphan integration test.
- Updates test mocks that pointed at deleted barrel paths
(notion-client, connector barrels in scan/local-scan-connectors
tests) to mock the source files instead.
- Points the maintainer benchmark script
(`scripts/relationship-benchmark-report.mjs`) at source files
instead of `dist/context/scan/index.js`.
- Drops the barrel `!` entries from `knip.json`; adds explicit
production entries only for the benchmark code reached via dist by
the maintainer script.
Net: 413 files changed, ~1.2k insertions, ~9.4k deletions.
`pnpm run dead-code` (Biome + knip default + knip production) and
`pnpm run type-check` are clean; 2277 tests pass.
* refactor(workspace): rename @ktx/cli to @kaelio/ktx and pack it directly
Promote the CLI workspace package to the public name `@kaelio/ktx` and
drop the separate `scripts/build-public-npm-package.mjs` wrapper. The
CLI package is now publishable in place (`publishConfig.access: public`,
`provenance: true`), so artifact packing uses `pnpm pack` against
`packages/cli/` instead of assembling a parallel package tree.
Updates all workspace filter invocations, docs, tests, and release
readiness checks to reference the new package name, and folds the
tarball-name helper into `scripts/public-npm-release-metadata.mjs`.
* docs: align "agent clients" and "data agents" terminology
Replace "client agents" with "agent clients" and "database agents" with
"data agents" across AGENTS.md, README.md, the docs-site copy, and the
matching setup-agents test description, matching the canonical
vocabulary in docs/terminology.md.
Also moves packages/cli/tsconfig.json's tsBuildInfoFile from
node_modules/.cache/ to dist/.tsbuildinfo so incremental builds survive
node_modules reinstalls.
* refactor(release): single source of truth for package version
Make packages/cli/package.json the single source of truth for the
@kaelio/ktx version. publicNpmPackageVersion() now reads it directly,
so artifact filenames, release-readiness checks, and the Python wheel
version all derive from one field. The duplicate
release-policy.json.publicNpmPackageVersion is removed.
Previously the two fields could drift: tarballs were named
kaelio-ktx-0.4.1.tgz while internally containing
@kaelio/ktx@0.0.0-private.
- update-public-release-version.mjs rewrites both Python pyproject.toml
files (ktx-daemon, ktx-sl) alongside the npm package.jsons,
normalizing the version for PEP 440 (e.g. 0.1.0-rc.2 -> 0.1.0rc2).
- semantic-release-config.cjs adds the two pyproject.toml files to
@semantic-release/git assets so the release commit back to main
carries every version source in lockstep.
- The six "?? '0.0.0-private'" fallback literals across the CLI are
replaced with "?? getKtxCliPackageInfo().version", and
createDefaultKtxMcpServer makes its version arg required.
- docs/release.md describes the actual commit-back model: the dev tree
always reflects the most recent release; no sentinel pin to
maintain.
Verified: pnpm run artifacts:build now produces
kaelio-ktx-0.4.1.tgz and kaelio_ktx-0.4.1-py3-none-any.whl with
@kaelio/ktx@0.4.1 inside. Full type-check, dead-code, and
2287 vitests + 173 script tests pass.
* refactor(cli): inject embedding provider resolution and detect sentence-transformers runtime
Make resolveProjectEmbeddingProvider and runtimeIo injectable in ingest and
scan command entrypoints so tests can stub them, and teach
resolvePublicIngestRuntimeRequirements to flag the local-embeddings runtime
feature when ktx.yaml selects sentence-transformers.
* chore(cli): mark buildLocalStatsStatus and LocalStatsStatus as @internal
Both symbols are consumed only by status-project.test.ts. Annotating with
/** @internal */ keeps knip's production-mode check clean without changing
runtime behavior.
* fix(cli): use real package metadata in print-command-tree
The stubbed package name embedded a forbidden product identifier that
tripped the boundary check in CI. Read the metadata from package.json
instead — keeps the rendered tree unchanged and removes a duplicate
source of truth.
* feat(cli): show embedding coverage in `ktx status`, drop duplicate disk counts
Inline `(N embedded)` next to the Wiki scope counts and Semantic-layer
source counts, computed with `SUM(embedding_json IS NOT NULL)` over
`knowledge_pages` and `local_sl_sources`. Rename the "Knowledge" label to
"Wiki" (canonical per `docs/terminology.md`) and rename the matching
`localStats.knowledgePages` field to `localStats.wikiPages`.
Drop `wiki=N md` and `semantic-layer=N yaml` from the Disk row — those
duplicated the per-surface rows above. Disk now reports only actual byte
usage (db, cache, raw-sources). The unused `wikiGlobalMarkdownCount` /
`semanticLayerYamlCount` fields, the `isMarkdownEntry` / `isYamlEntry`
helpers, and the `filter` arg on `summarizeDir` are removed.
2026-05-21 15:28:58 +02:00
|
|
|
packageInfo: { name: '@kaelio/ktx', version: '0.0.0-test' },
|
2026-05-15 02:35:09 +02:00
|
|
|
setExitCode: (code) => {
|
|
|
|
|
exitCode = code;
|
|
|
|
|
},
|
|
|
|
|
runInit: vi.fn(),
|
|
|
|
|
writeDebug: vi.fn(),
|
|
|
|
|
...overrides,
|
|
|
|
|
get exitCode() {
|
|
|
|
|
return exitCode;
|
|
|
|
|
},
|
|
|
|
|
} as KtxCliCommandContext;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
describe('registerMcpCommands', () => {
|
|
|
|
|
it('registers the public mcp lifecycle commands', () => {
|
|
|
|
|
const program = new Command().exitOverride();
|
|
|
|
|
registerMcpCommands(program, makeContext());
|
|
|
|
|
const mcp = program.commands.find((command) => command.name() === 'mcp');
|
|
|
|
|
|
|
|
|
|
expect(mcp?.commands.map((command) => command.name()).sort()).toEqual([
|
|
|
|
|
'logs',
|
|
|
|
|
'serve-internal',
|
|
|
|
|
'start',
|
|
|
|
|
'status',
|
feat(setup): add Claude Desktop target and MCP-first agent setup (#114)
* feat(setup): add Claude Desktop target and MCP-first agent setup
Adds `ktx mcp stdio` and a `claude-desktop` setup target that generates a
local plugin ZIP wiring the analytics skill and a stdio MCP config. Replaces
the CLI-only agent install mode with MCP+analytics (default) and an optional
admin CLI skill, renames the research skill to analytics, and lets interactive
setup pick project vs global scope when every target supports it. Extracts a
shared MCP server factory used by both HTTP and stdio entrypoints.
* Add MCP agent client setup support
* Polish setup output formatting
* Add MCP tool polish design spec
Design for slimming the MCP-registered surface from 25 to 11 tools,
introducing memory_ingest, applying the per-tool polish kit (annotations,
outputSchema, .describe(), in-band error wrapping, union-drift fixes,
type-narrowed jsonToolResult), emitting progress notifications on
sql_execution + sl_query, and refining the ktx-analytics SKILL.md to
match.
* Refine MCP tool polish design spec after adversarial review iteration 1
* Refine MCP tool polish design spec after adversarial review iteration 2
* Refine MCP tool polish design spec after adversarial review iteration 3
* refactor(context): rename memory capture service to ingest
* feat(mcp): slim research tool surface
* refactor(mcp): remove admin ports from server factory
* refactor(cli): rename text ingest memory port
* docs: update analytics skill for memory ingest
* chore: verify mcp surface rename
* Add MCP tool polish v1 surface change plan
* feat(context): polish mcp tool metadata
* fix(context): enforce resolved semantic layer compute sources
* feat(context): emit mcp query progress stages
* fix(context): keep mcp progress event internal
* Add MCP tool polish v1 metadata & progress plan
* Fix CI snapshot and docs checks
2026-05-16 11:39:55 +02:00
|
|
|
'stdio',
|
2026-05-15 02:35:09 +02:00
|
|
|
'stop',
|
|
|
|
|
]);
|
|
|
|
|
expect(
|
|
|
|
|
(mcp?.commands.find((command) => command.name() === 'serve-internal') as { _hidden?: boolean } | undefined)
|
|
|
|
|
?._hidden,
|
|
|
|
|
).toBe(true);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('rejects non-loopback start without token before spawning', async () => {
|
|
|
|
|
const program = new Command().exitOverride();
|
|
|
|
|
const startDaemon = vi.fn();
|
|
|
|
|
const context = makeContext({ deps: { mcp: { startDaemon } } });
|
|
|
|
|
registerMcpCommands(program, context);
|
|
|
|
|
|
|
|
|
|
await expect(program.parseAsync(['mcp', 'start', '--host', '0.0.0.0'], { from: 'user' })).rejects.toThrow(
|
|
|
|
|
'Binding KTX MCP to 0.0.0.0 requires --token or KTX_MCP_TOKEN',
|
|
|
|
|
);
|
|
|
|
|
expect(startDaemon).not.toHaveBeenCalled();
|
|
|
|
|
});
|
feat(setup): add Claude Desktop target and MCP-first agent setup (#114)
* feat(setup): add Claude Desktop target and MCP-first agent setup
Adds `ktx mcp stdio` and a `claude-desktop` setup target that generates a
local plugin ZIP wiring the analytics skill and a stdio MCP config. Replaces
the CLI-only agent install mode with MCP+analytics (default) and an optional
admin CLI skill, renames the research skill to analytics, and lets interactive
setup pick project vs global scope when every target supports it. Extracts a
shared MCP server factory used by both HTTP and stdio entrypoints.
* Add MCP agent client setup support
* Polish setup output formatting
* Add MCP tool polish design spec
Design for slimming the MCP-registered surface from 25 to 11 tools,
introducing memory_ingest, applying the per-tool polish kit (annotations,
outputSchema, .describe(), in-band error wrapping, union-drift fixes,
type-narrowed jsonToolResult), emitting progress notifications on
sql_execution + sl_query, and refining the ktx-analytics SKILL.md to
match.
* Refine MCP tool polish design spec after adversarial review iteration 1
* Refine MCP tool polish design spec after adversarial review iteration 2
* Refine MCP tool polish design spec after adversarial review iteration 3
* refactor(context): rename memory capture service to ingest
* feat(mcp): slim research tool surface
* refactor(mcp): remove admin ports from server factory
* refactor(cli): rename text ingest memory port
* docs: update analytics skill for memory ingest
* chore: verify mcp surface rename
* Add MCP tool polish v1 surface change plan
* feat(context): polish mcp tool metadata
* fix(context): enforce resolved semantic layer compute sources
* feat(context): emit mcp query progress stages
* fix(context): keep mcp progress event internal
* Add MCP tool polish v1 metadata & progress plan
* Fix CI snapshot and docs checks
2026-05-16 11:39:55 +02:00
|
|
|
|
|
|
|
|
it('prints "already running" when startDaemon reports already-running', async () => {
|
|
|
|
|
const program = new Command().exitOverride().option('--project-dir <path>');
|
|
|
|
|
const startDaemon = vi.fn().mockResolvedValue({
|
|
|
|
|
status: 'already-running',
|
|
|
|
|
url: 'http://127.0.0.1:7878/mcp',
|
|
|
|
|
state: {
|
|
|
|
|
schemaVersion: 1,
|
|
|
|
|
pid: 4242,
|
|
|
|
|
host: '127.0.0.1',
|
|
|
|
|
port: 7878,
|
|
|
|
|
tokenAuth: false,
|
|
|
|
|
projectDir: '/tmp/ktx-already',
|
|
|
|
|
startedAt: '2026-05-14T00:00:00.000Z',
|
|
|
|
|
logPath: '/tmp/ktx-already/.ktx/logs/mcp.log',
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
const context = makeContext({ deps: { mcp: { startDaemon } } });
|
|
|
|
|
registerMcpCommands(program, context);
|
|
|
|
|
|
|
|
|
|
await program.parseAsync(['--project-dir', '/tmp/ktx-already', 'mcp', 'start'], { from: 'user' });
|
|
|
|
|
|
|
|
|
|
expect(startDaemon).toHaveBeenCalledTimes(1);
|
|
|
|
|
expect(context.io.stdout.write).toHaveBeenCalledWith(
|
2026-05-18 18:54:20 -04:00
|
|
|
[
|
|
|
|
|
'KTX MCP daemon already running: http://127.0.0.1:7878/mcp',
|
|
|
|
|
'',
|
|
|
|
|
'KTX is ready for configured agents.',
|
|
|
|
|
'Open your agent for this KTX project and ask a data question, for example:',
|
|
|
|
|
' "Use KTX to show me the available tables and metrics."',
|
|
|
|
|
'',
|
|
|
|
|
].join('\n'),
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('prints a friendly next step after starting the daemon', async () => {
|
|
|
|
|
const program = new Command().exitOverride().option('--project-dir <path>');
|
|
|
|
|
const startDaemon = vi.fn().mockResolvedValue({
|
|
|
|
|
status: 'started',
|
|
|
|
|
url: 'http://127.0.0.1:7878/mcp',
|
|
|
|
|
state: {
|
|
|
|
|
schemaVersion: 1,
|
|
|
|
|
pid: 4242,
|
|
|
|
|
host: '127.0.0.1',
|
|
|
|
|
port: 7878,
|
|
|
|
|
tokenAuth: false,
|
|
|
|
|
projectDir: '/tmp/ktx-started',
|
|
|
|
|
startedAt: '2026-05-14T00:00:00.000Z',
|
|
|
|
|
logPath: '/tmp/ktx-started/.ktx/logs/mcp.log',
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
const context = makeContext({ deps: { mcp: { startDaemon } } });
|
|
|
|
|
registerMcpCommands(program, context);
|
|
|
|
|
|
|
|
|
|
await program.parseAsync(['--project-dir', '/tmp/ktx-started', 'mcp', 'start'], { from: 'user' });
|
|
|
|
|
|
|
|
|
|
expect(context.io.stdout.write).toHaveBeenCalledWith(
|
|
|
|
|
expect.stringContaining('KTX MCP daemon started: http://127.0.0.1:7878/mcp\n\nKTX is ready for configured agents.'),
|
|
|
|
|
);
|
|
|
|
|
expect(context.io.stdout.write).toHaveBeenCalledWith(
|
|
|
|
|
expect.stringContaining('"Use KTX to show me the available tables and metrics."'),
|
feat(setup): add Claude Desktop target and MCP-first agent setup (#114)
* feat(setup): add Claude Desktop target and MCP-first agent setup
Adds `ktx mcp stdio` and a `claude-desktop` setup target that generates a
local plugin ZIP wiring the analytics skill and a stdio MCP config. Replaces
the CLI-only agent install mode with MCP+analytics (default) and an optional
admin CLI skill, renames the research skill to analytics, and lets interactive
setup pick project vs global scope when every target supports it. Extracts a
shared MCP server factory used by both HTTP and stdio entrypoints.
* Add MCP agent client setup support
* Polish setup output formatting
* Add MCP tool polish design spec
Design for slimming the MCP-registered surface from 25 to 11 tools,
introducing memory_ingest, applying the per-tool polish kit (annotations,
outputSchema, .describe(), in-band error wrapping, union-drift fixes,
type-narrowed jsonToolResult), emitting progress notifications on
sql_execution + sl_query, and refining the ktx-analytics SKILL.md to
match.
* Refine MCP tool polish design spec after adversarial review iteration 1
* Refine MCP tool polish design spec after adversarial review iteration 2
* Refine MCP tool polish design spec after adversarial review iteration 3
* refactor(context): rename memory capture service to ingest
* feat(mcp): slim research tool surface
* refactor(mcp): remove admin ports from server factory
* refactor(cli): rename text ingest memory port
* docs: update analytics skill for memory ingest
* chore: verify mcp surface rename
* Add MCP tool polish v1 surface change plan
* feat(context): polish mcp tool metadata
* fix(context): enforce resolved semantic layer compute sources
* feat(context): emit mcp query progress stages
* fix(context): keep mcp progress event internal
* Add MCP tool polish v1 metadata & progress plan
* Fix CI snapshot and docs checks
2026-05-16 11:39:55 +02:00
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('runs the stdio server with the resolved project directory', async () => {
|
|
|
|
|
const program = new Command().exitOverride().option('--project-dir <path>');
|
|
|
|
|
const runStdioServer = vi.fn().mockResolvedValue(undefined);
|
|
|
|
|
const context = makeContext({ deps: { mcp: { runStdioServer } } });
|
|
|
|
|
registerMcpCommands(program, context);
|
|
|
|
|
|
|
|
|
|
await expect(program.parseAsync(['--project-dir', '/tmp/ktx6', 'mcp', 'stdio'], { from: 'user' })).resolves.toBe(
|
|
|
|
|
program,
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
expect(runStdioServer).toHaveBeenCalledWith({
|
|
|
|
|
projectDir: '/tmp/ktx6',
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
io: context.io,
|
|
|
|
|
});
|
|
|
|
|
});
|
2026-05-15 02:35:09 +02:00
|
|
|
});
|