feat(compose): add ability to get docker compose config #669
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #669 +/- ##
=======================================
Coverage ? 78.29%
=======================================
Files ? 12
Lines ? 599
Branches ? 89
=======================================
Hits ? 469
Misses ? 104
Partials ? 26 ☔ View full report in Codecov by Sentry. |
|
im not sure i like the change to the public api so i marked as experimental and lets see where it goes. |
|
Fair enough, thanks for your review ;) |
alexanderankin
pushed a commit
that referenced
this pull request
Aug 14, 2024
🤖 I have created a release *beep* *boop* --- ## [4.8.0](testcontainers-v4.7.2...testcontainers-v4.8.0) (2024-08-14) ### Features * Adding support for Cassandra and Scylla ([#167](#167)) ([2d8bc11](2d8bc11)) * **compose:** ability to retain volumes when using context manager ([#659](#659)) ([e1e3d13](e1e3d13)) * **compose:** add ability to get docker compose config ([#669](#669)) ([8c28a86](8c28a86)) * **core:** add ability to do OR & AND for waitforlogs ([#661](#661)) ([b1453e8](b1453e8)) * **new:** Added AWS Lambda module ([#655](#655)) ([9161cb6](9161cb6)) * refactor network setup ([#678](#678)) ([d5de0aa](d5de0aa)) ### Bug Fixes * Add Db2 support ([#673](#673)) ([1e43923](1e43923)) * bring back cassandra driver bc otherwise how does it get installed for cassandra module test run? ([#680](#680)) ([71c3a1a](71c3a1a)) * **rabbitmq:** add `vhost` as parameter to RabbitMqContainer ([#656](#656)) ([fa2081a](fa2081a)) * **selenium:** add Arg/Options to api of selenium container ([#654](#654)) ([e02c1b3](e02c1b3)), closes [#652](#652) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
This PR add a new function to the
testcontainers.compose.DockerComposerclass,get_configwhich usedocker compose configcommand for resolving and returning the actual docker compose configuration.This can be useful for example if you want to retrieve a connection string you pass to your app in your docker compose in order to connect to your database service instead of copy pasting it from your compose file into your tests.
Also note thats its way easier to rely on docker compose config to get you the config than trying to manually find, read and merge compose files in specified context (I tried it first ...).
About the tests I mostly ensured the docker compose command was as expected. This is because the config produced by the docker compose can not always reflect exactly what is in the file. There is some normalization/resolving which is done (even when you pass all flags to disable them). But anyway, I'm not sure its a good idea to actually test the behavior of the docker config command itself.
Let me know what you think of it!