Skip to content
shunt

Testing and Quality

Overview

Section titled “Overview”

Testing exists because shunt’s correctness is mostly protocol preservation. The dangerous failures are subtle: a beta header split incorrectly, an SSE stream buffered until the end, a tool call ID lost during translation, or an upstream error hidden behind a generic gateway error. The repository uses colocated unit tests plus Wiremock integration tests to lock those behaviors down tests/passthrough.rs:72-247 tests/responses_translate.rs:25-287.

Test layer Scope Representative file Source
Unit tests Config, routing, auth, adapters, translation helpers src/** module tests src/routing.rs:97-134 src/config.rs:301-391
Integration tests Axum gateway with mock upstream tests/passthrough.rs tests/passthrough.rs:72-247
Translation tests Request conversion, SSE state machine, error mapping tests/responses_translate.rs tests/responses_translate.rs:25-287
CI Format, clippy with warnings denied, test suite .github/workflows/ci.yml .github/workflows/ci.yml:1-42

Test Architecture

Section titled “Test Architecture”
graph TB
    subgraph Unit[Colocated unit tests]
      Config[config.rs tests]
      Routing[routing.rs tests]
      Auth[auth tests]
      Adapter[adapter tests]
    end
    subgraph Integration[tests]
      Pass[passthrough.rs]
      Translate[responses_translate.rs]
    end
    subgraph CI[GitHub Actions]
      Fmt[cargo fmt]
      Clippy[cargo clippy -D warnings]
      CargoTest[cargo test]
    end
    Unit --> CargoTest
    Integration --> CargoTest
    Fmt --> Clippy --> CargoTest
    classDef dark fill:#2d333b,stroke:#6d5dfc,color:#e6edf3;
    class Config,Routing,Auth,Adapter,Pass,Translate,Fmt,Clippy,CargoTest dark;
    style Unit fill:#161b22,stroke:#30363d,color:#e6edf3;
    style Integration fill:#161b22,stroke:#30363d,color:#e6edf3;
    style CI fill:#161b22,stroke:#30363d,color:#e6edf3;
    linkStyle default stroke:#8b949e;

Pass-through Integration Flow

Section titled “Pass-through Integration Flow”
sequenceDiagram
    autonumber
    participant Test as Wiremock test
    participant Gateway as shunt gateway
    participant Mock as Mock upstream
    Test->>Mock: mount expected request matchers
    Test->>Gateway: POST /v1/messages or count_tokens
    Gateway->>Mock: forwarded request
    Mock-->>Gateway: configured status/body/stream
    Gateway-->>Test: response
    Test->>Mock: verify expected calls

Translation Test Coverage

Section titled “Translation Test Coverage”
flowchart LR
    Input[Anthropic fixture] --> Translate[translate_request]
    Translate --> Assertions[JSON assertions]
    SSE[Responses SSE fixture] --> Parse[parse_sse_events]
    Parse --> Machine[AnthropicSseMachine]
    Machine --> EventAssertions[Event name and payload assertions]
    Error[OpenAI/Codex error shapes] --> Map[map_error_value]
    Map --> ErrorAssertions[Anthropic error assertions]
    classDef dark fill:#2d333b,stroke:#6d5dfc,color:#e6edf3;
    class Input,Translate,Assertions,SSE,Parse,Machine,EventAssertions,Error,Map,ErrorAssertions dark;
    linkStyle default stroke:#8b949e;

CI State Machine

Section titled “CI State Machine”
stateDiagram-v2
    [*] --> Checkout
    Checkout --> RustToolchain
    RustToolchain --> CacheCargo
    CacheCargo --> FormatCheck
    FormatCheck --> Clippy
    Clippy --> Tests
    Tests --> Success
    FormatCheck --> Failed: formatting differs
    Clippy --> Failed: warning or lint
    Tests --> Failed: test failure
    Success --> [*]

Quality Gates

Section titled “Quality Gates”
Gate Command What it protects Source
Formatting cargo fmt --all --check Consistent Rust style .github/workflows/ci.yml:1-42
Lints cargo clippy --all-targets --all-features -- -D warnings No warnings in all targets/features .github/workflows/ci.yml:1-42
Tests cargo test --all-features --workspace Unit and integration behavior .github/workflows/ci.yml:1-42
PR checklist Build, test, clippy, fmt, 500-line limit, spec sync Review discipline .github/PULL_REQUEST_TEMPLATE.md:1-26
Contribution guide Same commands plus SHA-pinned GitHub Actions Contributor expectations CONTRIBUTING.md:1-52
Section titled “Related Pages”
Page Relationship
Operations Shows the commands CI runs
Adapters and Translation Explains the behavior translation tests protect
Routing and Configuration Explains config/routing unit tests
Contributor Guide Contributor workflow and first task guidance

References

Section titled “References”