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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
package resourceLinks
import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.PluginConfigurationImpl
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.DokkaBaseConfiguration
import org.jetbrains.dokka.base.renderers.html.TEMPLATE_REPLACEMENT
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.DokkaPlugin
import org.jetbrains.dokka.plugability.DokkaPluginApiPreview
import org.jetbrains.dokka.plugability.PluginApiPreviewAcknowledgement
import org.jetbrains.dokka.transformers.pages.PageTransformer
import org.jsoup.Jsoup
import org.jsoup.nodes.TextNode
import org.junit.jupiter.api.Test
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.ValueSource
import utils.TestOutputWriterPlugin
import utils.assertContains
import java.io.File
import kotlin.test.assertNotNull
import kotlin.test.assertNull
import kotlin.test.assertTrue
class ResourceLinksTest : BaseAbstractTest() {
class TestResourcesAppenderPlugin(val resources: List<String>) : DokkaPlugin() {
class TestResourcesAppender(val resources: List<String>) : PageTransformer {
override fun invoke(input: RootPageNode) = input.transformContentPagesTree {
it.modified(
embeddedResources = it.embeddedResources + resources
)
}
}
val appender by extending {
plugin<DokkaBase>().htmlPreprocessors with TestResourcesAppender(resources)
}
@OptIn(DokkaPluginApiPreview::class)
override fun pluginApiPreviewAcknowledgement(): PluginApiPreviewAcknowledgement =
PluginApiPreviewAcknowledgement
}
@Test
fun resourceLinksTest() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin/test/Test.kt")
}
}
}
val absoluteResources = listOf(
"https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css",
"https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js"
)
val relativeResources = listOf(
"test/relativePath.js",
"test/relativePath.css"
)
val source =
"""
|/src/main/kotlin/test/Test.kt
|package example
""".trimIndent()
val writerPlugin = TestOutputWriterPlugin()
testInline(
source,
configuration,
pluginOverrides = listOf(TestResourcesAppenderPlugin(absoluteResources + relativeResources), writerPlugin)
) {
renderingStage = { _, _ ->
Jsoup
.parse(writerPlugin.writer.contents.getValue("root/example.html"))
.head()
.select("link, script")
.let {
absoluteResources.forEach { r ->
assert(it.`is`("[href=$r], [src=$r]"))
}
relativeResources.forEach { r ->
assert(it.`is`("[href=../$r] , [src=../$r]"))
}
}
}
}
}
@ParameterizedTest
@ValueSource(booleans = [true, false])
fun resourceCustomPreprocessorTest(isMultiModule: Boolean) {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin/test/Test.kt")
}
}
delayTemplateSubstitution = isMultiModule
pluginsConfigurations = mutableListOf(
PluginConfigurationImpl(
DokkaBase::class.java.canonicalName,
DokkaConfiguration.SerializationFormat.JSON,
toJsonString(
DokkaBaseConfiguration(
customStyleSheets = listOf(File("test/customStyle.css")),
customAssets = listOf(File("test/customImage.svg"))
)
)
)
)
}
val source =
"""
|/src/main/kotlin/test/Test.kt
|package example
""".trimIndent()
val writerPlugin = TestOutputWriterPlugin()
testInline(
source,
configuration,
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
run {
if (isMultiModule) {
assertNull(writerPlugin.writer.contents["images/customImage.svg"])
assertNull(writerPlugin.writer.contents["styles/customStyle.css"])
} else {
assertNotNull(writerPlugin.writer.contents["images/customImage.svg"])
assertNotNull(writerPlugin.writer.contents["styles/customStyle.css"])
}
if (isMultiModule) {
Jsoup
.parse(writerPlugin.writer.contents.getValue("example.html"))
.head()
.select("link, script")
.let {
listOf("styles/customStyle.css").forEach { r ->
assert(it.`is`("[href=$TEMPLATE_REPLACEMENT$r]"))
}
}
} else {
Jsoup
.parse(writerPlugin.writer.contents.getValue("root/example.html"))
.head()
.select("link, script")
.let {
listOf("styles/customStyle.css").forEach { r ->
assert(it.`is`("[href=../$r], [src=../$r]"))
}
}
}
}
}
}
}
@Test
fun resourceMultiModuleLinksTest() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin/test/Test.kt")
}
}
delayTemplateSubstitution = false
}
val absoluteResources = listOf(
"https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css",
"https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js"
)
val relativeResources = listOf(
"test/relativePath.js",
"test/relativePath.css"
)
val source =
"""
|/src/main/kotlin/test/Test.kt
|package example
""".trimIndent()
val writerPlugin = TestOutputWriterPlugin()
testInline(
source,
configuration,
pluginOverrides = listOf(TestResourcesAppenderPlugin(absoluteResources + relativeResources), writerPlugin)
) {
renderingStage = { _, _ ->
run {
assertNull(writerPlugin.writer.contents["scripts/relativePath.js"])
assertNull(writerPlugin.writer.contents["styles/relativePath.js"])
Jsoup
.parse(writerPlugin.writer.contents.getValue("root/example.html"))
.head()
.select("link, script")
.let {
absoluteResources.forEach { r ->
assert(it.`is`("[href=$r], [src=$r]"))
}
relativeResources.forEach { r ->
assert(it.`is`("[href=../$r] , [src=../$r]"))
}
}
}
}
}
}
@Test // see #3040; plain text added to <head> can be rendered by engines inside <body> as well
fun `should not add unknown resources as text to the head or body section`() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin")
}
}
pluginsConfigurations = mutableListOf(
PluginConfigurationImpl(
DokkaBase::class.java.canonicalName,
DokkaConfiguration.SerializationFormat.JSON,
toJsonString(
DokkaBaseConfiguration(
customAssets = listOf(File("test/unknown-file.ext"))
)
)
)
)
}
val writerPlugin = TestOutputWriterPlugin()
testInline(
"""
|/src/main/kotlin/test/Test.kt
|package test
|
|class Test
""".trimMargin(),
configuration,
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val testClassPage = writerPlugin.writer.contents
.getValue("root/test/-test/-test.html")
.let { Jsoup.parse(it) }
val headChildNodes = testClassPage.head().childNodes()
assertTrue("<head> section should not contain non-blank text nodes") {
headChildNodes.all { it !is TextNode || it.isBlank }
}
val bodyChildNodes = testClassPage.body().childNodes()
assertTrue("<body> section should not contain non-blank text nodes. Something leaked from head?") {
bodyChildNodes.all { it !is TextNode || it.isBlank }
}
}
}
}
@Test
fun `should load script as defer if name ending in _deferred`() {
val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/main/kotlin")
}
}
}
val writerPlugin = TestOutputWriterPlugin()
testInline(
"""
|/src/main/kotlin/test/Test.kt
|package test
|
|class Test
""".trimMargin(),
configuration,
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val generatedFiles = writerPlugin.writer.contents
assertContains(generatedFiles.keys, "scripts/symbol-parameters-wrapper_deferred.js")
val scripts = generatedFiles.getValue("root/test/-test/-test.html").let { Jsoup.parse(it) }.select("script")
val deferredScriptSources = scripts.filter { element -> element.hasAttr("defer") }.map { it.attr("src") }
// important to check symbol-parameters-wrapper_deferred specifically since it might break some features
assertContains(deferredScriptSources, "../../../scripts/symbol-parameters-wrapper_deferred.js")
}
}
}
}
|
