Cleanups

Goooler · Goooler · commit 2bbe80b97bad · 2025-01-09T19:50:30.000+08:00
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/ApplicationTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/ApplicationTest.kt
@@ -8,7 +8,6 @@ import assertk.assertions.exists
 import assertk.assertions.isEqualTo
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
 import com.github.jengelman.gradle.plugins.shadow.util.isRegular
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import kotlin.io.path.appendText
 import kotlin.io.path.readText
 import kotlin.io.path.writeText
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/BasePluginTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/BasePluginTest.kt
@@ -1,6 +1,9 @@
 package com.github.jengelman.gradle.plugins.shadow
 
 import assertk.Assert
+import assertk.all
+import assertk.assertThat
+import assertk.assertions.doesNotContain
 import assertk.assertions.isEqualTo
 import assertk.assertions.isNotNull
 import com.github.jengelman.gradle.plugins.shadow.ShadowApplicationPlugin.Companion.SHADOW_RUN_TASK_NAME
@@ -10,6 +13,7 @@ import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import com.github.jengelman.gradle.plugins.shadow.transformers.Transformer
 import com.github.jengelman.gradle.plugins.shadow.util.AppendableMavenRepository
 import com.github.jengelman.gradle.plugins.shadow.util.JarPath
+import java.io.Closeable
 import java.nio.file.Path
 import java.util.Properties
 import kotlin.io.path.ExperimentalPathApi
