`ModuleHasDependency` problem with Dependency Versions

[MBoegers]

What version of OpenRewrite are you using?

Main branch

How are you running OpenRewrite?

via tests

Problem

When we run org.openrewrite.java.dependencies.search.ModuleHasDependency with a version we see wrong behavior in search results leading to not fulfilled preconditions in recipes.

Situation

• Dependencies 'org.springframework:spring-core:6.1.5' and 'org.springframework:spring-aop:6.2.2' defined, see below

We search for:

1. 'org.springframework:*:6.1.5' with new ModuleHasDependency("org.springframework", "*", null, 6.1.5, null)
2. 'org.springframework:*:5.1.5' with new ModuleHasDependency("org.springframework", "*", null, 5.1.5, null)

Expectation

1. both modules (Gradle and Maven) are marked to have the 'org.springframework:*:6.1.5' Dependency
2. no module is marked to have the 'org.springframework:*:6.1.5' Dependency

Observation

1. Maven finds nothing, gradle marks
2. Maven finds nothing, gradle marks

The problem is that ModuleHasDependency configures DependencyInsight incorrectly (switched scope and version).

rewrite-java-dependencies/src/main/java/org/openrewrite/java/dependencies/search/ModuleHasDependency.java

Line 96 in 98e26f5

Tree t = new DependencyInsight(groupIdPattern, artifactIdPattern, scope, version)

If we correct this we observe a different, wrong behavior. On maven the Recipe behaves correct, Gradle stops finding not exsiting versions but also finds nothing, except if configured using with a caret range.

Test files

pom.xml

<project>
  <groupId>com.example</groupId>
  <artifactId>foo</artifactId>
  <version>1.0.0</version>

  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>6.1.5</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-aop</artifactId>
      <version>6.2.2</version>
    </dependency>
  </dependencies>
</project>

build.gradle

plugins {
    id 'java-library'
}
repositories {
    mavenCentral()
}
dependencies {
    implementation 'org.springframework:spring-core:6.1.5'
    implementation 'org.springframework:spring-aop:6.2.2'
}

Note

See #150 for reproducing tests.

[MBoegers]

Complete test for ModuleHasDependency

class WithVersionsPattern {
    @ParameterizedTest
    @ValueSource(strings = {
      "6.1.5", // exact
      "6.1.1-6.1.15", // hyphenated
      "[6.1.1,6.1.6)", "[6.1.1,6.1.5]", "[6.1.5,6.1.15]", "(6.1.4,6.1.15]", // full range
      "6.1.X", // X range
      "~6.1.0", "~6.1", // tilde range
      "^6.1.0", // caret range
    })
    void maven(String versionPattern) {
        rewriteRun(
          recipeSpec -> recipeSpec.recipe(new ModuleHasDependency("org.springframework", "*", null, versionPattern, null)),
          mavenProject("project-maven",
            //language=xml
            pomXml(
              """
                <project>
                  <groupId>com.example</groupId>
                  <artifactId>foo</artifactId>
                  <version>1.0.0</version>

                  <dependencies>
                    <dependency>
                      <groupId>org.springframework</groupId>
                      <artifactId>spring-core</artifactId>
                      <version>6.1.5</version>
                    </dependency>
                    <dependency>
                      <groupId>org.springframework</groupId>
                      <artifactId>spring-aop</artifactId>
                      <version>6.2.2</version>
                    </dependency>
                  </dependencies>
                </project>
                """,
              """
                <!--~~(Module has dependency: org.springframework:*:%s)~~>--><project>
                  <groupId>com.example</groupId>
                  <artifactId>foo</artifactId>
                  <version>1.0.0</version>

                  <dependencies>
                    <dependency>
                      <groupId>org.springframework</groupId>
                      <artifactId>spring-core</artifactId>
                      <version>6.1.5</version>
                    </dependency>
                    <dependency>
                      <groupId>org.springframework</groupId>
                      <artifactId>spring-aop</artifactId>
                      <version>6.2.2</version>
                    </dependency>
                  </dependencies>
                </project>
                """.formatted(versionPattern)
            )
          )
        );
    }

