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
|
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package locationProvider
import org.jetbrains.dokka.base.resolvers.external.Dokka010ExternalLocationProvider
import org.jetbrains.dokka.base.resolvers.shared.ExternalDocumentation
import org.jetbrains.dokka.base.resolvers.shared.PackageList
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.links.Callable
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.links.TypeConstructor
import org.jetbrains.dokka.plugability.DokkaContext
import java.net.URL
import kotlin.test.Test
import kotlin.test.assertEquals
class Dokka010ExternalLocationProviderTest : BaseAbstractTest() {
private val testDataDir =
getTestDataDir("locationProvider").toAbsolutePath().toString().removePrefix("/").let { "/$it" }
private val kotlinLang = "https://kotlinlang.org/api/latest/jvm/stdlib"
private val packageListURL = URL("file://$testDataDir/old-package-list")
private val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
classpath += jvmStdlibPath!!
}
}
}
private fun getTestLocationProvider(context: DokkaContext? = null): Dokka010ExternalLocationProvider {
val dokkaContext = context ?: DokkaContext.create(configuration, logger, emptyList())
val packageList = PackageList.load(packageListURL, 8, true)!!
val externalDocumentation =
ExternalDocumentation(URL(kotlinLang), packageList)
return Dokka010ExternalLocationProvider(externalDocumentation, ".html", dokkaContext)
}
@Test
fun `ordinary link`() {
val locationProvider = getTestLocationProvider()
val dri = DRI("kotlin.reflect", "KVisibility")
assertEquals("$kotlinLang/kotlin.reflect/-k-visibility/index.html", locationProvider.resolve(dri))
}
@Test
fun `relocation in package list`() {
val locationProvider = getTestLocationProvider()
val dri = DRI("kotlin.text", "StringBuilder")
assertEquals("$kotlinLang/kotlin.relocated.text/-string-builder/index.html", locationProvider.resolve(dri))
}
@Test
fun `method relocation in package list`() {
val locationProvider = getTestLocationProvider()
val dri = DRI(
"kotlin",
"",
Callable(
"minus",
null,
listOf(
TypeConstructor("java.math.BigDecimal", emptyList()),
TypeConstructor("java.math.BigDecimal", emptyList())
)
)
)
assertEquals("$kotlinLang/kotlin/java.math.-big-decimal/minus.html", locationProvider.resolve(dri))
}
@Test
fun `#1268 companion part should be stripped`() {
val locationProvider = getTestLocationProvider()
val dri = DRI(
"kotlin",
"Int.Companion",
Callable(
"MIN_VALUE",
null,
emptyList()
)
)
assertEquals("$kotlinLang/kotlin/-int/-m-i-n_-v-a-l-u-e.html", locationProvider.resolve(dri))
}
@Test
fun `companion part should be stripped in relocations`() {
val locationProvider = getTestLocationProvider()
val dri = DRI(
"kotlin",
"Int.Companion",
Callable(
"MAX_VALUE",
null,
emptyList()
)
)
assertEquals("$kotlinLang/kotlin/-int/max-value.html", locationProvider.resolve(dri))
}
@Test
fun `should return null for method not in list`() {
val locationProvider = getTestLocationProvider()
val dri = DRI(
"foo",
"Bar",
Callable(
"baz",
null,
emptyList()
)
)
assertEquals(null, locationProvider.resolve(dri))
}
}
|
