windtunnel-bench 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (157) hide show
  1. windtunnel_bench-0.1.0/.github/workflows/ci.yml +31 -0
  2. windtunnel_bench-0.1.0/.github/workflows/docs.yml +40 -0
  3. windtunnel_bench-0.1.0/.github/workflows/publish.yml +25 -0
  4. windtunnel_bench-0.1.0/.github/workflows/release-please.yml +18 -0
  5. windtunnel_bench-0.1.0/.gitignore +23 -0
  6. windtunnel_bench-0.1.0/.release-please-manifest.json +3 -0
  7. windtunnel_bench-0.1.0/AGENTS.md +40 -0
  8. windtunnel_bench-0.1.0/CONTRIBUTING.md +127 -0
  9. windtunnel_bench-0.1.0/LICENSE +202 -0
  10. windtunnel_bench-0.1.0/PKG-INFO +223 -0
  11. windtunnel_bench-0.1.0/README.md +210 -0
  12. windtunnel_bench-0.1.0/docs/agent-quickstart.md +135 -0
  13. windtunnel_bench-0.1.0/docs/architecture.md +209 -0
  14. windtunnel_bench-0.1.0/docs/failure-taxonomy.md +274 -0
  15. windtunnel_bench-0.1.0/docs/getting-started.md +166 -0
  16. windtunnel_bench-0.1.0/docs/index.md +39 -0
  17. windtunnel_bench-0.1.0/docs/writing-a-classifier.md +164 -0
  18. windtunnel_bench-0.1.0/docs/writing-a-runtime.md +185 -0
  19. windtunnel_bench-0.1.0/docs/writing-a-scenario.md +279 -0
  20. windtunnel_bench-0.1.0/docs/writing-an-optimizer.md +170 -0
  21. windtunnel_bench-0.1.0/mkdocs.yml +48 -0
  22. windtunnel_bench-0.1.0/pyproject.toml +67 -0
  23. windtunnel_bench-0.1.0/release-please-config.json +14 -0
  24. windtunnel_bench-0.1.0/runs/.gitkeep +0 -0
  25. windtunnel_bench-0.1.0/tests/__init__.py +0 -0
  26. windtunnel_bench-0.1.0/tests/fixtures/__init__.py +1 -0
  27. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_01_tool_affordance.json +77 -0
  28. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_02_tool_affordance.json +106 -0
  29. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_03_clarification.json +110 -0
  30. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_04_clarification.json +79 -0
  31. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_05_side_effect_safety_violation.json +104 -0
  32. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_06_side_effect_safety_violation.json +104 -0
  33. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_07_template_corruption.json +97 -0
  34. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_08_template_corruption.json +86 -0
  35. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_09_policy.json +102 -0
  36. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_10_memory.json +101 -0
  37. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_11_recovery.json +100 -0
  38. windtunnel_bench-0.1.0/tests/fixtures/labeled_failures/fixture_12_sampler_variance.json +77 -0
  39. windtunnel_bench-0.1.0/tests/test_cli_wt.py +286 -0
  40. windtunnel_bench-0.1.0/tests/test_dim_clarify_vs_guess.py +582 -0
  41. windtunnel_bench-0.1.0/tests/test_dim_icl_poisoning.py +733 -0
  42. windtunnel_bench-0.1.0/tests/test_dim_memory_conflict.py +741 -0
  43. windtunnel_bench-0.1.0/tests/test_dim_multi_turn_drift.py +666 -0
  44. windtunnel_bench-0.1.0/tests/test_dim_policy_pressure.py +583 -0
  45. windtunnel_bench-0.1.0/tests/test_dim_recovery.py +800 -0
  46. windtunnel_bench-0.1.0/tests/test_dim_sampler_sensitivity.py +588 -0
  47. windtunnel_bench-0.1.0/tests/test_dim_side_effect_safety.py +715 -0
  48. windtunnel_bench-0.1.0/tests/test_dim_silent_failure.py +905 -0
  49. windtunnel_bench-0.1.0/tests/test_dim_tool_affordance.py +523 -0
  50. windtunnel_bench-0.1.0/tests/test_forbidden_before_clip.py +25 -0
  51. windtunnel_bench-0.1.0/tests/test_forbidden_facts_gate.py +549 -0
  52. windtunnel_bench-0.1.0/tests/test_import_invariants.py +189 -0
  53. windtunnel_bench-0.1.0/tests/test_in_memory_runtime.py +155 -0
  54. windtunnel_bench-0.1.0/tests/test_pre_send_perturbations.py +223 -0
  55. windtunnel_bench-0.1.0/tests/test_report.py +867 -0
  56. windtunnel_bench-0.1.0/tests/test_runner.py +433 -0
  57. windtunnel_bench-0.1.0/tests/test_runtime_conformance.py +189 -0
  58. windtunnel_bench-0.1.0/tests/test_runtime_plugins.py +140 -0
  59. windtunnel_bench-0.1.0/tests/test_scenario_packs.py +285 -0
  60. windtunnel_bench-0.1.0/tests/test_scoring.py +1262 -0
  61. windtunnel_bench-0.1.0/tests/test_spi_protocols.py +277 -0
  62. windtunnel_bench-0.1.0/tests/test_trace.py +569 -0
  63. windtunnel_bench-0.1.0/tests/test_trajectory_evidence.py +275 -0
  64. windtunnel_bench-0.1.0/tests/test_triage.py +1045 -0
  65. windtunnel_bench-0.1.0/uv.lock +1500 -0
  66. windtunnel_bench-0.1.0/windtunnel/__init__.py +1 -0
  67. windtunnel_bench-0.1.0/windtunnel/api/__init__.py +82 -0
  68. windtunnel_bench-0.1.0/windtunnel/api/aggregate.py +131 -0
  69. windtunnel_bench-0.1.0/windtunnel/api/evaluators.py +518 -0
  70. windtunnel_bench-0.1.0/windtunnel/api/pack.py +73 -0
  71. windtunnel_bench-0.1.0/windtunnel/api/perturbations.py +1087 -0
  72. windtunnel_bench-0.1.0/windtunnel/api/replay.py +71 -0
  73. windtunnel_bench-0.1.0/windtunnel/api/runner.py +475 -0
  74. windtunnel_bench-0.1.0/windtunnel/api/scenario.py +274 -0
  75. windtunnel_bench-0.1.0/windtunnel/api/score.py +91 -0
  76. windtunnel_bench-0.1.0/windtunnel/api/state_reset.py +91 -0
  77. windtunnel_bench-0.1.0/windtunnel/api/trace.py +224 -0
  78. windtunnel_bench-0.1.0/windtunnel/cli.py +804 -0
  79. windtunnel_bench-0.1.0/windtunnel/effect_classes.py +87 -0
  80. windtunnel_bench-0.1.0/windtunnel/mcp/__init__.py +0 -0
  81. windtunnel_bench-0.1.0/windtunnel/mcp/fastmcp/__init__.py +0 -0
  82. windtunnel_bench-0.1.0/windtunnel/mcp/fastmcp/server.py +463 -0
  83. windtunnel_bench-0.1.0/windtunnel/report.py +872 -0
  84. windtunnel_bench-0.1.0/windtunnel/runtimes/__init__.py +0 -0
  85. windtunnel_bench-0.1.0/windtunnel/runtimes/in_memory/__init__.py +4 -0
  86. windtunnel_bench-0.1.0/windtunnel/runtimes/in_memory/runtime.py +125 -0
  87. windtunnel_bench-0.1.0/windtunnel/scenarios/__init__.py +47 -0
  88. windtunnel_bench-0.1.0/windtunnel/scenarios/_mock_factory.py +71 -0
  89. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_clarify_vs_guess/__init__.py +12 -0
  90. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_clarify_vs_guess/mock_mcp/Dockerfile +14 -0
  91. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_clarify_vs_guess/mock_mcp/__init__.py +1 -0
  92. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_clarify_vs_guess/mock_mcp/server.py +299 -0
  93. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_clarify_vs_guess/scenarios.py +278 -0
  94. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_clarify_vs_guess/synthetic_db.py +212 -0
  95. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_icl_poisoning/__init__.py +31 -0
  96. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_icl_poisoning/scenarios.py +244 -0
  97. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_memory_conflict/__init__.py +27 -0
  98. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_memory_conflict/memory_seeder.py +130 -0
  99. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_memory_conflict/mock_mcp/Dockerfile +14 -0
  100. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_memory_conflict/mock_mcp/__init__.py +1 -0
  101. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_memory_conflict/mock_mcp/server.py +135 -0
  102. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_memory_conflict/scenarios.py +308 -0
  103. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_memory_conflict/synthetic_db.py +100 -0
  104. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_multi_turn_drift/__init__.py +17 -0
  105. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_multi_turn_drift/mock_mcp/Dockerfile +14 -0
  106. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_multi_turn_drift/mock_mcp/server.py +238 -0
  107. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_multi_turn_drift/multi_turn.py +38 -0
  108. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_multi_turn_drift/scenarios.py +187 -0
  109. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_multi_turn_drift/synthetic_db.py +224 -0
  110. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_policy_pressure/__init__.py +12 -0
  111. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_policy_pressure/mock_mcp/Dockerfile +14 -0
  112. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_policy_pressure/mock_mcp/__init__.py +1 -0
  113. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_policy_pressure/mock_mcp/server.py +299 -0
  114. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_policy_pressure/scenarios.py +382 -0
  115. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_policy_pressure/synthetic_db.py +204 -0
  116. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_recovery/__init__.py +12 -0
  117. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_recovery/mock_mcp/Dockerfile +14 -0
  118. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_recovery/mock_mcp/__init__.py +1 -0
  119. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_recovery/mock_mcp/server.py +291 -0
  120. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_recovery/scenarios.py +236 -0
  121. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_recovery/synthetic_db.py +226 -0
  122. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_sampler_sensitivity/__init__.py +14 -0
  123. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_sampler_sensitivity/matrix.py +141 -0
  124. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_sampler_sensitivity/mock_mcp/Dockerfile +14 -0
  125. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_sampler_sensitivity/mock_mcp/__init__.py +1 -0
  126. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_sampler_sensitivity/mock_mcp/server.py +165 -0
  127. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_sampler_sensitivity/scenarios.py +144 -0
  128. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_sampler_sensitivity/synthetic_db.py +137 -0
  129. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_side_effect_safety/__init__.py +14 -0
  130. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_side_effect_safety/mock_mcp/Dockerfile +14 -0
  131. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_side_effect_safety/mock_mcp/__init__.py +1 -0
  132. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_side_effect_safety/mock_mcp/server.py +342 -0
  133. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_side_effect_safety/scenarios.py +394 -0
  134. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_side_effect_safety/synthetic_db.py +223 -0
  135. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_silent_failure/__init__.py +45 -0
  136. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_silent_failure/mock_mcp/Dockerfile +20 -0
  137. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_silent_failure/mock_mcp/__init__.py +1 -0
  138. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_silent_failure/mock_mcp/server.py +388 -0
  139. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_silent_failure/scenarios.py +237 -0
  140. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_silent_failure/synthetic_db.py +296 -0
  141. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_tool_affordance/__init__.py +25 -0
  142. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_tool_affordance/mock_mcp/Dockerfile +14 -0
  143. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_tool_affordance/mock_mcp/Dockerfile.windtunnel +18 -0
  144. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_tool_affordance/mock_mcp/__init__.py +1 -0
  145. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_tool_affordance/mock_mcp/server.py +344 -0
  146. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_tool_affordance/scenarios.py +272 -0
  147. windtunnel_bench-0.1.0/windtunnel/scenarios/dim_tool_affordance/synthetic_db.py +285 -0
  148. windtunnel_bench-0.1.0/windtunnel/scenarios/prototype.py +192 -0
  149. windtunnel_bench-0.1.0/windtunnel/spi/__init__.py +25 -0
  150. windtunnel_bench-0.1.0/windtunnel/spi/agent_runtime.py +242 -0
  151. windtunnel_bench-0.1.0/windtunnel/spi/mcp_server.py +172 -0
  152. windtunnel_bench-0.1.0/windtunnel/spi/runtime_plugin.py +99 -0
  153. windtunnel_bench-0.1.0/windtunnel/triage/__init__.py +20 -0
  154. windtunnel_bench-0.1.0/windtunnel/triage/classifier.py +150 -0
  155. windtunnel_bench-0.1.0/windtunnel/triage/llm_judge.py +151 -0
  156. windtunnel_bench-0.1.0/windtunnel/triage/optimizer.py +287 -0
  157. windtunnel_bench-0.1.0/windtunnel/triage/rule_based.py +688 -0
