search

apter-tech / junit5-robolectric-extension

This repository aims to bridge the gap between JUnit 5 and Robolectric, enabling developers to leverage the benefits of both frameworks for unit testing Android applications. While Robolectric currently lacks a dedicated JUnit 5 extension, this project proposes a community-driven solution to achieve seamless integration.
Apache License 2.0
49 stars 2 forks source link

test: Add tests for the gradle plugin #40

Closed warnyul closed 6 months ago

warnyul commented 6 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent updates enhance the Robolectric JUnit Jupiter Gradle Plugin by refining its testing capabilities and configuration management. Key changes include the introduction of JUnit Platform support, dependency management adjustments, and methodological refinements in plugin configuration. These improvements aim to streamline testing processes and enhance the plugin's integration with Android and Kotlin environments.

Changes

File Path Changes Summary
.../build.gradle Added test configurations and dependencies for JUnit 5, Kotlin, and Android Gradle.
.../RobolectricJUnitJupiterGradlePlugin.kt and .../RobolectricJUnitJupiterGradlePluginExtension.kt Updated property access and refactored test task setup; transformed a class into an interface with property management.
.../RobolectricJUnitJupiterGradlePluginTest.kt Enhanced testing with new functions and scenarios to ensure plugin functionality across different project types.

Poem

🐰✨ In the burrow of code, where the digital hops, A plugin was polished with not a flop. JUnit and Kotlin, together they bind, In tests they trust, leaving no bug behind. Cheers to the devs, with each line they craft, In the realm of builds, they've mastered the art. 🌟 🐰💻

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between e8b693f572150d2e28611422923906c1525fcda2 and 87eda38f4236f53f8719e5106209b086bc026d7c.
Files selected for processing (4) * robolectric-extension-gradle-plugin/build.gradle (1 hunks) * robolectric-extension-gradle-plugin/src/main/kotlin/tech/apter/robolectric/junit/jupiter/gradle/plugin/RobolectricJUnitJupiterGradlePlugin.kt (2 hunks) * robolectric-extension-gradle-plugin/src/main/kotlin/tech/apter/robolectric/junit/jupiter/gradle/plugin/RobolectricJUnitJupiterGradlePluginExtension.kt (1 hunks) * robolectric-extension-gradle-plugin/src/test/kotlin/tech/apter/robolectric/junit/jupiter/gradle/plugin/RobolectricJUnitJupiterGradlePluginTest.kt (1 hunks)
Additional comments not posted (11)
robolectric-extension-gradle-plugin/src/main/kotlin/tech/apter/robolectric/junit/jupiter/gradle/plugin/RobolectricJUnitJupiterGradlePluginExtension.kt (1)
`6-8`: Conversion to interface and use of `Property` for `doNotAddDependencies` aligns well with Gradle's configuration avoidance APIs.
robolectric-extension-gradle-plugin/src/main/kotlin/tech/apter/robolectric/junit/jupiter/gradle/plugin/RobolectricJUnitJupiterGradlePlugin.kt (3)
`21-21`: Proper use of `doNotAddDependencies.get()` ensures dependencies are conditionally added based on the property's value. --- `30-33`: Setting a default value for `doNotAddDependencies` during extension registration is a good practice for maintainability and clarity. --- `46-52`: Method `prepareForRobolectric` correctly sets up test tasks with necessary configurations for JUnit 5 integration.
robolectric-extension-gradle-plugin/build.gradle (2)
`29-31`: Correct configuration of JUnit Platform within the `test` block to enable JUnit 5 testing. --- `38-43`: Dependencies added are appropriate for enhancing testing capabilities with JUnit 5, Kotlin, and Android Gradle.
robolectric-extension-gradle-plugin/src/test/kotlin/tech/apter/robolectric/junit/jupiter/gradle/plugin/RobolectricJUnitJupiterGradlePluginTest.kt (5)
`20-40`: Test function correctly verifies the enabling of JUnit Platform and setting of launcher interceptors, ensuring proper integration with JUnit 5. --- `43-55`: Test function effectively verifies the inclusion of Android resources when the plugin is applied to an Android project. --- `58-78`: Test functions correctly verify the conditional addition of dependencies based on the `doNotAddDependencies` flag. --- `81-131`: Test functions correctly verify the conditional addition of dependencies based on the `doNotAddDependencies` flag. --- `134-140`: Method `triggerEvaluate` appropriately handles project evaluation and exceptions, facilitating effective testing of plugin configurations.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 6 months ago

Branch Coverage

File Coverage [83.33%] :white_check_mark:
robolectric-extension-gradle-plugin/src/main/kotlin/tech/apter/robolectric/junit/jupiter/gradle/plugin/RobolectricJUnitJupiterGradlePlugin.kt 83.33% :white_check_mark:
Total Project Coverage 65.46% :white_check_mark:
github-actions[bot] commented 6 months ago

Line Coverage

File Coverage [96.97%] :white_check_mark:
robolectric-extension-gradle-plugin/src/main/kotlin/tech/apter/robolectric/junit/jupiter/gradle/plugin/RobolectricJUnitJupiterGradlePlugin.kt 96.97% :white_check_mark:
Total Project Coverage 82.70% :white_check_mark: