Skip to content

docs(esdk): add the test-server local-development README #19

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
kessplas merged 4 commits into from
Sep 16, 2026
Merged

docs(esdk): add the test-server local-development README #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8eaa8de
docs(esdk): add the test-server local-development README
kessplas Sep 15, 2026
655c9f5
docs(esdk): split the test-server README into library- and TestServer…
kessplas Sep 16, 2026
60684aa
docs(esdk): list the Smithy CLI and per-language toolchains as prereq…
kessplas Sep 16, 2026
85df914
docs(esdk): add a concise top-level README; move guides under docs/
kessplas Sep 16, 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
20 changes: 20 additions & 0 deletions esdk/test-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# ESDK TestServer

The ESDK TestServer is a cross-language compatibility harness for the AWS
Encryption SDK. A single Smithy model defines the client under test and a single
suite of integration Tests is written once and run against every language
implementation: the Orchestrator resolves and builds each language's Server from
its repository, launches them, and drives the same Tests over all of them. One
test case therefore checks that every ESDK language behaves identically, and a
new implementation can adopt the entire existing test suite as soon as its
Server exists.

The shared pieces — the model, the Tests, the Orchestrator, and the canonical
Configuration — live here in `aws-crypto-tools-commons`; each language's Server
lives in that language's own repository and is pulled in by the Orchestrator.
The supported servers (languages, major versions, and where each is resolved
from) are defined in [`config/server-config.json`](config/server-config.json).
To build and run the TestServer locally, see
[docs/LOCAL_DEVELOPMENT.md](docs/LOCAL_DEVELOPMENT.md); for the design of the
Configuration — the Server, Feature, and Bug config and how the Orchestrator
resolves sources — see [docs/CONFIG_DESIGN.md](docs/CONFIG_DESIGN.md).
Loading
Loading