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
|
package org.jetbrains.dokka.tests
import org.jetbrains.kotlin.cli.common.messages.*
import com.intellij.openapi.util.*
import kotlin.test.fail
import org.jetbrains.dokka.*
import java.io.File
import com.intellij.openapi.application.PathManager
import org.junit.Assert
public fun verifyModel(vararg files: String, verifier: (DocumentationModule) -> Unit) {
val messageCollector = object : MessageCollector {
override fun report(severity: CompilerMessageSeverity, message: String, location: CompilerMessageLocation) {
when (severity) {
CompilerMessageSeverity.WARNING,
CompilerMessageSeverity.LOGGING,
CompilerMessageSeverity.OUTPUT,
CompilerMessageSeverity.INFO,
CompilerMessageSeverity.ERROR -> {
println("$severity: $message at $location")
}
CompilerMessageSeverity.EXCEPTION -> {
fail("$severity: $message at $location")
}
}
}
}
val environment = AnalysisEnvironment(messageCollector) {
val stringRoot = PathManager.getResourceRoot(javaClass<String>(), "/java/lang/String.class")
addClasspath(File(stringRoot))
addSources(files.toList())
}
val options = DocumentationOptions(includeNonPublic = true, sourceLinks = listOf<SourceLinkDefinition>())
val documentation = buildDocumentationModule(environment, "test", options, logger = DokkaConsoleLogger)
verifier(documentation)
Disposer.dispose(environment)
}
public fun verifyPackageMember(vararg files: String, verifier: (DocumentationNode) -> Unit) {
verifyModel(*files) { model ->
val pkg = model.members.single()
verifier(pkg.members.single())
}
}
public fun verifyOutput(path: String, outputExtension: String, outputGenerator: (DocumentationModule, StringBuilder) -> Unit) {
verifyModel(path) {
val output = StringBuilder()
outputGenerator(it, output)
val expectedOutput = File(path.replace(".kt", outputExtension)).readText()
assertEqualsIgnoringSeparators(expectedOutput, output.toString())
}
}
public fun assertEqualsIgnoringSeparators(expectedOutput: String, output: String) {
Assert.assertEquals(expectedOutput.replace("\r\n", "\n"), output.replace("\r\n", "\n"))
}
fun StringBuilder.appendChildren(node: ContentBlock): StringBuilder {
for (child in node.children) {
val childText = child.toTestString()
append(childText)
}
return this
}
fun StringBuilder.appendNode(node: ContentNode): StringBuilder {
when (node) {
is ContentText -> {
append(node.text)
}
is ContentEmphasis -> append("*").appendChildren(node).append("*")
is ContentBlockCode -> {
appendln("[code]")
appendChildren(node)
appendln()
appendln("[/code]")
}
is ContentNodeLink -> {
append("[")
appendChildren(node)
append(" -> ")
append(node.node.toString())
append("]")
}
is ContentBlock -> {
appendChildren(node)
}
else -> throw IllegalStateException("Don't know how to format node $node")
}
return this
}
fun ContentNode.toTestString(): String {
val node = this
return StringBuilder {
appendNode(node)
}.toString()
}
class InMemoryLocation(override val path: String): Location {
override fun relativePathTo(other: Location, anchor: String?): String =
if (anchor != null) other.path + "#" + anchor else other.path
}
object InMemoryLocationService: LocationService {
override fun location(qualifiedName: List<String>, hasMembers: Boolean) =
InMemoryLocation(relativePathToNode(qualifiedName, hasMembers))
}
val tempLocation = InMemoryLocation("")
|
