Remove dependency on the plugin API from the adapter interfaces

Author: pshevche

build.gradle

@@ -75,7 +75,6 @@ testing {
             dependencies {
                 implementation(platform('org.junit:junit-bom:5.10.2'))
                 implementation('org.junit.jupiter:junit-jupiter')
-                implementation('com.tngtech.archunit:archunit-junit5:1.2.1')
             }
         }
 

src/develocityCompatibilityTest/java/com/gradle/ccud/adapters/develocity/DevelocityBuildCacheAdapterTest.java

@@ -23,7 +23,7 @@ public class DevelocityBuildCacheAdapterTest {
     @BeforeEach
     void setup() {
         cache = mock();
-        adapter = BuildCacheAdapter.create(cache, DevelocityBuildCache.class);
+        adapter = new DevelocityBuildCacheAdapter(cache);
     }
 
     @Test

src/develocityCompatibilityTest/java/com/gradle/ccud/adapters/develocity/DevelocityConfigurationAdapterTest.java

@@ -30,7 +30,7 @@ void setup() {
         buildScan = mock();
         configuration = mock();
         when(configuration.getBuildScan()).thenReturn(buildScan);
-        adapter = DevelocityAdapter.create(configuration);
+        adapter = new DevelocityConfigurationAdapter(configuration);
     }
 
     @Test

src/enterpriseCompatibilityTest/java/com/gradle/ccud/adapters/enterprise/BuildScanExtension_1_X_AdapterTest.java

@@ -3,8 +3,6 @@
 import com.gradle.ccud.adapters.BuildResultAdapter;
 import com.gradle.ccud.adapters.DevelocityAdapter;
 import com.gradle.ccud.adapters.PublishedBuildScanAdapter;
-import com.gradle.ccud.adapters.enterprise.proxies.BuildScanExtensionProxy;
-import com.gradle.ccud.adapters.reflection.ProxyFactory;
 import com.gradle.cuud.adapters.ActionMockFixtures.ArgCapturingAction;
 import com.gradle.scan.plugin.BuildScanExtension;
 import org.junit.jupiter.api.BeforeEach;
@@ -35,7 +33,7 @@ public class BuildScanExtension_1_X_AdapterTest {
     void setup() {
         extension = mock();
         // bypass Gradle version check
-        adapter = new BuildScanExtension_1_X_Adapter(ProxyFactory.createProxy(extension, BuildScanExtensionProxy.class));
+        adapter = new BuildScanExtension_1_X_Adapter(extension);
     }
 
     @Test

src/enterpriseCompatibilityTest/java/com/gradle/ccud/adapters/enterprise/GradleEnterpriseBuildCacheAdapterTest.java

@@ -1,6 +1,8 @@
 package com.gradle.ccud.adapters.enterprise;
 
 import com.gradle.ccud.adapters.BuildCacheAdapter;
+import com.gradle.ccud.adapters.enterprise.proxies.GradleEnterpriseBuildCacheProxy;
+import com.gradle.ccud.adapters.reflection.ProxyFactory;
 import com.gradle.enterprise.gradleplugin.GradleEnterpriseBuildCache;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.DisplayName;
@@ -23,7 +25,7 @@ public class GradleEnterpriseBuildCacheAdapterTest {
     @BeforeEach
     void setup() {
         cache = mock();
-        adapter = BuildCacheAdapter.create(cache, GradleEnterpriseBuildCache.class);
+        adapter = new GradleEnterpriseBuildCacheAdapter(ProxyFactory.createProxy(cache, GradleEnterpriseBuildCacheProxy.class));
     }
 
     @Test

src/enterpriseCompatibilityTest/java/com/gradle/ccud/adapters/enterprise/GradleEnterpriseExtensionAdapterTest.java

@@ -27,7 +27,7 @@ void setup() {
         buildScan = mock();
         extension = mock();
         when(extension.getBuildScan()).thenReturn(buildScan);
-        adapter = DevelocityAdapter.create(extension);
+        adapter = new GradleEnterpriseExtensionAdapter(extension);
     }
 
     @Test

src/main/java/com/gradle/AdapterFactory.java

@@ -0,0 +1,80 @@
+package com.gradle;
+
+import com.gradle.ccud.adapters.BuildCacheAdapter;
+import com.gradle.ccud.adapters.DevelocityAdapter;
+import com.gradle.ccud.adapters.develocity.DevelocityBuildCacheAdapter;
+import com.gradle.ccud.adapters.develocity.DevelocityConfigurationAdapter;
+import com.gradle.ccud.adapters.enterprise.BuildScanExtension_1_X_Adapter;
+import com.gradle.ccud.adapters.enterprise.GradleEnterpriseBuildCacheAdapter;
+import com.gradle.ccud.adapters.enterprise.GradleEnterpriseExtensionAdapter;
+import com.gradle.ccud.adapters.enterprise.proxies.GradleEnterpriseBuildCacheProxy;
+import com.gradle.ccud.adapters.reflection.ProxyFactory;
+import com.gradle.develocity.agent.gradle.buildcache.DevelocityBuildCache;
+import org.gradle.caching.configuration.AbstractBuildCache;
+
+import java.util.Arrays;
+import java.util.stream.Stream;
+
+import static com.gradle.Utils.isGradle5OrNewer;
+
+class AdapterFactory {
+
+    private AdapterFactory() {
+    }
+
+    private static final String DEVELOCITY_CONFIGURATION = "com.gradle.develocity.agent.gradle.DevelocityConfiguration";
+    private static final String GRADLE_ENTERPRISE_EXTENSION = "com.gradle.enterprise.gradleplugin.GradleEnterpriseExtension";
+    private static final String BUILD_SCAN_EXTENSION = "com.gradle.scan.plugin.BuildScanExtension";
+
+    static DevelocityAdapter createDevelocityAdapter(Object gradleEnterpriseOrDevelocity) {
+        if (isDevelocityConfiguration(gradleEnterpriseOrDevelocity)) {
+            return new DevelocityConfigurationAdapter(gradleEnterpriseOrDevelocity);
+        } else if (isGradleEnterpriseExtension(gradleEnterpriseOrDevelocity)) {
+            return new GradleEnterpriseExtensionAdapter(gradleEnterpriseOrDevelocity);
+        } else if (!isGradle5OrNewer() && isBuildScanExtension(gradleEnterpriseOrDevelocity)) {
+            // Build Scan plugin only exposes the buildScan extension with a limited functionality
+            return new BuildScanExtension_1_X_Adapter(gradleEnterpriseOrDevelocity);
+        }
+
+        throw new IllegalArgumentException("Provided extension of type '" + gradleEnterpriseOrDevelocity.getClass().getName() + "' is neither the Develocity configuration nor the Gradle Enterprise extension");
+    }
+
+    static boolean isDevelocityConfiguration(Object gradleEnterpriseOrDevelocity) {
+        return implementsInterface(gradleEnterpriseOrDevelocity, DEVELOCITY_CONFIGURATION);
+    }
+
+    static boolean isGradleEnterpriseExtension(Object gradleEnterpriseOrDevelocity) {
+        return implementsInterface(gradleEnterpriseOrDevelocity, GRADLE_ENTERPRISE_EXTENSION);
+    }
+
+    static boolean isBuildScanExtension(Object gradleEnterpriseOrDevelocity) {
+        return implementsInterface(gradleEnterpriseOrDevelocity, BUILD_SCAN_EXTENSION);
+    }
+
+    static boolean implementsInterface(Object object, String interfaceName) {
+        Class<?> clazz = object.getClass();
+        while (clazz != null) {
+            Class<?>[] interfaces = clazz.getInterfaces();
+            boolean implementsInterface = Stream.concat(
+                Arrays.stream(interfaces),
+                Arrays.stream(interfaces).flatMap(it -> Arrays.stream(it.getInterfaces()))
+            ).anyMatch(it -> interfaceName.equals(it.getName()));
+
+            if (implementsInterface) {
+                return true;
+            }
+
+            clazz = clazz.getSuperclass();
+        }
+
+        return false;
+    }
+
+    static BuildCacheAdapter createBuildCacheAdapter(AbstractBuildCache cache, Class<? extends AbstractBuildCache> reportedCacheClass) {
+        if (reportedCacheClass.getName().toLowerCase().contains("develocity")) {
+            return new DevelocityBuildCacheAdapter((DevelocityBuildCache) cache);
+        }
+
+        return new GradleEnterpriseBuildCacheAdapter(ProxyFactory.createProxy(cache, GradleEnterpriseBuildCacheProxy.class));
+    }
+}

src/main/java/com/gradle/CommonCustomUserDataGradlePlugin.java

@@ -14,6 +14,7 @@
 import java.util.Arrays;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import static com.gradle.AdapterFactory.createDevelocityAdapter;
 import static com.gradle.Utils.isGradle4OrNewer;
 import static com.gradle.Utils.isGradle5OrNewer;
 import static com.gradle.Utils.isGradle6OrNewer;
@@ -56,7 +57,7 @@ public static void apply(Object gradleEnterpriseOrDevelocity, ProviderFactory pr
     }
 
     private static void applySettingsPlugin(Object gradleEnterpriseOrDevelocity, ProviderFactory providers, Settings settings) {
-        DevelocityAdapter develocity = DevelocityAdapter.create(gradleEnterpriseOrDevelocity);
+        DevelocityAdapter develocity = createDevelocityAdapter(gradleEnterpriseOrDevelocity);
         CustomDevelocityConfig customDevelocityConfig = new CustomDevelocityConfig();
 
         customDevelocityConfig.configureDevelocity(develocity);
@@ -123,7 +124,7 @@ private void applyProjectPluginGradle4(Project project) {
     private void applyProjectPlugin(Project project, Object develocityOrBuildScanExtension) {
         CustomDevelocityConfig customDevelocityConfig = new CustomDevelocityConfig();
 
-        DevelocityAdapter develocity = DevelocityAdapter.create(develocityOrBuildScanExtension);
+        DevelocityAdapter develocity = createDevelocityAdapter(develocityOrBuildScanExtension);
         customDevelocityConfig.configureDevelocity(develocity);
 
         BuildScanAdapter buildScan = develocity.getBuildScan();

src/main/java/com/gradle/Overrides.java

@@ -10,6 +10,8 @@
 import java.time.Duration;
 import java.util.Optional;
 
+import static com.gradle.AdapterFactory.createBuildCacheAdapter;
+
 /**
  * Provide standardized Develocity configuration. By applying the plugin, these settings will automatically be applied.
  */
@@ -69,7 +71,7 @@ void configureBuildCache(BuildCacheConfiguration buildCache, Class<? extends Abs
             });
         } else if (develocityCacheClass.isInstance(buildCache.getRemote())) {
             buildCache.remote(develocityCacheClass, remote -> {
-                BuildCacheAdapter adapter = BuildCacheAdapter.create(remote, develocityCacheClass);
+                BuildCacheAdapter adapter = createBuildCacheAdapter(remote, develocityCacheClass);
                 sysPropertyOrEnvVariable(REMOTE_CACHE_SERVER, providers).ifPresent(adapter::setServer);
                 sysPropertyOrEnvVariable(REMOTE_CACHE_PATH, providers).ifPresent(adapter::setPath);
                 booleanSysPropertyOrEnvVariable(REMOTE_CACHE_ALLOW_UNTRUSTED_SERVER, providers).ifPresent(adapter::setAllowUntrustedServer);

src/main/java/com/gradle/ccud/adapters/BuildCacheAdapter.java

@@ -1,11 +1,5 @@
 package com.gradle.ccud.adapters;
 
-import com.gradle.ccud.adapters.develocity.DevelocityBuildCacheAdapter;
-import com.gradle.ccud.adapters.enterprise.GradleEnterpriseBuildCacheAdapter;
-import com.gradle.ccud.adapters.enterprise.proxies.GradleEnterpriseBuildCacheProxy;
-import com.gradle.ccud.adapters.reflection.ProxyFactory;
-import com.gradle.develocity.agent.gradle.buildcache.DevelocityBuildCache;
-import org.gradle.caching.configuration.AbstractBuildCache;
 import org.gradle.caching.configuration.BuildCache;
 
 import javax.annotation.Nullable;
@@ -15,15 +9,6 @@
  */
 public interface BuildCacheAdapter extends BuildCache {
 
-    // if the method is called, we know that it is either a GE or DV cache
-    static BuildCacheAdapter create(AbstractBuildCache cache, Class<? extends AbstractBuildCache> reportedCacheClass) {
-        if (reportedCacheClass.getName().toLowerCase().contains("develocity")) {
-            return new DevelocityBuildCacheAdapter((DevelocityBuildCache) cache);
-        }
-
-        return new GradleEnterpriseBuildCacheAdapter(ProxyFactory.createProxy(cache, GradleEnterpriseBuildCacheProxy.class));
-    }
-
     @Nullable
     String getServer();