feat: add `WithReuseByName` for modifying Generic Container Requests #3064

jm96441n · 2025-03-28T15:26:16Z

What does this PR do?

This adds one functional options WithReuseByName

Why is it important?

When creating a GenericContainerRequest you can easily set these fields, but when using something like the postgres.Run function you cannot set these fields.

Related issues

Closes #2726

How to test this PR

Run the tests
You can use the following gist: https://gist.github.com/jm96441n/74b6fa9b621cdd0c8d6548a6d2abd6d0
- Clone down the gist
- run go mod tidy
- in one terminal window run watch -n 1 docker ps
- in one terminal window run go test ./..., the test will sleep for 10 seconds to see the container is reused)
- in the terminal running the watch command see only one container pg-test come up and then go away when ryuk cleans it up (alternatively you can just run docker ps repeatedly to see)

Added a test demonstrating how the Ollama container can be reused

GenericContainerRequest

netlify · 2025-03-28T15:26:34Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`c557cff`
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/680a449d5f536b00083a490d
😎 Deploy Preview	https://deploy-preview-3064--testcontainers-go.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mdelapenya · 2025-03-28T15:30:15Z

options.go

@@ -96,6 +96,25 @@ func WithHostPortAccess(ports ...int) CustomizeRequestOption {
 	}
 }

