Fix custom-dokka-plugin example and update test

- Add custom test tasks to only test a specific example project.
Kotlin · Nov 12, 2024 · 54fc084 · 54fc084
1 parent 971bfcc
commit 54fc084
Show file tree

Hide file tree

Showing 57 changed files with 3,741 additions and 6 deletions.
diff --git a/build-logic/src/main/kotlin/dokkabuild/utils/SystemPropertyAdder.kt b/build-logic/src/main/kotlin/dokkabuild/utils/SystemPropertyAdder.kt
@@ -153,6 +153,16 @@ abstract class SystemPropertyAdder @Inject internal constructor(
         return task.inputs.property("SystemProperty input property $key", value)
     }
 
+    fun inputProperty(
+        key: String,
+        value: String,
+    ): TaskInputPropertyBuilder {
+        task.jvmArgumentProviders.add(
+            SystemPropertyArgumentProvider(key, value) { it }
+        )
+        return task.inputs.property("SystemProperty input property $key", value)
+    }
+
     @JvmName("inputBooleanProperty")
     fun inputProperty(
         key: String,

diff --git a/build-logic/src/main/kotlin/dokkabuild/utils/strings.kt b/build-logic/src/main/kotlin/dokkabuild/utils/strings.kt
@@ -0,0 +1,7 @@
+/*
+ * Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+package dokkabuild.utils
+
+/** Title case the first char of a string */
+fun String.uppercaseFirstChar(): String = replaceFirstChar(Char::uppercaseChar)
diff --git a/dokka-integration-tests/gradle/build.gradle.kts b/dokka-integration-tests/gradle/build.gradle.kts
@@ -5,6 +5,7 @@
 
 import dokkabuild.tasks.GitCheckoutTask
 import dokkabuild.utils.systemProperty
+import dokkabuild.utils.uppercaseFirstChar
 import org.gradle.api.tasks.PathSensitivity.NAME_ONLY
 import org.gradle.api.tasks.PathSensitivity.RELATIVE
 
@@ -198,7 +199,7 @@ testing {
     }
     val testExampleProjects by suites.registering(JvmTestSuite::class) {
         targets.configureEach {
-            testTask.configure {
+            testTask {
 
                 val exampleGradleProjectsDir = projectDir.resolve("../../examples/gradle-v2")
                 systemProperty
@@ -215,5 +216,29 @@ testing {
                 systemProperty("junit.jupiter.execution.parallel.mode.default", "CONCURRENT")
             }
         }
+
+        listOf(
+            "basic-gradle-example",
+            "composite-build-example",
+            "custom-dokka-plugin-example",
+            "custom-styling-example",
+            "java-example",
+            "javadoc-example",
+            "kotlin-as-java-example",
+            "kotlin-multiplatform-example",
+            "library-publishing-example",
+            "multimodule-example",
+            "versioning-multimodule-example",
+        ).forEach { exampleProjectName ->
+            val prettyName = exampleProjectName.split("-").joinToString("") { it.uppercaseFirstChar() }
+            targets.register("test$prettyName") {
+                testTask {
+                    description = "Only test $exampleProjectName"
+                    group = "verification - example projects"
+                    systemProperty
+                        .inputProperty("exampleProjectFilter", exampleProjectName)
+                }
+            }
+        }
     }
 }
diff --git a/...mpleProjects/custom-dokka-plugin-example/html/-demo -library/demo/-entry-point/index.html b/...mpleProjects/custom-dokka-plugin-example/html/-demo -library/demo/-entry-point/index.html
diff --git a/...ampleProjects/custom-dokka-plugin-example/html/-demo -library/demo/-greeter/-greeter.html b/...ampleProjects/custom-dokka-plugin-example/html/-demo -library/demo/-greeter/-greeter.html
diff --git a/.../exampleProjects/custom-dokka-plugin-example/html/-demo -library/demo/-greeter/greet.html b/.../exampleProjects/custom-dokka-plugin-example/html/-demo -library/demo/-greeter/greet.html