ktx/python/ktx-daemon/tests/test_database_introspection.py
Andrey Avtomonov 394a985d2a
fix(snowflake): unblock multi-schema ingest and relationship discovery (#204)
* feat(setup): drop redundant Snowflake schema prompt; fall back to free-text on listSchemas failure

Snowflake setup previously asked for a single schema as free text, then
ran a multiselect against the discovered schemas — two schema questions
back-to-back, with the first being only a session bootstrap. The SDK's
`schema` is optional, so the bootstrap step is unnecessary.

- Remove the free-text Snowflake schema prompt; only pass `schema` to
  snowflake-sdk when one is configured.
- When `listSchemas()` fails (e.g. role lacks SHOW SCHEMAS), prompt the
  user for a comma-separated list, persist it as `schema_names`, and use
  it as both the table-list filter and the multiselect default. Applies
  to every driver with a scope-discovery spec, not just Snowflake.
- Update docs to lead with `schema_names`; keep `schema_name` as a
  documented single-schema shorthand.

* fix(snowflake): keep introspecting when primary-key discovery is denied

The PK query joins INFORMATION_SCHEMA.TABLE_CONSTRAINTS and
INFORMATION_SCHEMA.KEY_COLUMN_USAGE, which require grants the
connection role may not have. Previously a 'SQL compilation error:
Object ANALYTICS.INFORMATION_SCHEMA.KEY_COLUMN_USAGE does not exist
or not authorized' aborted the entire introspect — schemas, columns,
and row counts were all discarded over a missing nice-to-have.

Wrap the constraint query in try/catch, log a one-line warning per
schema, and return an empty PK map. Columns end up with
primaryKey=false; relationship inference still has FK and profiling
to fall back on.

* fix(scan): unblock relationship discovery on Snowflake

Two adjacent bugs prevented the scan's relationship pipeline from producing
any joins on a Snowflake warehouse:

- relationship-profiling.ts fell through to a default `GROUP_CONCAT` branch
  for unknown drivers. Snowflake has no GROUP_CONCAT, so every per-table
  profile query failed with "Unknown function GROUP_CONCAT". Add an explicit
  Snowflake branch that uses LISTAGG with a literal '\x1f' delimiter
  (Snowflake requires the delimiter to be a constant, so CHR(31) is rejected).
- description-generation.ts destructured `connector.sampleTable` and
  `connector.sampleColumn` into bare locals, losing the `this` binding when
  the class-method connectors (Snowflake, Postgres, MySQL) were invoked.
  Every sample call threw "Cannot read properties of undefined (reading
  'assertConnection')" and degraded LLM descriptions to metadata-only
  prompts. Call the methods through the connector instead.

Without these, even after the primary-key probe is allowed to fail softly,
the scan ends up with 0 validated relationships and an empty `joins:` block
in every shard YAML.

* test(scan): cover table-ref helpers

* feat(scan): plumb tableScope through live-database introspection port

* feat(scan): apply tableScope during metadata fetch

* feat(scan): enforce table scope at fetch boundary

* feat(scan): pool Snowflake sessions and batch enrichment for faster ingest (#206)

* feat(cli): add RSA key-pair auth option to Snowflake setup wizard

Extends the interactive Snowflake setup flow with an authentication-method
prompt (password vs RSA/JWT key-pair). The RSA branch collects a private-key
path (env/file/absolute) and an optional passphrase; the resulting connection
config records `authMethod: 'rsa'` with `privateKey` and `passphrase` instead
of `password`.

* feat(scan): pool Snowflake sessions

* fix(scan): reuse structural snapshots and cleanup connectors

* feat(scan): parallelize relationship profiling

* feat(scan): batch table description generation

* docs: document Snowflake ingest concurrency knobs

* fix(scan): close Snowflake ingest perf verification gaps

* fix(scan): keep batched description failure bounded

* feat(scan): dispatch query-history probes by connection driver

Extract historic-sql dialect resolution into a shared helper so the
status-project readiness check and the local ingest factory agree on
which connections enable query history and which probe to run. The
status command now picks the postgres/snowflake/bigquery probe based on
the connection's driver instead of always reporting against postgres,
which previously caused snowflake connections with queryHistory.enabled
to surface a misleading "driver is snowflake" failure.

Also drops a noisy console.warn from Snowflake primary-key discovery —
INFORMATION_SCHEMA.KEY_COLUMN_USAGE is commonly ungranted for read-only
roles and the FK + profiling paths handle the empty PK map already.

* fix(llm): allow StructuredOutput tool and raise maxTurns for generateObject

The Claude Code agent SDK announces an internal pseudo-tool named
StructuredOutput in the system/init message whenever outputFormat is set
to { type: 'json_schema' }. The runtime's isolation check built its
allowedToolIds set only from MCP tool ids and treated StructuredOutput
as an unexpected host-injected tool, so every generateObject call threw
"Claude Code runtime isolation failed: tools=StructuredOutput ..." and
the table-descriptions and relationship-LLM-proposal enrichment stages
recorded null output across the board.

Whitelist StructuredOutput specifically in generateObject's
allowedToolIds — the check also enforces missing_tools symmetry, so
generateText and runAgentLoop, which do not see StructuredOutput, must
not require it.

generateObject also ran with maxTurns: 1, which the model intermittently
breached when it emitted thinking text before the structured response.
Raised to 5 to give the schema-bound call enough headroom without
allowing unbounded loops. The existing tests now exercise the path with
an init message that announces StructuredOutput so the regression cannot
slip back in.

* chore(scripts): add ktx-reset.sh project-cleanup helper

Convenience script for repeatable ingest testing: takes a project
directory and prunes everything except ktx.yaml and .ktx/secrets/, so
the next ktx setup or ktx ingest run starts from a known-clean state.
2026-05-23 10:41:30 +02:00

171 lines
5.7 KiB
Python

from __future__ import annotations
import pytest
from ktx_daemon.database_introspection import (
DatabaseIntrospectionRequest,
DatabaseIntrospectionRows,
LiveDatabaseTableScopeRef,
_statement_timeout_config,
_table_scope_json,
introspect_database_response,
)
def test_introspect_database_response_maps_postgres_catalog_rows() -> None:
def fake_load_rows(
request: DatabaseIntrospectionRequest,
) -> DatabaseIntrospectionRows:
assert request.connection_id == "warehouse"
assert request.driver == "postgres"
assert request.schemas == ["public"]
return DatabaseIntrospectionRows(
table_rows=[
{
"table_catalog": "warehouse",
"table_schema": "public",
"table_name": "customers",
"table_comment": None,
},
{
"table_catalog": "warehouse",
"table_schema": "public",
"table_name": "orders",
"table_comment": "Orders table",
},
],
column_rows=[
{
"table_catalog": "warehouse",
"table_schema": "public",
"table_name": "orders",
"column_name": "id",
"formatted_type": "integer",
"is_nullable": False,
"is_primary_key": True,
"column_comment": "Order ID",
},
{
"table_catalog": "warehouse",
"table_schema": "public",
"table_name": "orders",
"column_name": "customer_id",
"formatted_type": "integer",
"is_nullable": False,
"is_primary_key": False,
"column_comment": None,
},
{
"table_catalog": "warehouse",
"table_schema": "public",
"table_name": "customers",
"column_name": "id",
"formatted_type": "integer",
"is_nullable": False,
"is_primary_key": True,
"column_comment": None,
},
],
foreign_key_rows=[
{
"table_catalog": "warehouse",
"table_schema": "public",
"table_name": "orders",
"from_column": "customer_id",
"to_table": "customers",
"to_column": "id",
"constraint_name": "orders_customer_id_fkey",
}
],
)
response = introspect_database_response(
DatabaseIntrospectionRequest(
connection_id="warehouse",
driver="postgres",
url="postgresql://readonly@example.test/warehouse",
schemas=["public"],
),
load_rows=fake_load_rows,
now=lambda: "2026-04-28T10:00:00+00:00",
)
assert response.connection_id == "warehouse"
assert response.extracted_at == "2026-04-28T10:00:00+00:00"
assert response.metadata == {"driver": "postgres", "schemas": ["public"]}
assert [table.name for table in response.tables] == ["customers", "orders"]
orders = response.tables[1]
assert orders.model_dump(exclude_none=True) == {
"catalog": "warehouse",
"db": "public",
"name": "orders",
"comment": "Orders table",
"columns": [
{
"name": "id",
"type": "integer",
"nullable": False,
"primary_key": True,
"comment": "Order ID",
},
{
"name": "customer_id",
"type": "integer",
"nullable": False,
"primary_key": False,
},
],
"foreign_keys": [
{
"from_column": "customer_id",
"to_table": "customers",
"to_column": "id",
"constraint_name": "orders_customer_id_fkey",
}
],
}
def test_introspect_database_response_rejects_non_postgres_driver() -> None:
with pytest.raises(ValueError, match='supports only driver "postgres"'):
introspect_database_response(
DatabaseIntrospectionRequest(
connection_id="warehouse",
driver="snowflake",
url="snowflake://example",
),
load_rows=lambda request: DatabaseIntrospectionRows([], [], []),
)
def test_database_introspection_request_rejects_empty_schema_list() -> None:
with pytest.raises(ValueError, match="at least one schema"):
DatabaseIntrospectionRequest(
connection_id="warehouse",
driver="postgres",
url="postgresql://readonly@example.test/warehouse",
schemas=[],
)
def test_table_scope_json_serializes_null_wildcards() -> None:
assert _table_scope_json(
[
LiveDatabaseTableScopeRef(catalog=None, db="public", name="orders"),
LiveDatabaseTableScopeRef(
catalog="warehouse",
db="marts",
name="customers",
),
]
) == (
'[{"catalog": null, "db": "public", "name": "orders"}, '
'{"catalog": "warehouse", "db": "marts", "name": "customers"}]'
)
def test_statement_timeout_config_uses_parameterized_set_config() -> None:
assert _statement_timeout_config(30_000) == (
"SELECT set_config('statement_timeout', %s, true)",
("30000ms",),
)