Run tests using shaded dependencies (#5146)

* Test shaded JARs

* Find shaded projects recursively

* Add missing space

* fix core tests

* fix HiveMQ module

* Simplify the HiveMQ workaround

* Add a comment that explains why we pin Jackson version in k3s

Author: bsideup

core/src/test/java/org/testcontainers/dockerclient/EnvironmentAndSystemPropertyClientProviderStrategyTest.java

@@ -1,8 +1,8 @@
 package org.testcontainers.dockerclient;
 
 import com.github.dockerjava.core.DefaultDockerClientConfig;
-import com.github.dockerjava.core.LocalDirectorySSLConfig;
 import com.github.dockerjava.transport.SSLConfig;
+import org.assertj.core.api.Assertions;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
@@ -16,15 +16,12 @@
 import java.net.URI;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
+import java.util.Properties;
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
-import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.ArgumentMatchers.isNull;
@@ -93,21 +90,24 @@ public void testWhenDockerHostAndSSLConfigPresent() throws IOException {
         assertEquals("tcp://1.2.3.4:2375", transportConfig.getDockerHost().toString());
 
         SSLConfig sslConfig = transportConfig.getSslConfig();
-        assertNotNull(sslConfig);
-        assertTrue(sslConfig instanceof LocalDirectorySSLConfig);
-        assertEquals(tempDirPath, ((LocalDirectorySSLConfig) sslConfig).getDockerCertPath());
+        Assertions.assertThat(sslConfig)
+            .extracting("dockerCertPath")
+            .isEqualTo(tempDirPath);
     }
 
     @Test
     public void applicableWhenIgnoringUserPropertiesAndConfigured() {
         Mockito.doReturn("autoIgnoringUserProperties").when(TestcontainersConfiguration.getInstance()).getEnvVarOrProperty(eq("dockerconfig.source"), anyString());
 
-        DefaultDockerClientConfig.Builder configBuilder = DefaultDockerClientConfig.createDefaultConfigBuilder()
-            .withDockerHost("tcp://1.2.3.4:2375");
+        Properties oldProperties = System.getProperties();
+        try {
+            System.setProperty("DOCKER_HOST", "tcp://1.2.3.4:2375");
+            EnvironmentAndSystemPropertyClientProviderStrategy strategy = new EnvironmentAndSystemPropertyClientProviderStrategy();
 
-        EnvironmentAndSystemPropertyClientProviderStrategy strategy = new EnvironmentAndSystemPropertyClientProviderStrategy(configBuilder);
-
-        assertTrue(strategy.isApplicable());
+            assertTrue(strategy.isApplicable());
+        } finally {
+            System.setProperties(oldProperties);
+        }
     }
 
     @Test

gradle/shading.gradle

@@ -55,4 +55,16 @@ project.afterEvaluate {
 
         tasks.shadowJar.relocate(pkg, "org.testcontainers.shaded.${pkg}")
     }
+
+    // Add shaded JARs first
+    tasks.test.classpath = findShadedProjects(project)
+        .plus(project)
+        .sum { it.tasks.findByName("shadowJar").outputs.files }
+        .plus(sourceSets.test.runtimeClasspath)
+}
+
+static Set<Project> findShadedProjects(Project project) {
+    Set<Project> dependencies = project.configurations.api.dependencies.withType(ProjectDependency)*.dependencyProject
+
+    return dependencies + dependencies.collectMany { it -> findShadedProjects(it) }
 }

modules/hivemq/src/main/java/org/testcontainers/hivemq/HiveMQExtension.java

@@ -4,9 +4,12 @@
 import javassist.NotFoundException;
 import lombok.Getter;
 import org.apache.commons.io.FileUtils;
+import org.jboss.shrinkwrap.api.ExtensionLoader;
 import org.jboss.shrinkwrap.api.ShrinkWrap;
 import org.jboss.shrinkwrap.api.exporter.ZipExporter;
 import org.jboss.shrinkwrap.api.spec.JavaArchive;
+import org.jboss.shrinkwrap.impl.base.exporter.zip.ZipExporterImpl;
+import org.jboss.shrinkwrap.impl.base.spec.JavaArchiveImpl;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
@@ -101,9 +104,16 @@ private HiveMQExtension(
             }
         }
 
-        final JavaArchive javaArchive =
-            ShrinkWrap.create(JavaArchive.class)
-                .addAsServiceProvider(EXTENSION_MAIN_CLASS_NAME, hiveMQExtension.getMainClass().getName());
+        // Shadow Gradle plugin doesn't know how to handle ShrinkWrap's SPI definitions
+        // This workaround creates the mappings programmatically
+        // TODO write a custom Gradle Shadow transformer?
+        ExtensionLoader extensionLoader = ShrinkWrap.getDefaultDomain().getConfiguration().getExtensionLoader();
+        extensionLoader.addOverride(JavaArchive.class, JavaArchiveImpl.class);
+        extensionLoader.addOverride(ZipExporter.class, ZipExporterImpl.class);
+
+        final JavaArchive javaArchive = ShrinkWrap
+            .create(JavaArchive.class)
+            .addAsServiceProvider(EXTENSION_MAIN_CLASS_NAME, hiveMQExtension.getMainClass().getName());
 
         putSubclassesIntoJar(hiveMQExtension.getId(), hiveMQExtension.getMainClass(), javaArchive);
         for (final Class<?> additionalClass : hiveMQExtension.getAdditionalClasses()) {

modules/k3s/build.gradle

@@ -3,7 +3,10 @@ description = "Testcontainers :: K3S"
 dependencies {
     api project(":testcontainers")
 
-    shaded 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.13.1'
+    // https://youtu.be/otCpCn0l4Wo
+    // The core module depends on jackson-databind 2.8.x for backward compatibility.
+    // Any >2.8 version here is not compatible with jackson-databind 2.8.x.
+    shaded 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.8.8'
 
     testImplementation 'io.fabric8:kubernetes-client:5.11.0'
     testImplementation 'io.kubernetes:client-java:14.0.0'