    @ParameterizedTest
    @ValueSource(strings = {
      "6.1.5", // exact
      "6.1.1-6.1.15", // hyphenated
      "[6.1.1,6.1.6)", "[6.1.1,6.1.5]", "[6.1.5,6.1.15]", "(6.1.4,6.1.15]", // full range
      "6.1.X", // X range
      "~6.1.0", "~6.1", // tilde range
      "^6.1.0", // caret range
    })
    void gradle(String versionPattern) {
        rewriteRun(
          recipeSpec -> recipeSpec.recipe(new ModuleHasDependency("org.springframework", "*", null, versionPattern, null)),
          mavenProject("project-maven",
            //language=groovy
            buildGradle(
              """
                plugins {
                    id 'java-library'
                }
                repositories {
                    mavenCentral()
                }
                dependencies {
                    implementation 'org.springframework:spring-core:6.1.5'
                    implementation 'org.springframework:spring-aop:6.2.2'
                }
                """,
              """
                /*~~(Module has dependency: org.springframework:*:%s)~~>*/plugins {
                    id 'java-library'
                }
                repositories {
                    mavenCentral()
                }
                dependencies {
                    implementation 'org.springframework:spring-core:6.1.5'
                    implementation 'org.springframework:spring-aop:6.2.2'
                }
                """.formatted(versionPattern)
            )
          )
        );
    }

    @Test
    void noPresentVersion() {
        rewriteRun(
          recipeSpec -> recipeSpec.recipe(new ModuleHasDependency("org.springframework", "*", null, "5.1.2", null)),
          mavenProject("project-maven",
            //language=groovy
            buildGradle(
              """
                plugins {
                    id 'java-library'
                }
                repositories {
                    mavenCentral()
                }
                dependencies {
                    implementation 'org.springframework:spring-core:6.1.5'
                    implementation 'org.springframework:spring-aop:6.2.2'
                }
                """
            )
          )
        );
    }
}

[MBoegers]

If we proceed and dig deeper into DependencyInsight and its delegates org.openrewrite.gradle.search.DependencyInsight and org.openrewrite.maven.search.DependencyInsight we can reproduce this behavior, indicating that the org.openrewrite.gradle.search.DependencyInsight recipe seems to ignore versions.

test to prove

class VersionsPatterns {

    final String groupIdPattern = "org.springframework";
    final String artifactIdPattern = "*";
    final @Nullable String scope = null;

    @ParameterizedTest
    @ValueSource(strings = {
      "6.1.5", // exact
      "6.1.1-6.1.15", // hyphenated
      "[6.1.1,6.1.6)", "[6.1.1,6.1.5]", "[6.1.5,6.1.15]", "(6.1.4,6.1.15]", // full range
      "6.1.X", // X range
      "~6.1.0", "~6.1", // tilde range
      "^6.1.0", // caret range
    })
    void inPoms(String versionPattern) {
        rewriteRun(
          recipeSpec -> recipeSpec.recipe(new DependencyInsight(groupIdPattern, artifactIdPattern, versionPattern, scope)),
          //language=xml
          pomXml(
            """
              <project>
                <groupId>com.example</groupId>
                <artifactId>foo</artifactId>
                <version>1.0.0</version>

                <dependencies>
                  <dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-core</artifactId>
                    <version>6.1.5</version>
                  </dependency>
                  <dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-aop</artifactId>
                    <version>6.2.2</version>
                  </dependency>
                </dependencies>
              </project>
              """,
            """
              <project>
                <groupId>com.example</groupId>
                <artifactId>foo</artifactId>
                <version>1.0.0</version>

                <dependencies>
                  <!--~~>--><dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-core</artifactId>
                    <version>6.1.5</version>
                  </dependency>
                  <dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-aop</artifactId>
                    <version>6.2.2</version>
                  </dependency>
                </dependencies>
              </project>
              """
          )
        );
    }

