Gradle: fix IllegalStateException when resolving project deps

snazy · gsmet · commit d291b4e8839f · 2024-02-13T21:30:06.000+01:00
Fixes a regression from #37938 (cherry picked from commit 9a86f02)
diff --git a/devtools/gradle/gradle-model/src/main/java/io/quarkus/gradle/tooling/ToolingUtils.java b/devtools/gradle/gradle-model/src/main/java/io/quarkus/gradle/tooling/ToolingUtils.java
@@ -108,10 +108,16 @@ public static Project findIncludedProject(Project project, ExternalModuleDepende
             }
         }
 
-        final Gradle parentGradle = project.getRootProject().getGradle().getParent();
-        if (parentGradle != null) {
-            return findIncludedProject(parentGradle.getRootProject(), dependency);
-        } else {
+        try {
+            final Gradle parentGradle = project.getRootProject().getGradle().getParent();
+            if (parentGradle != null) {
+                return findIncludedProject(parentGradle.getRootProject(), dependency);
+            } else {
+                return null;
+            }
+        } catch (IllegalStateException ise) {
+            // This can happen if the project itself is in an included build, which means that the root-project
+            // is not yet known, so `DefaultGradle.getRootProject()` throws an ISE.
             return null;
         }
     }
@@ -134,9 +140,15 @@ private static Project findIncludedBuildProject(IncludedBuild ib, ExternalModule
         }
 
         final DefaultIncludedBuild.IncludedBuildImpl dib = (DefaultIncludedBuild.IncludedBuildImpl) ib;
