Add DoNotMockRecords to warn against mocking record data objects #4384
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.
Overview
Records are typically used as simple wrappers of data without any methods or complex behavior requiring external dependencies or expensive IO operations. As such, they should (almost) never be mocked, and instead a real instance should be used instead.
Details
The class hierarchy has changed from
to
This was because
AbstractMockChecker
assumed that only annotations would be used in determining that a class should not be mocked. The majority ofAbstractAnnotationMockChecker
is a straight lift and shift of the originalAbstractMockChecker
.Open Questions
ElementKind.RECORD
results in an IDE error in Intellij as it is annotated with@since 16
, suggesting that the language level of the module be changed. This does not cause issues with complilation, but as I am entirely new to projects that deal with the AST I am wondering if there is a better approach here.