blob: 46b13763b8cc542621eeeed3926025578cb545b8 (
plain)
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
package pageMerger
import org.jetbrains.dokka.pages.ClasslikePageNode
import org.jetbrains.dokka.pages.ContentPage
import org.jetbrains.dokka.pages.PageNode
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Disabled
import org.junit.jupiter.api.Test
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
class PageNodeMergerTest : BaseAbstractTest() {
/* object SameNameStrategy : DokkaPlugin() {
val strategy by extending { CoreExtensions.pageMergerStrategy with SameMethodNamePageMergerStrategy }
}
class DefaultStrategy(val strList: MutableList<String> = mutableListOf()) : DokkaPlugin(), DokkaLogger {
val strategy by extending { CoreExtensions.pageMergerStrategy with DefaultPageMergerStrategy(this@DefaultStrategy) }
override var warningsCount: Int = 0
override var errorsCount: Int = 0
override fun debug(message: String) = TODO()
override fun info(message: String) = TODO()
override fun progress(message: String) = TODO()
override fun warn(message: String) {
strList += message
}
override fun error(message: String) = TODO()
override fun report() = TODO()
}
*/
@Test
fun sameNameStrategyTest() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin/pageMerger/Test.kt")
}
}
}
testInline(
"""
|/src/main/kotlin/pageMerger/Test.kt
|package pageMerger
|
|fun testT(): Int = 1
|fun testT(i: Int): Int = i
|
|object Test {
| fun test(): String = ""
| fun test(str: String): String = str
|}
""".trimMargin(),
configuration/*,
pluginOverrides = listOf(SameNameStrategy)*/
) {
pagesTransformationStage = {
val allChildren = it.childrenRec().filterIsInstance<ContentPage>()
val testT = allChildren.filter { it.name == "testT" }
val test = allChildren.filter { it.name == "test" }
assertTrue(testT.size == 1) { "There can be only one testT page" }
assertTrue(testT.first().dri.size == 2) { "testT page should have 2 DRI, but has ${testT.first().dri.size}" }
assertTrue(test.size == 1) { "There can be only one test page" }
assertTrue(test.first().dri.size == 2) { "test page should have 2 DRI, but has ${test.first().dri.size}" }
}
}
}
@Disabled("TODO: reenable when we have infrastructure for turning off extensions")
@Test
fun defaultStrategyTest() {
val strList: MutableList<String> = mutableListOf()
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin/pageMerger/Test.kt")
}
}
}
testInline(
"""
|/src/main/kotlin/pageMerger/Test.kt
|package pageMerger
|
|fun testT(): Int = 1
|fun testT(i: Int): Int = i
|
|object Test {
| fun test(): String = ""
| fun test(str: String): String = str
|}
""".trimMargin(),
configuration/*,
pluginOverrides = listOf(DefaultStrategy(strList)) */
) {
pagesTransformationStage = { root ->
val allChildren = root.childrenRec().filterIsInstance<ContentPage>()
val testT = allChildren.filter { it.name == "testT" }
val test = allChildren.filter { it.name == "test" }
assertTrue(testT.size == 1) { "There can be only one testT page" }
assertTrue(testT.first().dri.size == 1) { "testT page should have single DRI, but has ${testT.first().dri.size}" }
assertTrue(test.size == 1) { "There can be only one test page" }
assertTrue(test.first().dri.size == 1) { "test page should have single DRI, but has ${test.first().dri.size}" }
assertTrue(strList.count() == 2) { "Expected 2 warnings, got ${strList.count()}" }
}
}
}
fun PageNode.childrenRec(): List<PageNode> = listOf(this) + children.flatMap { it.childrenRec() }
@Test
fun `should not be merged`() {
val configuration = dokkaConfiguration {
moduleName = "example"
sourceSets {
val common = sourceSet {
name = "common"
displayName = "common"
analysisPlatform = "common"
sourceRoots = listOf("src/commonMain/kotlin/pageMerger/Test.kt")
}
sourceSet {
name = "js"
displayName = "js"
analysisPlatform = "js"
dependentSourceSets = setOf(common.value.sourceSetID)
sourceRoots = listOf("src/jsMain/kotlin/pageMerger/Test.kt")
}
sourceSet {
name = "jvm"
displayName = "jvm"
analysisPlatform = "jvm"
dependentSourceSets = setOf(common.value.sourceSetID)
sourceRoots = listOf("src/jvmMain/kotlin/pageMerger/Test.kt")
}
}
}
testInline(
"""
|/src/commonMain/kotlin/pageMerger/Test.kt
|package pageMerger
|
|/src/jsMain/kotlin/pageMerger/Test.kt
|package pageMerger
|
|annotation class DoNotMerge
|
|/src/jvmMain/kotlin/pageMerger/Test.kt
|package pageMerger
|
|annotation class DoNotMerge
""".trimMargin(),
configuration
) {
pagesTransformationStage = {
println(it)
val allChildren = it.childrenRec().filterIsInstance<ClasslikePageNode>()
val jvmClass = allChildren.filter { it.name == "[jvm]DoNotMerge" }
val jsClass = allChildren.filter { it.name == "[js]DoNotMerge" }
val noClass = allChildren.filter { it.name == "DoNotMerge" }
assertTrue(jvmClass.size == 1) { "There can be only one DoNotMerge(jvm) page" }
assertTrue(jvmClass.first().documentables.firstOrNull()?.sourceSets?.single()?.analysisPlatform?.key == "jvm") { "[jvm]DoNotMerge should have only jvm sources" }
assertTrue(jsClass.size == 1) { "There can be only one DoNotMerge(js) page" }
assertTrue(jsClass.first().documentables.firstOrNull()?.sourceSets?.single()?.analysisPlatform?.key == "js") { "[js]DoNotMerge should have only js sources" }
assertTrue(noClass.isEmpty()) { "There can't be any DoNotMerge page" }
}
}
}
}
|
