Adding recipe for `DoesNotIncludeDependency` for Gradle (Maven had one already), to allow for checking whether a dependency is not included. #5725

steve-aom-elliott · 2025-07-07T21:21:48Z

What's changed?

Added recipe to check that a dependency is not included in Gradle

What's your motivation?

I have a need for being able to detect that a dependency is not included to decide whether to proceed with additional migrations or not. Maven already had a version of this, but Gradle was missing one, and I want to be thorough in this precondition check.

I have not written tests for this quite yet. All of the tests for the Maven version appear to be commented out for some reason, though I do want to add a couple of examples in tests still.

One thing to point out is that it does not include the same directOnly option as the Maven version, as the way the implementations of DependencyInsight is processing dependencies between Maven and Gradle is slightly different, and that class does not take the option in the Gradle version.

Checklist

I've added unit tests to cover both positive and negative cases
I've read and applied the recipe conventions and best practices
I've used the IntelliJ IDEA auto-formatter on affected files

rewrite-gradle/src/main/java/org/openrewrite/gradle/search/DoesNotIncludeDependency.java

…OM or build.gradle have a dependency on `org.testng:testng`. Relies on openrewrite/rewrite#5725

rewrite-gradle/src/main/java/org/openrewrite/gradle/search/DoesNotIncludeDependency.java

steve-aom-elliott · 2025-07-08T21:33:17Z

Still working on the tests to include ones for specific configurations and transitive dependencies, but getting closer.

rewrite-gradle/src/test/java/org/openrewrite/gradle/search/DoesNotIncludeDependencyTest.java

rewrite-maven/src/test/java/org/openrewrite/maven/search/DoesNotIncludeDependencyTest.java

timtebeek · 2025-07-11T10:51:04Z

rewrite-gradle/src/test/java/org/openrewrite/gradle/search/DependencyInsightTest.java

+        }
+
+        @ParameterizedTest
+        @MethodSource("configurationsAndMatches")


Would something like this help readability perhaps? Took me 20 seconds with Claude, so don't go changing things manually:

@CsvSource( useHeadersInDisplayName = true, textBlock = """ configuration, annotationProcessor, api, implementation, compileOnly, runtimeOnly, testImplementation, testCompileOnly, testRuntimeOnly annotationProcessor, true, false, false, false, false, false, false, false compileClasspath, false, true, true, true, false, false, false, false runtimeClasspath, false, true, true, false, true, false, false, false testCompileClasspath, false, true, true, false, false, true, true, false testRuntimeClasspath, false, true, true, false, true, true, false, true """)

Honestly I've never used the @CsvSource with textBlock before, but yeah, something like that would also work.

timtebeek · 2025-07-11T11:02:25Z

rewrite-maven/src/test/java/org/openrewrite/maven/search/DoesNotIncludeDependencyTest.java

+            @CsvSource({"compile,compile", "compile,test"})
+            @CsvSource({"runtime,compile", "runtime,test",})
+            @CsvSource({"test,test"})


I was a bit surprised by the repeated annotation here; is there a logic to the grouping that I'm missing? Might a textBlock make sense?

I was grouping them by the existing scope of the dependency per row. It was more for my own legibility than anything else.

rewrite-maven/src/test/java/org/openrewrite/maven/search/DoesNotIncludeDependencyTest.java

rewrite-gradle/src/main/java/org/openrewrite/gradle/search/DoesNotIncludeDependency.java

timtebeek · 2025-07-11T11:31:56Z

Mostly looks good already; couple questions & comments, but nothing blocking. Once addressed we can merge.

…e already), to allow for checking whether a dependency is not included.

…sNotIncludeDependency.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