@@ -0,0 +1,31 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ test:
10
+ runs-on: ubuntu-latest
11
+ steps:
12
+ - uses: actions/checkout@v4
13
+ - uses: astral-sh/setup-uv@v5
14
+ with:
15
+ python-version: "3.11"
16
+ - name: Install
17
+ run: uv sync
18
+ - name: Lint
19
+ run: uv run ruff check windtunnel/ tests/
20
+ - name: Unit tests (no infrastructure required)
21
+ run: uv run pytest -m "not integration" -q --timeout=120
22
+
23
+ docs:
24
+ runs-on: ubuntu-latest
25
+ steps:
26
+ - uses: actions/checkout@v4
27
+ - uses: astral-sh/setup-uv@v5
28
+ with:
29
+ python-version: "3.11"
30
+ - name: Build docs (strict — broken nav/links fail)
31
+ run: uv run --group docs mkdocs build --strict
@@ -0,0 +1,40 @@
1
+ name: Docs
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+
7
+ permissions:
8
+ contents: read
9
+ pages: write
10
+ id-token: write
11
+
12
+ # One Pages deploy at a time; don't cancel a deploy mid-flight.
13
+ concurrency:
14
+ group: pages
15
+ cancel-in-progress: false
16
+
17
+ jobs:
18
+ build:
19
+ runs-on: ubuntu-latest
20
+ steps:
21
+ - uses: actions/checkout@v4
22
+ - uses: astral-sh/setup-uv@v5
23
+ with:
24
+ python-version: "3.11"
25
+ - name: Build site
26
+ run: uv run --group docs mkdocs build --strict
27
+ - uses: actions/configure-pages@v5
28
+ - uses: actions/upload-pages-artifact@v3
29
+ with:
30
+ path: site
31
+
32
+ deploy:
33
+ needs: build
34
+ runs-on: ubuntu-latest
35
+ environment:
36
+ name: github-pages
37
+ url: ${{ steps.deployment.outputs.page_url }}
38
+ steps:
39
+ - id: deployment
40
+ uses: actions/deploy-pages@v4
@@ -0,0 +1,25 @@
1
+ name: Publish to PyPI
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ jobs:
8
+ publish:
9
+ runs-on: ubuntu-latest
10
+ # Trusted Publishing (OIDC) — no API token. The PyPI project must list
11
+ # this repo + workflow + environment as a trusted publisher (see
12
+ # CONTRIBUTING.md "One-time repository setup").
13
+ environment: pypi
14
+ permissions:
15
+ id-token: write
16
+ contents: read
17
+ steps:
18
+ - uses: actions/checkout@v4
19
+ - uses: astral-sh/setup-uv@v5
20
+ with:
21
+ python-version: "3.11"
22
+ - name: Build sdist and wheel
23
+ run: uv build
24
+ - name: Publish
25
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,18 @@
1
+ name: Release Please
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+
7
+ permissions:
8
+ contents: write
9
+ pull-requests: write
10
+
11
+ jobs:
12
+ release-please:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: googleapis/release-please-action@v4
16
+ with:
17
+ config-file: release-please-config.json
18
+ manifest-file: .release-please-manifest.json
@@ -0,0 +1,23 @@
1
+ # Virtual environments
2
+ .venv/
3
+
4
+ # Run artifacts (traces + score sidecars + reports — generated, not source)
5
+ runs/*
6
+ !runs/.gitkeep
7
+ report.html
8
+
9
+ # Caches
10
+ __pycache__/
11
+ .pytest_cache/
12
+ .ruff_cache/
13
+ .mypy_cache/
14
+ *.egg-info/
15
+
16
+ # OS noise
17
+ .DS_Store
18
+
19
+ # MkDocs build output
20
+ site/
21
+
22
+ # Build artifacts
23
+ dist/
@@ -0,0 +1,3 @@
1
+ {
2
+ ".": "0.1.0"
3
+ }
@@ -0,0 +1,40 @@
1
+ # Wind Tunnel — agent notes
2
+
3
+ unittest for agents: scenarios score tool-using LLM agents on four layers
4
+ (outcome / trajectory / constraint / robustness). Layout: `windtunnel/api`
5
+ (scenario authoring), `windtunnel/spi` (runtime Protocols),
6
+ `windtunnel/scenarios/dim_*` (the dimension catalog), `tests/`.
7
+
8
+ ## Commands
9
+
10
+ ```bash
11
+ uv sync # setup (.venv + dev group)
12
+ uv run pytest -m "not integration" -q # unit suite — must always pass, no infra
13
+ uv run ruff check windtunnel/ tests/ # lint — keep at zero
14
+ uv run wt run --scenario <name> --runtime in_memory --runs 1 # smoke a scenario
15
+ ```
16
+
17
+ ## Invariants (test-enforced — do not weaken)
18
+
19
+ - Scenarios NEVER import `windtunnel.runtimes.*` (`tests/test_import_invariants.py`).
20
+ - Scenario `must_call`/`forbidden_calls` use canonical bare tool names
21
+ (`client_lookup`); the evaluator matches platform decorations.
22
+ - The per-run pass/fail gate is the **outcome layer only**; trajectory,
23
+ constraint, and robustness are recorded, not gating
24
+ (`windtunnel/api/aggregate.py`).
25
+ - `evaluate_outcome` scores the actual last assistant turn, even if empty —
26
+ never backfill from earlier turns (`windtunnel/api/evaluators.py`).
27
+ - Synthetic data stays fictional: fake orgs, `.example` domains.
28
+
29
+ ## Gotchas
30
+
31
+ - The `in_memory` runtime never calls tools — `requires_tool_use` scenarios
32
+ correctly FAIL under it. That's the gate working, not a bug.
33
+ - Entry points (`windtunnel.runtimes` and `windtunnel.scenario_packs` groups)
34
+ refresh only on reinstall: after touching pyproject entry points, `uv sync`
35
+ before trusting resolution.
36
+ - `runs/` is generated output (gitignored); traces pair with `.score.json`
37
+ sidecars written by `wt run`/`wt replay`.
38
+
39
+ Integrating Wind Tunnel into another repo? Use
40
+ [docs/agent-quickstart.md](docs/agent-quickstart.md).
@@ -0,0 +1,127 @@
1
+ # Contributing to Wind Tunnel
2
+
3
+ ## Dev setup
4
+
5
+ ```bash
6
+ git clone https://github.com/syntropy-systems-oss/windtunnel
7
+ cd windtunnel
8
+ uv sync # creates .venv, installs editable + the dev group
9
+ ```
10
+
11
+ ## Running checks
12
+
13
+ ```bash
14
+ uv run pytest -m "not integration" -q # the unit suite — fast, no infrastructure
15
+ uv run ruff check windtunnel/ tests/
16
+ ```
17
+
18
+ The `integration` marker is reserved for tests that need a live agent stack;
19
+ the unit suite must always pass with no network, no Docker, no model.
20
+
21
+ ## The one rule that is not negotiable
22
+
23
+ **Scenarios never import platform-specific types.** If you can't write a
24
+ scenario without importing `windtunnel.runtimes.*`, the SPI has leaked — fix
25
+ the contract, not the scenario. This is enforced by
26
+ `tests/test_import_invariants.py`; a PR that weakens that test needs a very
27
+ good story.
28
+
29
+ Two corollaries:
30
+
31
+ - Scenario `must_call` / `forbidden_calls` use **canonical bare tool names**
32
+ (`client_lookup`), never platform-decorated ones — the trajectory evaluator
33
+ matches decorations (`mcp_<server>_<prefix>_client_lookup`, dotted forms)
34
+ for you.
35
+ - New runtime drivers ship as **separate packages** registering the
36
+ `windtunnel.runtimes` entry-point group (see
37
+ [docs/writing-a-runtime.md](docs/writing-a-runtime.md)); they don't get
38
+ merged into `windtunnel/runtimes/`. The in-tree `in_memory` runtime is the
39
+ only exception — it's the zero-infrastructure reference. Scenario
40
+ dimensions have the same seam: external dims ship as `ScenarioPack`s
41
+ registering the `windtunnel.scenario_packs` group (see
42
+ [docs/writing-a-scenario.md](docs/writing-a-scenario.md#shipping-a-scenario-pack)).
43
+
44
+ ## Code style
45
+
46
+ - Python 3.11+, ruff (`E,F,W,I,UP`, line length 100), full type hints on
47
+ public API surfaces.
48
+ - Dataclasses for data shapes; Protocols for contracts.
49
+ - Docstrings explain *why* and record behavioral contracts — the evaluator
50
+ semantics in `windtunnel/api/evaluators.py` are the house style to imitate.
51
+ - Tests: one behavior per test, names that read as sentences, and when you
52
+ fix a bug, the regression test's docstring says what broke.
53
+
54
+ ## Adding a scenario or dimension
55
+
56
+ Read [docs/writing-a-scenario.md](docs/writing-a-scenario.md). A new dim
57
+ package needs `scenarios.py`, a mock MCP server (build on
58
+ `windtunnel.mcp.fastmcp.server.LoggingFastMCP` — call logging and failure
59
+ injection come free), a synthetic DB, and a `PACK` (a
60
+ `windtunnel.api.ScenarioPack` in the dim's `__init__.py`, listed in
61
+ `windtunnel/scenarios/__init__.py`'s `builtin_packs()`). Keep synthetic data
62
+ fictional: fake names, `.example` domains.
63
+
64
+ ## Docs
65
+
66
+ The docs site is MkDocs Material over `docs/`, deployed to GitHub Pages by
67
+ `.github/workflows/docs.yml` on every push to `main`. Preview locally:
68
+
69
+ ```bash
70
+ uv run --group docs mkdocs serve
71
+ ```
72
+
73
+ CI builds the site with `--strict`, so a broken nav entry or dead internal
74
+ link fails the build — treat docs like code.
75
+
76
+ ## Releases
77
+
78
+ Releases are automated with [release-please](https://github.com/googleapis/release-please)
79
+ and **conventional commits** — commit messages drive the version:
80
+
81
+ - `fix:` → patch, `feat:` → minor, `feat!:`/`BREAKING CHANGE:` → major
82
+ (pre-1.0, majors are taken as minors).
83
+ - On every push to `main`, release-please maintains a release PR that
84
+ accumulates the CHANGELOG and the next version (in `pyproject.toml` +
85
+ `.release-please-manifest.json`). **Merging that PR is the release**: it
86
+ tags `vX.Y.Z`, creates the GitHub release, and the publish workflow
87
+ (`.github/workflows/publish.yml`) builds with `uv build` and uploads to
88
+ PyPI via Trusted Publishing — no API tokens anywhere.
89
+
90
+ Pre-1.0: breaking changes are allowed but must be a `feat!:` so the
91
+ changelog calls them out. The config encodes the pre-1.0 stance:
92
+
93
+ - `bump-minor-pre-major: true` — a `feat!:` bumps 0.x → 0.(x+1), never
94
+ to 1.0.0. Going 1.0 is a deliberate act, not a commit-message accident.
95
+ - `prerelease: true` — GitHub releases are flagged "pre-release" while
96
+ we're 0.x. This is display-only; PyPI never sees it.
97
+ - We deliberately do NOT use release-please's prerelease *versioning*
98
+ (rc/beta suffixes): it emits semver-style `0.2.0-rc.1`, which is not a
99
+ valid PEP 440 version — PyPI wants `0.2.0rc1`. Plain 0.x versions are
100
+ pip-installable and honest about stability.
101
+ - `include-component-in-tag: false` — tags are plain `vX.Y.Z`, not
102
+ `windtunnel-vX.Y.Z`, so the manual first tag and release-please's tags
103
+ agree.
104
+
105
+ **At 1.0**: remove `bump-minor-pre-major` and `prerelease` from
106
+ `release-please-config.json`. That's the whole graduation ceremony.
107
+
108
+ ### One-time repository setup (maintainers)
109
+
110
+ Things the workflows need that only the GitHub/PyPI UIs can grant:
111
+
112
+ 1. **Pages**: repo Settings → Pages → Source = "GitHub Actions".
113
+ 2. **Release PRs**: Settings → Actions → General → enable
114
+ "Allow GitHub Actions to create and approve pull requests"
115
+ (release-please needs it).
116
+ 3. **PyPI Trusted Publisher**: on PyPI, add a publisher for project
117
+ `windtunnel-bench` → owner `syntropy-systems-oss`, repo `windtunnel`,
118
+ workflow `publish.yml`, environment `pypi`. (For a not-yet-existing
119
+ project, use PyPI's "pending publisher" flow.) Then create the `pypi`
120
+ environment in repo Settings → Environments. The bare name
121
+ `windtunnel` is a squatted empty registration on PyPI; a PEP 541
122
+ transfer request is pending — if granted, the distribution may be
123
+ renamed (the import name `windtunnel` is unaffected either way).
124
+ 4. **First release**: release-please versions *changes since the last
125
+ release*, so the initial `v0.1.0` is cut by hand once:
126
+ `gh release create v0.1.0 --title "v0.1.0" --generate-notes` — the
127
+ publish workflow takes it from there. Everything after is release PRs.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 Bryson Tang
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.