Make integration tests debuggable (#3401)

Author: vmishenev

build-logic/src/main/kotlin/dokkabuild.test-integration.gradle.kts

@@ -66,7 +66,7 @@ val integrationTest by tasks.registering(NonCacheableIntegrationTest::class) {
             ?: System.getenv("DOKKA_INTEGRATION_TEST_IS_EXHAUSTIVE")?.toBoolean()
             ?: false.toString()
     )
-
+    
     testLogging {
         exceptionFormat = TestExceptionFormat.FULL
         events(TestLogEvent.SKIPPED, TestLogEvent.FAILED)

dokka-integration-tests/gradle/README.md

@@ -6,6 +6,8 @@ build.gradle.kts file -> "import gradle project".
 Before importing: Make sure that you have dokka installed
 locally (`./gradlew publishToMavenLocal`).
 
+To debug Gradle tests, the environment variable `ENABLE_DEBUG=true` should be declared.
+
 ### To update git submodules 
 
 Integration tests have fixed git revision number, with the diff patch applied from the corresponding file (e.g. [`coroutines.diff`](projects/coroutines/coroutines.diff)).

dokka-integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt

@@ -34,6 +34,7 @@ public abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest()
             .forwardOutput()
             .withJetBrainsCachedGradleVersion(buildVersions.gradleVersion)
             .withTestKitDir(File("build", "gradle-test-kit").absoluteFile)
+            .withDebug(TestEnvironment.isEnabledDebug)
             .withArguments(
                 listOfNotNull(
                     "-Pdokka_it_dokka_version=${System.getenv("DOKKA_VERSION")}",

dokka-integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/TestEnvironment.kt

@@ -13,6 +13,8 @@ public object TestEnvironment {
         "Missing `isExhaustive` environment variable"
     }.toBoolean()
 
+    public val isEnabledDebug: Boolean = System.getenv("ENABLE_DEBUG").toBoolean()
+
     /**
      * By default, it is disabled
      */