refactor(warnings): rework MiscalledStubWarning checker for clarity #219
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.
#204 raised a couple questions about when Decoy chooses to emit errors and warnings, one of which is addressed by #218. The second question asks:
Currently, Decoy will not complain in this scenario. It will issue a
MiscalledStubWarning
if and only if the mock in question is used at least once withdecoy.when
, which acts as a marker for a test to say "I care about this dependency". This PR comes out of an investigation into the feasibility of enabling aMiscalledStubWarning
even if the mock is fully unconfigured. In the course of answering this question:Issuing a warning in this case forces every test using given subject to
decoy.when
ordecoy.verify
every single dependency the subject uses, even if a particular test isn't concerned with that behavior. In Decoy's own test suite this would trigger 8 warnings, and "fixing" those warnings would bloat the tests in question without providing meaningful design feedback