Correct functional test kits (#1297)

* Move buildJar into super

* Rename writeMainClass to writeClass

* Replace main.class hardcode

* Remove unnecessary inline functions

* Rearrange properties

* Mark AfterAll for doLast

* Replace unnecessary project.files usages

* Fix things

Author: Goooler

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/ApplicationPluginTest.kt

@@ -31,6 +31,8 @@ import org.junit.jupiter.api.Test
 
 @ExperimentalPathApi
 class ApplicationPluginTest : BasePluginTest() {
+  private lateinit var mainClass: String
+
   @Test
   fun integrationWithApplicationPluginAndJavaToolchains() {
     prepare(
@@ -73,7 +75,7 @@ class ApplicationPluginTest : BasePluginTest() {
 
     commonAssertions(
       jarPath("myapp-shadow/lib/myapp-1.0-all.jar", installPath),
-      entriesContained = arrayOf("my/Main.class", *junitEntries),
+      entriesContained = arrayOf(mainClass, *junitEntries),
     )
 
     val unixScript = path("myapp-shadow/bin/myapp", installPath)
@@ -114,7 +116,7 @@ class ApplicationPluginTest : BasePluginTest() {
   )
   @Test
   fun canOverrideMainClassAttrInManifestBlock() {
-    writeMainClass(className = "Main2")
+    val main2Class = writeClass(className = "Main2")
     prepare(
       projectBlock = """
         shadowJar {
@@ -135,7 +137,7 @@ class ApplicationPluginTest : BasePluginTest() {
     assertions(run(runShadowTask).output, "foo")
     commonAssertions(
       jarPath("build/install/myapp-shadow/lib/myapp-1.0-all.jar"),
-      entriesContained = entriesInA + arrayOf("my/Main.class", "my/Main2.class"),
+      entriesContained = entriesInA + arrayOf(mainClass, main2Class),
       mainClassAttr = "my.Main2",
     )
 
@@ -216,7 +218,7 @@ class ApplicationPluginTest : BasePluginTest() {
     dependenciesBlock: String = "implementation 'my:a:1.0'",
     runShadowBlock: String = "",
   ) {
-    writeMainClass(withImports = mainClassWithImports)
+    mainClass = writeClass(withImports = mainClassWithImports)
     projectScriptPath.appendText(
       """
         apply plugin: 'application'
@@ -244,7 +246,7 @@ class ApplicationPluginTest : BasePluginTest() {
 
   private fun commonAssertions(
     jarPath: JarPath,
-    entriesContained: Array<String> = entriesInA + "my/Main.class",
+    entriesContained: Array<String> = entriesInA + mainClass,
     mainClassAttr: String = "my.Main",
     classPathAttr: String? = null,
   ) {

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/BasePluginTest.kt

@@ -12,6 +12,7 @@ import com.github.jengelman.gradle.plugins.shadow.internal.requireResourceAsPath
 import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import com.github.jengelman.gradle.plugins.shadow.transformers.ResourceTransformer
 import com.github.jengelman.gradle.plugins.shadow.util.AppendableMavenRepository
+import com.github.jengelman.gradle.plugins.shadow.util.JarBuilder
 import com.github.jengelman.gradle.plugins.shadow.util.JarPath
 import java.io.Closeable
 import java.nio.file.Path
@@ -32,6 +33,7 @@ import kotlin.io.path.writeText
 import org.gradle.testkit.runner.BuildResult
 import org.gradle.testkit.runner.GradleRunner
 import org.gradle.testkit.runner.TaskOutcome
+import org.junit.jupiter.api.AfterAll
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.BeforeAll
 import org.junit.jupiter.api.BeforeEach
@@ -50,6 +52,16 @@ abstract class BasePluginTest {
   lateinit var entriesInB: Array<String>
   lateinit var entriesInAB: Array<String>
 
+  val shadowJarTask = ":$SHADOW_JAR_TASK_NAME"
+  val serverShadowJarTask = ":server:$SHADOW_JAR_TASK_NAME"
+  val runShadowTask = ":$SHADOW_RUN_TASK_NAME"
+  val shadowDistZipTask = ":shadowDistZip"
+
+  val projectScriptPath: Path get() = path("build.gradle")
+  val settingsScriptPath: Path get() = path("settings.gradle")
+  open val outputShadowJar: JarPath get() = jarPath("build/libs/my-1.0-all.jar")
+  val outputServerShadowJar: JarPath get() = jarPath("server/build/libs/server-1.0-all.jar")
+
   @BeforeAll
   open fun doFirst() {
     localRepo = AppendableMavenRepository(
@@ -87,21 +99,12 @@ abstract class BasePluginTest {
     println(projectScriptPath.readText())
   }
 
-  @OptIn(ExperimentalPathApi::class)
+  @AfterAll
   fun doLast() {
+    @OptIn(ExperimentalPathApi::class)
     localRepo.root.deleteRecursively()
   }
 
-  val shadowJarTask = ":$SHADOW_JAR_TASK_NAME"
-  val serverShadowJarTask = ":server:$SHADOW_JAR_TASK_NAME"
-  val runShadowTask = ":$SHADOW_RUN_TASK_NAME"
-  val shadowDistZipTask = ":shadowDistZip"
-
-  val projectScriptPath: Path get() = path("build.gradle")
-  val settingsScriptPath: Path get() = path("settings.gradle")
-  open val outputShadowJar: JarPath get() = jarPath("build/libs/my-1.0-all.jar")
-  val outputServerShadowJar: JarPath get() = jarPath("server/build/libs/server-1.0-all.jar")
-
   fun getDefaultProjectBuildScript(
     plugin: String = "java",
     withGroup: Boolean = false,
@@ -159,14 +162,18 @@ abstract class BasePluginTest {
     }
   }
 
-  inline fun run(
+  fun buildJar(relative: String, builder: JarBuilder.() -> Unit): Path {
+    return JarBuilder(path("temp/$relative")).apply(builder).write()
+  }
+
+  fun run(
     vararg tasks: String,
     runnerBlock: (GradleRunner) -> GradleRunner = { it },
   ): BuildResult {
     return runnerBlock(runner(tasks.toList())).build().assertNoDeprecationWarnings()
   }
 
-  inline fun runWithFailure(
+  fun runWithFailure(
     vararg tasks: String,
     runnerBlock: (GradleRunner) -> GradleRunner = { it },
   ): BuildResult {
@@ -189,17 +196,16 @@ abstract class BasePluginTest {
     }.publish()
   }
 
-  fun writeMainClass(
+  fun writeClass(
     sourceSet: String = "main",
     packageName: String = "my",
     withImports: Boolean = false,
     className: String = "Main",
     isJava: Boolean = true,
-  ): String {
-    if (isJava) {
-      val imports = if (withImports) "import junit.framework.Test;" else ""
-      val classRef = if (withImports) "\"Refs: \" + Test.class.getName()" else "\"Refs: null\""
-      path("src/$sourceSet/java/$packageName/$className.java").writeText(
+    classContent: () -> String = {
+      if (isJava) {
+        val imports = if (withImports) "import junit.framework.Test;" else ""
+        val classRef = if (withImports) "\"Refs: \" + Test.class.getName()" else "\"Refs: null\""
         """
           package $packageName;
           $imports
@@ -211,12 +217,10 @@ abstract class BasePluginTest {
               System.out.println($classRef);
             }
           }
-        """.trimIndent(),
-      )
-    } else {
-      val imports = if (withImports) "import junit.framework.Test;" else ""
-      val classRef = if (withImports) "\"Refs: \" + Test.class.getName()" else "\"Refs: null\""
-      path("src/$sourceSet/kotlin/$packageName/$className.kt").writeText(
+        """.trimIndent()
+      } else {
+        val imports = if (withImports) "import junit.framework.Test;" else ""
+        val classRef = if (withImports) "\"Refs: \" + Test.class.getName()" else "\"Refs: null\""
         """
           package $packageName
           $imports
@@ -226,8 +230,14 @@ abstract class BasePluginTest {
             println(content)
             println($classRef)
           }
-        """.trimIndent(),
-      )
+        """.trimIndent()
+      }
+    },
+  ): String {
+    if (isJava) {
+      path("src/$sourceSet/java/$packageName/$className.java").writeText(classContent())
+    } else {
+      path("src/$sourceSet/kotlin/$packageName/$className.kt").writeText(classContent())
     }
     val baseClassPath = packageName.replace('.', '/') + "/$className"
     return if (isJava) "$baseClassPath.class" else "${baseClassPath}Kt.class"

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/JavaPluginTest.kt

@@ -73,7 +73,7 @@ class JavaPluginTest : BasePluginTest() {
     disabledReason = "Gradle 8.3 doesn't support Java 21.",
   )
   fun compatibleWithMinGradleVersion() {
-    writeMainClass(withImports = true)
+    val mainClass = writeClass(withImports = true)
     projectScriptPath.appendText(
       """
         dependencies {
@@ -88,7 +88,7 @@ class JavaPluginTest : BasePluginTest() {
 
     assertThat(outputShadowJar).useAll {
       containsEntries(
-        "my/Main.class",
+        mainClass,
         *junitEntries,
       )
     }
@@ -505,7 +505,7 @@ class JavaPluginTest : BasePluginTest() {
   )
   @Test
   fun canRegisterCustomShadowJarTask() {
-    writeMainClass(sourceSet = "test", withImports = true)
+    val mainClass = writeClass(sourceSet = "test", withImports = true)
     val testShadowJarTask = "testShadowJar"
     projectScriptPath.appendText(
       """
@@ -530,7 +530,7 @@ class JavaPluginTest : BasePluginTest() {
     assertThat(result).taskOutcomeEquals(":$testShadowJarTask", SUCCESS)
     assertThat(jarPath("build/libs/my-1.0-tests.jar")).useAll {
       containsEntries(
-        "my/Main.class",
+        mainClass,
         *junitEntries,
       )
       getMainAttr(mainClassAttributeKey).isNotNull()
@@ -586,12 +586,12 @@ class JavaPluginTest : BasePluginTest() {
   fun failBuildIfProcessingBadJar() {
     val badJarPath = path("bad.jar").apply {
       writeText("A bad jar.")
-    }.toUri().toURL().path
+    }
 
     projectScriptPath.appendText(
       """
         dependencies {
-          implementation files('$badJarPath')
+          ${implementationFiles(badJarPath)}
         }
       """.trimIndent(),
     )
@@ -606,7 +606,7 @@ class JavaPluginTest : BasePluginTest() {
 
   @Test
   fun worksWithArchiveFileName() {
-    writeMainClass()
+    val mainClass = writeClass()
     projectScriptPath.appendText(
       """
         dependencies {
@@ -622,7 +622,7 @@ class JavaPluginTest : BasePluginTest() {
 
     assertThat(jarPath("build/libs/my-shadow.tar")).useAll {
       containsEntries(
-        "my/Main.class",
+        mainClass,
         *junitEntries,
       )
     }
@@ -659,12 +659,12 @@ class JavaPluginTest : BasePluginTest() {
 
   @Test
   fun canAddExtraFilesIntoShadowJar() {
-    writeMainClass()
+    val mainClass = writeClass()
     path("Foo").writeText("Foo")
     projectScriptPath.appendText(
       """
         $shadowJar {
-          from(files('${artifactAJar.toUri().toURL().path}')) {
+          from(file('${artifactAJar.toUri().toURL().path}')) {
             into('META-INF')
           }
           from('Foo') {
@@ -678,7 +678,7 @@ class JavaPluginTest : BasePluginTest() {
 
     assertThat(outputShadowJar).useAll {
       containsEntries(
-        "my/Main.class",
+        mainClass,
         "META-INF/a-1.0.jar",
         "Bar/Foo",
       )
@@ -693,7 +693,7 @@ class JavaPluginTest : BasePluginTest() {
     }
     assertThat(jarPath(unzipped.name)).useAll {
       containsEntries(*entriesInA)
-      doesNotContainEntries("my/Main.class")
+      doesNotContainEntries(mainClass)
     }
   }
 }

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/KmpPluginTest.kt

@@ -21,7 +21,7 @@ class KmpPluginTest : BasePluginTest() {
 
   @Test
   fun compatKmpJvmTarget() {
-    val mainClass = writeMainClass(sourceSet = "jvmMain", isJava = false)
+    val mainClass = writeClass(sourceSet = "jvmMain", isJava = false)
     projectScriptPath.appendText(
       """
         kotlin {

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/RelocationTest.kt

@@ -26,7 +26,7 @@ class RelocationTest : BasePluginTest() {
   @ParameterizedTest
   @MethodSource("prefixProvider")
   fun autoRelocation(relocationPrefix: String) {
-    val mainClass = writeMainClass()
+    val mainClass = writeClass()
     projectScriptPath.appendText(
       """
         dependencies {
@@ -63,7 +63,7 @@ class RelocationTest : BasePluginTest() {
   )
   @Test
   fun relocateDependencyFiles() {
-    val mainClass = writeMainClass()
+    val mainClass = writeClass()
     projectScriptPath.appendText(
       """
         dependencies {
@@ -104,7 +104,7 @@ class RelocationTest : BasePluginTest() {
 
   @Test
   fun relocateDependencyFilesWithFiltering() {
-    val mainClass = writeMainClass()
+    val mainClass = writeClass()
     projectScriptPath.appendText(
       """
         dependencies {
@@ -355,7 +355,7 @@ class RelocationTest : BasePluginTest() {
     // Minus 3 sec to avoid the time difference between the file system and the JVM.
     val currentTimeMillis = System.currentTimeMillis() - 3.seconds.inWholeMilliseconds
     val junitEntryTimeRange = junitRawEntries.map { it.time }.let { it.min()..it.max() }
-    writeMainClass(withImports = true)
+    writeClass(withImports = true)
     projectScriptPath.appendText(
       """
         dependencies {

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/RelocationCachingTest.kt

@@ -18,11 +18,11 @@ class RelocationCachingTest : BaseCachingTest() {
         }
       """.trimIndent() + System.lineSeparator(),
     )
-    writeMainClass(withImports = true)
+    val mainClass = writeClass(withImports = true)
 
     assertCompositeExecutions {
       containsEntries(
-        "my/Main.class",
+        mainClass,
         *junitEntries,
       )
     }
@@ -39,7 +39,7 @@ class RelocationCachingTest : BaseCachingTest() {
 
     assertCompositeExecutions {
       containsEntries(
-        "my/Main.class",
+        mainClass,
         *shadowedEntries,
       )
       doesNotContainEntries(