Convert functional test kits to Kotlin and NIO

build.gradle.kts

@@ -54,6 +54,8 @@ val intiTestRuntimeOnly: Configuration by configurations.getting {
 val funcTest: SourceSet by sourceSets.creating
 val funcTestImplementation: Configuration by configurations.getting {
   extendsFrom(configurations.testImplementation.get())
+  // TODO: this will be removed after we migrated all functional tests to Kotlin.
+  extendsFrom(intiTestImplementation)
 }
 val funcTestRuntimeOnly: Configuration by configurations.getting {
   extendsFrom(configurations.testRuntimeOnly.get())
@@ -88,6 +90,10 @@ dependencies {
   funcTestImplementation(sourceSets.main.get().output)
   funcTestImplementation(intiTest.output)
 
+  intiTestImplementation(libs.okio)
+  intiTestImplementation(libs.apache.maven.modelBuilder)
+  intiTestImplementation(libs.apache.maven.repositoryMetadata)
+
   lintChecks(libs.androidx.gradlePluginLints)
   lintChecks(libs.assertk.lint)
 }

gradle/libs.versions.toml

@@ -1,14 +1,20 @@
+[versions]
+maven = "3.9.9"
+
 [libraries]
 apache-ant = "org.apache.ant:ant:1.10.15"
 apache-commonsIo = "commons-io:commons-io:2.18.0"
 apache-commonsLang = "org.apache.commons:commons-lang3:3.17.0"
 apache-log4j = "org.apache.logging.log4j:log4j-core:2.24.3"
+apache-maven-modelBuilder = { module = "org.apache.maven:maven-model-builder", version.ref = "maven" }
+apache-maven-repositoryMetadata = { module = "org.apache.maven:maven-repository-metadata", version.ref = "maven" }
 asm = "org.ow2.asm:asm-commons:9.7.1"
 jdependency = "org.vafer:jdependency:2.11"
 jdom2 = "org.jdom:jdom2:2.0.6.1"
 plexus-utils = "org.codehaus.plexus:plexus-utils:4.0.2"
 plexus-xml = "org.codehaus.plexus:plexus-xml:4.0.4"
 xmlunit = "org.xmlunit:xmlunit-legacy:2.10.0"
+okio = "com.squareup.okio:okio:3.9.1"
 
 pluginPublish = "com.gradle.publish:plugin-publish-plugin:1.3.0"
 mavenPublish = "com.vanniktech:gradle-maven-publish-plugin:0.30.0"

src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/ApplicationSpec.groovy

@@ -1,14 +1,13 @@
 package com.github.jengelman.gradle.plugins.shadow
 
-import com.github.jengelman.gradle.plugins.shadow.util.PluginSpecification
 import org.apache.tools.zip.ZipFile
 import org.gradle.testkit.runner.BuildResult
 import spock.lang.Issue
 
 import java.util.jar.Attributes
 import java.util.jar.JarFile
 
-class ApplicationSpec extends PluginSpecification {
+class ApplicationSpec extends BasePluginSpecification {
 
     def 'integration with application plugin'() {
         given:

src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/util/PluginSpecification.groovy → src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/BasePluginSpecification.groovy

@@ -1,17 +1,20 @@
-package com.github.jengelman.gradle.plugins.shadow.util
+package com.github.jengelman.gradle.plugins.shadow
 
+import com.github.jengelman.gradle.plugins.shadow.util.AppendableJar
+import com.github.jengelman.gradle.plugins.shadow.util.AppendableMavenFileRepository
 import org.codehaus.plexus.util.IOUtil
 import org.gradle.testkit.runner.BuildResult
 import org.gradle.testkit.runner.GradleRunner
 import spock.lang.Specification
 import spock.lang.TempDir
 
 import java.nio.file.Path
+import java.nio.file.Paths
 import java.util.function.Function
 import java.util.jar.JarEntry
 import java.util.jar.JarFile
 
-abstract class PluginSpecification extends Specification {
+abstract class BasePluginSpecification extends Specification {
 
     @TempDir
     Path dir
@@ -118,7 +121,7 @@ abstract class PluginSpecification extends Specification {
     }
 
     AppendableMavenFileRepository repo(String path = 'maven-repo') {
-        new AppendableMavenFileRepository(dir.resolve(path).toFile())
+        new AppendableMavenFileRepository(dir.resolve(path))
     }
 
     void assertJarFileContentsEqual(File f, String path, String contents) {
@@ -161,7 +164,7 @@ abstract class PluginSpecification extends Specification {
     }
 
     AppendableJar buildJar(String path) {
-        return new AppendableJar(file(path))
+        return new AppendableJar(file(path).toPath())
     }
 
     protected File getOutput() {
@@ -172,8 +175,8 @@ abstract class PluginSpecification extends Specification {
         getFile("build/libs/${name}")
     }
 
-    protected File getTestJar(String name = 'junit-3.8.2.jar') {
-        return new File(this.class.classLoader.getResource(name).toURI())
+    protected Path getTestJar(String name = 'junit-3.8.2.jar') {
+        return Paths.get(this.class.classLoader.getResource(name).toURI())
     }
 
     protected static File getTestKitDir() {
@@ -183,4 +186,8 @@ abstract class PluginSpecification extends Specification {
         }
         return new File(gradleUserHome, "testkit")
     }
+
+    protected static String escapedPath(Path path) {
+        return path.toString().replaceAll('\\\\', '\\\\\\\\')
+    }
 }

src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/ConfigurationCacheSpec.groovy

@@ -1,8 +1,6 @@
 package com.github.jengelman.gradle.plugins.shadow
 
-import com.github.jengelman.gradle.plugins.shadow.util.PluginSpecification
-
-class ConfigurationCacheSpec extends PluginSpecification {
+class ConfigurationCacheSpec extends BasePluginSpecification {
 
     @Override
     def setup() {

src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/ConfigureShadowRelocationSpec.groovy

@@ -1,9 +1,6 @@
 package com.github.jengelman.gradle.plugins.shadow
 
-import com.github.jengelman.gradle.plugins.shadow.util.PluginSpecification
-
-
-class ConfigureShadowRelocationSpec extends PluginSpecification {
+class ConfigureShadowRelocationSpec extends BasePluginSpecification {
 
     def "auto relocate plugin dependencies"() {
         given:

src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/FilteringSpec.groovy

@@ -1,12 +1,11 @@
 package com.github.jengelman.gradle.plugins.shadow
 
-import com.github.jengelman.gradle.plugins.shadow.util.PluginSpecification
 import org.gradle.testkit.runner.BuildResult
 import org.gradle.testkit.runner.TaskOutcome
 import spock.lang.Ignore
 import spock.lang.Issue
 
-class FilteringSpec extends PluginSpecification {
+class FilteringSpec extends BasePluginSpecification {
 
     @Override
     def setup() {

src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/PublishingSpec.groovy

@@ -1,14 +1,13 @@
 package com.github.jengelman.gradle.plugins.shadow
 
 import com.github.jengelman.gradle.plugins.shadow.util.AppendableMavenFileRepository
-import com.github.jengelman.gradle.plugins.shadow.util.PluginSpecification
 import groovy.json.JsonSlurper
 import groovy.xml.XmlSlurper
 import org.gradle.api.attributes.Bundling
 import org.gradle.api.attributes.Usage
 import spock.lang.Issue
 
-class PublishingSpec extends PluginSpecification {
+class PublishingSpec extends BasePluginSpecification {
 
     AppendableMavenFileRepository publishingRepo
 
@@ -60,14 +59,14 @@ class PublishingSpec extends PluginSpecification {
         run('publish')
 
         then:
-        File publishedFile = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0.jar').canonicalFile
+        File publishedFile = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0.jar').toFile().canonicalFile
         assert publishedFile.exists()
 
         and:
         contains(publishedFile, ['a.properties', 'a2.properties'])
 
         and:
-        File pom = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0.pom').canonicalFile
+        File pom = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0.pom').toFile().canonicalFile
         assert pom.exists()
 
         def contents = new XmlSlurper().parse(pom)
@@ -128,7 +127,7 @@ class PublishingSpec extends PluginSpecification {
         run('publish')
 
         then:
-        File publishedFile = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0-my-classifier.my-ext').canonicalFile
+        File publishedFile = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0-my-classifier.my-ext').toFile().canonicalFile
         assert publishedFile.exists()
     }
 
@@ -209,14 +208,14 @@ class PublishingSpec extends PluginSpecification {
         run('publish')
 
         then:
-        File publishedFile = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0.jar').canonicalFile
+        File publishedFile = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0.jar').toFile().canonicalFile
         assert publishedFile.exists()
 
         and:
         contains(publishedFile, ['a.properties', 'a2.properties'])
 
         and:
-        File pom = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0.pom').canonicalFile
+        File pom = publishingRepo.rootDir.resolve('shadow/maven-all/1.0/maven-all-1.0.pom').toFile().canonicalFile
         assert pom.exists()
 
         def contents = new XmlSlurper().parse(pom)
@@ -273,17 +272,17 @@ class PublishingSpec extends PluginSpecification {
         run('publish')
 
         then:
-        File mainJar = publishingRepo.rootDir.resolve('com/acme/maven/1.0/maven-1.0.jar').canonicalFile
-        File shadowJar = publishingRepo.rootDir.resolve('com/acme/maven/1.0/maven-1.0-all.jar').canonicalFile
+        File mainJar = publishingRepo.rootDir.resolve('com/acme/maven/1.0/maven-1.0.jar').toFile().canonicalFile
+        File shadowJar = publishingRepo.rootDir.resolve('com/acme/maven/1.0/maven-1.0-all.jar').toFile().canonicalFile
         assert mainJar.exists()
         assert shadowJar.exists()
 
         and:
         contains(shadowJar, ['a.properties', 'a2.properties'])
 
         and: "publishes both a POM file and a Gradle metadata file"
-        File pom = publishingRepo.rootDir.resolve('com/acme/maven/1.0/maven-1.0.pom').canonicalFile
-        File gmm = publishingRepo.rootDir.resolve('com/acme/maven/1.0/maven-1.0.module').canonicalFile
+        File pom = publishingRepo.rootDir.resolve('com/acme/maven/1.0/maven-1.0.pom').toFile().canonicalFile
+        File gmm = publishingRepo.rootDir.resolve('com/acme/maven/1.0/maven-1.0.module').toFile().canonicalFile
         pom.exists()
         gmm.exists()
 
@@ -328,13 +327,13 @@ class PublishingSpec extends PluginSpecification {
 
         and: "verify shadow publication"
         assertions {
-            shadowJar = publishingRepo.rootDir.resolve('com/acme/maven-all/1.0/maven-all-1.0-all.jar').canonicalFile
+            shadowJar = publishingRepo.rootDir.resolve('com/acme/maven-all/1.0/maven-all-1.0-all.jar').toFile().canonicalFile
             assert shadowJar.exists()
             contains(shadowJar, ['a.properties', 'a2.properties'])
         }
 
         assertions {
-            pom = publishingRepo.rootDir.resolve('com/acme/maven-all/1.0/maven-all-1.0.pom').canonicalFile
+            pom = publishingRepo.rootDir.resolve('com/acme/maven-all/1.0/maven-all-1.0.pom').toFile().canonicalFile
             assert pom.exists()
             pomContents = new XmlSlurper().parse(pom)
             assert pomContents.dependencies[0].dependency.size() == 1
@@ -351,7 +350,7 @@ class PublishingSpec extends PluginSpecification {
         }
 
         assertions {
-            gmm = publishingRepo.rootDir.resolve('com/acme/maven-all/1.0/maven-all-1.0.module').canonicalFile
+            gmm = publishingRepo.rootDir.resolve('com/acme/maven-all/1.0/maven-all-1.0.module').toFile().canonicalFile
             assert gmm.exists()
             gmmContents = new JsonSlurper().parse(gmm)
             assert gmmContents.variants.size() == 1

src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/RelocationSpec.groovy

@@ -1,13 +1,12 @@
 package com.github.jengelman.gradle.plugins.shadow
 
-import com.github.jengelman.gradle.plugins.shadow.util.PluginSpecification
 import spock.lang.Ignore
 import spock.lang.Issue
 
 import java.util.jar.Attributes
 import java.util.jar.JarFile
 
-class RelocationSpec extends PluginSpecification {
+class RelocationSpec extends BasePluginSpecification {
 
     @Issue('SHADOW-58')
     def "relocate dependency files"() {

src/funcTest/groovy/com/github/jengelman/gradle/plugins/shadow/ShadowPluginSpec.groovy

@@ -1,7 +1,6 @@
 package com.github.jengelman.gradle.plugins.shadow
 
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
-import com.github.jengelman.gradle.plugins.shadow.util.PluginSpecification
 import org.gradle.api.JavaVersion
 import org.gradle.api.Project
 import org.gradle.api.artifacts.Configuration
@@ -17,7 +16,7 @@ import spock.lang.Unroll
 import java.util.jar.Attributes
 import java.util.jar.JarFile
 
-class ShadowPluginSpec extends PluginSpecification {
+class ShadowPluginSpec extends BasePluginSpecification {
 
     def 'apply plugin'() {
         given:
@@ -63,7 +62,7 @@ class ShadowPluginSpec extends PluginSpecification {
     @Unroll
     def 'Compatible with Gradle #version'() {
         given:
-        File one = buildJar('one.jar').insertFile('META-INF/services/shadow.Shadow',
+        def one = buildJar('one.jar').insert('META-INF/services/shadow.Shadow',
             'one # NOTE: No newline terminates this line/file').write()
 
         repo.module('shadow', 'two', '1.0').insertFile('META-INF/services/shadow.Shadow',
@@ -1272,8 +1271,4 @@ class ShadowPluginSpec extends PluginSpecification {
         def jarFile = new JarFile(output("shadow-1.0-tests.jar"))
         assert jarFile.getEntry('junit') != null
     }
-
-    private String escapedPath(File file) {
-        file.path.replaceAll('\\\\', '\\\\\\\\')
-    }
 }