Reduce log level of test Gradle projects (#3717)

* Reduce log level of test Gradle projects ### Motivation Too many logs when using Gradle TestKit causes the tests to run slower. This is mainly because Gradle TestKit stores logs in-memory (see gradle/gradle#23965). Reducing the amount of logging would be beneficial for two reasons: - The tests can run faster. - The logs are not cluttered with unimportant messages from other Gradle tasks. We can focus on the Dokka Generator logs. However, reducing the log level to 'lifecycle' would mean that the Dokka Generator logs would not be reported. To work around this, I added an internal flag that can override the default log level of Dokka Generator. The result is that the tests run faster, and test results are easier to read and verify. ### Summary of changes - Reduce the log-level of Gradle tests to 'lifecycle' by default (this can be overridden if necessary). - Introduce an internal flag, `dokka.internal.dokkaGenerator.logLevelOverride`, in AbstractDokkaTask that can re-direct the logs of Dokka Generator to a specific level, independent from the Gradle log level. - Correctly enable `--stacktrace` on all tests, and enable it by default for all tests. ^OSIP-355 * rename property * ignore invalid log level values
Kotlin · Aug 12, 2024 · f0f6347 · f0f6347
1 parent fa96393
commit f0f6347
Show file tree

Hide file tree

Showing 21 changed files with 98 additions and 64 deletions.
diff --git a/...sts/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/...sts/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt
@@ -4,6 +4,8 @@
 
 package org.jetbrains.dokka.it.gradle
 
+import org.gradle.api.logging.LogLevel
+import org.gradle.api.logging.LogLevel.*
 import org.gradle.testkit.runner.BuildResult
 import org.gradle.testkit.runner.GradleRunner
 import org.gradle.tooling.GradleConnectionException
@@ -42,7 +44,21 @@ abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() {
         buildVersions: BuildVersions,
         vararg arguments: String,
         jvmArgs: List<String> = listOf("-Xmx2G", "-XX:MaxMetaspaceSize=1G"),
-        enableBuildCache: Boolean = true,
+        enableBuildCache: Boolean? = true,
+        /**
+         * The log level that Gradle will use.
+         *
+         * Prefer using [LogLevel.LIFECYCLE] or above. Gradle TestKit stores logs in-memory, which makes the tests slow.
+         * See https://github.com/gradle/gradle/issues/23965
+         *
+         * Avoid using [LogLevel.DEBUG] - it is *very* noisy!
+         */
+        gradleLogLevel: LogLevel = LIFECYCLE,
+        /**
+         * The log level that Dokka Generator will use.
+         * Defaults to [gradleLogLevel], so that the Dokka logs are always produced.
+         */
+        dokkaLogLevel: LogLevel = gradleLogLevel,
     ): GradleRunner {
 
         // TODO quick hack to add `android { namespace }` on AGP 7+ (it's mandatory in 8+).
@@ -58,7 +74,7 @@ abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() {
                 |    namespace = "org.jetbrains.dokka.it.android"
                 |}
                 |
-            """.trimMargin()
+                """.trimMargin()
             )
         }
 
