From 4789ec33f878a13c50635a5af24ba5ed47b2b1d0 Mon Sep 17 00:00:00 2001 From: Jan B <608446+janb84@users.noreply.github.com> Date: Mon, 24 Nov 2025 15:17:24 +0100 Subject: [PATCH 1/2] Revise README architecture and usage instructions Updated architecture diagram and instructions in README. --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 552aabd..05e6541 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,11 @@ The framework ensures that all language bindings (Go, Python, Rust, etc.) behave ## Architecture ``` -┌─────────────┐ ┌──────────────────┐ -│ Test Runner │────────▶│ Handler Binary │ -│ (Go CLI) │ stdin │ (Go/Rust/etc) │ -│ │◀────────│ │ -└─────────────┘ stdout └──────────────────┘ +┌─────────────┐ ┌───────────────────┐ +│ Test Runner │────────▶│ Handler Binary** │ +│ (Go CLI) │ stdin │ (Go/Rust/etc) │ +│ │◀────────│ │ +└─────────────┘ stdout └───────────────────┘ │ │ │ │ ▼ ▼ @@ -35,7 +35,7 @@ The framework ensures that all language bindings (Go, Python, Rust, etc.) behave 3. [**Test Cases**](./testdata): JSON files defining requests and expected responses 4. [**Mock Handler**](./cmd/mock-handler/main.go): Validates the runner by echoing expected responses from test cases -**Handler binaries** are not hosted in this repository. They must be implemented separately following the [**Handler Specification**](./docs/handler-spec.md) and should: +** **Handler binaries** are not hosted in this repository. They must be implemented separately following the [**Handler Specification**](./docs/handler-spec.md) and should: - Implement the JSON protocol for communication with the test runner - Call the binding API to execute operations - Pin to a specific version/tag of this test repository @@ -51,3 +51,13 @@ make build # Run tests against the mock handler make test ``` + +Use the test runner: + +```bash +# Build both runner +make build + +# Run the Test runner against your Handler binary: + ./build/runner --handler <> +``` From f7f89c2684af5063f96b8942f9161d39f2ecf325 Mon Sep 17 00:00:00 2001 From: stringintech Date: Tue, 25 Nov 2025 12:20:36 +0330 Subject: [PATCH 2/2] Apply minor polish to Getting Started section --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 05e6541..8dfe8e3 100644 --- a/README.md +++ b/README.md @@ -42,22 +42,26 @@ The framework ensures that all language bindings (Go, Python, Rust, etc.) behave ## Getting Started -Build and test against the mock handler: +### Testing Your Binding (Custom Handler) + +Test your handler implementation using the test runner: ```bash -# Build both runner and mock handler -make build +# Build the test runner +make runner -# Run tests against the mock handler -make test +# Run the test runner against your handler binary +./build/runner --handler ``` -Use the test runner: +### Testing the Runner + +Build and test the runner using the mock handler: ```bash -# Build both runner +# Build both runner and mock handler make build -# Run the Test runner against your Handler binary: - ./build/runner --handler <> +# Run the test runner against the mock handler +make test ```