Skip to content

Polish transformer caching tests #1209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Goooler merged 7 commits into from
Jan 28, 2025
Merged

Polish transformer caching tests #1209

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3d2bbe4
Use Path.deleteExisting
Goooler Jan 28, 2025
40d6329
Reuse assertions in shadowJarIsCachedCorrectlyWhenUsingServiceFileTra…
Goooler Jan 28, 2025
aaaa2f4
Reuse assertions in shadowJarIsCachedCorrectlyWhenUsingAppendingTrans…
Goooler Jan 28, 2025
6e4ce01
Reuse assertions in shadowJarIsCachedCorrectlyWhenUsingXmlAppendingTr…
Goooler Jan 28, 2025
d93da72
Reuse assertions in shadowJarIsCachedCorrectlyWhenUsingGroovyExtensio…
Goooler Jan 28, 2025
079425f
Rename TransformCachingTest to TransformerCachingTest
Goooler Jan 28, 2025
7b5ca4a
Reuse writeMainClass
Goooler Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 54 additions & 65 deletions ...ns/shadow/caching/TransformCachingTest.kt → .../shadow/caching/TransformerCachingTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,38 @@
package com.github.jengelman.gradle.plugins.shadow.caching

import assertk.assertThat
import assertk.assertions.contains
import assertk.assertions.isEqualTo
import com.github.jengelman.gradle.plugins.shadow.transformers.AppendingTransformer
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer
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.getContent
import kotlin.io.path.appendText
import kotlin.io.path.deleteExisting
import kotlin.io.path.readText
import kotlin.io.path.writeText
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test

class TransformCachingTest : BaseCachingTest() {
class TransformerCachingTest : BaseCachingTest() {
@BeforeEach
override fun setup() {
super.setup()
writeMainClass()
}

@Test
fun shadowJarIsCachedCorrectlyWhenUsingServiceFileTransformer() {
writeMainClass()
val assertions = {
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
}

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions()

projectScriptPath.appendText(
transform<ServiceFileTransformer>(
Expand All @@ -28,40 +41,34 @@ class TransformCachingTest : BaseCachingTest() {
""".trimIndent(),
),
)

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions()

assertExecutionsAreCachedAndUpToDate()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions()

val replaced = projectScriptPath.readText().replace("META-INF/foo", "META-INF/bar")
projectScriptPath.writeText(replaced)

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions()

assertExecutionsAreCachedAndUpToDate()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions()
}

@Test
fun shadowJarIsCachedCorrectlyWhenUsingAppendingTransformer() {
path("src/main/resources/foo/bar.properties").writeText("foo=bar")
writeMainClass()
val assertions = { name: String ->
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/$name.properties")
getContent("foo/$name.properties").isEqualTo("foo=$name")
}
}

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions("bar")

projectScriptPath.appendText(
transform<AppendingTransformer>(
Expand All @@ -70,42 +77,36 @@ class TransformCachingTest : BaseCachingTest() {
""".trimIndent(),
),
)

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/bar.properties")
}
assertions("bar")

assertExecutionsAreCachedAndUpToDate()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/bar.properties")
}
assertions("bar")

path("src/main/resources/foo/bar.properties").toFile().delete()
path("src/main/resources/foo/bar.properties").deleteExisting()
path("src/main/resources/foo/baz.properties").writeText("foo=baz")
val replaced = projectScriptPath.readText().replace("foo/bar.properties", "foo/baz.properties")
projectScriptPath.writeText(replaced)

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/baz.properties")
}
assertions("baz")

assertExecutionsAreCachedAndUpToDate()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/baz.properties")
}
assertions("baz")
}

@Test
fun shadowJarIsCachedCorrectlyWhenUsingXmlAppendingTransformer() {
path("src/main/resources/foo/bar.xml").writeText("<foo>bar</foo>")
writeMainClass()
val assertions = { name: String ->
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/$name.xml")
getContent("foo/$name.xml").contains("<foo>$name</foo>")
}
}

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions("bar")

projectScriptPath.appendText(
transform<XmlAppendingTransformer>(
Expand All @@ -114,54 +115,42 @@ class TransformCachingTest : BaseCachingTest() {
""".trimIndent(),
),
)

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/bar.xml")
}
assertions("bar")

assertExecutionsAreCachedAndUpToDate()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/bar.xml")
}
assertions("bar")

path("src/main/resources/foo/bar.xml").toFile().delete()
path("src/main/resources/foo/bar.xml").deleteExisting()
path("src/main/resources/foo/baz.xml").writeText("<foo>baz</foo>")
val replaced = projectScriptPath.readText().replace("foo/bar.xml", "foo/baz.xml")
projectScriptPath.writeText(replaced)

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/baz.xml")
}
assertions("baz")

assertExecutionsAreCachedAndUpToDate()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class", "foo/baz.xml")
}
assertions("baz")
}

@Test
fun shadowJarIsCachedCorrectlyWhenUsingGroovyExtensionModuleTransformer() {
writeMainClass()
val assertions = {
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
}

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions()

projectScriptPath.appendText(
transform<GroovyExtensionModuleTransformer>(),
)

assertFirstExecutionSuccess()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions()

assertExecutionsAreCachedAndUpToDate()
assertThat(outputShadowJar).useAll {
containsEntries("shadow/Main.class")
}
assertions()
}
}