enable build cache by default in tests (so they are faster!)

aSemy · aSemy · commit 1cdbcc07417c · 2024-06-02T10:35:35.000+02:00
diff --git a/gradle.properties b/gradle.properties
@@ -1,10 +1,8 @@
 org.gradle.jvmargs=-Dfile.encoding=UTF-8 -XX:+HeapDumpOnOutOfMemoryError -Xmx4g -XX:MaxMetaspaceSize=1g
 
 org.gradle.caching=true
-
 org.gradle.configuration-cache=true
 org.gradle.configuration-cache-problems=warn
-
 org.gradle.parallel=true
 org.gradle.welcome=never
 
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/DefaultConfigTests.kt b/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/DefaultConfigTests.kt
@@ -5,8 +5,7 @@ import dev.adamko.kotlin.binary_compatibility_validator.test.utils.api.*
 import io.kotest.matchers.comparables.shouldBeEqualComparingTo
 import io.kotest.matchers.file.shouldBeEmpty
 import io.kotest.matchers.string.shouldContain
-import org.gradle.testkit.runner.TaskOutcome.FAILED
-import org.gradle.testkit.runner.TaskOutcome.SUCCESS
+import org.gradle.testkit.runner.TaskOutcome.*
 import org.junit.jupiter.api.Assertions.assertFalse
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.Test
@@ -160,7 +159,7 @@ internal class DefaultConfigTests : BaseKotlinGradleTest() {
     }
 
     runner.build {
-      shouldHaveRunTask(":apiDump", SUCCESS)
+      shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)
 
       assertTrue(
         rootProjectApiDump.exists(),
@@ -187,7 +186,7 @@ internal class DefaultConfigTests : BaseKotlinGradleTest() {
     }
 
     runner.build {
-      shouldHaveRunTask(":apiDump", SUCCESS)
+      shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)
 
       val apiDumpFile = rootProjectDir.resolve("api/testproject.api")
       assertTrue(apiDumpFile.exists(), "api dump file ${apiDumpFile.path} should exist")
@@ -217,7 +216,7 @@ internal class DefaultConfigTests : BaseKotlinGradleTest() {
     }
 
     runner.build {
-      shouldHaveRunTask(":apiDump", SUCCESS)
+      shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)
 
       assertTrue(rootProjectApiDump.exists(), "api dump file should exist")
 
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/IgnoredClassesTests.kt b/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/IgnoredClassesTests.kt
@@ -4,6 +4,7 @@ import dev.adamko.kotlin.binary_compatibility_validator.test.utils.api.*
 import dev.adamko.kotlin.binary_compatibility_validator.test.utils.build
 import dev.adamko.kotlin.binary_compatibility_validator.test.utils.shouldHaveRunTask
 import io.kotest.matchers.comparables.shouldBeEqualComparingTo
+import org.gradle.testkit.runner.TaskOutcome.FROM_CACHE
 import org.gradle.testkit.runner.TaskOutcome.SUCCESS
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.Test
@@ -78,7 +79,7 @@ internal class IgnoredClassesTests : BaseKotlinGradleTest() {
     }
 
     runner.build {
-      shouldHaveRunTask(":apiDump", SUCCESS)
+      shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)
 
       assertTrue(rootProjectApiDump.exists(), "api dump file should exist")
 
@@ -107,7 +108,7 @@ internal class IgnoredClassesTests : BaseKotlinGradleTest() {
     }
 
     runner.build().apply {
-      shouldHaveRunTask(":apiDump", SUCCESS)
+      shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)
 
       assertTrue(rootProjectApiDump.exists(), "api dump file should exist")
 
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/JvmProjectTests.kt b/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/JvmProjectTests.kt
@@ -5,6 +5,7 @@ import dev.adamko.kotlin.binary_compatibility_validator.test.utils.build
 import dev.adamko.kotlin.binary_compatibility_validator.test.utils.invariantNewlines
 import dev.adamko.kotlin.binary_compatibility_validator.test.utils.shouldHaveTaskWithOutcome
 import io.kotest.matchers.shouldBe
+import org.gradle.testkit.runner.TaskOutcome.FROM_CACHE
 import org.gradle.testkit.runner.TaskOutcome.SUCCESS
 import org.junit.jupiter.api.Test
 
@@ -24,7 +25,7 @@ class JvmProjectTests : BaseKotlinGradleTest() {
       }
     }
     runner.build {
-      shouldHaveTaskWithOutcome(":apiDump", SUCCESS)
+      shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)
 
       val expected = readResourceFile("/examples/classes/GeneratedSources.dump")
       rootProjectApiDump.readText().invariantNewlines() shouldBe expected
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/KlibVerificationTests.kt b/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/KlibVerificationTests.kt
@@ -692,7 +692,7 @@ internal class KlibVerificationTests : BaseKotlinGradleTest() {
     }
 
     runner.build {
-      shouldHaveTaskWithOutcome(":apiDump", SUCCESS)
+      shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)
       rootProjectApiDump.parentFile.shouldBeEmptyDirectory()
     }
   }
