Skip to content

Commit

Permalink
docs(integv2): add architecture diagram (#5072)
Browse files Browse the repository at this point in the history
  • Loading branch information
jmayclin authored Jan 31, 2025
1 parent d80e093 commit e593a5b
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions tests/integrationv2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,34 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
uv run pytest --provider-version <LINKED_LIBCRYPTO> --best-effort-NOT-FOR-CI -x -rpfs -n auto
```

## Architecture
```
┌────────────────────────────────────────────────────────────┐
│ │
│ Pytest Process │
│ Managed Managed │
│ Process (s2n) Process (Ossl) │
│ │ ▲ │ ▲ │
└─────┼───────┼─────────────────────────────┼────────┼───────┘
│ │ │ │
STDIN STDOUT STDIN STDOUT
│ │ │ │
│ │ │ │
┌──▼───────┼───┐ ┌──▼────────┼────┐
│ s2nc │◄────────TLS─────────►│ openssl server│
└──────────────┘ ▲ └────────────────┘
│ ▲
│ │
localhost/socket │
process
```
The integration test harness relies on client and server executables. It coordinates
these through stdin/stdout.

The above diagram shows an example setup with `s2nc` as the client and `openssl`
as the server. Note that these are just for the purpose of documentation, and the
actual integration tests run with a wide variety of executables.

## Run all tests

The fastest way to run the integrationv2 tests is to run `make` from the S2N root directory.
Expand Down

0 comments on commit e593a5b

Please sign in to comment.