Skip to content

Update the architecture doc #63

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
oleg-nenashev merged 2 commits into from
Oct 29, 2025
Merged

Update the architecture doc #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24dec62
Update the architecture doc
oleg-nenashev Oct 25, 2025
bfbe8a7
Update docs/architecture/README.md
oleg-nenashev Oct 26, 2025
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
15 changes: 10 additions & 5 deletions docs/architecture/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,26 @@

![Testcontainers Native Build Process](./images/build-process.png)

### Stage 1. Testcontainers for C shared library
### Stage 1. Testcontainers for C Bridge library

The core `testcontainers-c` shared library is built with [Cgo](https://pkg.go.dev/cmd/cgo).
The core `testcontainers-bridge` shared library is built with [Cgo](https://pkg.go.dev/cmd/cgo).
For that the `-buildmode=c-shared` is used in the Golang builder,
and it also receives a customized header so that the types can be mapped between C and Golang.
For that, we also have to flatten the structure and to switch the reference-based build process to fixed Objects stored in the Golang namespace, and C API
We also have to flatten the structure and to switch the reference-based build process to fixed Objects stored in the Golang namespace, and C API
using unique object IDs.

### Stage 2. Language Bindings
### Stage 2. Testcontainers for C shared library

As _Cgo_ cannot produce fancy headers and structure, we have a manually created header file that wraps core functionality of `tescontainers-bridge`.
This provides a static library and header files that can be used natively in C/C++ development, or by language bindings.

### Stage 3. Language Bindings

Then, we build custom binding libraries, by using Testcontainers for C
as a static library that is bundled into the language specific libs.
This stage depends on the language and common practices there.

### Stage 3. Executable Code
### Stage 4. Executable Code

Well, you build it.
From the previous stages,
Expand Down