feat: Add support for TestContainers (pgsql + redis modules) #503
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 ReportAttention: Patch coverage is
... and 45 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
Add support for TestContainers to make it easy to set up independent test environments to allow running tests in parallel without risk of cross-contamination even if they touch the DB. TestContainers support is behind the `test-containers` flag. When the flag is enabled, the consumer can enable TestContainers for the DB and Sidekiq Redis in the `AppConfig`, in which case a TestContainer instance will be create when building the `AppContext`, and the URI in the `AppConfig` will be updated to match that of the TestContainer instance. Additionally, a new method was added to `AppConfig` to allow consumers to create it themselves. This would allow consumers more control over the config, including manually creating a TestContainer instance and updating the URI of a field in the `AppConfig` before loading the application. Finally, a new `app::init_state` method was added to allow getting access to a real `AppState` instance in tests. This method performs most of the setup of the app without actually running the app. This is similar but slightly different to the existing `app::prepare` method, and is intended to only be used in tests. Closes #500
spencewenski
force-pushed
the
test-containers
branch
from
c6520a2 to
67222c9
Compare
Merged
spencewenski
added a commit
that referenced
this pull request
Nov 13, 2024
## 🤖 New release * `roadster`: 0.6.16 -> 0.6.17 (✓ API compatible changes) <details><summary><i><b>Changelog</b></i></summary><p> <blockquote> ## [0.6.17](roadster-v0.6.16...roadster-v0.6.17) - 2024-11-12 ### Added - Add support for TestContainers (pgsql + redis modules) ([#503](#503)) ### Other - Update `thiserror` to 2.x ([#499](#499)) - Update `validator` crate ([#497](#497)) - Use justfile scripts for pre-commit/pre-push hooks ([#494](#494)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Spencer Ferris <[email protected]>
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.
Add support for TestContainers to make it easy to set up independent test environments to allow running tests in parallel without risk of cross-contamination even if they touch the DB.
TestContainers support is behind the
test-containersflag. When the flag is enabled, the consumer can enable TestContainers for the DB and Sidekiq Redis in theAppConfig, in which case a TestContainer instance will be create when building theAppContext, and the URI in theAppConfigwill be updated to match that of the TestContainer instance.Additionally, a new method was added to
AppConfigto allow consumers to create it themselves. This would allow consumers more control over the config, including manually creating a TestContainer instance and updating the URI of a field in theAppConfigbefore loading the application.Finally, a new
app::init_statemethod was added to allow getting access to a realAppStateinstance in tests. This method performs most of the setup of the app without actually running the app. This is similar but slightly different to the existingapp::preparemethod, and is intended to only be used in tests.Closes #500