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
|
package org.jetbrains.dokka.tests
import com.google.inject.Guice
import com.intellij.openapi.application.PathManager
import com.intellij.openapi.util.Disposer
import com.intellij.openapi.util.io.FileUtil
import org.jetbrains.dokka.*
import org.jetbrains.dokka.Utilities.DokkaAnalysisModule
import org.jetbrains.kotlin.cli.common.messages.CompilerMessageLocation
import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
import org.jetbrains.kotlin.cli.common.messages.MessageCollector
import org.jetbrains.kotlin.cli.jvm.config.JavaSourceRoot
import org.jetbrains.kotlin.config.ContentRoot
import org.jetbrains.kotlin.config.KotlinSourceRoot
import org.junit.Assert
import org.junit.Assert.fail
import java.io.File
fun verifyModel(vararg roots: ContentRoot,
withJdk: Boolean = false,
withKotlinRuntime: Boolean = false,
format: String = "html",
includeNonPublic: Boolean = true,
verifier: (DocumentationModule) -> Unit) {
val documentation = DocumentationModule("test")
appendDocumentation(documentation, *roots,
withJdk = withJdk,
withKotlinRuntime = withKotlinRuntime,
format = format,
includeNonPublic = includeNonPublic)
verifier(documentation)
}
fun appendDocumentation(documentation: DocumentationModule,
vararg roots: ContentRoot,
withJdk: Boolean = false,
withKotlinRuntime: Boolean = false,
format: String = "html",
includeNonPublic: Boolean = true,
implicitPlatforms: List<String> = emptyList()) {
val messageCollector = object : MessageCollector {
override fun clear() {
}
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")
}
}
}
override fun hasErrors() = false
}
val environment = AnalysisEnvironment(messageCollector)
environment.apply {
if (withJdk || withKotlinRuntime) {
val stringRoot = PathManager.getResourceRoot(String::class.java, "/java/lang/String.class")
addClasspath(File(stringRoot))
}
if (withKotlinRuntime) {
val kotlinPairRoot = PathManager.getResourceRoot(Pair::class.java, "/kotlin/Pair.class")
addClasspath(File(kotlinPairRoot))
val kotlinStrictfpRoot = PathManager.getResourceRoot(Strictfp::class.java, "/kotlin/jvm/Strictfp.class")
addClasspath(File(kotlinStrictfpRoot))
}
addRoots(roots.toList())
}
val options = DocumentationOptions("", format,
includeNonPublic = includeNonPublic,
skipEmptyPackages = false,
sourceLinks = listOf<SourceLinkDefinition>(),
generateIndexPages = false)
val injector = Guice.createInjector(DokkaAnalysisModule(environment, options, implicitPlatforms, DokkaConsoleLogger))
buildDocumentationModule(injector, documentation)
Disposer.dispose(environment)
}
fun verifyModel(source: String,
withJdk: Boolean = false,
withKotlinRuntime: Boolean = false,
format: String = "html",
includeNonPublic: Boolean = true,
verifier: (DocumentationModule) -> Unit) {
if (!File(source).exists()) {
throw IllegalArgumentException("Can't find test data file $source")
}
verifyModel(contentRootFromPath(source),
withJdk = withJdk,
withKotlinRuntime = withKotlinRuntime,
format = format,
includeNonPublic = includeNonPublic,
verifier = verifier)
}
fun verifyPackageMember(source: String,
withJdk: Boolean = false,
withKotlinRuntime: Boolean = false,
verifier: (DocumentationNode) -> Unit) {
verifyModel(source, withJdk = withJdk, withKotlinRuntime = withKotlinRuntime) { model ->
val pkg = model.members.single()
verifier(pkg.members.single())
}
}
fun verifyJavaModel(source: String,
withKotlinRuntime: Boolean = false,
verifier: (DocumentationModule) -> Unit) {
val tempDir = FileUtil.createTempDirectory("dokka", "")
try {
val sourceFile = File(source)
FileUtil.copy(sourceFile, File(tempDir, sourceFile.name))
verifyModel(JavaSourceRoot(tempDir, null), withJdk = true, withKotlinRuntime = withKotlinRuntime, verifier = verifier)
}
finally {
FileUtil.delete(tempDir)
}
}
fun verifyJavaPackageMember(source: String,
withKotlinRuntime: Boolean = false,
verifier: (DocumentationNode) -> Unit) {
verifyJavaModel(source, withKotlinRuntime) { model ->
val pkg = model.members.single()
verifier(pkg.members.single())
}
}
fun verifyOutput(roots: Array<ContentRoot>,
outputExtension: String,
withJdk: Boolean = false,
withKotlinRuntime: Boolean = false,
format: String = "html",
outputGenerator: (DocumentationModule, StringBuilder) -> Unit) {
verifyModel(*roots, withJdk = withJdk, withKotlinRuntime = withKotlinRuntime, format = format) {
verifyModelOutput(it, outputExtension, roots.first().path, outputGenerator)
}
}
fun verifyModelOutput(it: DocumentationModule,
outputExtension: String,
sourcePath: String,
outputGenerator: (DocumentationModule, StringBuilder) -> Unit) {
val output = StringBuilder()
outputGenerator(it, output)
val ext = outputExtension.removePrefix(".")
val expectedFileContent = File(sourcePath.replaceAfterLast(".", ext, sourcePath + "." + ext)).readText()
val expectedOutput =
if (ext.equals("html", true))
expectedFileContent.lines().joinToString(separator = "\n", transform = String::trim)
else
expectedFileContent
assertEqualsIgnoringSeparators(expectedOutput, output.toString())
}
fun verifyOutput(path: String,
outputExtension: String,
withJdk: Boolean = false,
withKotlinRuntime: Boolean = false,
format: String = "html",
outputGenerator: (DocumentationModule, StringBuilder) -> Unit) {
verifyOutput(arrayOf(contentRootFromPath(path)), outputExtension, withJdk, withKotlinRuntime, format, outputGenerator)
}
fun verifyJavaOutput(path: String,
outputExtension: String,
withKotlinRuntime: Boolean = false,
outputGenerator: (DocumentationModule, StringBuilder) -> Unit) {
verifyJavaModel(path, withKotlinRuntime) { model ->
verifyModelOutput(model, outputExtension, path, outputGenerator)
}
}
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 -> {
if (node.language.isNotBlank())
appendln("[code lang=${node.language}]")
else
appendln("[code]")
appendChildren(node)
appendln()
appendln("[/code]")
}
is ContentNodeLink -> {
append("[")
appendChildren(node)
append(" -> ")
append(node.node.toString())
append("]")
}
is ContentBlock -> {
appendChildren(node)
}
is ContentEmpty -> { /* nothing */ }
else -> throw IllegalStateException("Don't know how to format node $node")
}
return this
}
fun ContentNode.toTestString(): String {
val node = this
return StringBuilder().apply {
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))
override val root: Location
get() = InMemoryLocation("")
}
val tempLocation = InMemoryLocation("")
val ContentRoot.path: String
get() = when(this) {
is KotlinSourceRoot -> path
is JavaSourceRoot -> file.path
else -> throw UnsupportedOperationException()
}
|