@@ -35,7 +39,7 @@ import org.junit.jupiter.api.TestInstance
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 abstract class BasePluginTest {
-  lateinit var root: Path
+  lateinit var projectRoot: Path
   lateinit var localRepo: AppendableMavenRepository
 
   @BeforeAll
@@ -60,7 +64,7 @@ abstract class BasePluginTest {
 
   @BeforeEach
   open fun setup() {
-    root = createTempDirectory()
+    projectRoot = createTempDirectory()
 
     projectScriptPath.writeText(getDefaultProjectBuildScript(withGroup = true, withVersion = true))
     settingsScriptPath.writeText(getDefaultSettingsBuildScript())
@@ -71,7 +75,7 @@ abstract class BasePluginTest {
   fun cleanup() {
     runCatching {
       // TODO: workaround for https://github.com/junit-team/junit5/issues/2811.
-      root.deleteRecursively()
+      projectRoot.deleteRecursively()
     }
 
     println(projectScriptPath.readText())
@@ -82,6 +86,15 @@ abstract class BasePluginTest {
     localRepo.root.deleteRecursively()
   }
 
+  open val shadowJarTask = ":$SHADOW_JAR_TASK_NAME"
+  open val runShadowTask = ":$SHADOW_RUN_TASK_NAME"
+  val serverShadowJarTask = ":server:$SHADOW_JAR_TASK_NAME"
+
+  val projectScriptPath: Path get() = path("build.gradle")
+  val settingsScriptPath: Path get() = path("settings.gradle")
+  open val outputShadowJar: JarPath get() = jarPath("build/libs/shadow-1.0-all.jar")
+  val outputServerShadowJar: JarPath get() = jarPath("server/build/libs/server-1.0-all.jar")
+
   fun getDefaultProjectBuildScript(
     javaPlugin: String = "java",
     withGroup: Boolean = false,
@@ -115,32 +128,16 @@ abstract class BasePluginTest {
     """.trimIndent() + System.lineSeparator()
   }
 
-  open val shadowJarTask = ":$SHADOW_JAR_TASK_NAME"
-  open val runShadowTask = ":$SHADOW_RUN_TASK_NAME"
-  val serverShadowJarTask = ":server:$SHADOW_JAR_TASK_NAME"
-
-  val projectScriptPath: Path
-    get() = path("build.gradle")
-
-  val settingsScriptPath: Path
-    get() = path("settings.gradle")
-
-  open val outputShadowJar: JarPath
-    get() = jarPath("build/libs/shadow-1.0-all.jar")
-
-  val outputServerShadowJar: JarPath
-    get() = jarPath("server/build/libs/server-1.0-all.jar")
-
   fun jarPath(path: String): JarPath {
-    val realPath = root.resolve(path).also {
+    val realPath = projectRoot.resolve(path).also {
       check(it.exists()) { "Path not found: $it" }
       check(it.isRegularFile()) { "Path is not a regular file: $it" }
     }
     return JarPath(realPath)
   }
 
   fun path(path: String): Path {
-    return root.resolve(path).also {
+    return projectRoot.resolve(path).also {
       if (it.exists()) return@also
       it.parent.createDirectories()
       // We should create text file only if it doesn't exist.
@@ -300,7 +297,7 @@ abstract class BasePluginTest {
 
   fun runner(
     arguments: Iterable<String> = emptyList(),
-    projectDir: Path? = root,
+    projectDir: Path? = projectRoot,
   ): GradleRunner = GradleRunner.create()
     .forwardOutput()
     .withPluginClasspath()
@@ -362,18 +359,20 @@ abstract class BasePluginTest {
     }
 
     fun BuildResult.assertNoDeprecationWarnings() = apply {
-      output.lines().forEach {
-        assert(!containsDeprecationWarning(it))
-      }
+      assertThat(output).doesNotContain(
+        "has been deprecated and is scheduled to be removed in Gradle",
+        "has been deprecated. This is scheduled to be removed in Gradle",
+      )
     }
 
-    fun Assert<BuildResult>.taskOutcomeEquals(taskPath: String, expectedOutcome: TaskOutcome) {
-      return transform { it.task(taskPath)?.outcome }.isNotNull().isEqualTo(expectedOutcome)
+    fun <T : Closeable> Assert<T>.useAll(body: Assert<T>.() -> Unit) = all {
+      body()
+      // Close the resource after all assertions are done.
+      given { it.use(block = {}) }
     }
 
-    private fun containsDeprecationWarning(output: String): Boolean {
-      return output.contains("has been deprecated and is scheduled to be removed in Gradle") ||
-        output.contains("has been deprecated. This is scheduled to be removed in Gradle")
+    fun Assert<BuildResult>.taskOutcomeEquals(taskPath: String, expectedOutcome: TaskOutcome) {
+      return transform { it.task(taskPath)?.outcome }.isNotNull().isEqualTo(expectedOutcome)
     }
   }
 }
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/FilteringTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/FilteringTest.kt
@@ -3,7 +3,6 @@ package com.github.jengelman.gradle.plugins.shadow
 import assertk.assertThat
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
 import com.github.jengelman.gradle.plugins.shadow.util.doesNotContainEntries
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import kotlin.io.path.appendText
 import kotlin.io.path.readText
 import kotlin.io.path.writeText
@@ -201,13 +200,13 @@ class FilteringTest : BasePluginTest() {
     run(serverShadowJarTask)
 
     assertThat(outputServerShadowJar).useAll {
-      doesNotContainEntries(
-        "client/Client.class",
-      )
       containsEntries(
         "server/Server.class",
         "junit/framework/Test.class",
       )
+      doesNotContainEntries(
+        "client/Client.class",
+      )
     }
   }
 
@@ -224,13 +223,13 @@ class FilteringTest : BasePluginTest() {
     run(serverShadowJarTask)
 
     assertThat(outputServerShadowJar).useAll {
-      doesNotContainEntries(
-        "junit/framework/Test.class",
-      )
       containsEntries(
         "client/Client.class",
         "server/Server.class",
       )
+      doesNotContainEntries(
+        "junit/framework/Test.class",
+      )
     }
   }
 
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/PublishingTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/PublishingTest.kt
@@ -9,7 +9,6 @@ import com.github.jengelman.gradle.plugins.shadow.util.Issue
 import com.github.jengelman.gradle.plugins.shadow.util.JarPath
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
 import com.github.jengelman.gradle.plugins.shadow.util.doesNotContainEntries
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import com.squareup.moshi.JsonAdapter
 import com.squareup.moshi.Moshi
 import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory
@@ -33,12 +32,12 @@ class PublishingTest : BasePluginTest() {
   private val gmmAdapter = moshi.adapter(GradleModuleMetadata::class.java)
   private val pomReader = MavenXpp3Reader()
 
-  private lateinit var remoteRepo: Path
+  private lateinit var remoteRepoPath: Path
 
   @BeforeEach
   override fun setup() {
     super.setup()
-    remoteRepo = root.resolve("remote-maven-repo")
+    remoteRepoPath = projectRoot.resolve("remote-maven-repo")
     settingsScriptPath.appendText("rootProject.name = 'maven'" + System.lineSeparator())
   }
 
@@ -216,7 +215,7 @@ class PublishingTest : BasePluginTest() {
   }
 
   private fun repoPath(path: String): Path {
-    return remoteRepo.resolve(path).also {
+    return remoteRepoPath.resolve(path).also {
       check(it.exists()) { "Path not found: $it" }
       check(it.isRegularFile()) { "Path is not a regular file: $it" }
     }
@@ -257,7 +256,7 @@ class PublishingTest : BasePluginTest() {
           }
           repositories {
             maven {
-              url = '${remoteRepo.toUri()}'
+              url = '${remoteRepoPath.toUri()}'
             }
           }
         }
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/RelocationTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/RelocationTest.kt
@@ -4,20 +4,18 @@ import assertk.assertFailure
 import assertk.assertThat
 import assertk.assertions.isEqualTo
 import assertk.assertions.isInstanceOf
+import assertk.fail
 import com.github.jengelman.gradle.plugins.shadow.ShadowJavaPlugin.Companion.SHADOW_JAR_TASK_NAME
 import com.github.jengelman.gradle.plugins.shadow.util.Issue
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
 import com.github.jengelman.gradle.plugins.shadow.util.doesNotContainEntries
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import java.net.URLClassLoader
 import kotlin.io.path.appendText
 import kotlin.io.path.writeText
 import org.junit.jupiter.api.Test
-import org.junit.jupiter.api.fail
 import org.opentest4j.AssertionFailedError
 
 class RelocationTest : BasePluginTest() {
-
   @Test
   fun defaultEnableRelocation() {
     projectScriptPath.appendText(
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/ShadowPluginTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/ShadowPluginTest.kt
@@ -13,7 +13,6 @@ import com.github.jengelman.gradle.plugins.shadow.util.Issue
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
 import com.github.jengelman.gradle.plugins.shadow.util.doesNotContainEntries
 import com.github.jengelman.gradle.plugins.shadow.util.isRegular
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import kotlin.io.path.appendText
 import kotlin.io.path.readText
 import kotlin.io.path.writeText
@@ -27,7 +26,6 @@ import org.junit.jupiter.api.condition.EnabledForJreRange
 import org.junit.jupiter.api.condition.JRE
 
 class ShadowPluginTest : BasePluginTest() {
-
   @Test
   fun applyPlugin() {
     val projectName = "my-shadow"
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/BaseCachingTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/BaseCachingTest.kt
@@ -16,8 +16,7 @@ import org.gradle.testkit.runner.TaskOutcome.UP_TO_DATE
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.io.TempDir
 
-sealed class BaseCachingTest : BasePluginTest() {
-
+abstract class BaseCachingTest : BasePluginTest() {
   @TempDir
   lateinit var alternateDir: Path
 
@@ -48,7 +47,7 @@ sealed class BaseCachingTest : BasePluginTest() {
       // ignore if the file does not exist
     }
     alternateDir.deleteRecursively()
-    root.copyToRecursively(alternateDir, followLinks = false, overwrite = false)
+    projectRoot.copyToRecursively(alternateDir, followLinks = false, overwrite = false)
     // check that shadowJar pulls from cache in the original directory
     assertShadowJarHasResult(firstOutcome)
     // check that shadowJar pulls from cache in a different directory
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/MinimizationCachingTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/MinimizationCachingTest.kt
@@ -4,7 +4,6 @@ import assertk.assertThat
 import com.github.jengelman.gradle.plugins.shadow.util.JarPath
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
 import com.github.jengelman.gradle.plugins.shadow.util.doesNotContainEntries
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import kotlin.io.path.appendText
 import kotlin.io.path.writeText
 import org.junit.jupiter.api.Test
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/RelocationCachingTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/RelocationCachingTest.kt
@@ -3,7 +3,6 @@ package com.github.jengelman.gradle.plugins.shadow.caching
 import assertk.assertThat
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
 import com.github.jengelman.gradle.plugins.shadow.util.doesNotContainEntries
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import kotlin.io.path.appendText
 import org.junit.jupiter.api.Test
 
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/ShadowJarCachingTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/ShadowJarCachingTest.kt
@@ -4,7 +4,6 @@ import assertk.assertThat
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
 import com.github.jengelman.gradle.plugins.shadow.util.doesNotContainEntries
 import com.github.jengelman.gradle.plugins.shadow.util.isRegular
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import kotlin.io.path.appendText
 import kotlin.io.path.readText
 import kotlin.io.path.writeText
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/TransformCachingTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/caching/TransformCachingTest.kt
@@ -7,7 +7,6 @@ import com.github.jengelman.gradle.plugins.shadow.transformers.NoOpTransformer
 import com.github.jengelman.gradle.plugins.shadow.transformers.ServiceFileTransformer
 import com.github.jengelman.gradle.plugins.shadow.transformers.XmlAppendingTransformer
 import com.github.jengelman.gradle.plugins.shadow.util.containsEntries
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import kotlin.io.path.appendText
 import kotlin.io.path.readText
 import kotlin.io.path.writeText
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/BaseTransformerTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/BaseTransformerTest.kt
@@ -4,8 +4,7 @@ import com.github.jengelman.gradle.plugins.shadow.BasePluginTest
 import com.github.jengelman.gradle.plugins.shadow.util.JarBuilder
 import java.nio.file.Path
 
-sealed class BaseTransformerTest : BasePluginTest() {
-
+abstract class BaseTransformerTest : BasePluginTest() {
   fun buildJarOne(
     builder: JarBuilder.() -> Unit = {
       insert(ENTRY_SERVICES_SHADE, CONTENT_ONE)
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformerTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ServiceFileTransformerTest.kt
@@ -3,13 +3,11 @@ package com.github.jengelman.gradle.plugins.shadow.transformers
 import assertk.assertThat
 import assertk.assertions.isEqualTo
 import com.github.jengelman.gradle.plugins.shadow.util.Issue
-import com.github.jengelman.gradle.plugins.shadow.util.useAll
 import kotlin.io.path.appendText
 import kotlin.io.path.writeText
 import org.junit.jupiter.api.Test
 
 class ServiceFileTransformerTest : BaseTransformerTest() {
-
   @Test
   fun serviceResourceTransformer() {
     projectScriptPath.appendText(
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/TransformersTest.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/TransformersTest.kt
@@ -15,7 +15,6 @@ import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.MethodSource
 
 class TransformersTest : BaseTransformerTest() {
-
   @Test
   fun manifestRetained() {
     writeMainClass()
diff --git a/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/util/JarPath.kt b/src/funcTest/kotlin/com/github/jengelman/gradle/plugins/shadow/util/JarPath.kt
@@ -29,16 +29,13 @@ class JarPath(val path: Path) :
   }
 }
 
-fun Assert<JarPath>.useAll(body: Assert<JarPath>.() -> Unit) = all {
-  body()
-  given { it.close() }
-}
-
 /**
  * Common regular assertions for [JarPath].
  */
-fun Assert<JarPath>.isRegular() = useAll {
+fun Assert<JarPath>.isRegular() = all {
   transform { it.entries().toList() }.isNotEmpty()
+  // Close the resource after all assertions are done.
+  given { it.use(block = {}) }
 }
 
 fun Assert<JarPath>.containsEntries(vararg entries: String) = transform { actual ->

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@ import com.github.jengelman.gradle.plugins.shadow.util.Issue`
`9`	`9`	`import com.github.jengelman.gradle.plugins.shadow.util.JarPath`
`10`	`10`	`import com.github.jengelman.gradle.plugins.shadow.util.containsEntries`
`11`	`11`	`import com.github.jengelman.gradle.plugins.shadow.util.doesNotContainEntries`
`12`		`-import com.github.jengelman.gradle.plugins.shadow.util.useAll`
`13`	`12`	`import com.squareup.moshi.JsonAdapter`
`14`	`13`	`import com.squareup.moshi.Moshi`
`15`	`14`	`import com.squareup.moshi.kotlin.reflect.KotlinJsonAdapterFactory`
`@@ -33,12 +32,12 @@ class PublishingTest : BasePluginTest() {`
`33`	`32`	`private val gmmAdapter = moshi.adapter(GradleModuleMetadata::class.java)`
`34`	`33`	`private val pomReader = MavenXpp3Reader()`
`35`	`34`
`36`		`- private lateinit var remoteRepo: Path`
	`35`	`+ private lateinit var remoteRepoPath: Path`
`37`	`36`
`38`	`37`	`@BeforeEach`
`39`	`38`	`override fun setup() {`
`40`	`39`	`super.setup()`
`41`		`- remoteRepo = root.resolve("remote-maven-repo")`
	`40`	`+ remoteRepoPath = projectRoot.resolve("remote-maven-repo")`
`42`	`41`	`settingsScriptPath.appendText("rootProject.name = 'maven'" + System.lineSeparator())`
`43`	`42`	`}`
`44`	`43`
`@@ -216,7 +215,7 @@ class PublishingTest : BasePluginTest() {`
`216`	`215`	`}`
`217`	`216`
`218`	`217`	`private fun repoPath(path: String): Path {`
`219`		`- return remoteRepo.resolve(path).also {`
	`218`	`+ return remoteRepoPath.resolve(path).also {`
`220`	`219`	`check(it.exists()) { "Path not found: $it" }`
`221`	`220`	`check(it.isRegularFile()) { "Path is not a regular file: $it" }`
`222`	`221`	`}`
`@@ -257,7 +256,7 @@ class PublishingTest : BasePluginTest() {`
`257`	`256`	`}`
`258`	`257`	`repositories {`
`259`	`258`	`maven {`
`260`		`- url = '${remoteRepo.toUri()}'`
	`259`	`+ url = '${remoteRepoPath.toUri()}'`
`261`	`260`	`}`
`262`	`261`	`}`
`263`	`262`	`}`