@@ -767,7 +767,7 @@ internal class KlibVerificationTests : BaseKotlinGradleTest() {
     projectName: String = "testproject",
   ) {
     withClue(output) {
-      shouldHaveRunTask(":apiDump", SUCCESS)
+      shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)
 
       val generatedDump = rootProjectAbiDump(projectName)
 
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/MultiPlatformSingleJvmTargetTest.kt b/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/MultiPlatformSingleJvmTargetTest.kt
@@ -115,7 +115,7 @@ internal class MultiPlatformSingleJvmTargetTest : BaseKotlinGradleTest() {
     }
 
     runner.build {
-      shouldHaveRunTask(":apiDump", SUCCESS)
+      shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)
 
       val mainExpectedApi = """
         |${readResourceFile("/examples/classes/Subsub1Class.dump").trim()}
@@ -145,7 +145,7 @@ internal class MultiPlatformSingleJvmTargetTest : BaseKotlinGradleTest() {
     runner.build {
 //      shouldHaveTaskWithOutcome(":jvmApiDump", SKIPPED)
 //      shouldHaveTaskWithOutcome(":apiDump", UP_TO_DATE)
-      shouldHaveTaskWithOutcome(":apiDump", SUCCESS)
+      shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)
     }
   }
 
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/MultipleJvmTargetsTest.kt b/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/MultipleJvmTargetsTest.kt
@@ -7,8 +7,7 @@ import io.kotest.matchers.file.shouldBeAFile
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.string.shouldContain
 import java.io.File
-import org.gradle.testkit.runner.TaskOutcome.FAILED
-import org.gradle.testkit.runner.TaskOutcome.SUCCESS
+import org.gradle.testkit.runner.TaskOutcome.*
 import org.junit.jupiter.api.Test
 
 internal class MultipleJvmTargetsTest : BaseKotlinGradleTest() {
@@ -117,7 +116,7 @@ internal class MultipleJvmTargetsTest : BaseKotlinGradleTest() {
     }
     runner.build {
       withClue(output) {
-        shouldHaveRunTask(":apiDump", SUCCESS)
+        shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)
 
         val anotherExpectedApi = readResourceFile("/examples/classes/Subsub1Class.dump")
         anotherApiDump.shouldBeAFile()
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/NonPublicMarkersTest.kt b/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/NonPublicMarkersTest.kt
@@ -5,6 +5,7 @@ import dev.adamko.kotlin.binary_compatibility_validator.test.utils.build
 import dev.adamko.kotlin.binary_compatibility_validator.test.utils.shouldHaveTaskWithOutcome
 import io.kotest.matchers.file.shouldExist
 import io.kotest.matchers.shouldBe
+import org.gradle.testkit.runner.TaskOutcome.FROM_CACHE
 import org.gradle.testkit.runner.TaskOutcome.SUCCESS
 import org.junit.jupiter.api.Disabled
 import org.junit.jupiter.api.Test
@@ -97,7 +98,7 @@ class NonPublicMarkersTest : BaseKotlinGradleTest() {
     runner
       .forwardOutput()
       .build {
-        shouldHaveTaskWithOutcome(":apiDump", SUCCESS)
+        shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)
 
         rootProjectApiDump.shouldExist()
 
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/OutputDirectoryTests.kt b/modules/bcv-gradle-plugin-functional-tests/src/functionalTest/kotlin/kotlinx/validation/test/OutputDirectoryTests.kt
@@ -8,8 +8,7 @@ import io.kotest.assertions.withClue
 import io.kotest.matchers.file.shouldExist
 import io.kotest.matchers.shouldBe
 import io.kotest.matchers.string.shouldContain
-import org.gradle.testkit.runner.TaskOutcome.FAILED
-import org.gradle.testkit.runner.TaskOutcome.SUCCESS
+import org.gradle.testkit.runner.TaskOutcome.*
 import org.junit.jupiter.api.Test
 
 class OutputDirectoryTests : BaseKotlinGradleTest() {
@@ -35,7 +34,7 @@ class OutputDirectoryTests : BaseKotlinGradleTest() {
     }
 
     runner.build {
-      shouldHaveTaskWithOutcome(":apiDump", SUCCESS)
+      shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)
 
       val dumpFile = rootProjectDir.resolve("custom/${rootProjectDir.name}.api")
       dumpFile.shouldExist()
@@ -95,7 +94,7 @@ class OutputDirectoryTests : BaseKotlinGradleTest() {
     }
 
     runner.build {
-      shouldHaveTaskWithOutcome(":apiDump", SUCCESS)
+      shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)
 
       val dumpFile = rootProjectDir.resolve("validation/api/${rootProjectDir.name}.api")
       dumpFile.shouldExist()
diff --git a/modules/bcv-gradle-plugin-functional-tests/src/testFixtures/kotlin/api/TestDsl.kt b/modules/bcv-gradle-plugin-functional-tests/src/testFixtures/kotlin/api/TestDsl.kt
@@ -221,7 +221,7 @@ class Runner {
   var configurationCache: Boolean = true
   var rerunTasks: Boolean = false
   var rerunTask: Boolean = false
-  var buildCache: Boolean = false
+  var buildCache: Boolean = true
   var stacktrace: Boolean = true
   var continues: Boolean = true
 
diff --git a/modules/bcv-gradle-plugin/src/testFixtures/kotlin/kotestGradleAssertions.kt b/modules/bcv-gradle-plugin/src/testFixtures/kotlin/kotestGradleAssertions.kt
@@ -34,14 +34,18 @@ infix fun BuildResult?.shouldHaveRunTask(taskPath: String): BuildTask {
   return this?.task(taskPath)!!
 }
 
-/** Assert that a task ran, with an [expected outcome][expectedOutcome]. */
+/** Assert that a task ran, with any [expected outcome][expectedOutcomes]. */
 fun BuildResult?.shouldHaveRunTask(
   taskPath: String,
-  expectedOutcome: TaskOutcome
+  vararg expectedOutcomes: TaskOutcome
 ): BuildTask {
   this should haveTask(taskPath)
   val task = this?.task(taskPath)!!
-  task should haveOutcome(expectedOutcome)
+  if (expectedOutcomes.size == 1) {
+    task should haveOutcome(expectedOutcomes.single())
+  } else {
+    task should haveAnyOutcome(expectedOutcomes.toList())
+  }
   return task
 }
 
@@ -71,6 +75,10 @@ infix fun BuildTask?.shouldHaveOutcome(outcome: TaskOutcome) {
   this should haveOutcome(outcome)
 }
 
+fun BuildTask?.shouldHaveAnyOutcome(vararg outcomes: TaskOutcome) {
+  this should haveAnyOutcome(outcomes.toList())
+}
+
 infix fun BuildTask?.shouldNotHaveOutcome(outcome: TaskOutcome) {
   this shouldNot haveOutcome(outcome)
 }
@@ -84,6 +92,18 @@ private fun haveOutcome(outcome: TaskOutcome): Matcher<BuildTask?> =
     )
   }
 
-fun BuildResult.shouldHaveTaskWithOutcome(taskPath: String, outcome: TaskOutcome) {
-  this shouldHaveRunTask taskPath shouldHaveOutcome outcome
+private fun haveAnyOutcome(outcomes: List<TaskOutcome>): Matcher<BuildTask?> =
+  neverNullMatcher { value ->
+    MatcherResult(
+      value.outcome in outcomes,
+      { "Task ${value.path} should have any outcome ${outcomes.sorted()}, but was ${value.outcome}" },
+      { "Task ${value.path} should not have any outcome ${outcomes.sorted()}, but was ${value.outcome}" },
+    )
+  }
+
+fun BuildResult.shouldHaveTaskWithOutcome(
+  taskPath: String,
+  vararg outcomes: TaskOutcome
+) {
+  (this shouldHaveRunTask taskPath).shouldHaveAnyOutcome(outcomes = outcomes)
 }

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import dev.adamko.kotlin.binary_compatibility_validator.test.utils.build`
`5`	`5`	`import dev.adamko.kotlin.binary_compatibility_validator.test.utils.invariantNewlines`
`6`	`6`	`import dev.adamko.kotlin.binary_compatibility_validator.test.utils.shouldHaveTaskWithOutcome`
`7`	`7`	`import io.kotest.matchers.shouldBe`
	`8`	`+import org.gradle.testkit.runner.TaskOutcome.FROM_CACHE`
`8`	`9`	`import org.gradle.testkit.runner.TaskOutcome.SUCCESS`
`9`	`10`	`import org.junit.jupiter.api.Test`
`10`	`11`
`@@ -24,7 +25,7 @@ class JvmProjectTests : BaseKotlinGradleTest() {`
`24`	`25`	`}`
`25`	`26`	`}`
`26`	`27`	`runner.build {`
`27`		`- shouldHaveTaskWithOutcome(":apiDump", SUCCESS)`
	`28`	`+ shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)`
`28`	`29`
`29`	`30`	`val expected = readResourceFile("/examples/classes/GeneratedSources.dump")`
`30`	`31`	`rootProjectApiDump.readText().invariantNewlines() shouldBe expected`
Original file line number	Diff line number	Diff line change
`@@ -692,7 +692,7 @@ internal class KlibVerificationTests : BaseKotlinGradleTest() {`
`692`	`692`	`}`
`693`	`693`
`694`	`694`	`runner.build {`
`695`		`- shouldHaveTaskWithOutcome(":apiDump", SUCCESS)`
	`695`	`+ shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)`
`696`	`696`	`rootProjectApiDump.parentFile.shouldBeEmptyDirectory()`
`697`	`697`	`}`
`698`	`698`	`}`
`@@ -767,7 +767,7 @@ internal class KlibVerificationTests : BaseKotlinGradleTest() {`
`767`	`767`	`projectName: String = "testproject",`
`768`	`768`	`) {`
`769`	`769`	`withClue(output) {`
`770`		`- shouldHaveRunTask(":apiDump", SUCCESS)`
	`770`	`+ shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)`
`771`	`771`
`772`	`772`	`val generatedDump = rootProjectAbiDump(projectName)`
`773`	`773`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ internal class MultiPlatformSingleJvmTargetTest : BaseKotlinGradleTest() {`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`runner.build {`
`118`		`- shouldHaveRunTask(":apiDump", SUCCESS)`
	`118`	`+ shouldHaveRunTask(":apiDump", SUCCESS, FROM_CACHE)`
`119`	`119`
`120`	`120`	`val mainExpectedApi = """`
`121`	`121`	`\|${readResourceFile("/examples/classes/Subsub1Class.dump").trim()}`
`@@ -145,7 +145,7 @@ internal class MultiPlatformSingleJvmTargetTest : BaseKotlinGradleTest() {`
`145`	`145`	`runner.build {`
`146`	`146`	`// shouldHaveTaskWithOutcome(":jvmApiDump", SKIPPED)`
`147`	`147`	`// shouldHaveTaskWithOutcome(":apiDump", UP_TO_DATE)`
`148`		`- shouldHaveTaskWithOutcome(":apiDump", SUCCESS)`
	`148`	`+ shouldHaveTaskWithOutcome(":apiDump", SUCCESS, FROM_CACHE)`
`149`	`149`	`}`
`150`	`150`	`}`
`151`	`151`