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(), "/java/lang/String.class") addClasspath(File(stringRoot)) addSources(files.toList()) addClasspath(files.map { File(it)}.filter { it.isDirectory()} ) } val options = DocumentationOptions(includeNonPublic = true, skipEmptyPackages = false, sourceLinks = listOf()) 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 ext = outputExtension.trimLeading(".") val expectedOutput = File(path.replaceAfterLast(".", ext, path + "." + ext)).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, hasMembers: Boolean) = InMemoryLocation(relativePathToNode(qualifiedName, hasMembers)) } val tempLocation = InMemoryLocation("")