Clarify @DoNotMock error message in ClassInstrumentor
#9000
Conversation
This file contains hidden or 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
Robolectric's ClassInstrumentor adds a @DoNotMock annotation to Android classes that originally contained the 'final' modifier. The warning message always suggested to create or enhance a Shadow for the Android class being instrumented. However, there are cases when it is preferable to create a Builder, such as when the class is a pure Java data class. Update the `@DoNotMock` message to include this nuance. Note that this @DoNotMock annotation is purely informative and requires special infrastructure to enforce, so it's not on by default for Gradle/third-party projects. PiperOrigin-RevId: 625720769
262e013 to
f8bbdb1
Compare
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.
Clarify
@DoNotMockerror message in ClassInstrumentorRobolectric's ClassInstrumentor adds a @DoNotMock annotation to Android classes
that originally contained the 'final' modifier.
The warning message always suggested to create or enhance a Shadow for the
Android class being instrumented. However, there are cases when it is
preferable to create a Builder, such as when the class is a pure Java data
class.
Update the
@DoNotMockmessage to include this nuance.Note that this @DoNotMock annotation is purely informative and requires special
infrastructure to enforce, so it's not on by default for Gradle/third-party
projects.