Ilya Ryzhenkov | 8a4dad4 | 2014-07-11 20:41:53 +0400 | [diff] [blame] | 1 | package org.jetbrains.dokka.tests |
Ilya Ryzhenkov | 044e1b8 | 2014-07-11 17:11:35 +0400 | [diff] [blame] | 2 | |
Alexander Udalov | 5dbadfe | 2015-01-12 12:36:54 +0300 | [diff] [blame] | 3 | import org.jetbrains.kotlin.cli.common.messages.* |
Ilya Ryzhenkov | 044e1b8 | 2014-07-11 17:11:35 +0400 | [diff] [blame] | 4 | import com.intellij.openapi.util.* |
Ilya Ryzhenkov | 044e1b8 | 2014-07-11 17:11:35 +0400 | [diff] [blame] | 5 | import kotlin.test.fail |
Ilya Ryzhenkov | 044308b | 2014-07-11 20:49:04 +0400 | [diff] [blame] | 6 | import org.jetbrains.dokka.* |
Dmitry Jemerov | c43a437 | 2014-12-29 20:22:43 +0100 | [diff] [blame] | 7 | import java.io.File |
Dmitry Jemerov | 69dd298 | 2014-12-30 18:47:03 +0100 | [diff] [blame] | 8 | import com.intellij.openapi.application.PathManager |
Dmitry Jemerov | 7fbff24 | 2015-01-09 18:54:06 +0100 | [diff] [blame] | 9 | import org.junit.Assert |
Ilya Ryzhenkov | 044e1b8 | 2014-07-11 17:11:35 +0400 | [diff] [blame] | 10 | |
Ilya Ryzhenkov | a600080 | 2014-07-12 04:23:51 +0400 | [diff] [blame] | 11 | public fun verifyModel(vararg files: String, verifier: (DocumentationModule) -> Unit) { |
Ilya Ryzhenkov | 044e1b8 | 2014-07-11 17:11:35 +0400 | [diff] [blame] | 12 | val messageCollector = object : MessageCollector { |
| 13 | override fun report(severity: CompilerMessageSeverity, message: String, location: CompilerMessageLocation) { |
| 14 | when (severity) { |
| 15 | CompilerMessageSeverity.WARNING, |
| 16 | CompilerMessageSeverity.LOGGING, |
| 17 | CompilerMessageSeverity.OUTPUT, |
| 18 | CompilerMessageSeverity.INFO, |
| 19 | CompilerMessageSeverity.ERROR -> { |
| 20 | println("$severity: $message at $location") |
| 21 | } |
| 22 | CompilerMessageSeverity.EXCEPTION -> { |
| 23 | fail("$severity: $message at $location") |
| 24 | } |
| 25 | } |
| 26 | } |
| 27 | } |
| 28 | |
Ilya Ryzhenkov | 044308b | 2014-07-11 20:49:04 +0400 | [diff] [blame] | 29 | val environment = AnalysisEnvironment(messageCollector) { |
Dmitry Jemerov | 69dd298 | 2014-12-30 18:47:03 +0100 | [diff] [blame] | 30 | val stringRoot = PathManager.getResourceRoot(javaClass<String>(), "/java/lang/String.class") |
| 31 | addClasspath(File(stringRoot)) |
Ilya Ryzhenkov | 044e1b8 | 2014-07-11 17:11:35 +0400 | [diff] [blame] | 32 | addSources(files.toList()) |
Dmitry Jemerov | fc70184 | 2015-02-25 20:06:16 +0100 | [diff] [blame] | 33 | addClasspath(files.map { File(it)}.filter { it.isDirectory()} ) |
Ilya Ryzhenkov | 044e1b8 | 2014-07-11 17:11:35 +0400 | [diff] [blame] | 34 | } |
Dmitry Jemerov | fac6872 | 2015-01-14 20:21:49 +0100 | [diff] [blame] | 35 | val options = DocumentationOptions(includeNonPublic = true, sourceLinks = listOf<SourceLinkDefinition>()) |
Dmitry Jemerov | f2fd617 | 2015-02-13 12:17:47 +0100 | [diff] [blame] | 36 | val documentation = buildDocumentationModule(environment, "test", options, logger = DokkaConsoleLogger) |
Ilya Ryzhenkov | 08e6900 | 2014-07-14 15:44:32 +0400 | [diff] [blame] | 37 | verifier(documentation) |
Ilya Ryzhenkov | 044e1b8 | 2014-07-11 17:11:35 +0400 | [diff] [blame] | 38 | Disposer.dispose(environment) |
| 39 | } |
| 40 | |
Dmitry Jemerov | aa3f051 | 2015-02-13 17:04:58 +0100 | [diff] [blame] | 41 | public fun verifyPackageMember(vararg files: String, verifier: (DocumentationNode) -> Unit) { |
| 42 | verifyModel(*files) { model -> |
| 43 | val pkg = model.members.single() |
| 44 | verifier(pkg.members.single()) |
| 45 | } |
| 46 | } |
| 47 | |
Dmitry Jemerov | 8ef6818 | 2014-12-30 12:36:14 +0100 | [diff] [blame] | 48 | public fun verifyOutput(path: String, outputExtension: String, outputGenerator: (DocumentationModule, StringBuilder) -> Unit) { |
Dmitry Jemerov | c43a437 | 2014-12-29 20:22:43 +0100 | [diff] [blame] | 49 | verifyModel(path) { |
| 50 | val output = StringBuilder() |
| 51 | outputGenerator(it, output) |
Dmitry Jemerov | fc70184 | 2015-02-25 20:06:16 +0100 | [diff] [blame] | 52 | val ext = outputExtension.trimLeading(".") |
| 53 | val expectedOutput = File(path.replaceAfterLast(".", ext, path + "." + ext)).readText() |
Dmitry Jemerov | 599f32d | 2015-01-22 11:30:57 +0100 | [diff] [blame] | 54 | assertEqualsIgnoringSeparators(expectedOutput, output.toString()) |
Dmitry Jemerov | c43a437 | 2014-12-29 20:22:43 +0100 | [diff] [blame] | 55 | } |
| 56 | } |
| 57 | |
Dmitry Jemerov | 599f32d | 2015-01-22 11:30:57 +0100 | [diff] [blame] | 58 | public fun assertEqualsIgnoringSeparators(expectedOutput: String, output: String) { |
| 59 | Assert.assertEquals(expectedOutput.replace("\r\n", "\n"), output.replace("\r\n", "\n")) |
| 60 | } |
| 61 | |
Dmitry Jemerov | 0d0fc1f | 2015-02-10 18:32:12 +0100 | [diff] [blame] | 62 | fun StringBuilder.appendChildren(node: ContentBlock): StringBuilder { |
Ilya Ryzhenkov | 778e2b3 | 2014-09-29 20:54:59 +0400 | [diff] [blame] | 63 | for (child in node.children) { |
| 64 | val childText = child.toTestString() |
| 65 | append(childText) |
| 66 | } |
| 67 | return this |
| 68 | } |
| 69 | |
Ilya Ryzhenkov | 11355ce | 2014-10-12 22:35:47 +0400 | [diff] [blame] | 70 | fun StringBuilder.appendNode(node: ContentNode): StringBuilder { |
Ilya Ryzhenkov | 778e2b3 | 2014-09-29 20:54:59 +0400 | [diff] [blame] | 71 | when (node) { |
| 72 | is ContentText -> { |
| 73 | append(node.text) |
| 74 | } |
| 75 | is ContentEmphasis -> append("*").appendChildren(node).append("*") |
Ilya Ryzhenkov | 1b5f12b | 2014-12-22 20:01:01 +0300 | [diff] [blame] | 76 | is ContentBlockCode -> { |
| 77 | appendln("[code]") |
| 78 | appendChildren(node) |
| 79 | appendln() |
| 80 | appendln("[/code]") |
| 81 | } |
Ilya Ryzhenkov | bd6cddd | 2014-12-16 21:41:32 +0300 | [diff] [blame] | 82 | is ContentNodeLink -> { |
| 83 | append("[") |
| 84 | appendChildren(node) |
| 85 | append(" -> ") |
| 86 | append(node.node.toString()) |
| 87 | append("]") |
| 88 | } |
Dmitry Jemerov | 0d0fc1f | 2015-02-10 18:32:12 +0100 | [diff] [blame] | 89 | is ContentBlock -> { |
Ilya Ryzhenkov | 778e2b3 | 2014-09-29 20:54:59 +0400 | [diff] [blame] | 90 | appendChildren(node) |
| 91 | } |
Dmitry Jemerov | 0d0fc1f | 2015-02-10 18:32:12 +0100 | [diff] [blame] | 92 | else -> throw IllegalStateException("Don't know how to format node $node") |
Ilya Ryzhenkov | 778e2b3 | 2014-09-29 20:54:59 +0400 | [diff] [blame] | 93 | } |
| 94 | return this |
| 95 | } |
| 96 | |
| 97 | fun ContentNode.toTestString(): String { |
| 98 | val node = this |
| 99 | return StringBuilder { |
| 100 | appendNode(node) |
| 101 | }.toString() |
| 102 | } |
Dmitry Jemerov | c43a437 | 2014-12-29 20:22:43 +0100 | [diff] [blame] | 103 | |
Dmitry Jemerov | d9bfa02 | 2015-02-19 18:59:00 +0100 | [diff] [blame] | 104 | class InMemoryLocation(override val path: String): Location { |
Dmitry Jemerov | 85a3ae7 | 2015-02-20 14:08:30 +0100 | [diff] [blame] | 105 | override fun relativePathTo(other: Location, anchor: String?): String = |
| 106 | if (anchor != null) other.path + "#" + anchor else other.path |
Dmitry Jemerov | d9bfa02 | 2015-02-19 18:59:00 +0100 | [diff] [blame] | 107 | } |
Dmitry Jemerov | c43a437 | 2014-12-29 20:22:43 +0100 | [diff] [blame] | 108 | |
| 109 | object InMemoryLocationService: LocationService { |
Dmitry Jemerov | ecadf40 | 2015-02-20 14:44:30 +0100 | [diff] [blame] | 110 | override fun location(qualifiedName: List<String>, hasMembers: Boolean) = |
| 111 | InMemoryLocation(relativePathToNode(qualifiedName, hasMembers)) |
Dmitry Jemerov | c43a437 | 2014-12-29 20:22:43 +0100 | [diff] [blame] | 112 | } |
Dmitry Jemerov | d9bfa02 | 2015-02-19 18:59:00 +0100 | [diff] [blame] | 113 | |
| 114 | val tempLocation = InMemoryLocation("") |