-
Notifications
You must be signed in to change notification settings - Fork 391
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Maven Integration tests to use JVM test suites
Part of KT-64200 WIP
- Loading branch information
Showing
7 changed files
with
268 additions
and
92 deletions.
There are no files selected for viewing
144 changes: 72 additions & 72 deletions
144
build-logic/src/main/kotlin/dokkabuild.test-integration.gradle.kts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,72 @@ | ||
| /* | ||
| * Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. | ||
| */ | ||
|
|
||
| import org.gradle.api.tasks.testing.logging.TestExceptionFormat | ||
| import org.gradle.api.tasks.testing.logging.TestLogEvent | ||
|
|
||
| plugins { | ||
| id("dokkabuild.kotlin-jvm") | ||
| } | ||
|
|
||
| val integrationTestSourceSet: SourceSet = sourceSets.create("integrationTest") { | ||
| compileClasspath += sourceSets.main.get().output | ||
| runtimeClasspath += sourceSets.main.get().output | ||
| } | ||
|
|
||
| val integrationTestImplementation: Configuration by configurations.getting { | ||
| extendsFrom(configurations.implementation.get()) | ||
| } | ||
|
|
||
| val integrationTestRuntimeOnly: Configuration by configurations.getting { | ||
| extendsFrom(configurations.runtimeOnly.get()) | ||
| } | ||
|
|
||
| /** | ||
| * Dokka's integration test task is not cacheable because the HTML outputs | ||
| * it produces when running the tests are used for showcasing resulting documentation, | ||
| * which does not work well with caching. | ||
| * | ||
| * At the moment there are two problems that do not allow to make it cacheable: | ||
| * | ||
| * 1. The task's inputs are such that changes in Dokka's code do not invalidate the cache, | ||
| * because it is run with the same version of Dokka (`"DOKKA_VERSION"`) on the same | ||
| * test project inputs. | ||
| * 2. The tests generate HTML output which is then used to showcase documentation. | ||
| * The outputs are usually copied to a location from which it will be served. | ||
| * However, if the test is cacheable, it produces no outputs, so no documentation | ||
| * to showcase. It needs to be broken into two separate tasks: one cacheable for running | ||
| * the tests and producing HTML output, and another non-cacheable for copying the output. | ||
| * | ||
| * @see [org.jetbrains.dokka.it.TestOutputCopier] for more details on showcasing documentation | ||
| */ | ||
| @DisableCachingByDefault(because = "Contains incorrect inputs/outputs configuration, see the KDoc for details") | ||
| abstract class NonCacheableIntegrationTest : Test() | ||
|
|
||
| val integrationTest by tasks.registering(NonCacheableIntegrationTest::class) { | ||
| maxHeapSize = "2G" | ||
| description = "Runs integration tests." | ||
| group = "verification" | ||
| testClassesDirs = integrationTestSourceSet.output.classesDirs | ||
| classpath = integrationTestSourceSet.runtimeClasspath | ||
|
|
||
| useJUnitPlatform { | ||
| if (dokkaBuild.integrationTestUseK2.get()) excludeTags("onlyDescriptors", "onlyDescriptorsMPP") | ||
| } | ||
|
|
||
| systemProperty("org.jetbrains.dokka.experimental.tryK2", dokkaBuild.integrationTestUseK2.get()) | ||
|
|
||
| dokkaBuild.integrationTestParallelism.orNull?.let { parallelism -> | ||
| maxParallelForks = parallelism | ||
| } | ||
|
|
||
| environment("isExhaustive", dokkaBuild.integrationTestExhaustive.get()) | ||
|
|
||
| testLogging { | ||
| exceptionFormat = TestExceptionFormat.FULL | ||
| events(TestLogEvent.SKIPPED, TestLogEvent.FAILED) | ||
| showExceptions = true | ||
| showCauses = true | ||
| showStackTraces = true | ||
| } | ||
| } | ||
| ///* | ||
| // * Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. | ||
| // */ | ||
| // | ||
| //import org.gradle.api.tasks.testing.logging.TestExceptionFormat | ||
| //import org.gradle.api.tasks.testing.logging.TestLogEvent | ||
| // | ||
| //plugins { | ||
| // id("dokkabuild.kotlin-jvm") | ||
| //} | ||
| // | ||
| //val integrationTestSourceSet: SourceSet = sourceSets.create("integrationTest") { | ||
| // compileClasspath += sourceSets.main.get().output | ||
| // runtimeClasspath += sourceSets.main.get().output | ||
| //} | ||
| // | ||
| //val integrationTestImplementation: Configuration by configurations.getting { | ||
| // extendsFrom(configurations.implementation.get()) | ||
| //} | ||
| // | ||
| //val integrationTestRuntimeOnly: Configuration by configurations.getting { | ||
| // extendsFrom(configurations.runtimeOnly.get()) | ||
| //} | ||
| // | ||
| ///** | ||
| // * Dokka's integration test task is not cacheable because the HTML outputs | ||
| // * it produces when running the tests are used for showcasing resulting documentation, | ||
| // * which does not work well with caching. | ||
| // * | ||
| // * At the moment there are two problems that do not allow to make it cacheable: | ||
| // * | ||
| // * 1. The task's inputs are such that changes in Dokka's code do not invalidate the cache, | ||
| // * because it is run with the same version of Dokka (`"DOKKA_VERSION"`) on the same | ||
| // * test project inputs. | ||
| // * 2. The tests generate HTML output which is then used to showcase documentation. | ||
| // * The outputs are usually copied to a location from which it will be served. | ||
| // * However, if the test is cacheable, it produces no outputs, so no documentation | ||
| // * to showcase. It needs to be broken into two separate tasks: one cacheable for running | ||
| // * the tests and producing HTML output, and another non-cacheable for copying the output. | ||
| // * | ||
| // * @see [org.jetbrains.dokka.it.TestOutputCopier] for more details on showcasing documentation | ||
| // */ | ||
| //@DisableCachingByDefault(because = "Contains incorrect inputs/outputs configuration, see the KDoc for details") | ||
| //abstract class NonCacheableIntegrationTest : Test() | ||
| // | ||
| //val integrationTest by tasks.registering(NonCacheableIntegrationTest::class) { | ||
| // maxHeapSize = "2G" | ||
| // description = "Runs integration tests." | ||
| // group = "verification" | ||
| // testClassesDirs = integrationTestSourceSet.output.classesDirs | ||
| // classpath = integrationTestSourceSet.runtimeClasspath | ||
| // | ||
| // useJUnitPlatform { | ||
| // if (dokkaBuild.integrationTestUseK2.get()) excludeTags("onlyDescriptors", "onlyDescriptorsMPP") | ||
| // } | ||
| // | ||
| // systemProperty("org.jetbrains.dokka.experimental.tryK2", dokkaBuild.integrationTestUseK2.get()) | ||
| // | ||
| // dokkaBuild.integrationTestParallelism.orNull?.let { parallelism -> | ||
| // maxParallelForks = parallelism | ||
| // } | ||
| // | ||
| // environment("isExhaustive", dokkaBuild.integrationTestExhaustive.get()) | ||
| // | ||
| // testLogging { | ||
| // exceptionFormat = TestExceptionFormat.FULL | ||
| // events(TestLogEvent.SKIPPED, TestLogEvent.FAILED) | ||
| // showExceptions = true | ||
| // showCauses = true | ||
| // showStackTraces = true | ||
| // } | ||
| //} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.