1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package renderers.html
import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.DokkaConfigurationImpl
import org.jetbrains.dokka.PluginConfigurationImpl
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.DokkaBaseConfiguration
import org.jetbrains.dokka.base.templating.toJsonString
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.pages.RootPageNode
import org.jetbrains.dokka.plugability.DokkaContext
import org.jsoup.Jsoup
import utils.TestOutputWriter
import utils.TestOutputWriterPlugin
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertNotNull
import kotlin.test.assertNull
class HeaderTest : BaseAbstractTest() {
private val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
name = "jvm"
sourceRoots = listOf("src/jvm")
}
sourceSet {
name = "js"
sourceRoots = listOf("src/js")
}
}
}
@Test
fun `should include homepage link if homepageLink is provided`() {
testRendering(
DokkaBaseConfiguration(homepageLink = "https://github.com/Kotlin/dokka/")
) { _, _, writer ->
val renderedContent = navigationElement(writer)
val sourceLinkElement =
assertNotNull(renderedContent.getElementById("homepage-link"), "Source link element not found")
val aElement = assertNotNull(sourceLinkElement.selectFirst("a"))
assertEquals("https://github.com/Kotlin/dokka/", aElement.attr("href"))
}
}
@Test
fun `should not include homepage link by default`() {
testRendering(null) { _, _, writer ->
val renderedContent = navigationElement(writer)
assertNull(renderedContent.getElementById("homepage-link"), "Source link element found")
}
}
private fun testRendering(
baseConfiguration: DokkaBaseConfiguration?,
block: (RootPageNode, DokkaContext, writer: TestOutputWriter) -> Unit
) {
fun configuration(): DokkaConfigurationImpl {
baseConfiguration ?: return configuration
return configuration.copy(
pluginsConfiguration = listOf(
PluginConfigurationImpl(
DokkaBase::class.java.canonicalName,
DokkaConfiguration.SerializationFormat.JSON,
toJsonString(baseConfiguration)
)
)
)
}
val writerPlugin = TestOutputWriterPlugin()
testInline(
"""
|/src/jvm/Test.kt
|fun test() {}
|/src/js/Test.kt
|fun test() {}
""",
configuration(),
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { node, context ->
block(node, context, writerPlugin.writer)
}
}
}
private fun navigationElement(writer: TestOutputWriter) =
writer
.contents
.getValue("index.html")
.let(Jsoup::parse)
.select(".navigation")
.single()
}
|
