llm-ingestion-okf/tests/test_multi_source_provenance.py
Kjell Tore Guttormsen 28f9a4b540 fix(profiles,materialize,structure,consume): a block sources sequence is decoded, not skipped
One grammar, four call sites. `read_block_mappings` moves out of
`consume.read_sources` -- where it was written and measured -- into
`profiles`, the module both the flat readers and `consume` already import,
and the three copies of the line-oriented frontmatter grammar now decode a
block sequence for the keys `STRUCTURED_BLOCK_KEYS` names. Two copies of a
block grammar would be two answers to one question.

The value TYPE was the real choice and it was measured, not argued.
`parse_frontmatter` is public API (`okf.parse_frontmatter`) returning
`dict[str, str]`, and a list of mappings is not a `str`. Widening the return
type to `str | list[dict[str, str]]` costs 15 `mypy --strict` errors across
four of the five modules that touch the reader, plus a signature every
caller outside this repository would have to follow. Rendering the entries
back into the flow form those same readers already round-trip costs 0. The
rendering is a READING projection and says so: it is not a claim that the
value is writable -- `yaml_flow_plain` still refuses a `?` and the guard
still refuses a quote inside a flow mapping, which is why the producer
writes block in the first place.

`STRUCTURED_BLOCK_KEYS` is one key wide. `sources` is the key `read_sources`
already knows how to read; a fixture in this tree carries a block
`verified:` that still reads as an empty value, and a test pins that state
so the next widening is a decision rather than a side effect.

Nothing nested reaches the document's namespace: the entries land inside
their own value, and the K3-20 substitution guarantee is asserted per reader
copy.

Three tests that pinned the old behaviour are rewritten to what is now true,
none weakened on its other half: the block round trip in
`test_multi_source_provenance` (the evidence behind `_render_sources`'
reason 1), the v0.2 characterization (whose key-space assertion is the half
that must never weaken), and K3-22's shipped-file known-positive, where the
one difference is counted and pinned at 1.

Suite 1807 passed / 1 skipped, rc 0, 94 s -- 1782/1 before plus 25 new.
ruff clean, `mypy --strict` clean over 21 files, `uv.lock` untouched.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-12 16:42:22 +02:00

168 lines
6.7 KiB
Python