…pendencyInsight` to showcase passing `configuration`. Adding `DoesNotIncludeDependency` tests (still need to add more).

…sts to match naming convention of the Maven version's tests.

… Maven version. I still want to change it a bit so that the test body can be shared for situations that behave the same (like `onlyDirect` has not effect when there is a direct dependency present, so all those tests are the same for whether it's `null`, `true` or `false` for that)

steve-aom-elliott · 2025-07-11T16:17:13Z

I think the only things I didn't end up changing right now were the suggestions for using @CsvSource with a textBlock, but please feel free to use Claude to convert those if they seem more legible afterwards.

rewrite-maven/src/test/java/org/openrewrite/maven/search/DoesNotIncludeDependencyTest.java

timtebeek

Approved already. Thanks for the help here!

…OM or build.gradle have a dependency on `org.testng:testng`. Relies on openrewrite/rewrite#5725

…OM or build.gradle have a dependency on `org.testng:testng`. (#760) * Adding dependency guards to the Junit 4 -> 5 migration for when the POM or build.gradle have a dependency on `org.testng:testng`. Relies on openrewrite/rewrite#5725 * Updating `DoesNotIncludeDependency` recipe call to be the shared one in `rewrite-java-dependencies` * Avoid tests passing for the wrong reason (class present) * Only pass testng dependency into the single test that needs it * Match any testng dependency * Adding TestNgGuard scanning recipe. Needs refinement, but this is a first pass * Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Making separate `TestNgGuard` tests and cleaning up other code * Cleanup of import Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Made the `TestNgGuard` more flexible for situations where there isn't an enclosing project for a source file, which was a majority of our existing tests. - If it figures out it's a loose file not in a `JavaProject`, it can't ensure project scope anyway, so falls back to solely whether the file itself has a TestNG dependency or uses TestNG types instead for those * Do not use getters internally * Adopt `ModuleHasDependency` and drop odd test: only look at dependencies Assuming classes can not be present without those dependencies * Revert change to `TestNgToAssertJTest` * Drop tests that were showing improbable use of types * Switching to using the new `invertMarking` option on `ModuleHasDependency` for the TestNG guard for JUnit --------- Co-authored-by: Tim te Beek <tim@moderne.io> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

steve-aom-elliott self-assigned this Jul 7, 2025

steve-aom-elliott added the enhancement New feature or request label Jul 7, 2025

steve-aom-elliott added this to OpenRewrite Jul 7, 2025

steve-aom-elliott added recipe Requested Recipe gradle labels Jul 7, 2025

github-project-automation bot moved this to In Progress in OpenRewrite Jul 7, 2025

github-actions bot reviewed Jul 7, 2025

View reviewed changes

rewrite-gradle/src/main/java/org/openrewrite/gradle/search/DoesNotIncludeDependency.java Show resolved Hide resolved

steve-aom-elliott mentioned this pull request Jul 7, 2025

Adding dependency guards to the Junit 4 -> 5 migration for when the POM or build.gradle have a dependency on org.testng:testng. openrewrite/rewrite-testing-frameworks#760

Merged

3 tasks

Laurens-W reviewed Jul 8, 2025

View reviewed changes

rewrite-gradle/src/main/java/org/openrewrite/gradle/search/DoesNotIncludeDependency.java Outdated Show resolved Hide resolved

Laurens-W reviewed Jul 8, 2025

View reviewed changes

rewrite-gradle/src/main/java/org/openrewrite/gradle/search/DoesNotIncludeDependency.java Outdated Show resolved Hide resolved

steve-aom-elliott force-pushed the does-not-include-dependency-gradle branch 2 times, most recently from 26793b8 to b4fbdb2 Compare July 8, 2025 21:31

github-actions bot reviewed Jul 8, 2025

View reviewed changes

rewrite-gradle/src/test/java/org/openrewrite/gradle/search/DoesNotIncludeDependencyTest.java Outdated Show resolved Hide resolved

steve-aom-elliott force-pushed the does-not-include-dependency-gradle branch from b4fbdb2 to 0c0443a Compare July 10, 2025 19:45

github-actions bot reviewed Jul 10, 2025

View reviewed changes

rewrite-gradle/src/test/java/org/openrewrite/gradle/search/DoesNotIncludeDependencyTest.java Outdated Show resolved Hide resolved

steve-aom-elliott moved this from In Progress to Ready to Review in OpenRewrite Jul 10, 2025

steve-aom-elliott marked this pull request as ready for review July 10, 2025 19:55

github-actions bot reviewed Jul 10, 2025

View reviewed changes

rewrite-maven/src/test/java/org/openrewrite/maven/search/DoesNotIncludeDependencyTest.java Show resolved Hide resolved

timtebeek self-requested a review July 11, 2025 10:42

timtebeek reviewed Jul 11, 2025

View reviewed changes

rewrite-maven/src/test/java/org/openrewrite/maven/search/DoesNotIncludeDependencyTest.java Outdated Show resolved Hide resolved

timtebeek reviewed Jul 11, 2025

View reviewed changes

rewrite-gradle/src/main/java/org/openrewrite/gradle/search/DoesNotIncludeDependency.java Outdated Show resolved Hide resolved

steve-aom-elliott and others added 4 commits July 11, 2025 12:13

Adding recipe for DoesNotIncludeDependency for Gradle (Maven had on…

aa8058a

…e already), to allow for checking whether a dependency is not included.

Update rewrite-gradle/src/main/java/org/openrewrite/gradle/search/Doe…

06378d7

…sNotIncludeDependency.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Renaming properties to match DependencyInsight. Adding tests to `De…

