Skip to content

Walkthrough — see the test case work

Step-by-step guide to verify Operator ETL on your machine after clone. Same proof CI runs on every push.

When to read: After install — you want to see the test case work (SQL, dashboard, CI).

Prerequisites: GETTING-STARTED.md §1–2 complete · Start here: README.md

Overview

flowchart LR
  E2E[make e2e] --> Sample[samples/public_comments.csv]
  E2E --> Warehouse[DuckDB warehouse]
  E2E --> Dashboard[Streamlit Gov tab]
  E2E --> CI[GitHub Actions]

Or run the helper: ./scripts/walkthrough.sh

What each test defends: See the proof matrix in FOUNDATIONS.md.

Pipeline sequence (FOIA demo)

sequenceDiagram
  participant CSV as public_comments.csv
  participant ETL as operator_etl
  participant PII as PII gate
  participant Graph as LangGraph
  participant Critic as critic
  participant WH as DuckDB warehouse

  CSV->>ETL: ingest 12 rows
  ETL->>WH: bronze_raw
  ETL->>PII: scan bodies
  PII->>WH: silver 10 + quarantine 2
  ETL->>WH: gold KPIs
  Graph->>WH: quality + insight via MCP
  Graph->>Critic: verify numbers
  Critic->>WH: persist insight
  Note over Graph,Critic: status=complete

Step 1 — Run the proof gate

make e2e

What runs:

Step Tool Proves
OKF validate scripts/okf_validate.py Documentation structure
pytest 41 tests PII, critic, graph, idempotency, MCP, HITL, mocked LLM
FOIA demo scripts/demo_mvp.sh End-to-end on fresh warehouse

Expected terminal output (FOIA demo section):

status=complete  run_id=...
rows_in=12  silver=10  quarantined=2
pii_findings=3

Public comment intake summary: 10 comments across 2 dockets and 2 agencies. ...

Expected summary:

Operator ETL MVP — PASS
  Sample: 12 public comments (EPA/FCC dockets)
  Silver: 10 valid | Quarantine: 2

If counts look wrong, you may have a stale warehouse — run ./scripts/demo_mvp.sh alone (uses fresh .tmp/mvp-demo/).

Step 2 — Inspect the sample data

Open samples/public_comments.csv:

  • 12 data rows (plus header)
  • 2 invalid rows quarantined: empty body, bad date
  • PII in bodies: emails, phones (synthetic — for demo only)

Registry entry: pipelines/public_comments.yaml

Step 3 — Inspect the warehouse

After make e2e, the demo warehouse is at .tmp/mvp-demo/operator.duckdb.

./scripts/walkthrough.sh --inspect-only

Or query manually:

duckdb .tmp/mvp-demo/operator.duckdb -c "
  SELECT 'silver' AS layer, COUNT(*) AS n FROM silver_comments
  UNION ALL
  SELECT 'quarantine', COUNT(*) FROM quarantine_comments
  UNION ALL
  SELECT 'pii_flagged', COUNT(*) FROM silver_comments WHERE pii_detected;
"

Expected:

layer n
silver 10
quarantine 2
pii_flagged 4+

Gold KPIs:

duckdb .tmp/mvp-demo/operator.duckdb -c "SELECT * FROM gold_comment_kpis;"

Step 4 — Dashboard visual check

export OPERATOR_ETL_WAREHOUSE=".tmp/mvp-demo/operator.duckdb"
export OPERATOR_ETL_PIPELINE_NAME=public_comments
export OPERATOR_ETL_DOMAIN=gov
uv run streamlit run dashboard/app.py

Open Gov / FOIA tab — comment count, PII flagged, quarantine expander, latest insight text should match Step 1 output. Full screenshot set: TOUR.md.

Gov / FOIA dashboard

Step 5 — CI (remote build)

Local make e2e mirrors GitHub Actions:

https://github.com/khaosans/operator-etl/actions/workflows/ci.yml

Green CI on master = same OKF + pytest + FOIA demo passed on a clean Ubuntu runner, plus Docker image build.

Step 6 — MCP smoke (optional)

cp .cursor/mcp.json.example .cursor/mcp.json
# edit cwd to your clone path

In Cursor, call get_gold_metrics with domain: gov after running the demo — counts should match gold marts.

Test file mapping

Assertion Test / script
Graph completes, critic passes tests/test_gov_graph.py
PII not in redacted output tests/test_pii.py
Hallucinated numbers rejected tests/test_critic.py
MCP allowlist deny/permit tests/test_mcp_tools.py
Idempotent ingest tests/test_pipeline.py
Fresh warehouse E2E smoke scripts/demo_mvp.sh
Full gate harness/e2e.sh / make e2e

Canonical numbers: okf/models/mvp-demo.md

Next steps

See also