GUILD-619: Test helpers don't automatically reset to test config #120
Conversation
README.md
Outdated
| configure_deimos(consumers: { reraise_errors: false }, | ||
| producers: { topic_prefix: nil }, | ||
| db_producer: { compact_topics: %w(my-topic my-topic2) }, | ||
| logger: Rails.logger) |
There was a problem hiding this comment.
Nice, I like this a lot! I think there might be some other changes to the README that are necessary - e.g. we should be calling out things like the test producer and how to interact with it rather than assuming that when you include TestHelpers you get it for free.
There was a problem hiding this comment.
@dorner I tried my best to add more info but there might be some that I missed and/or added incorrect information. Please let me know!
README.md
Outdated
| @@ -935,6 +936,18 @@ expect(message).to eq({ | |||
| topic: 'my-topic', | |||
| key: 'my-id' | |||
| }) | |||
|
|
|||
| ## Configuring Deimos to test settings | |||
There was a problem hiding this comment.
So this shouldn't be in the code block with everything else because it likely won't be in the test itself. Also, the previous examples in this block will only work if the test producers are being used, so we should call that out and put this explanation before that block.
You can give an example of a spec_helper that does it:
# spec_helper.rb
RSpec.before(:each) do
configure_deimos
endActually, now that I write this, it would be even better if we can allow this method to take a block and reset the config back to what it was. Then you could use it like this:
RSpec.around(:each) do |ex|
configure_deimos({...}) do
ex.run
end...and we would be able to ensure that config didn't leak past examples, which is something that's bitten me multiple times. You can deep-dup the config and restore it after the block is run.
README.md
Outdated
|
|
||
| # Similarly you can use the Kafka test helper | ||
| around(:each) do |example| | ||
| Deimos::TestHelpers.kafka_test |
CHANGELOG.md
Outdated
| @@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) | |||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | |||
|
|
|||
| ## UNRELEASED | |||
| ### Roadmap :car: | |||
|
|
|||
| - TestHelper does not automatically reset Deimos config before each test. [#120](https://github.com/flipp-oss/deimos/pull/120) | |||
There was a problem hiding this comment.
Should call out in bold that this is a breaking change.
README.md
Outdated
|
|
||
| # Kakfa test helper using schema registry | ||
| around(:each) do |example| | ||
| Deimos::TestHelpers.kafka_schema_registry_test! |
There was a problem hiding this comment.
Maybe call this full_integration_test?
Description
Fixes https://flippit.atlassian.net/browse/GUILD-619
Type of change
How Has This Been Tested?
Tested by calling this function in existing specs locally.
Checklist: