Make integration tests runnable from IDEA

Kotlin · Oct 27, 2023 · b3913d0 · b3913d0
1 parent b393a12
commit b3913d0
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 4 deletions.
diff --git a/build-logic/src/main/kotlin/dokkabuild.kotlin-jvm.gradle.kts b/build-logic/src/main/kotlin/dokkabuild.kotlin-jvm.gradle.kts
@@ -7,16 +7,23 @@ plugins {
     kotlin("jvm")
 }
 
+val rootProjectsWithoutDependencyOnDokkaCore = listOf("dokka-integration-tests")
+
 kotlin {
     explicitApi()
     compilerOptions {
         allWarningsAsErrors.set(true)
         languageVersion.set(dokkaBuild.kotlinLanguageLevel)
         apiVersion.set(dokkaBuild.kotlinLanguageLevel)
-        optIn.addAll(
-            "kotlin.RequiresOptIn",
-            "org.jetbrains.dokka.InternalDokkaApi"
-        )
+
+        // These projects know nothing about the `@InternalDokkaApi` annotation, so the Kotlin compiler
+        // will complain about an unresolved opt-in requirement marker and fail the build if it's not excluded.
+        if (rootProject.name !in rootProjectsWithoutDependencyOnDokkaCore) {
+            optIn.addAll(
+                "kotlin.RequiresOptIn",
+                "org.jetbrains.dokka.InternalDokkaApi"
+            )
+        }
 
         freeCompilerArgs.addAll(
             // need 1.4 support, otherwise there might be problems

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -26,6 +26,12 @@ registerParentTaskOfIncludedBuilds("publishPlugins", groupName = "publication")
     it.name in listOf("gradle-plugin-classic")
 }
 
+tasks.register("integrationTest") {
+    group = "verification"
+    description = "Runs integration tests of this project. Might take a while and require additional setup."
+    dependsOn(gradle.includedBuilds.single { it.name == "dokka-integration-tests" }.task(":integrationTest"))
+}
+
 fun addDependencyOnSameTaskOfIncludedBuilds(existingTaskName: String, filter: (IncludedBuild) -> Boolean = { true }) {
     tasks.named(existingTaskName) {
         dependsOn(includedBuildTasks(existingTaskName, filter))

diff --git a/dokka-integration-tests/cli/build.gradle.kts b/dokka-integration-tests/cli/build.gradle.kts
@@ -11,6 +11,7 @@ plugins {
 
 dependencies {
     implementation(kotlin("test-junit5"))
+    implementation(libs.junit.jupiterApi)
     implementation(projects.utilities)
 }
 

diff --git a/dokka-integration-tests/maven/build.gradle.kts b/dokka-integration-tests/maven/build.gradle.kts
@@ -11,6 +11,7 @@ dependencies {
     implementation(projects.utilities)
 
     implementation(kotlin("test-junit5"))
+    implementation(libs.junit.jupiterApi)
 }
 
 val dokkaSubprojects = gradle.includedBuild("dokka-subprojects")