break: disable reaper at config level #941
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It comes in the TC config
✅ Deploy Preview for testcontainers-go ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Kudos, SonarCloud Quality Gate passed!
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR removes the ability to skip the reaper for a container, delegating that reponsability to the entire execution: all containers or none.
For that, we had to cause a breaking change with the
NewDockerClientmethod, as it was returning too many things. Instead, we are removing from the return signature the Testcontainers configuration and the current Docker Host.To compensate that, we are exposing a
ReadConfigmethod that provides the same information, as the config properties file contains information about the host.As part of the refactor, we are initialising the config just once, using the
syncpackage, and displaying the existing reaper banner only at that time. This banner is a warning that is shown when the reaper is disabled.In this PR we are adding a GH workflow to run the tests without the reaper.
Why is it important?
First, it's about project organisation and code responsibility: obtaining a Docker client from TC was doing too many things, and now it's possible to extract that information with different methods.
Second, we are deprecating the usage of the
req.SkipReaperattribute from the container request struct, as we consider it weird to enable/diable the reaper per container, instead of per test execution, which is what this PR is proposing.Related issues