Defensively protect against a broken WindowsRegistry service

Native-platform is sometimes unavailable. Without native-platform, we're unable to look-up things from the Windows registry.
gradle · May 8, 2024 · a8931dc · a8931dc
1 parent 591afee
commit a8931dc
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 14 deletions.
diff --git a/...services/src/main/java/org/gradle/jvm/toolchain/internal/WindowsInstallationSupplier.java b/...services/src/main/java/org/gradle/jvm/toolchain/internal/WindowsInstallationSupplier.java
@@ -19,6 +19,7 @@
 import com.google.common.collect.Lists;
 import net.rubygrapefruit.platform.MissingRegistryEntryException;
 import net.rubygrapefruit.platform.WindowsRegistry;
+import org.gradle.internal.nativeintegration.NativeIntegrationUnavailableException;
 import org.gradle.internal.os.OperatingSystem;
 
 import java.io.File;
@@ -67,9 +68,9 @@ private Set<InstallationLocation> findInstallationsInRegistry() {
 
     private List<String> find(String sdkSubkey, String path, String value) {
         try {
-            return getVersions(sdkSubkey).stream()
-                .map(version -> getValue(sdkSubkey, path, value, version)).collect(Collectors.toList());
-        } catch (MissingRegistryEntryException e) {
+            List<String> versions = getVersions(sdkSubkey);
+            return versions.stream().map(version -> getValue(sdkSubkey, path, value, version)).collect(Collectors.toList());
+        } catch (MissingRegistryEntryException | NativeIntegrationUnavailableException e) {
             // Ignore
             return Collections.emptyList();
         }

diff --git a/.../src/test/groovy/org/gradle/jvm/toolchain/internal/WindowsInstallationSupplierTest.groovy b/.../src/test/groovy/org/gradle/jvm/toolchain/internal/WindowsInstallationSupplierTest.groovy
@@ -18,8 +18,7 @@ package org.gradle.jvm.toolchain.internal
 
 import net.rubygrapefruit.platform.MissingRegistryEntryException
 import net.rubygrapefruit.platform.WindowsRegistry
-import org.gradle.api.internal.provider.Providers
-import org.gradle.api.provider.ProviderFactory
+import org.gradle.internal.nativeintegration.NativeIntegrationUnavailableException
 import org.gradle.internal.os.OperatingSystem
 import spock.lang.Specification
 
@@ -74,8 +73,20 @@ class WindowsInstallationSupplierTest extends Specification {
 
     def "handles absent adoptopenjdk keys"() {
         given:
-        registry.getSubkeys(WindowsRegistry.Key.HKEY_LOCAL_MACHINE, "SOFTWARE\\AdoptOpenJDK\\JDK") >> { throw new MissingRegistryEntryException() }
-        def supplier = createSupplier(OperatingSystem.MAC_OS)
+        registry.getSubkeys(WindowsRegistry.Key.HKEY_LOCAL_MACHINE, _) >> { throw new MissingRegistryEntryException() }
+        def supplier = createSupplier()
+
+        when:
+        def locations = supplier.get()
+
+        then:
+        locations.isEmpty()
+    }
+
+    def "gracefully handles unavailable native integration"() {
+        given:
+        registry.getSubkeys(WindowsRegistry.Key.HKEY_LOCAL_MACHINE, _) >> { throw new NativeIntegrationUnavailableException() }
+        def supplier = createSupplier()
 
         when:
         def locations = supplier.get()
@@ -114,11 +125,4 @@ class WindowsInstallationSupplierTest extends Specification {
     WindowsInstallationSupplier createSupplier(OperatingSystem os = OperatingSystem.WINDOWS) {
         new WindowsInstallationSupplier(registry, os)
     }
-
-    ProviderFactory createProviderFactory(String propertyValue) {
-        def providerFactory = Mock(ProviderFactory)
-        providerFactory.gradleProperty("org.gradle.java.installations.auto-detect") >> Providers.notDefined()
-        providerFactory
-    }
-
 }