    @ParameterizedTest
    @ValueSource(strings = {
      "6.1.5", // exact
      "6.1.1-6.1.15", // hyphenated
      "[6.1.1,6.1.6)", "[6.1.1,6.1.5]", "[6.1.5,6.1.15]", "(6.1.4,6.1.15]", // full range
      "6.1.X", // X range
      "~6.1.0", "~6.1", // tilde range
      "^6.1.0", // caret range
    })
    void directToMaven(String versionPattern) {
        rewriteRun(
          recipeSpec -> recipeSpec.recipe(new org.openrewrite.maven.search.DependencyInsight(groupIdPattern, artifactIdPattern, scope, versionPattern, false)),
          //language=xml
          pomXml(
            """
              <project>
                <groupId>com.example</groupId>
                <artifactId>foo</artifactId>
                <version>1.0.0</version>

                <dependencies>
                  <dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-core</artifactId>
                    <version>6.1.5</version>
                  </dependency>
                  <dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-aop</artifactId>
                    <version>6.2.2</version>
                  </dependency>
                </dependencies>
              </project>
              """,
            """
              <project>
                <groupId>com.example</groupId>
                <artifactId>foo</artifactId>
                <version>1.0.0</version>

                <dependencies>
                  <!--~~>--><dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-core</artifactId>
                    <version>6.1.5</version>
                  </dependency>
                  <dependency>
                    <groupId>org.springframework</groupId>
                    <artifactId>spring-aop</artifactId>
                    <version>6.2.2</version>
                  </dependency>
                </dependencies>
              </project>
              """
          )
        );
    }

    @ParameterizedTest
    @ValueSource(strings = {
      "6.1.5", // exact
      "6.1.1-6.1.15", // hyphenated
      "[6.1.1,6.1.6)", "[6.1.1,6.1.5]", "[6.1.5,6.1.15]", "(6.1.4,6.1.15]", // full range
      "6.1.X", // X range
      "~6.1.0", "~6.1", // tilde range
      "^6.1.0", // caret range
    })
    void inBuildGradle(String versionPattern) {
        rewriteRun(
          recipeSpec -> recipeSpec.recipe(new DependencyInsight(groupIdPattern, artifactIdPattern, versionPattern, scope)),
          //language=groovy
          buildGradle(
            """
              plugins {
                  id 'java-library'
              }
              repositories {
                  mavenCentral()
              }
              dependencies {
                  implementation 'org.springframework:spring-core:6.1.5'
                  implementation 'org.springframework:spring-aop:6.2.2'
              }
              """,
            """
              /*~~(Module has dependency: org.springframework:*:%s)~~>*/plugins {
                  id 'java-library'
              }
              repositories {
                  mavenCentral()
              }
              dependencies {
                  implementation 'org.springframework:spring-core:6.1.5'
                  implementation 'org.springframework:spring-aop:6.2.2'
              }
              """.formatted(versionPattern)
          )
        );
    }

    @ParameterizedTest
    @ValueSource(strings = {
      "6.1.5", // exact
      "6.1.1-6.1.15", // hyphenated
      "[6.1.1,6.1.6)", "[6.1.1,6.1.5]", "[6.1.5,6.1.15]", "(6.1.4,6.1.15]", // full range
      "6.1.X", // X range
      "~6.1.0", "~6.1", // tilde range
      "^6.1.0", // caret range
    })
    void directGradle(String versionPattern) {
        rewriteRun(
          recipeSpec -> recipeSpec.recipe(new org.openrewrite.gradle.search.DependencyInsight(groupIdPattern, artifactIdPattern, versionPattern, null)),
          //language=groovy
          buildGradle(
            """
              plugins {
                  id 'java-library'
              }
              repositories {
                  mavenCentral()
              }
              dependencies {
                  implementation 'org.springframework:spring-core:6.1.5'
                  implementation 'org.springframework:spring-aop:6.2.2'
              }
              """,
            """
              /*~~(Module has dependency: org.springframework:*:%s)~~>*/plugins {
                  id 'java-library'
              }
              repositories {
                  mavenCentral()
              }
              dependencies {
                  implementation 'org.springframework:spring-core:6.1.5'
                  implementation 'org.springframework:spring-aop:6.2.2'
              }
              """.formatted(versionPattern)
          )
        );
    }
}