58a1675

…pendencyInsight` to showcase passing `configuration`. Adding `DoesNotIncludeDependency` tests (still need to add more).

Adding remaining tests for DoesNotIncludeDependency and renaming te…

fb03857

…sts to match naming convention of the Maven version's tests.

steve-aom-elliott added 6 commits July 11, 2025 12:13

Newline at end of file

1aa95df

Reorganizing tests for the Gradle versoin

d5dfe4d

Small fix for test case.

c22ad8a

Formatting

616f4c5

Updates based on PR comments

a69aeb7

steve-aom-elliott force-pushed the does-not-include-dependency-gradle branch from e45bea1 to a69aeb7 Compare July 11, 2025 16:13

github-actions bot reviewed Jul 11, 2025

View reviewed changes

rewrite-maven/src/test/java/org/openrewrite/maven/search/DoesNotIncludeDependencyTest.java Outdated Show resolved Hide resolved

Formatting

8a97d80

timtebeek approved these changes Jul 12, 2025

View reviewed changes

steve-aom-elliott merged commit 2065d3e into main Jul 14, 2025
2 checks passed

steve-aom-elliott deleted the does-not-include-dependency-gradle branch July 14, 2025 13:25

github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Jul 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adding recipe for `DoesNotIncludeDependency` for Gradle (Maven had one already), to allow for checking whether a dependency is not included. #5725

Adding recipe for `DoesNotIncludeDependency` for Gradle (Maven had one already), to allow for checking whether a dependency is not included. #5725

Uh oh!

steve-aom-elliott commented Jul 7, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

steve-aom-elliott commented Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timtebeek Jul 11, 2025

Uh oh!

steve-aom-elliott Jul 11, 2025

Uh oh!

timtebeek Jul 11, 2025

Uh oh!

steve-aom-elliott Jul 11, 2025

Uh oh!

Uh oh!

Uh oh!

timtebeek commented Jul 11, 2025

Uh oh!

steve-aom-elliott commented Jul 11, 2025

Uh oh!

Uh oh!

timtebeek left a comment

Uh oh!

Uh oh!

Uh oh!

Adding recipe for DoesNotIncludeDependency for Gradle (Maven had one already), to allow for checking whether a dependency is not included. #5725

Adding recipe for DoesNotIncludeDependency for Gradle (Maven had one already), to allow for checking whether a dependency is not included. #5725

Uh oh!

Conversation

steve-aom-elliott commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What's changed?

What's your motivation?

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

steve-aom-elliott commented Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

timtebeek Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

steve-aom-elliott Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

timtebeek Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

steve-aom-elliott Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

timtebeek commented Jul 11, 2025

Uh oh!

steve-aom-elliott commented Jul 11, 2025

Uh oh!

Uh oh!

timtebeek left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Adding recipe for `DoesNotIncludeDependency` for Gradle (Maven had one already), to allow for checking whether a dependency is not included. #5725

Adding recipe for `DoesNotIncludeDependency` for Gradle (Maven had one already), to allow for checking whether a dependency is not included. #5725

steve-aom-elliott commented Jul 7, 2025 •

edited

Loading