Update the "Shadows" page #311
Merged
Conversation
This file contains 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
This PR updates the [Shadows](https://robolectric.org/extending/) page. This continues the work I've done on other pages: - Adding Kotlin code samples. - Adding links to other Robolectric pages and the Android documentation. - Removing outdated sections.
MGaetan89
commented
Sep 21, 2024
Comment on lines
+5
to
+7
| 1. Android native code cannot execute on your development machine. | ||
| 2. There are no Android system services running on your development machine. | ||
| 3. Android includes next to no APIs suitable for testing. |
There was a problem hiding this comment.
I've removed the leading texts since they didn't seem to bring any value.
|
|
||
| ### Using a Custom Shadows | ||
|
|
||
| Custom Shadows get hooked up to Robolectric using the `@Config` annotation on the test class or test method, using the `shadows` array attribute. To use the `MyShadowBitmap` class mentioned in the previous section, you would annotate the test in question with `@Config(shadows={MyShadowBitmap.class})`, and to include multiple custom shadows: `@Config(shadows={MyShadowBitmap.class, MyOtherCustomShadow.class})`. This causes Robolectric to recognize and use your custom shadow when executing code against the class you shadowed. | ||
| Custom Shadows get hooked up to Robolectric using the [`@Config`](javadoc/latest/org/robolectric/annotation/Config.html) annotation on the test class or test method, using the [`shadows`](javadoc/latest/org/robolectric/annotation/Config.html#shadows()) array attribute. To use the `MyShadowBitmap` class mentioned in the previous section, you would annotate the test in question with `@Config(shadows = { MyShadowBitmap.class })`. This causes Robolectric to recognize and use your custom shadow when executing code against the class you shadowed. |
There was a problem hiding this comment.
I've removed the example with multiple custom shadows, as it teaches more about Java syntax rather than Robolectric usage.
Comment on lines
-195
to
-196
| ### Don't use `useinheritImplementationMethods` | ||
| This is usually unnecessary and will be removed in [Robolectric 3.8](https://github.com/robolectric/robolectric/releases/tag/robolectric-3.8) |
There was a problem hiding this comment.
useinheritImplementationMethods doesn't seem to exist anymore (as documented), and Robolectric 3.8 is a rather old version now. So I've removed that section.
utzcoz
approved these changes
Sep 21, 2024
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.
This PR updates the Shadows page.
This continues the work I've done on other pages: