Fix RSpec #log_deprecation matcher error when #log_deprecation uses :key #3781
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?
#3675 added a limit feature to
log_deprecation
. However, leveraging this feature (by passingkey:
as an arg) will cause the use of thelog_deprecation
RSpec matcher to fail, because it explicitly expectsno_args
. This bug has no effect on production, only our test suite.This feature loosens this constraint, allowing use of
key
args withlog_deprecation
and corresponding RSpec matcher.Additional Notes:
This will also need to be backported to 1.x.
It would also be nice to augment the
log_deprecation
matcher to more explicitly handle the presence of akey
arg in a way that tests the limitation set in place, akaexpect { set_service_name }.to log_deprecation(include('service name')).with_limit(key: :deprecation_conf_service_name)
. However, this may not be an insignificant effort, and is out of scope for my efforts right now.