"""SPEC 5.1 `sources` with more than one entry, and the form it is emitted in.
PM decision B6 asked for a list-taking `_render_sources` so a concept can
record more than one source. It also prescribed the BLOCK list as the emitted
form. The list is delivered; the block form is not, and this file carries the
measurement rather than the argument.
Three facts, each pinned by a test below:
- **Our own parser loses a block list entirely.** `parse_frontmatter` is
line-oriented and skips indented lines, so `sources:` followed by ` - id: a`
round-trips to an EMPTY value with every entry gone -- silently. A provenance
record we cannot read back is worse than one we never wrote.
- **The consumer's decoder reads the flow sequence and refuses the block one.**
`portfolio-optimiser`'s `decode_flow_value` accepts `[{ k: v }, { k: v }]` --
plural -- and classifies a block sequence as `UnreadableProvenance`. Emitting
block would hand the consumer that asked for multi-source exactly the state it
reports as unreadable.
- **The order's own acceptance test settles it.** It asks for a round trip
through our `parse_frontmatter` equivalent. No block form can pass that.
So the goal is delivered in the form that reaches a reader: one flow sequence of
N flow mappings, on one line. A single source stays byte-identical, which is
what keeps all six goldens unmoved.
"""
from __future__ import annotations
from pathlib import Path
import pytest
from llm_ingestion_okf.consume import _frontmatter_lines, _parse_flow_mappings, read_sources
from llm_ingestion_okf.errors import MaterializationError
from llm_ingestion_okf.manifest import FileSource, HttpSource, Source, SqlSource
from llm_ingestion_okf.materialize import _render_sources, parse_frontmatter
CATALOGUE = FileSource(id="golden-catalogue", root="fixture")
DATABASE = SqlSource(id="golden-db", connection_ref="OKF_GOLDEN_SQL_DB")
API = HttpSource(id="golden-api", base_url="https://golden.example.test")
def _document(sources: str) -> str:
return (
"---\n"
"type: dataset\n"
"title: Orders\n"
"generated: { by: process:okf-ingest, at: 2026-01-01T00:00:00Z }\n"
f"sources: {sources}\n"
"---\n"
"\nBody.\n"
)
# --- the rendered form ------------------------------------------------------
def test_one_source_renders_the_byte_identical_single_form() -> None:
"""The additivity arm. Every golden in the suite reads this line."""
assert _render_sources([CATALOGUE]) == "[{ id: golden-catalogue, resource: fixture }]"
def test_two_sources_render_as_one_flow_sequence_on_one_line() -> None:
assert _render_sources([CATALOGUE, DATABASE]) == (
"[{ id: golden-catalogue, resource: fixture }, "
"{ id: golden-db, resource: OKF_GOLDEN_SQL_DB }]"
)
assert "\n" not in _render_sources([CATALOGUE, DATABASE])
def test_sources_keep_the_order_they_were_given() -> None:
"""No sort. The order a manifest names its sources in is the manifest's
statement, and nothing here can recover it once reordered."""
forward = _render_sources([CATALOGUE, DATABASE, API])
reverse = _render_sources([API, DATABASE, CATALOGUE])
assert forward.index("golden-catalogue") < forward.index("golden-api")
assert reverse.index("golden-api") < reverse.index("golden-catalogue")
def test_an_empty_source_list_is_refused() -> None:
"""`sources: []` is a provenance record naming no source: it reads as a
measured absence when it is the absence of a measurement."""
with pytest.raises(MaterializationError) as excinfo:
_render_sources([])
assert excinfo.value.code == "sources_empty"
# --- the round trip, which is the acceptance test ---------------------------
def test_two_sources_round_trip_through_our_own_parser(tmp_path: Path) -> None:
rendered = _render_sources([CATALOGUE, DATABASE])
path = tmp_path / "concept.md"
path.write_text(_document(rendered), encoding="utf-8")
frontmatter = parse_frontmatter(path)
assert frontmatter["sources"] == rendered
assert sorted(frontmatter) == ["generated", "sources", "title", "type"]
def test_the_block_form_round_trips_through_the_flat_reader(tmp_path: Path) -> None:
"""Two entries go in and BOTH come back (K3-24).
This test carried the opposite assertion until 2026-09-12, and it was the
evidence behind the first of the three reasons `_render_sources` gives for
not emitting the block form: a block list round-tripped to an EMPTY value
with every entry gone, silently. That reason is now false, and the test
says what is true instead of standing as a justification nothing measures.
It is still a control and not a regression guard: what it pins is that
the flat reader and `read_sources` return the same entries from the same
bytes. The emission rule did not move with it -- reasons 2 and 3 are
separate measurements and live in the docstring they belong to."""
path = tmp_path / "concept.md"
path.write_text(
"---\n"
"type: dataset\n"
"sources:\n"
" - id: golden-catalogue\n"
" resource: fixture\n"
" - id: golden-db\n"
" resource: OKF_GOLDEN_SQL_DB\n"
"---\n"
"\nBody.\n",
encoding="utf-8",
)
frontmatter = parse_frontmatter(path)
entries, present = read_sources(_frontmatter_lines(path))
assert present
assert _parse_flow_mappings(frontmatter["sources"]) == [
{"id": "golden-catalogue", "resource": "fixture"},
{"id": "golden-db", "resource": "OKF_GOLDEN_SQL_DB"},
]
assert _parse_flow_mappings(frontmatter["sources"]) == [dict(entry) for entry in entries]
# The quieter half, unchanged: an entry's keys stay inside the value.
assert set(frontmatter) == {"type", "sources"}
# --- the refusal applies to every entry, not only the first -----------------
@pytest.mark.parametrize("position", [0, 1, 2], ids=["first", "middle", "last"])
def test_an_unquotable_locator_is_refused_in_any_position(position: int) -> None:
"""A gate that only reads the head of a list is a gate the second entry
walks past."""
sources: list[Source] = [CATALOGUE, DATABASE, API]
sources[position] = FileSource(id="broken", root="data, backup")
with pytest.raises(MaterializationError) as excinfo:
_render_sources(sources)
assert excinfo.value.code == "source_reference_unquotable"
@pytest.mark.parametrize("position", [0, 1], ids=["first", "last"])
def test_an_unquotable_id_is_refused_in_any_position(position: int) -> None:
sources: list[Source] = [CATALOGUE, DATABASE]
sources[position] = FileSource(id="a{1}", root="fixture")
with pytest.raises(MaterializationError) as excinfo:
_render_sources(sources)
assert excinfo.value.code == "source_reference_unquotable"