feat(termination)!: make container termination timeout configurable #2926

moogacs · 2024-12-19T23:24:35Z

What does this PR do?

extend Terminate() method with optional configuration for timeout configuration.
moved the terminationOptions under container to give the ability to make timeout, etc configurable via a functional option.
moved cleaning up under Terminate() function.

Why is it important?

Terminate() became broken with latest release version with latest release 0.34.0 Terminate() require handle for errors "is already in progress"
this is CleanupContainer method signature and to use it in down streams that will require many refactors because it expects testing.TB

func CleanupContainer(tb testing.TB, ctr Container, options ...TerminateOption) {

so with this change it will give the ability to configure the timeout and move the cleanup logic under termination

Related issues

Closes [Bug]: response from daemon: removal of container x is already in progress on calling Terminate() #2917

a unit test added and shall be tested with all the existed pipelines

netlify · 2024-12-19T23:24:54Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`4ccbbb1`
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/6776554a1ca1b00008abe737
😎 Deploy Preview	https://deploy-preview-2926--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.

container.go

stevenh

Thanks for PR, seems like a good idea, unfortunately this approach doesn't work with an interface design, see comments for details.

cleanup.go

docker.go

stevenh

Thanks for fleshing out what this looks like, I've done a review on how it stands and will discuss with @mdelapenya in the new year the pros and cons of functional options vs require args.

modules/etcd/etcd.go

docker.go

docker_test.go

moogacs · 2024-12-23T11:49:57Z

@stevenh thanks for feedback, i have address the comments. looking forward, Happy new year 😊

stevenh

Sorry to be a pain, but looking at what you've done with this, we should actually make the fields private with methods to avoid any ambiguity as to their use by other types, see suggestion in cleanup.go.

docker.go

docker_test.go

docker.go

cleanup.go

stevenh

Thanks for the updates, just a few bits I've clarified from previous suggestions, to allow us to get this over the line.

cleanup.go

docker.go

…iner and introduce configuration test

stevenh

Sorry missed a bug in the last review

cleanup.go

stevenh

Thanks for all your work on this, looks good to me.

mdelapenya

I'm still on PTO, being back Jan 2nd, but had time between sweets and meals to take a quick look.

Just a few comments to be addressed, other than that, will approve once resolved.

Thank you both for your time and effort here

cleanup.go

docker_test.go

cleanup.go

docs/features/common_functional_options.md

mdelapenya

LGTM, approving it although I added two docs changes.

Will merge this PR right after they are addressed and the CI passes 🤞

Thank you for your work here 🙇

docs/features/garbage_collector.md

mdelapenya · 2025-01-02T08:59:58Z

Merged, thank you @moogacs and @stevenh for your time reviewing this PR

* main: chore(deps): bump sonarsource/sonarcloud-github-action (#2933) feat(termination)!: make container termination timeout configurable (#2926) chore(deps): bump slackapi/slack-github-action from 1.26.0 to 2.0.0 (#2934) chore(deps): bump github/codeql-action from 3.25.15 to 3.28.0 (#2932)

* main: (103 commits) feat(postgres): ssl for postgres (testcontainers#2473) feat(ollama): support calling the Ollama local process (testcontainers#2923) chore(deps): bump jinja2 from 3.1.4 to 3.1.5 (testcontainers#2935) chore(deps): bump sonarsource/sonarcloud-github-action (testcontainers#2933) feat(termination)!: make container termination timeout configurable (testcontainers#2926) chore(deps): bump slackapi/slack-github-action from 1.26.0 to 2.0.0 (testcontainers#2934) chore(deps): bump github/codeql-action from 3.25.15 to 3.28.0 (testcontainers#2932) feat(wait): log sub match callback (testcontainers#2929) fix: Handle nil value in CleanupNetwork (testcontainers#2928) fix: avoid double lock in DockerProvider.DaemonHost() (testcontainers#2900) feat!: build log writer for container request (testcontainers#2925) feat(gcloud)!: add support to seed data when using RunBigQueryContainer (testcontainers#2523) security(deps): bump golang.org/x/crypto from 0.28.0 to 0.31.0 (testcontainers#2916) chore(ci): add Github labels based on PR title (testcontainers#2914) chore(gha): Use official setup-docker-action (testcontainers#2913) chore(ci): enforce conventional commits syntax in PR titles (testcontainers#2911) feat(nats): WithConfigFile - pass a configuration file to nats server (testcontainers#2905) chore: enable implicit default logger only in testing with -v (testcontainers#2877) fix: container binds syntax (testcontainers#2899) refactor(cockroachdb): to use request driven options (testcontainers#2883) ...

ash2k · 2025-01-15T02:02:59Z

container.go

@@ -50,7 +50,7 @@ type Container interface {
 	Stop(context.Context, *time.Duration) error                                    // stop the container

 	// Terminate stops and removes the container and its image if it was built and not flagged as kept.
-	Terminate(ctx context.Context) error
+	Terminate(ctx context.Context, opts ...TerminateOption) error


Hm, I wonder why we need a separate parameter for the timeout when a context is already provided to Terminate()?

As a user, I expect this to work fine. Does this code not do what is expected?

ctx, _ := context.WithTimeout(context.Background(), time.Second*10) c.Terminate(ctx)

If a Duration value is needed (vs reacting to a channel close), ctx.Deadline() returns a deadline Time. It seems that there is no need for a new API.

moogacs marked this pull request as ready for review December 19, 2024 23:39

moogacs requested a review from a team as a code owner December 19, 2024 23:39

mdelapenya reviewed Dec 20, 2024

View reviewed changes

container.go Show resolved Hide resolved

mdelapenya added feature New functionality or new behaviors on the existing one breaking change Causing compatibility issues. labels Dec 20, 2024

moogacs changed the title ~~feat(termination): make container termination timeout configurable~~ feat(termination)!: make container termination timeout configurable Dec 20, 2024

mdelapenya mentioned this pull request Dec 20, 2024

feat(ollama): support calling the Ollama local process #2923

Merged

stevenh requested changes Dec 20, 2024

View reviewed changes

cleanup.go Outdated Show resolved Hide resolved

cleanup.go Show resolved Hide resolved

docker.go Outdated Show resolved Hide resolved

moogacs requested a review from stevenh December 21, 2024 16:02

stevenh requested changes Dec 23, 2024

View reviewed changes

stevenh requested changes Dec 24, 2024

View reviewed changes

docker.go Outdated Show resolved Hide resolved

docker_test.go Outdated Show resolved Hide resolved

docker.go Outdated Show resolved Hide resolved

docker.go Outdated Show resolved Hide resolved

docker.go Outdated Show resolved Hide resolved

cleanup.go Outdated Show resolved Hide resolved

moogacs requested a review from stevenh December 25, 2024 12:59

stevenh requested changes Dec 29, 2024

View reviewed changes

cleanup.go Outdated Show resolved Hide resolved

docker.go Outdated Show resolved Hide resolved

docker.go Outdated Show resolved Hide resolved

moogacs added 7 commits December 29, 2024 13:56

feat(termination): make container termination timeout configurable

8632a79

revert TerminateOption to terminateOptions, seperate from DockerConta…

ac8ce58

…iner and introduce configuration test

rename to defaultOptions and pass ctx

4cdb318

address comments

d994d55

resolve more suggestions

c38f36b

don't export terminateOptions

1377520

address more comments

6f16fa0

moogacs force-pushed the feat/cterminationTimeout branch from 12269a4 to 6f16fa0 Compare December 29, 2024 12:56

moogacs requested a review from stevenh December 29, 2024 12:56

stevenh requested changes Dec 29, 2024

View reviewed changes

cleanup.go Outdated Show resolved Hide resolved

cleanup.go Outdated Show resolved Hide resolved

avoid global default

6461173

moogacs requested a review from stevenh December 29, 2024 14:48

stevenh previously approved these changes Dec 29, 2024

View reviewed changes

stevenh requested a review from mdelapenya December 29, 2024 19:04

mdelapenya reviewed Dec 31, 2024

View reviewed changes

cleanup.go Outdated Show resolved Hide resolved

cleanup.go Outdated Show resolved Hide resolved

docker_test.go Show resolved Hide resolved

cleanup.go Show resolved Hide resolved

address more comments

ac27a52

moogacs dismissed stevenh’s stale review via ac27a52 December 31, 2024 12:20

add docs for new termination options

f4c786f

stevenh previously approved these changes Dec 31, 2024

View reviewed changes

mdelapenya reviewed Jan 2, 2025

View reviewed changes

docs/features/common_functional_options.md Outdated Show resolved Hide resolved

move docs to garbage_collector/#terminate-function

12a8722

moogacs dismissed stevenh’s stale review via 12a8722 January 2, 2025 07:25

moogacs requested a review from mdelapenya January 2, 2025 07:38

mdelapenya previously approved these changes Jan 2, 2025

View reviewed changes

docs/features/garbage_collector.md Outdated Show resolved Hide resolved

docs/features/garbage_collector.md Show resolved Hide resolved

resolve doc comments

f6d6fd2

moogacs dismissed mdelapenya’s stale review via f6d6fd2 January 2, 2025 08:01

moogacs requested a review from mdelapenya January 2, 2025 08:02

mdelapenya reviewed Jan 2, 2025

View reviewed changes

docs/features/garbage_collector.md Outdated Show resolved Hide resolved

docs: typo

4ccbbb1

mdelapenya approved these changes Jan 2, 2025

View reviewed changes

mdelapenya merged commit 6f718ee into testcontainers:main Jan 2, 2025
21 of 22 checks passed

ash2k reviewed Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(termination)!: make container termination timeout configurable #2926

feat(termination)!: make container termination timeout configurable #2926

moogacs commented Dec 19, 2024

netlify bot commented Dec 19, 2024 •

edited

Loading

stevenh left a comment

stevenh left a comment

moogacs commented Dec 23, 2024

stevenh left a comment •

edited

Loading

stevenh left a comment

stevenh left a comment

stevenh left a comment

mdelapenya left a comment

mdelapenya left a comment

mdelapenya commented Jan 2, 2025

ash2k Jan 15, 2025 •

edited

Loading

feat(termination)!: make container termination timeout configurable #2926

feat(termination)!: make container termination timeout configurable #2926

Conversation

moogacs commented Dec 19, 2024

What does this PR do?

Why is it important?

Related issues

netlify bot commented Dec 19, 2024 • edited Loading

✅ Deploy Preview for testcontainers-go ready!

stevenh left a comment

Choose a reason for hiding this comment

stevenh left a comment

Choose a reason for hiding this comment

moogacs commented Dec 23, 2024

stevenh left a comment • edited Loading

Choose a reason for hiding this comment

stevenh left a comment

Choose a reason for hiding this comment

stevenh left a comment

Choose a reason for hiding this comment

stevenh left a comment

Choose a reason for hiding this comment

mdelapenya left a comment

Choose a reason for hiding this comment

mdelapenya left a comment

Choose a reason for hiding this comment

mdelapenya commented Jan 2, 2025

ash2k Jan 15, 2025 • edited Loading

Choose a reason for hiding this comment

netlify bot commented Dec 19, 2024 •

edited

Loading

stevenh left a comment •

edited

Loading

ash2k Jan 15, 2025 •

edited

Loading