Tidy up core's build file (#4207)

* Tidy up core's build file

* post-merge fixes

* Extract shading config

* fix modules

* fix tests

* fix merge conflicts, simplify shading.gradle

* cleanup

* Workaround BOM dependency

* Use `resolvedConfiguration`

Author: bsideup

build.gradle

@@ -21,7 +21,7 @@ subprojects {
     apply plugin: 'java-library'
     apply plugin: 'idea'
     apply plugin: 'io.franzbecker.gradle-lombok'
-    apply plugin: 'com.github.johnrengelman.shadow'
+    apply from: "$rootDir/gradle/shading.gradle"
 
     group = "org.testcontainers"
 
@@ -101,37 +101,6 @@ subprojects {
         source = delombok.outputs
     }
 
-    shadowJar {
-        configurations = []
-        archiveClassifier.set(null)
-
-        doFirst {
-            // See https://github.com/johnrengelman/shadow/blob/5.0.0/src/main/groovy/com/github/jengelman/gradle/plugins/shadow/tasks/ConfigureShadowRelocation.groovy
-            Set<String> packages = []
-            // Always read from core's configurations
-            for (configuration in tasks.getByPath(":testcontainers:shadowJar").configurations) {
-                for (jar in configuration.files) {
-                    def jf = new java.util.jar.JarFile(jar)
-                    for (entry in jf.entries()) {
-                        def name = entry.name
-                        if (name.endsWith(".class")) {
-                            def index = name.lastIndexOf('/')
-                            if (index != -1) {
-                                packages.add(name.substring(0, index))
-                            }
-                        }
-                    }
-                    jf.close()
-                }
-            }
-            for (pkg in packages) {
-                pkg = pkg.replaceAll('/', '.')
-
-                tasks.shadowJar.relocate(pkg, "org.testcontainers.shaded.${pkg}")
-            }
-        }
-    }
-
     dependencies {
         testImplementation 'ch.qos.logback:logback-classic:1.2.3'
     }

core/build.gradle

@@ -8,16 +8,7 @@ sourceSets {
 
 idea.module.testSourceDirs += sourceSets.jarFileTest.allSource.srcDirs
 
-configurations {
-    shaded
-    [api, compileOnly, testCompile]*.extendsFrom shaded
-}
-
 shadowJar {
-    configurations = [project.configurations.shaded]
-
-    mergeServiceFiles()
-
     [
         'META-INF/NOTICE',
         'META-INF/NOTICE.txt',
@@ -77,23 +68,16 @@ dependencies {
 
     shaded 'org.awaitility:awaitility:4.1.0'
 
+    api platform('com.github.docker-java:docker-java-bom:3.2.12')
     shaded platform('com.github.docker-java:docker-java-bom:3.2.12')
 
     api "com.github.docker-java:docker-java-api"
 
-    shaded ('com.github.docker-java:docker-java-core') {
-        exclude(group: 'com.github.docker-java', module: 'docker-java-api')
-        exclude(group: 'com.github.docker-java', module: 'docker-java-transport')
-        exclude(group: 'com.fasterxml.jackson.core', module: 'jackson-annotations')
-        exclude(group: 'com.google.code.findbug')
-        exclude(group: 'org.slf4j')
-        exclude(group: 'org.apache.commons', module: 'commons-compress')
-    }
+    shaded 'com.github.docker-java:docker-java-core'
 
-    shaded ('com.github.docker-java:docker-java-transport-okhttp') {
-        exclude(group: 'com.github.docker-java', module: 'docker-java-core')
-        exclude(group: 'net.java.dev.jna')
-        exclude(group: 'org.slf4j')
+    shaded 'com.github.docker-java:docker-java-transport-okhttp', {
+        // TODO remove unused `net.java.dev.jna:jna-platform` from `docker-java-transport-okhttp`
+        exclude(group: 'net.java.dev.jna', module: 'jna-platform')
     }
 
     api 'com.github.docker-java:docker-java-transport-zerodep'
@@ -102,9 +86,7 @@ dependencies {
 
     shaded 'org.glassfish.main.external:trilead-ssh2-repackaged:4.1.2'
 
-    shaded 'org.zeroturnaround:zt-exec:1.12', {
-        exclude(group: 'org.slf4j')
-    }
+    shaded 'org.zeroturnaround:zt-exec:1.12'
 
     testImplementation 'org.apache.httpcomponents:httpclient:4.5.9'
     testImplementation 'redis.clients:jedis:3.7.0'

gradle/publishing.gradle

@@ -57,27 +57,34 @@ publishing {
 
                 def dependenciesNode = rootNode.appendNode('dependencies')
 
-                def addDependency = { dependency, scope ->
-                    dependenciesNode.appendNode('dependency').with {
-                        appendNode('groupId', dependency.group)
-                        appendNode('artifactId', dependency.name)
-                        appendNode('version', dependency.version)
-                        appendNode('scope', scope)
+                def addDependencies = { Configuration configuration, scope ->
+                    for (dependency in configuration.resolvedConfiguration.firstLevelModuleDependencies) {
+                        if (dependency.configuration.startsWith("platform-")) {
+                            continue
+                        }
+                        dependenciesNode.appendNode('dependency').with {
+                            if (!dependency.moduleGroup || !dependency.moduleName || !dependency.moduleVersion) {
+                                throw new IllegalStateException("Wrong dependency: $dependency")
+                            }
+                            appendNode('groupId', dependency.moduleGroup)
+                            appendNode('artifactId', dependency.moduleName)
+                            appendNode('version', dependency.moduleVersion)
+                            appendNode('scope', scope)
 
-                        if (dependency instanceof ModuleDependency && !dependency.excludeRules.empty) {
-                            def excludesNode = appendNode('exclusions')
-                            for (rule in dependency.excludeRules) {
-                                excludesNode.appendNode('exclusion').with {
-                                    appendNode('groupId', rule.group)
-                                    appendNode('artifactId', rule.module)
+                            if (dependency instanceof ModuleDependency && !dependency.excludeRules.empty) {
+                                def excludesNode = appendNode('exclusions')
+                                for (rule in dependency.excludeRules) {
+                                    excludesNode.appendNode('exclusion').with {
+                                        appendNode('groupId', rule.group)
+                                        appendNode('artifactId', rule.module)
+                                    }
                                 }
                             }
                         }
                     }
                 }
-
-                project.configurations.api.dependencies.each { addDependency(it, 'compile') }
-                project.configurations.provided.dependencies.each { addDependency(it, 'provided') }
+                addDependencies(project.configurations.api, 'compile')
+                addDependencies(project.configurations.provided, 'provided')
             }
         }
     }

gradle/shading.gradle

@@ -0,0 +1,58 @@
+import java.util.jar.JarFile
+
+apply plugin: 'com.github.johnrengelman.shadow'
+
+configurations {
+    shaded
+    [apiElements, implementation, compileOnly, testCompile]*.extendsFrom shaded
+}
+configurations.api.canBeResolved = true
+
+shadowJar {
+    configurations = [project.configurations.shaded]
+    archiveClassifier.set(null)
+
+    mergeServiceFiles()
+}
+
+project.afterEvaluate {
+    Set<ModuleIdentifier> apiDependencies = project.configurations.api.resolvedConfiguration.resolvedArtifacts*.moduleVersion*.id*.module
+
+    // Exclude `api` dependencies, to prevent them being included into the final JAR
+    shadowJar.dependencies {
+        for (id in apiDependencies) {
+            exclude(dependency("${id.group}:${id.name}"))
+        }
+    }
+
+    // Inherit dependencies' relocators
+    shadowJar.relocators = configurations.api.dependencies.withType(ProjectDependency).collectMany {
+        return it.dependencyProject.tasks.findByName("shadowJar")?.relocators ?: []
+    }
+
+    // See https://github.com/johnrengelman/shadow/blob/5.0.0/src/main/groovy/com/github/jengelman/gradle/plugins/shadow/tasks/ConfigureShadowRelocation.groovy
+    Set<String> packages = []
+
+    for (artifact in project.configurations.shaded.resolvedConfiguration.resolvedArtifacts) {
+        if (apiDependencies.contains(artifact.moduleVersion.id.module)) {
+            continue
+        }
+
+        try (def jf = new JarFile(artifact.file)) {
+            for (entry in jf.entries()) {
+                def name = entry.name
+                if (name.endsWith(".class")) {
+                    def index = name.lastIndexOf('/')
+                    if (index != -1) {
+                        packages.add(name.substring(0, index))
+                    }
+                }
+            }
+        }
+    }
+    for (pkg in packages) {
+        pkg = pkg.replaceAll('/', '.')
+
+        tasks.shadowJar.relocate(pkg, "org.testcontainers.shaded.${pkg}")
+    }
+}