Skip to content

Commit cbffc84

Browse files
gitvsshgitvssh
committed
feat: publish deterministic E2E harness v1.0.0
0 parents  commit cbffc84

38 files changed

Lines changed: 2822 additions & 0 deletions

‎.github/workflows/ci.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
11+
concurrency:
12+
group: ci-${{ github.workflow }}-${{ github.ref }}
13+
cancel-in-progress: true
14+
15+
jobs:
16+
validate:
17+
# The internal runner executes only trusted owner pushes and manual runs.
18+
if: github.repository == 'gitvssh/deterministic-e2e-harness' && github.actor == 'gitvssh'
19+
runs-on: homelab-deterministic-e2e-harness
20+
timeout-minutes: 30
21+
steps:
22+
- name: Check out the requested commit
23+
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
24+
with:
25+
persist-credentials: false
26+
fetch-depth: 1
27+
28+
- name: Install uv without Actions cache
29+
uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d # v10.0.1
30+
with:
31+
enable-cache: false
32+
version: "0.9.26"
33+
34+
- name: Pin Python
35+
run: uv python install 3.14
36+
37+
- name: Run the complete public-release quality gate
38+
run: python3 scripts/quality.py all

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.tools/
2+
.venv/
3+
.mypy_cache/
4+
.pytest_cache/
5+
.ruff_cache/
6+
__pycache__/
7+
*.pyc
8+
reports/
9+
env/*.vars

‎.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.14

‎CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
All notable changes are documented here. This project follows Semantic Versioning.
4+
5+
## 1.0.0 - 2026-08-20
6+
7+
- Publish the tool-neutral compile-review-run model.
8+
- Add bootstrap, Hurl compilation, deterministic execution, triage, and audit guides.
9+
- Add a synthetic registration and declined-payment retry journey.
10+
- Add pinned Hurl bootstrap, self-test, CI policy validation, SBOM, audit, and license gates.

‎CONTRIBUTING.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
3+
Contributions should preserve the central invariant: committed deterministic specifications—not an
4+
LLM judgment—own CI pass/fail.
5+
6+
1. Describe the behavior change in a use case or scenario document.
7+
2. Update the matching Hurl specification in the same change.
8+
3. Use synthetic data only.
9+
4. Run `python3 scripts/quality.py all`.
10+
5. Explain any compatibility impact to consumers of `kit/`.
11+
12+
Do not weaken an assertion solely to make a failing implementation pass. If the contract changed,
13+
make the contract change explicit and review the document and specification diff together.

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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 [yyyy] [name of copyright owner]
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.

‎README.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# Deterministic E2E Harness
2+
3+
A document-driven API testing kit where AI may compile reviewed requirements into static Hurl
4+
specifications, while a deterministic runner remains the only CI pass/fail authority.
5+
6+
> The included registration and payment flow is entirely synthetic. It runs locally without an
7+
> account, API key, database, or external service.
8+
9+
## Problem
10+
11+
AI-generated tests become difficult to trust when an LLM invents requests or judges results during
12+
every CI run. The same prompt can produce different traffic, hide a real regression by rewriting a
13+
failing assertion, or require credentials just to reproduce a result.
14+
15+
## Solution
16+
17+
This kit separates nondeterministic authoring from deterministic execution:
18+
19+
1. requirements and scenarios are the source of truth;
20+
2. an AI assistant may compile them into plain-text Hurl specifications;
21+
3. a human reviews the specification diff before it is committed;
22+
4. CI runs only the committed specification and trusts only Hurl's exit code;
23+
5. failures produce evidence for triage—never an automatic assertion rewrite.
24+
25+
The rules are tool-neutral. Hurl is the reference adapter because its request and assertion format is
26+
plain text, reviewable, and independent of the application language.
27+
28+
## Architecture
29+
30+
```text
31+
requirements + scenario documents
32+
|
33+
v
34+
AI-assisted compilation ----> human diff review
35+
| |
36+
+-------------------------+
37+
|
38+
v
39+
committed *.hurl spec
40+
|
41+
v
42+
deterministic Hurl run
43+
|
44+
pass/fail exit code + report
45+
```
46+
47+
`kit/AI_GUIDE.md` defines the non-negotiable boundaries. The numbered documents under
48+
`kit/harness/` cover bootstrap, compilation, execution, triage, and consistency auditing. See
49+
[`docs/architecture.md`](docs/architecture.md) for component responsibilities.
50+
51+
## Quickstart
52+
53+
Requirements: Linux or macOS, Python 3.14, and `uv` 0.9.26. Hurl 8.0.1 is downloaded from its
54+
official release and verified against a pinned SHA-256 digest.
55+
56+
```bash
57+
python3 scripts/quality.py quickstart
58+
```
59+
60+
The command installs locked development tools, starts the synthetic API on a random loopback port,
61+
runs the reviewed Hurl journey, and shuts the server down. It does not use Docker or credentials.
62+
63+
To adopt the kit in another repository, copy `kit/`, then create project-specific `docs/`, `specs/`,
64+
and `project-config.yaml` from the templates. Never edit the shared rules to make a failing product
65+
look green.
66+
67+
## Validation
68+
69+
Local and CI validation use the same entry point:
70+
71+
```bash
72+
python3 scripts/quality.py all
73+
```
74+
75+
It performs formatting and lint checks, strict type checking, unit tests, the real Hurl integration
76+
journey, dependency vulnerability auditing, CycloneDX SBOM validation, and dependency-license
77+
review. GitHub Actions uses the repository-scoped `homelab-deterministic-e2e-harness` ARC runner
78+
with read-only permissions and no Actions cache or artifact storage.
79+
80+
## Demo
81+
82+
The synthetic scenario proves a complete state transition:
83+
84+
1. register a fictional user;
85+
2. submit a payment using a deterministic decline token and assert HTTP 402;
86+
3. retry with a deterministic approval token and capture the payment;
87+
4. query the payment and verify the final `captured` state.
88+
89+
The human-readable contract and executable specification live together:
90+
91+
- [`examples/payment_flow/docs/UC-PAY-001.md`](examples/payment_flow/docs/UC-PAY-001.md)
92+
- [`examples/payment_flow/docs/TS-PAY-001.md`](examples/payment_flow/docs/TS-PAY-001.md)
93+
- [`examples/payment_flow/specs/TS-PAY-001.hurl`](examples/payment_flow/specs/TS-PAY-001.hurl)
94+
- [`examples/payment_flow/openapi.yaml`](examples/payment_flow/openapi.yaml)
95+
96+
## Limitations
97+
98+
- The reference adapter validates HTTP APIs; browser journeys require a separately reviewed runner
99+
adapter.
100+
- AI compilation is an authoring aid, not a CI dependency or test oracle.
101+
- The synthetic server is deliberately in-memory and single-process; it is not production payment
102+
code.
103+
- This kit does not provision test environments, seed real customer data, or manage credentials.
104+
- Hurl downloads are pinned for Linux x86-64/ARM64 and macOS x86-64/ARM64 only.
105+
106+
## License
107+
108+
Apache-2.0. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)