-        final Project rootProject = dib.getTarget().getMutableModel().getRootProject();
+        try {
+            final Project rootProject = dib.getTarget().getMutableModel().getRootProject();
 
-        return findLocalProject(rootProject, dependency);
+            return findLocalProject(rootProject, dependency);
+        } catch (IllegalStateException ise) {
+            // This can happen if the project itself is in an included build, which means that the root-project
+            // is not yet known, so `DefaultGradle.getRootProject()` throws an ISE.
+            return null;
+        }
     }
 
     public static Path serializeAppModel(ApplicationModel appModel, Task context, boolean test) throws IOException {
diff --git a/integration-tests/gradle/src/main/resources/included-build/README.txt b/integration-tests/gradle/src/main/resources/included-build/README.txt
@@ -0,0 +1,2 @@
+Reproducer for https://github.com/quarkusio/quarkus/pull/38607: IllegalStateException when resolving project deps
+Test class: io.quarkus.gradle.IncludedQuarkusBuildTest
diff --git a/integration-tests/gradle/src/main/resources/included-build/build.gradle b/integration-tests/gradle/src/main/resources/included-build/build.gradle
@@ -0,0 +1,45 @@
+buildscript {
+    repositories {
+        mavenLocal {
+            content {
+                includeGroupByRegex 'io.quarkus.*'
+                includeGroup 'org.hibernate.orm'
+            }
+        }
+        mavenCentral()
+        gradlePluginPortal()
+    }
+}
+
+apply plugin: 'java'
+
+group = 'com.quarkus.demo'
+version = '1.0'
+
+
+subprojects {
+
+    apply plugin: 'java'
+    group = 'com.quarkus.demo'
+
+    test {
+        dependsOn 'cleanTest'
+        useJUnitPlatform()
+        forkEvery 1
+        systemProperty "java.util.logging.manager", "org.jboss.logmanager.LogManager"
+    }
+
+    repositories {
+        mavenLocal {
+            content {
+                includeGroupByRegex 'io.quarkus.*'
+                includeGroup 'org.hibernate.orm'
+            }
+        }
+        mavenCentral()
+    }
+
+    dependencies {
+        implementation enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatformArtifactId}:${quarkusPlatformVersion}")
+    }
+}
diff --git a/integration-tests/gradle/src/main/resources/included-build/depend-on-included-build/build.gradle b/integration-tests/gradle/src/main/resources/included-build/depend-on-included-build/build.gradle
@@ -0,0 +1,7 @@
+plugins {
+    id 'java-library'
+}
+
+dependencies {
+    implementation("com.quarkus.includedbuild:included-quarkus:1.0")
+}
diff --git a/integration-tests/gradle/src/main/resources/included-build/gradle.properties b/integration-tests/gradle/src/main/resources/included-build/gradle.properties
@@ -0,0 +1,2 @@
+quarkusPlatformArtifactId=quarkus-bom
+quarkusPlatformGroupId=io.quarkus
diff --git a/integration-tests/gradle/src/main/resources/included-build/included/build.gradle b/integration-tests/gradle/src/main/resources/included-build/included/build.gradle
@@ -0,0 +1,45 @@
+buildscript {
+    repositories {
+        mavenLocal {
+            content {
+                includeGroupByRegex 'io.quarkus.*'
+                includeGroup 'org.hibernate.orm'
+            }
+        }
+        mavenCentral()
+        gradlePluginPortal()
+    }
+}
+
+apply plugin: 'java'
+
+group = 'com.quarkus.directinclude'
+version = '1.0'
+
+
+subprojects {
+
+    apply plugin: 'java'
+    group = 'com.quarkus.directinclude'
+
+    test {
+        dependsOn 'cleanTest'
+        useJUnitPlatform()
+        forkEvery 1
+        systemProperty "java.util.logging.manager", "org.jboss.logmanager.LogManager"
+    }
+
+    repositories {
+        mavenLocal {
+            content {
+                includeGroupByRegex 'io.quarkus.*'
+                includeGroup 'org.hibernate.orm'
+            }
+        }
+        mavenCentral()
+    }
+
+    dependencies {
+        implementation enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatformArtifactId}:${quarkusPlatformVersion}")
+    }
+}
diff --git a/integration-tests/gradle/src/main/resources/included-build/included/nested/build.gradle b/integration-tests/gradle/src/main/resources/included-build/included/nested/build.gradle
@@ -0,0 +1,45 @@
+buildscript {
+    repositories {
+        mavenLocal {
+            content {
+                includeGroupByRegex 'io.quarkus.*'
+                includeGroup 'org.hibernate.orm'
+            }
+        }
+        mavenCentral()
+        gradlePluginPortal()
+    }
+}
+
+apply plugin: 'java'
+
+group = 'com.quarkus.includedbuild'
+version = '1.0'
+
+
+subprojects {
+
+    apply plugin: 'java'
+    group = 'com.quarkus.includedbuild'
+
+    test {
+        dependsOn 'cleanTest'
+        useJUnitPlatform()
+        forkEvery 1
+        systemProperty "java.util.logging.manager", "org.jboss.logmanager.LogManager"
+    }
+
+    repositories {
+        mavenLocal {
+            content {
+                includeGroupByRegex 'io.quarkus.*'
+                includeGroup 'org.hibernate.orm'
+            }
+        }
+        mavenCentral()
+    }
+
+    dependencies {
+        implementation enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatformArtifactId}:${quarkusPlatformVersion}")
+    }
+}
diff --git a/integration-tests/gradle/src/main/resources/included-build/included/nested/included-quarkus/build.gradle b/integration-tests/gradle/src/main/resources/included-build/included/nested/included-quarkus/build.gradle
@@ -0,0 +1,7 @@
+plugins {
+    id 'java-library'
+    id 'io.quarkus'
+}
+
+dependencies {
+}
diff --git a/integration-tests/gradle/src/main/resources/included-build/included/nested/settings.gradle b/integration-tests/gradle/src/main/resources/included-build/included/nested/settings.gradle
@@ -0,0 +1,20 @@
+pluginManagement {
+    repositories {
+        mavenLocal {
+            content {
+                includeGroupByRegex 'io.quarkus.*'
+                includeGroup 'org.hibernate.orm'
+            }
+        }
+        mavenCentral()
+        gradlePluginPortal()
+    }
+    //noinspection GroovyAssignabilityCheck
+    plugins {
+        id 'io.quarkus' version "${quarkusPluginVersion}"
+    }
+}
+
+rootProject.name = 'nested'
+
+include ':included-quarkus'
diff --git a/integration-tests/gradle/src/main/resources/included-build/included/settings.gradle b/integration-tests/gradle/src/main/resources/included-build/included/settings.gradle
@@ -0,0 +1,23 @@
+pluginManagement {
+    repositories {
+        mavenLocal {
+            content {
+                includeGroupByRegex 'io.quarkus.*'
+                includeGroup 'org.hibernate.orm'
+            }
+        }
+        mavenCentral()
+        gradlePluginPortal()
+    }
+    //noinspection GroovyAssignabilityCheck
+    plugins {
+        id 'io.quarkus' version "${quarkusPluginVersion}"
+    }
+}
+
+includeBuild 'nested'
+
+rootProject.name = 'included'
+
+include ':dependency'
+include ':included-quarkus'
diff --git a/integration-tests/gradle/src/main/resources/included-build/settings.gradle b/integration-tests/gradle/src/main/resources/included-build/settings.gradle
@@ -0,0 +1,5 @@
+rootProject.name = 'include-quarkus-build'
+
+includeBuild 'included'
+
+include ':depend-on-included-build'
diff --git a/integration-tests/gradle/src/test/java/io/quarkus/gradle/IncludedQuarkusBuildTest.java b/integration-tests/gradle/src/test/java/io/quarkus/gradle/IncludedQuarkusBuildTest.java
@@ -0,0 +1,48 @@
+package io.quarkus.gradle;
+
+import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.stream.Stream;
+
+import org.assertj.core.api.SoftAssertions;
+import org.assertj.core.api.junit.jupiter.InjectSoftAssertions;
+import org.assertj.core.api.junit.jupiter.SoftAssertionsExtension;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+/**
+ * Reproducer for <a href="https://github.com/quarkusio/quarkus/pull/38607">{@code IllegalStateException} when
+ * Quarkus project is in an <em>included</em> Gradle build</a>.
+ */
+@ExtendWith(SoftAssertionsExtension.class)
+public class IncludedQuarkusBuildTest extends QuarkusGradleWrapperTestBase {
+    @InjectSoftAssertions
+    SoftAssertions soft;
+
+    @Test
+    public void test() throws Exception {
+
+        final File projectDir = getProjectDir("included-build");
+
+        Path prjDir = projectDir.toPath();
+        Path target1 = prjDir.resolve("included").resolve("gradle.properties");
+        Path target2 = prjDir.resolve("included").resolve("nested").resolve("gradle.properties");
+        Files.deleteIfExists(target1);
+        Files.deleteIfExists(target2);
+        Files.copy(prjDir.resolve("gradle.properties"), target1);
+        Files.copy(prjDir.resolve("gradle.properties"), target2);
+
+        soft.assertThat(runGradleWrapper(projectDir, "clean", "jar", "--no-build-cache").unsuccessfulTasks())
+                .isEmpty();
+
+        try {
+            soft.assertAll();
+        } catch (AssertionError ex) {
+            try (Stream<Path> files = Files.walk(prjDir)) {
+                files.map(Path::toString).sorted().forEach(System.err::println);
+            }
+            throw ex;
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -108,10 +108,16 @@ public static Project findIncludedProject(Project project, ExternalModuleDepende`
`108`	`108`	`}`
`109`	`109`	`}`
`110`	`110`
`111`		`- final Gradle parentGradle = project.getRootProject().getGradle().getParent();`
`112`		`- if (parentGradle != null) {`
`113`		`- return findIncludedProject(parentGradle.getRootProject(), dependency);`
`114`		`- } else {`
	`111`	`+ try {`
	`112`	`+ final Gradle parentGradle = project.getRootProject().getGradle().getParent();`
	`113`	`+ if (parentGradle != null) {`
	`114`	`+ return findIncludedProject(parentGradle.getRootProject(), dependency);`
	`115`	`+ } else {`
	`116`	`+ return null;`
	`117`	`+ }`
	`118`	`+ } catch (IllegalStateException ise) {`
	`119`	`+ // This can happen if the project itself is in an included build, which means that the root-project`
	`120`	+ // is not yet known, so `DefaultGradle.getRootProject()` throws an ISE.
`115`	`121`	`return null;`
`116`	`122`	`}`
`117`	`123`	`}`
`@@ -134,9 +140,15 @@ private static Project findIncludedBuildProject(IncludedBuild ib, ExternalModule`
`134`	`140`	`}`
`135`	`141`
`136`	`142`	`final DefaultIncludedBuild.IncludedBuildImpl dib = (DefaultIncludedBuild.IncludedBuildImpl) ib;`
`137`		`- final Project rootProject = dib.getTarget().getMutableModel().getRootProject();`
	`143`	`+ try {`
	`144`	`+ final Project rootProject = dib.getTarget().getMutableModel().getRootProject();`
`138`	`145`
`139`		`- return findLocalProject(rootProject, dependency);`
	`146`	`+ return findLocalProject(rootProject, dependency);`
	`147`	`+ } catch (IllegalStateException ise) {`
	`148`	`+ // This can happen if the project itself is in an included build, which means that the root-project`
	`149`	+ // is not yet known, so `DefaultGradle.getRootProject()` throws an ISE.
	`150`	`+ return null;`
	`151`	`+ }`
`140`	`152`	`}`
`141`	`153`
`142`	`154`	`public static Path serializeAppModel(ApplicationModel appModel, Task context, boolean test) throws IOException {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Reproducer for https://github.com/quarkusio/quarkus/pull/38607: IllegalStateException when resolving project deps`
	`2`	`+Test class: io.quarkus.gradle.IncludedQuarkusBuildTest`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+quarkusPlatformArtifactId=quarkus-bom`
	`2`	`+quarkusPlatformGroupId=io.quarkus`