@@ -83,7 +99,24 @@ abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() {
             }
             .withArguments(
                 buildList {
-                    add(if (enableBuildCache) "--build-cache" else "--no-build-cache")
+
+                    when (gradleLogLevel) {
+                        // For the 'LogLevel to cli-option' mapping, see https://docs.gradle.org/8.9/userguide/logging.html#sec:choosing_a_log_level
+                        DEBUG -> add("--debug")
+                        INFO -> add("--info")
+                        LIFECYCLE -> {} // 'lifecycle' is the default and has no flag
+                        WARN -> add("--warn")
+                        QUIET -> add("--quiet")
+                        ERROR -> add("--error")
+                    }
+
+                    add("-PdokkaGeneratorLogLevel=$dokkaLogLevel")
+
+                    add("--stacktrace")
+
+                    if (enableBuildCache != null) {
+                        add(if (enableBuildCache) "--build-cache" else "--no-build-cache")
+                    }
 
                     add("-Pdokka_it_dokka_version=${dokkaVersion}")
                     add("-Pdokka_it_kotlin_version=${buildVersions.kotlinVersion}")
@@ -226,15 +259,10 @@ abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() {
     }
 }
 
-private fun GradleRunner.withJetBrainsCachedGradleVersion(version: GradleVersion): GradleRunner {
-    return withGradleDistribution(
-        URI.create(
-            "https://cache-redirector.jetbrains.com/" +
-                    "services.gradle.org/distributions/" +
-                    "gradle-${version.version}-bin.zip"
-        )
+private fun GradleRunner.withJetBrainsCachedGradleVersion(version: GradleVersion): GradleRunner =
+    withGradleDistribution(
+        URI("https://cache-redirector.jetbrains.com/services.gradle.org/distributions/gradle-${version.version}-bin.zip")
     )
-}
 
 private fun Throwable.withAllCauses(): Sequence<Throwable> {
     val root = this

diff --git a/...gradle/src/testExternalProjectKotlinxCoroutines/kotlin/CoroutinesGradleIntegrationTest.kt b/...gradle/src/testExternalProjectKotlinxCoroutines/kotlin/CoroutinesGradleIntegrationTest.kt
@@ -53,7 +53,7 @@ class CoroutinesGradleIntegrationTest : AbstractGradleIntegrationTest(), TestOut
     fun execute(buildVersions: BuildVersions) {
         val result = createGradleRunner(
             buildVersions,
-            ":dokkaHtmlMultiModule", "-i", "-s",
+            ":dokkaHtmlMultiModule",
             jvmArgs = listOf(
                 "-Xmx2G",
                 "-XX:MaxMetaspaceSize=500m", // Intentionally small to verify that Dokka tasks do not cause leaks.

diff --git a/.../src/testExternalProjectKotlinxSerialization/kotlin/SerializationGradleIntegrationTest.kt b/.../src/testExternalProjectKotlinxSerialization/kotlin/SerializationGradleIntegrationTest.kt
@@ -49,7 +49,7 @@ class SerializationGradleIntegrationTest : AbstractGradleIntegrationTest(), Test
     @ParameterizedTest(name = "{0}")
     @ArgumentsSource(SerializationBuildVersionsArgumentsProvider::class)
     fun execute(buildVersions: BuildVersions) {
-        val result = createGradleRunner(buildVersions, ":dokkaHtmlMultiModule", "-i", "-s").buildRelaxed()
+        val result = createGradleRunner(buildVersions, ":dokkaHtmlMultiModule").buildRelaxed()
 
         assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtmlMultiModule")).outcome)
 

diff --git a/...ation-tests/gradle/src/testTemplateProjectAndroid/kotlin/Android0GradleIntegrationTest.kt b/...ation-tests/gradle/src/testTemplateProjectAndroid/kotlin/Android0GradleIntegrationTest.kt
@@ -41,7 +41,7 @@ class Android0GradleIntegrationTest : AbstractGradleIntegrationTest() {
     @ParameterizedTest(name = "{0}")
     @ArgumentsSource(AndroidTestedVersionsArgumentsProvider::class)
     fun execute(buildVersions: BuildVersions) {
-        val result = createGradleRunner(buildVersions, "dokkaHtml", "-i", "-s").buildRelaxed()
+        val result = createGradleRunner(buildVersions, "dokkaHtml").buildRelaxed()
         result.shouldHaveTask(":dokkaHtml").shouldHaveOutcome(SUCCESS, FROM_CACHE)
 
         val htmlOutputDir = File(projectDir, "build/dokka/html")

diff --git a/...tegration-tests/gradle/src/testTemplateProjectBasic/kotlin/BasicCachingIntegrationTest.kt b/...tegration-tests/gradle/src/testTemplateProjectBasic/kotlin/BasicCachingIntegrationTest.kt
@@ -66,8 +66,6 @@ class BasicCachingIntegrationTest : AbstractGradleCachingIntegrationTest() {
             buildVersions,
             "clean",
             "dokkaHtml",
-            "-i",
-            "-s",
             "-Dorg.gradle.caching.debug=true",
             enableBuildCache = true,
         ).buildRelaxed()

diff --git a/...ntegration-tests/gradle/src/testTemplateProjectBasic/kotlin/BasicGradleIntegrationTest.kt b/...ntegration-tests/gradle/src/testTemplateProjectBasic/kotlin/BasicGradleIntegrationTest.kt
@@ -28,8 +28,6 @@ class BasicGradleIntegrationTest : AbstractGradleIntegrationTest() {
             "dokkaJavadoc",
             "dokkaGfm",
             "dokkaJekyll",
-            "-i",
-            "-s"
         ).buildRelaxed()
 
         assertEquals(expectedOutcome, assertNotNull(result.task(":dokkaHtml")).outcome)

diff --git a/...tests/gradle/src/testTemplateProjectBasic/kotlin/GradleRelocatedCachingIntegrationTest.kt b/...tests/gradle/src/testTemplateProjectBasic/kotlin/GradleRelocatedCachingIntegrationTest.kt
@@ -32,8 +32,6 @@ class GradleRelocatedCachingIntegrationTest : AbstractGradleCachingIntegrationTe
             buildVersions,
             "clean",
             "dokkaHtml",
-            "-i",
-            "-s",
             "-Dorg.gradle.caching.debug=true",
             enableBuildCache = true,
         ).withProjectDir(project).buildRelaxed()

diff --git a/...tion-tests/gradle/src/testTemplateProjectBasicGroovy/kotlin/BasicGroovyIntegrationTest.kt b/...tion-tests/gradle/src/testTemplateProjectBasicGroovy/kotlin/BasicGroovyIntegrationTest.kt
@@ -22,8 +22,6 @@ class BasicGroovyIntegrationTest : AbstractGradleIntegrationTest() {
             "dokkaJavadoc",
             "dokkaGfm",
             "dokkaJekyll",
-            "-i",
-            "-s"
         ).buildRelaxed()
 
         result.shouldHaveTask(":dokkaHtml").shouldHaveOutcome(SUCCESS, FROM_CACHE)

diff --git a/...gration-tests/gradle/src/testTemplateProjectCollector/kotlin/Collector0IntegrationTest.kt b/...gration-tests/gradle/src/testTemplateProjectCollector/kotlin/Collector0IntegrationTest.kt
@@ -22,7 +22,6 @@ class Collector0IntegrationTest : AbstractGradleIntegrationTest() {
             ":moduleA:dokkaJavadocCollector",
             ":moduleA:dokkaGfmCollector",
             ":moduleA:dokkaJekyllCollector",
-            "-i", "-s"
         ).buildRelaxed()
 
         result.shouldHaveTask(":moduleA:dokkaHtmlCollector").shouldHaveOutcome(SUCCESS, FROM_CACHE)

diff --git a/...integration-tests/gradle/src/testTemplateProjectConfiguration/kotlin/ConfigurationTest.kt b/...integration-tests/gradle/src/testTemplateProjectConfiguration/kotlin/ConfigurationTest.kt
@@ -33,8 +33,6 @@ class ConfigurationTest : AbstractGradleIntegrationTest() {
     ) {
         val result = createGradleRunner(
             buildVersions,
-            "-info",
-            "-stacktrace",
             "-Preport_undocumented=true",
             "-Pfail_on_warning=true",
             "dokkaHtml"

diff --git a/...-integration-tests/gradle/src/testTemplateProjectJsIr/kotlin/JsIRGradleIntegrationTest.kt b/...-integration-tests/gradle/src/testTemplateProjectJsIr/kotlin/JsIRGradleIntegrationTest.kt
@@ -35,8 +35,6 @@ class JsIRGradleIntegrationTest : AbstractGradleIntegrationTest() {
             buildVersions,
             "-Preact_version=$reactVersion",
             "dokkaHtml",
-            "-i",
-            "-s"
         ).buildRelaxed()
 
         result.shouldHaveTask(":dokkaHtml").shouldHaveOutcome(SUCCESS, FROM_CACHE)

diff --git a/...on-tests/gradle/src/testTemplateProjectMultimodule0/kotlin/MultiModule0IntegrationTest.kt b/...on-tests/gradle/src/testTemplateProjectMultimodule0/kotlin/MultiModule0IntegrationTest.kt
@@ -23,7 +23,6 @@ class MultiModule0IntegrationTest : AbstractGradleIntegrationTest() {
             ":moduleA:dokkaHtmlMultiModule",
             ":moduleA:dokkaGfmMultiModule",
             ":moduleA:dokkaJekyllMultiModule",
-            "-i", "-s"
         ).buildRelaxed()
 
         result.shouldHaveTask(":moduleA:dokkaHtmlMultiModule").shouldHaveOutcome(SUCCESS, FROM_CACHE)

diff --git a/...on-tests/gradle/src/testTemplateProjectMultimodule1/kotlin/MultiModule1IntegrationTest.kt b/...on-tests/gradle/src/testTemplateProjectMultimodule1/kotlin/MultiModule1IntegrationTest.kt
@@ -22,7 +22,6 @@ class MultiModule1IntegrationTest : AbstractGradleIntegrationTest() {
         val result = createGradleRunner(
             buildVersions,
             ":second:dokkaHtml",
-            "-i", "-s"
         ).buildRelaxed()
 
         result.shouldHaveTask(":second:dokkaHtml").shouldHaveOutcome(SUCCESS, FROM_CACHE)

diff --git a/...teProjectMultimoduleInterModuleLinks/kotlin/MultiModuleInterModuleLinksIntegrationTest.kt b/...teProjectMultimoduleInterModuleLinks/kotlin/MultiModuleInterModuleLinksIntegrationTest.kt
@@ -8,7 +8,9 @@ import org.gradle.testkit.runner.TaskOutcome
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.ArgumentsSource
 import java.io.File
-import kotlin.test.*
+import kotlin.test.assertEquals
+import kotlin.test.assertNotNull
+import kotlin.test.assertTrue
 
 /**
  * The test aims to check links to declarations from a package that is in two different modules.
@@ -29,7 +31,6 @@ class MultiModuleInterModuleLinksIntegrationTest : AbstractGradleIntegrationTest
         val result = createGradleRunner(
             buildVersions,
             ":moduleA:dokkaHtmlMultiModule",
-            "-i", "-s"
         ).buildRelaxed()
 
         assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":moduleA:dokkaHtmlMultiModule")).outcome)

diff --git a/.../gradle/src/testTemplateProjectMultimoduleVersioning/kotlin/Versioning0IntegrationTest.kt b/.../gradle/src/testTemplateProjectMultimoduleVersioning/kotlin/Versioning0IntegrationTest.kt
@@ -26,7 +26,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
         val result = createGradleRunner(
             buildVersions,
             ":dokkaHtmlMultiModuleBaseVersion",
-            "-i", "-s"
         ).buildRelaxed()
 
         assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtmlMultiModuleBaseVersion")).outcome)
@@ -37,7 +36,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
             buildVersions,
             "clean",
             ":dokkaHtmlMultiModuleNextVersion",
-            "-i", "-s"
         ).buildRelaxed()
 
         assertEquals(TaskOutcome.SUCCESS, assertNotNull(result2.task(":dokkaHtmlMultiModuleNextVersion")).outcome)
@@ -48,7 +46,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
             buildVersions,
             "clean",
             ":dokkaHtmlMultiModule",
-            "-i", "-s"
         ).buildRelaxed()
 
         assertEquals(TaskOutcome.SUCCESS, assertNotNull(result3.task(":dokkaHtmlMultiModule")).outcome)
@@ -83,7 +80,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
         val result = createGradleRunner(
             buildVersions,
             ":dokkaHtmlMultiModuleBaseVersion",
-            "-i", "-s",
             "-PolderVersionsDirName=$olderVersionsDirName"
         ).buildRelaxed()
 
@@ -95,7 +91,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
             buildVersions,
             "clean",
             ":dokkaHtmlMultiModuleNextVersion",
-            "-i", "-s",
             "-PolderVersionsDirName=$olderVersionsDirName"
         ).buildRelaxed()
 
@@ -107,7 +102,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
             buildVersions,
             "clean",
             ":dokkaHtmlMultiModule",
-            "-i", "-s",
             "-PolderVersionsDirName=$olderVersionsDirName"
         ).buildRelaxed()
 
@@ -147,7 +141,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
         val result = createGradleRunner(
             buildVersions,
             ":dokkaHtmlMultiModuleBaseVersion",
-            "-i", "-s",
             "-PolderVersionsDirName=$olderVersionsDirName"
         ).buildRelaxed()
 
@@ -159,7 +152,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
             buildVersions,
             "clean",
             ":dokkaHtmlMultiModuleNextVersion",
-            "-i", "-s",
             "-PolderVersionsDirName=$olderVersionsDirName"
         ).buildRelaxed()
 
@@ -171,7 +163,6 @@ class Versioning0IntegrationTest : AbstractGradleIntegrationTest() {
             buildVersions,
             "clean",
             ":dokkaHtmlMultiModule",
-            "-i", "-s",
             "-PolderVersionsDirName=$olderVersionsDirName"
         ).buildRelaxed()
 

diff --git a/...gradle/src/testTemplateProjectMultiplatform/kotlin/Multiplatform0GradleIntegrationTest.kt b/...gradle/src/testTemplateProjectMultiplatform/kotlin/Multiplatform0GradleIntegrationTest.kt
@@ -4,15 +4,11 @@
 
 package org.jetbrains.dokka.it.gradle
 
-import org.gradle.testkit.runner.TaskOutcome
 import org.gradle.testkit.runner.TaskOutcome.FROM_CACHE
 import org.gradle.testkit.runner.TaskOutcome.SUCCESS
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.ArgumentsSource
 import java.io.File
-import kotlin.test.BeforeTest
-import kotlin.test.assertEquals
-import kotlin.test.assertNotNull
 import kotlin.test.assertTrue
 
 class Multiplatform0GradleIntegrationTest : AbstractGradleIntegrationTest() {
@@ -26,13 +22,11 @@ class Multiplatform0GradleIntegrationTest : AbstractGradleIntegrationTest() {
             createGradleRunner(
                 buildVersions,
                 "dokkaHtml",
-                "-i",
-                "-s",
                 "-Pkotlin.mpp.enableGranularSourceSetsMetadata=true",
                 "-Pkotlin.native.enableDependencyPropagation=false"
             ).buildRelaxed()
         else
-            createGradleRunner(buildVersions, "dokkaHtml", "-i", "-s").buildRelaxed()
+            createGradleRunner(buildVersions, "dokkaHtml").buildRelaxed()
 
         result.shouldHaveTask(":dokkaHtml").shouldHaveOutcome(SUCCESS, FROM_CACHE)
 

diff --git a/.../src/testTemplateProjectTasksExecutionStress/kotlin/SequentialTasksExecutionStressTest.kt b/.../src/testTemplateProjectTasksExecutionStress/kotlin/SequentialTasksExecutionStressTest.kt
@@ -24,8 +24,6 @@ class SequentialTasksExecutionStressTest : AbstractGradleIntegrationTest() {
         val result = createGradleRunner(
             buildVersions,
             "runTasks",
-            "--info",
-            "--stacktrace",
             "-Ptask_number=$iterations",
             jvmArgs = listOf("-Xmx1G", "-XX:MaxMetaspaceSize=500m"),
             enableBuildCache = false,

diff --git a/...gration-tests/gradle/src/testTemplateProjectWasmBasic/kotlin/WasmGradleIntegrationTest.kt b/...gration-tests/gradle/src/testTemplateProjectWasmBasic/kotlin/WasmGradleIntegrationTest.kt
@@ -29,7 +29,10 @@ class WasmGradleIntegrationTest : AbstractGradleIntegrationTest() {
     @ParameterizedTest(name = "{0}")
     @ArgumentsSource(WasmTestedVersionsArgumentsProvider::class)
     fun execute(buildVersions: BuildVersions) {
-        val result = createGradleRunner(buildVersions, "dokkaHtml", "-i", "-s").buildRelaxed()
+        val result = createGradleRunner(
+            buildVersions,
+            "dokkaHtml",
+        ).buildRelaxed()
         result.shouldHaveTask(":dokkaHtml").shouldHaveOutcome(SUCCESS, FROM_CACHE)
 
         val htmlOutputDir = File(projectDir, "build/dokka/html")

diff --git a/...s/gradle/src/testTemplateProjectWasmJsWasiBasic/kotlin/WasmJsWasiGradleIntegrationTest.kt b/...s/gradle/src/testTemplateProjectWasmJsWasiBasic/kotlin/WasmJsWasiGradleIntegrationTest.kt
@@ -28,7 +28,7 @@ class WasmJsWasiGradleIntegrationTest : AbstractGradleIntegrationTest() {
     @ParameterizedTest(name = "{0}")
     @ArgumentsSource(WasmJsWasiTestedVersionsArgumentsProvider::class)
     fun execute(buildVersions: BuildVersions) {
-        val result = createGradleRunner(buildVersions, "dokkaHtml", "-i", "-s").buildRelaxed()
+        val result = createGradleRunner(buildVersions, "dokkaHtml").buildRelaxed()
         result.shouldHaveTask(":dokkaHtml").shouldHaveOutcome(SUCCESS, FROM_CACHE)
 
         val htmlOutputDir = File(projectDir, "build/dokka/html")

diff --git a/dokka-integration-tests/gradle/src/testUiShowcaseProject/kotlin/UiShowcaseIntegrationTest.kt b/dokka-integration-tests/gradle/src/testUiShowcaseProject/kotlin/UiShowcaseIntegrationTest.kt
@@ -24,8 +24,6 @@ class UiShowcaseIntegrationTest : AbstractGradleIntegrationTest(), TestOutputCop
         val result = createGradleRunner(
             buildVersions,
             "dokkaHtmlMultiModule",
-            "-i",
-            "-s"
         ).buildRelaxed()
 
         result.shouldHaveTask(":dokkaHtmlMultiModule").shouldHaveOutcome(SUCCESS, FROM_CACHE)