Skip to content

[FEAT]: add architecture and test-execution-flow diagrams to the Concepts overview #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spencrr merged 2 commits into from
May 18, 2026
Merged

[FEAT]: add architecture and test-execution-flow diagrams to the Concepts overview #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4656385
[FEAT]: Added architecture diagram and a execution flow diagram to th…
May 7, 2026
33dd8f2
addressed comments and updated architecture diagram to remove '... mo…
May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 16 additions & 19 deletions docs/concepts/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,26 +27,17 @@ RAMPART ships with the following probes; more will be added:

---

## Component Model
## Architecture at a Glance

Every RAMPART test involves these components:
RAMPART integrates within your **consumer package** (the thin integration layer in your product team's repo) and the **agent under test**, building on PyRIT primitives underneath. The diagram below shows how the layers fit together and where your code plugs in:

```mermaid
flowchart LR
subgraph Your Code
A[AgentAdapter] --> S[Session]
SF[Surface]
end
subgraph RAMPART
F[Attacks / Probes] --> E[Execution]
D[PromptDriver] --> E
EV[Evaluator] --> E
E --> R[Result]
R --> RP[ReportSink]
end
E -- "send_async()" --> S
E -- "inject()" --> SF
```
![RAMPART layered architecture: PyRIT (L1), RAMPART (L2), Consumer Package (L3), Agent Under Test (L4)](../images/rampart-architecture-dark.svg){ loading=lazy }
Comment thread
nina-msft marked this conversation as resolved.

*RAMPART's four layers — from PyRIT primitives up to the agent under test.*

## Component Model

Zooming in on the runtime path, every RAMPART test wires together the same handful of components:

| Component | You provide | RAMPART provides |
|-----------|-------------|-----------------|
Expand All @@ -61,7 +52,13 @@ flowchart LR

## Execution Lifecycle

Every execution follows a common lifecycle owned by [`BaseExecution`][rampart.core.execution.BaseExecution]:
A single test run flows from your pytest test, through a RAMPART attack or probe, into your `AgentAdapter`, and out to the agent system — then back again as a `Result`:

![RAMPART test execution flow: Test → Attacks/Probes → AgentAdapter → Agent System, with Pass/Fail returned](../images/rampart-execution-flow-dark.svg){ loading=lazy }
Comment thread
nina-msft marked this conversation as resolved.

*Request / response cycle for a single test run.*

Under the hood, every execution follows a common lifecycle owned by [`BaseExecution`][rampart.core.execution.BaseExecution], which drives the per-turn loop between the strategy, your adapter, and the evaluator:

```mermaid
sequenceDiagram
Expand Down
262 changes: 0 additions & 262 deletions docs/guides/authoring-tests.md
View file
Open in desktop

This file was deleted.

Loading
Loading