+// WithReuse will mark a container to be reused if it exists or create a new one if it doesn't.
+// It is used in conjunction with WithContainerName to ensure that the container is reused.
+func WithReuse() CustomizeRequestOption {


suggestion: given reuse needs a container name, wdyt if we pass the container name in here, to simplify the API?

I was debating that, I went with this because of how WithUsername and WithPassword in the postgres module are defined and wanted to keep it somewhat similar but I'm not super tied to the current implementation
https://pkg.go.dev/github.com/testcontainers/testcontainers-go/modules/postgres#WithUsername

went with your suggestion and simplified the API surface

Thanks! In general, we discourage the usage of container names. Actually, for reuse, we have an ongoing PR that improves the reusability conditions hashing the container request: if it did not change, reuse that container: #2768

For that reason I'd advocate against passing a single name, but for reuse, as a requirement, I consider they must go together

when #2768 lands would it make sense to remove the name are here entirely?

Let's rename the option to WithReuseByName to give us room when the other PR lands.

I'm doing it myself adding commits on top of yours

mdelapenya · 2025-03-31T12:57:52Z

@jm96441n I've added #3070 as a complementary PR to this one. You made me realise we are missing options that are needed at the modules side. Thanks for that!

I think this is good to go, will start a more in depth review asap.

* main: security(compose): upgrade github.com/docker/compose/v2 to fix security vulnerability (testcontainers#3095)

mdelapenya · 2025-04-11T10:28:10Z

@jm96441n we merged the PR with all the options, and took the chance to help you with this PR adding the docs for the new option added in here. I'd like you to add another test for the containers being actually reused, as we are including tests for the options, only. Could you please add it? 🙏

jm96441n · 2025-04-15T18:38:45Z

can do! will add it this week once I have some free time

* main: feat(postgres): add WithOrderedInitScripts for Postgres testcontainers (testcontainers#3121) feat(redis): add TLS support (testcontainers#3115) feat: add Docker Model Runner module (testcontainers#3106) feat: add toxiproxy module (testcontainers#3092) chore(ci): run core tests on Testcontainers Cloud (testcontainers#3117) deps(aerospike): replace core module in go.mod (testcontainers#3116) chore(deps): bump golang.org/x/net from 0.36.0 to 0.38.0 in /modules and /examples (testcontainers#3114) chore(ci): revert codeql improvements for CI resiliency (testcontainers#3112) docs(socat): add missing version marker for new options (testcontainers#3111)

stevenh

One tweak needed for the test and don't forget to change the details in the PR as its not WithReuse anymore and no WithContainerName either.

options_test.go

stevenh

LGTM

* main: chore(ci): close PR if it was sent from main (testcontainers#3123) feat: add `WithReuseByName` for modifying Generic Container Requests (testcontainers#3064) chore(deps): bump github/codeql-action from 3.28.15 to 3.28.16 (testcontainers#3120)

* main: (76 commits) chore(deps): bump mkdocs-include-markdown-plugin from 6.2.2 to 7.1.5 (testcontainers#3137) chore(deps): bump github.com/shirou/gopsutil/v4 from 4.25.1 to 4.25.4 (testcontainers#3133) chore(deps): bump github.com/docker/docker from 28.0.1+incompatible to 28.1.1+incompatible (testcontainers#3152) feat(memcached): add memcached module (testcontainers#3132) fix(etcd): single node etcd cluster access (testcontainers#3149) feat(valkey): add TLS support for Valkey (testcontainers#3131) fix(dockermodelrunner): wait for the model to be pulled (testcontainers#3125) fix(localstack): remove checksum before parsing version (testcontainers#3130) fix(dockermodelrunner): dependency with socat chore: prepare for next minor development cycle (0.38.0) chore: use new version (v0.37.0) in modules and examples fix: handle stopped containers more gracefully when reuse is enabled (testcontainers#3062) feat(gcloud): add option to run firestore in datastore mode (testcontainers#3009) feat: support for mounting images (testcontainers#3044) chore(ci): close PR if it was sent from main (testcontainers#3123) feat: add `WithReuseByName` for modifying Generic Container Requests (testcontainers#3064) chore(deps): bump github/codeql-action from 3.28.15 to 3.28.16 (testcontainers#3120) chore(deps): bump mkdocs-include-markdown-plugin from 6.2.2 to 7.1.5 (testcontainers#3119) chore(deps): bump github.com/magiconair/properties from 1.8.9 to 1.8.10 (testcontainers#3118) chore(ci): exclude more files for a full-blown build (testcontainers#3122) ...

* main: (302 commits) chore(deps): bump mkdocs-include-markdown-plugin from 6.2.2 to 7.1.5 (testcontainers#3137) chore(deps): bump github.com/shirou/gopsutil/v4 from 4.25.1 to 4.25.4 (testcontainers#3133) chore(deps): bump github.com/docker/docker from 28.0.1+incompatible to 28.1.1+incompatible (testcontainers#3152) feat(memcached): add memcached module (testcontainers#3132) fix(etcd): single node etcd cluster access (testcontainers#3149) feat(valkey): add TLS support for Valkey (testcontainers#3131) fix(dockermodelrunner): wait for the model to be pulled (testcontainers#3125) fix(localstack): remove checksum before parsing version (testcontainers#3130) fix(dockermodelrunner): dependency with socat chore: prepare for next minor development cycle (0.38.0) chore: use new version (v0.37.0) in modules and examples fix: handle stopped containers more gracefully when reuse is enabled (testcontainers#3062) feat(gcloud): add option to run firestore in datastore mode (testcontainers#3009) feat: support for mounting images (testcontainers#3044) chore(ci): close PR if it was sent from main (testcontainers#3123) feat: add `WithReuseByName` for modifying Generic Container Requests (testcontainers#3064) chore(deps): bump github/codeql-action from 3.28.15 to 3.28.16 (testcontainers#3120) chore(deps): bump mkdocs-include-markdown-plugin from 6.2.2 to 7.1.5 (testcontainers#3119) chore(deps): bump github.com/magiconair/properties from 1.8.9 to 1.8.10 (testcontainers#3118) chore(ci): exclude more files for a full-blown build (testcontainers#3122) ...

added WithReuse and WithContainerName functions for modifying the

3320c84

GenericContainerRequest

jm96441n requested a review from a team as a code owner March 28, 2025 15:26

mdelapenya reviewed Mar 28, 2025

View reviewed changes

jm96441n changed the title ~~feat: Add WithReuse and WithContainerName for modifying Generic Container Requests~~ feat: add WithReuse and WithContainerName for modifying Generic Container Requests Mar 28, 2025

Simplify API surface for WithReuse

72322ce

mdelapenya added 3 commits April 11, 2025 11:10

Merge branch 'main' into jmaguire/add-reuse-and-container-name-options

f2220ac

Merge branch 'main' into jmaguire/add-reuse-and-container-name-options

a4161ed

* main: security(compose): upgrade github.com/docker/compose/v2 to fix security vulnerability (testcontainers#3095)

docs: document new option

3f7d5cf

fix: lint

24b64c6

jm96441n and others added 4 commits April 15, 2025 14:38

Merge branch 'main' into jmaguire/add-reuse-and-container-name-options

37e1d08

chore: rename option to WithReuseByName

2921d3a

chore: add test for the new option

e6a8c20

stevenh requested changes Apr 24, 2025

View reviewed changes

options_test.go Outdated Show resolved Hide resolved

mdelapenya changed the title ~~feat: add WithReuse and WithContainerName for modifying Generic Container Requests~~ feat: add WithReuseByName for modifying Generic Container Requests Apr 24, 2025

chore: simplify test assertions

c557cff

mdelapenya requested a review from stevenh April 24, 2025 17:25

stevenh approved these changes Apr 24, 2025

View reviewed changes

mdelapenya merged commit 8a498b7 into testcontainers:main Apr 24, 2025
390 of 392 checks passed

mdelapenya mentioned this pull request Apr 24, 2025

feat(couchbase): adding auth to couchbase initCluster functions to support container reuse #3048

Merged

mdelapenya self-assigned this Apr 25, 2025

mdelapenya added the feature New functionality or new behaviors on the existing one label Apr 25, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add `WithReuseByName` for modifying Generic Container Requests #3064

feat: add `WithReuseByName` for modifying Generic Container Requests #3064

Uh oh!

jm96441n commented Mar 28, 2025 •

edited by mdelapenya

Loading

Uh oh!

netlify bot commented Mar 28, 2025 •

edited

Loading

Uh oh!

mdelapenya Mar 28, 2025

Uh oh!

jm96441n Mar 28, 2025

Uh oh!

jm96441n Mar 28, 2025

Uh oh!

mdelapenya Mar 28, 2025 •

edited

Loading

Uh oh!

jm96441n Mar 28, 2025

Uh oh!

mdelapenya Apr 24, 2025

Uh oh!

mdelapenya commented Mar 31, 2025

Uh oh!

mdelapenya commented Apr 11, 2025

Uh oh!

jm96441n commented Apr 15, 2025

Uh oh!

stevenh left a comment

Uh oh!

Uh oh!

stevenh left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

feat: add WithReuseByName for modifying Generic Container Requests #3064

feat: add WithReuseByName for modifying Generic Container Requests #3064

Uh oh!

Conversation

jm96441n commented Mar 28, 2025 • edited by mdelapenya Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Why is it important?

Related issues

How to test this PR

Uh oh!

netlify bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for testcontainers-go ready!

Uh oh!

mdelapenya Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

jm96441n Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

jm96441n Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

mdelapenya Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jm96441n Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

mdelapenya Apr 24, 2025

Choose a reason for hiding this comment

Uh oh!

mdelapenya commented Mar 31, 2025

Uh oh!

mdelapenya commented Apr 11, 2025

Uh oh!

jm96441n commented Apr 15, 2025

Uh oh!

stevenh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stevenh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

feat: add `WithReuseByName` for modifying Generic Container Requests #3064

feat: add `WithReuseByName` for modifying Generic Container Requests #3064

jm96441n commented Mar 28, 2025 •

edited by mdelapenya

Loading

netlify bot commented Mar 28, 2025 •

edited

Loading

mdelapenya Mar 28, 2025 •

edited

Loading