Working tests for includes, sources and samples. Minor bugfixes

1 files changed, 161 insertions, 0 deletions

diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt
new file mode 100644
index 00000000..71854035
--- /dev/null
+++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt
@@ -0,0 +1,161 @@
+package linkableContent
+
+import org.jetbrains.dokka.SourceLinkDefinitionImpl
+import org.jetbrains.dokka.base.transformers.pages.samples.DefaultSamplesTransformer
+import org.jetbrains.dokka.base.transformers.pages.sourcelinks.SourceLinksTransformer
+import org.jetbrains.dokka.pages.*
+import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest
+import org.jetbrains.kotlin.utils.addToStdlib.safeAs
+import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.api.Test
+
+class LinkableContentTest : AbstractCoreTest() {
+
+    @Test
+    fun `Include module and package documentation`() {
+
+        val testDataDir = getTestDataDir("multiplatform/basicMultiplatformTest").toAbsolutePath()
+        val includesDir = getTestDataDir("linkable/includes").toAbsolutePath()
+
+        val configuration = dokkaConfiguration {
+            passes {
+                pass {
+                    moduleName = "example"
+                    analysisPlatform = "js"
+                    targets = listOf("js")
+                    sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map {
+                        "$testDataDir/$it/kotlin"
+                    }
+                    includes = listOf("$includesDir/include2.md")
+                }
+                pass {
+                    moduleName = "example"
+                    analysisPlatform = "jvm"
+                    targets = listOf("jvm")
+                    sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map {
+                        "$testDataDir/$it/kotlin"
+                    }
+                    includes = listOf("$includesDir/include1.md")
+                }
+            }
+        }
+
+        testFromData(configuration) {
+            documentablesMergingStage = {
+                Assertions.assertEquals(2, it.documentation.size)
+                Assertions.assertEquals(2, it.packages.size)
+                Assertions.assertEquals(1, it.packages.first().documentation.size)
+                Assertions.assertEquals(1, it.packages.last().documentation.size)
+            }
+        }
+
+    }
+
+    @Test
+    fun `Sources multiplatform class documentation`() {
+
+        val testDataDir = getTestDataDir("linkable/sources").toAbsolutePath()
+
+        val configuration = dokkaConfiguration {
+            passes {
+                pass {
+                    moduleName = "example"
+                    analysisPlatform = "js"
+                    targets = listOf("js")
+                    sourceRoots = listOf("$testDataDir/jsMain/kotlin")
+                    sourceLinks = listOf(
+                        SourceLinkDefinitionImpl(
+                            path = "jsMain/kotlin",
+                            url = "https://github.com/user/repo/tree/master/src/jsMain/kotlin",
+                            lineSuffix = "#L"
+                        )
+                    )
+                }
+                pass {
+                    moduleName = "example"
+                    analysisPlatform = "jvm"
+                    targets = listOf("jvm")
+                    sourceRoots = listOf("$testDataDir/jvmMain/kotlin")
+                    sourceLinks = listOf(
+                        SourceLinkDefinitionImpl(
+                            path = "jvmMain/kotlin",
+                            url = "https://github.com/user/repo/tree/master/src/jvmMain/kotlin",
+                            lineSuffix = "#L"
+                        )
+                    )
+                }
+            }
+        }
+
+        testFromData(configuration) {
+            renderingStage = { rootPageNode, dokkaContext ->
+                val newRoot = SourceLinksTransformer(dokkaContext).invoke(rootPageNode)
+
+                val moduleChildren = newRoot.children
+                Assertions.assertEquals(1, moduleChildren.size)
+                val packageChildren = moduleChildren.first().children
+                Assertions.assertEquals(2, packageChildren.size)
+                packageChildren.forEach {
+                    val name = it.name.substringBefore("Class")
+                    val crl = it.safeAs<ClasslikePageNode>()?.content?.safeAs<ContentGroup>()?.children?.last()
+                        ?.safeAs<PlatformHintedContent>()?.children?.singleOrNull().safeAs<ContentResolvedLink>()
+                    Assertions.assertEquals(
+                        "https://github.com/user/repo/tree/master/src/${name.toLowerCase()}Main/kotlin/${name}Class.kt#L3",
+                        crl?.address
+                    )
+                }
+            }
+        }
+    }
+
+    @Test
+    fun `Samples multiplatform documentation`() {
+
+        val testDataDir = getTestDataDir("linkable/samples").toAbsolutePath()
+
+        val configuration = dokkaConfiguration {
+            passes {
+                pass {
+                    moduleName = "example"
+                    analysisPlatform = "js"
+                    targets = listOf("js")
+                    sourceRoots = listOf("$testDataDir/jsMain/kotlin")
+                    samples = listOf("$testDataDir/jsMain/resources/Samples.kt")
+                }
+                pass {
+                    moduleName = "example"
+                    analysisPlatform = "jvm"
+                    targets = listOf("jvm")
+                    sourceRoots = listOf("$testDataDir/jvmMain/kotlin")
+                    samples = listOf("$testDataDir/jvmMain/resources/Samples.kt")
+                }
+            }
+        }
+
+        testFromData(configuration) {
+            renderingStage = { rootPageNode, dokkaContext ->
+                val newRoot = DefaultSamplesTransformer(dokkaContext).invoke(rootPageNode)
+
+                val moduleChildren = newRoot.children
+                Assertions.assertEquals(1, moduleChildren.size)
+                val packageChildren = moduleChildren.first().children
+                Assertions.assertEquals(2, packageChildren.size)
+                packageChildren.forEach {
+                    val name = it.name.substringBefore("Class")
+                    val classChildren = it.children
+                    Assertions.assertEquals(2, classChildren.size)
+                    val function = classChildren.find { it.name == "printWithExclamation" }
+                    val text = function.safeAs<MemberPageNode>()?.content?.safeAs<ContentGroup>()?.children?.last()
+                        ?.safeAs<PlatformHintedContent>()?.children?.singleOrNull()
+                        ?.safeAs<ContentGroup>()?.children?.singleOrNull()?.safeAs<ContentGroup>()?.children?.last()
+                        ?.safeAs<ContentGroup>()?.children?.singleOrNull()
+                        ?.safeAs<ContentCode>()?.children?.singleOrNull()?.safeAs<ContentText>()?.text
+                    Assertions.assertEquals(
+                        "${name}Class().printWithExclamation(\"Hi, $name\")",
+                        text
+                    )
+                }
+            }
+        }
+    }
+}
\ No newline at end of file