# divesh-balani/restgym-wuppiefuzz-adapter architecture

> Architecture diagram of the GitHub repository divesh-balani/restgym-wuppiefuzz-adapter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/divesh-balani/restgym-wuppiefuzz-adapter
- Repository: https://github.com/divesh-balani/restgym-wuppiefuzz-adapter

## Overview

RESTgym automates empirical comparisons of black-box REST API testing tools. The main workflow is to select enabled API/tool pairs, run configurable repetitions in Docker while monitoring resources and container health, capture interactions and coverage, verify run integrity, then calculate per-run and cumulative effectiveness/efficiency reports. The graph focuses on these runtime and analysis stages; build-image handling and the internals of the bundled APIs and tools are outside that workflow. Some orchestration details are unsampled, so only documented or excerpt-supported relationships are shown.

Main entry points: [`src/run.py`](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/run.py) (Run orchestrator), [`results`](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/results) (Raw run data), [`src/common.py`](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/common.py) (Configuration and registry), [`src/check.py`](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/check.py) (Integrity verifier)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_experiment["Experiment control"]
  node_common["Configuration and registry<br/>[common.py]"]
  node_runner["Run orchestrator<br/>[run.py]"]
end

subgraph group_capture["Run data"]
  node_proxy["Interaction capture"]
  node_results[("Raw run data")]
end

subgraph group_analysis["Verification and analysis"]
  node_verifier["Integrity verifier<br/>[check.py]"]
  node_processor["Results processor<br/>[process_results.py]"]
  node_reports["Run and cumulative reports"]
end

node_researcher(("Experimenter"))
node_resources["Host resources"]
node_apis["Benchmark APIs"]
node_tools["Testing tools"]

node_researcher -->|"launches runs"| node_runner
node_runner -->|"reads configuration"| node_common
node_common -->|"selects enabled"| node_apis
node_common -->|"selects enabled"| node_tools
node_runner -->|"checks availability"| node_resources
node_runner -->|"starts containers"| node_apis
node_runner -->|"starts containers"| node_tools
node_runner -->|"records run data"| node_results
node_apis -.->|"sends interactions"| node_proxy
node_proxy -->|"stores interactions"| node_results
node_researcher -->|"verifies runs"| node_verifier
node_verifier -->|"checks integrity"| node_results
node_verifier -->|"marks verified"| node_results
node_researcher -->|"analyzes runs"| node_processor
node_processor -->|"reads verified data"| node_results
node_processor -->|"writes summaries"| node_reports

click node_common "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/common.py"
click node_runner "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/run.py"
click node_apis "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/apis"
click node_tools "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/tools"
click node_proxy "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/infrastructure/mitmproxy/store-interactions.py"
click node_results "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/results"
click node_verifier "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/check.py"
click node_processor "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/process_results.py"
click node_reports "https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/results"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_common,node_runner toneBlue
class node_proxy,node_results toneAmber
class node_verifier,node_processor,node_reports,node_apis toneMint
class node_researcher,node_resources toneIndigo
class node_tools toneTeal
```

## Components

### Experiment control

- [Configuration and registry](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/common.py): `src/common.py`
- [Run orchestrator](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/run.py): `src/run.py`

### Run data

- [Interaction capture](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/infrastructure/mitmproxy/store-interactions.py): `infrastructure/mitmproxy/store-interactions.py`
- [Raw run data](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/results): `results`

### Verification and analysis

- [Integrity verifier](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/check.py): `src/check.py`
- [Results processor](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/blob/main/src/process_results.py): `src/process_results.py`
- [Run and cumulative reports](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/results): `results`

### Other components

- **Experimenter**
- **Host resources**
- [Benchmark APIs](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/apis): `apis`
- [Testing tools](https://github.com/divesh-balani/restgym-wuppiefuzz-adapter/tree/main/tools): `tools`

## Connections

- Experimenter → Run orchestrator: launches runs (evidence: `README.md`)
- Run orchestrator → Configuration and registry: reads configuration (evidence: `src/run.py`)
- Configuration and registry → Benchmark APIs: selects enabled (evidence: `src/common.py`)
- Configuration and registry → Testing tools: selects enabled (evidence: `src/common.py`)
- Run orchestrator → Host resources: checks availability (evidence: `README.md`)
- Run orchestrator → Benchmark APIs: starts containers (evidence: `src/run.py`)
- Run orchestrator → Testing tools: starts containers (evidence: `src/run.py`)
- Run orchestrator → Raw run data: records run data (evidence: `src/run.py`)
- Benchmark APIs → Interaction capture: sends interactions
- Interaction capture → Raw run data: stores interactions (evidence: `infrastructure/mitmproxy/store-interactions.py`)
- Experimenter → Integrity verifier: verifies runs (evidence: `README.md`)
- Integrity verifier → Raw run data: checks integrity (evidence: `src/check.py`)
- Integrity verifier → Raw run data: marks verified (evidence: `src/check.py`)
- Experimenter → Results processor: analyzes runs (evidence: `README.md`)
- Results processor → Raw run data: reads verified data (evidence: `src/process_results.py`)
- Results processor → Run and cumulative reports: writes summaries (evidence: `src/process_results.py`)
