From f80d5938ccafcf5bd41d73f98bebe2d9699faa95 Mon Sep 17 00:00:00 2001
From: Andrzej Ratajczak <andrzej.ratajczak98@gmail.com>
Date: Thu, 2 Jul 2020 11:33:52 +0200
Subject: Add GFM renderer tests

---
 .../test/kotlin/renderers/RenderingOnlyTestBase.kt | 77 ++-------------------
 .../src/test/kotlin/renderers/defaultSourceSet.kt  | 31 +++++++++
 .../test/kotlin/renderers/html/DivergentTest.kt    |  2 +-
 .../kotlin/renderers/html/GroupWrappingTest.kt     |  2 +-
 .../renderers/html/HtmlRenderingOnlyTestBase.kt    | 78 ++++++++++++++++++++++
 .../renderers/html/SourceSetDependentHintTest.kt   |  6 +-
 .../test/kotlin/renderers/html/defaultSourceSet.kt | 31 ---------
 7 files changed, 119 insertions(+), 108 deletions(-)
 create mode 100644 plugins/base/src/test/kotlin/renderers/defaultSourceSet.kt
 create mode 100644 plugins/base/src/test/kotlin/renderers/html/HtmlRenderingOnlyTestBase.kt
 delete mode 100644 plugins/base/src/test/kotlin/renderers/html/defaultSourceSet.kt

(limited to 'plugins/base/src/test/kotlin/renderers')

diff --git a/plugins/base/src/test/kotlin/renderers/RenderingOnlyTestBase.kt b/plugins/base/src/test/kotlin/renderers/RenderingOnlyTestBase.kt
index 21a70802..8e58bbcd 100644
--- a/plugins/base/src/test/kotlin/renderers/RenderingOnlyTestBase.kt
+++ b/plugins/base/src/test/kotlin/renderers/RenderingOnlyTestBase.kt
@@ -1,50 +1,19 @@
 package renderers
 
-import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
-import org.jetbrains.dokka.DokkaConfigurationImpl
-import org.jetbrains.dokka.base.DokkaBase
-import org.jetbrains.dokka.base.renderers.RootCreator
-import org.jetbrains.dokka.base.resolvers.external.DokkaExternalLocationProviderFactory
-import org.jetbrains.dokka.base.resolvers.external.JavadocExternalLocationProviderFactory
-import org.jetbrains.dokka.base.resolvers.local.DefaultLocationProviderFactory
 import org.jetbrains.dokka.base.signatures.KotlinSignatureProvider
-import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
 import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
 import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.model.Documentable
-import org.jetbrains.dokka.model.doc.DocTag
-import org.jetbrains.dokka.model.properties.PropertyContainer
-import org.jetbrains.dokka.pages.*
+import org.jetbrains.dokka.pages.ContentNode
+import org.jetbrains.dokka.pages.ContentPage
+import org.jetbrains.dokka.pages.PageNode
+import org.jetbrains.dokka.pages.RootPageNode
 import org.jetbrains.dokka.testApi.context.MockContext
 import org.jetbrains.dokka.utilities.DokkaConsoleLogger
-import org.jsoup.Jsoup
-import org.jsoup.nodes.Element
-import org.jsoup.nodes.Node
-import org.jsoup.nodes.TextNode
-import utils.TestOutputWriter
+import renderers.html.EmptyCommentConverter
 
 abstract class RenderingOnlyTestBase {
-    val files = TestOutputWriter()
-    val context = MockContext(
-        DokkaBase().outputWriter to { _ -> files },
-        DokkaBase().locationProviderFactory to ::DefaultLocationProviderFactory,
-        DokkaBase().htmlPreprocessors to { _ -> RootCreator },
-        DokkaBase().externalLocationProviderFactory to { ::JavadocExternalLocationProviderFactory },
-        DokkaBase().externalLocationProviderFactory to { ::DokkaExternalLocationProviderFactory },
-        testConfiguration = DokkaConfigurationImpl(
-            "", "", null, false, emptyList(), emptyList(), emptyMap(), emptyList(), false
-        )
-    )
-
-    protected val renderedContent: Element by lazy {
-        files.contents.getValue("test-page.html").let { Jsoup.parse(it) }.select("#content").single()
-    }
-
-    protected fun linesAfterContentTag() =
-        files.contents.getValue("test-page.html").lines()
-            .dropWhile { !it.contains("""<div id="content">""") }
-            .joinToString(separator = "") { it.trim() }
-
+    abstract val context: MockContext
 }
 
 class TestPage(callback: PageContentBuilder.DocumentableContentBuilder.() -> Unit) : RootPageNode(), ContentPage {
@@ -76,37 +45,3 @@ class TestPage(callback: PageContentBuilder.DocumentableContentBuilder.() -> Uni
 
     override fun modified(name: String, children: List<PageNode>) = this
 }
-
-fun Element.match(vararg matchers: Any): Unit =
-    childNodes()
-        .filter { it !is TextNode || it.text().isNotBlank() }
-        .let { it.drop(it.size - matchers.size) }
-        .zip(matchers)
-        .forEach { (n, m) -> m.accepts(n) }
-
-open class Tag(val name: String, vararg val matchers: Any)
-class Div(vararg matchers: Any) : Tag("div", *matchers)
-class P(vararg matchers: Any) : Tag("p", *matchers)
-class Span(vararg matchers: Any) : Tag("span", *matchers)
-
-private fun Any.accepts(n: Node) {
-    when (this) {
-        is String -> assert(n is TextNode && n.text().trim() == this.trim()) { "\"$this\" expected but found: $n" }
-        is Tag -> {
-            assert(n is Element && n.tagName() == name) { "Tag $name expected but found: $n" }
-            if (n is Element && matchers.isNotEmpty()) n.match(*matchers)
-        }
-        else -> throw IllegalArgumentException("$this is not proper matcher")
-    }
-}
-
-
-internal object EmptyCommentConverter : CommentsToContentConverter {
-    override fun buildContent(
-        docTag: DocTag,
-        dci: DCI,
-        sourceSets: Set<DokkaSourceSet>,
-        styles: Set<Style>,
-        extras: PropertyContainer<ContentNode>
-    ): List<ContentNode> = emptyList()
-}
\ No newline at end of file
diff --git a/plugins/base/src/test/kotlin/renderers/defaultSourceSet.kt b/plugins/base/src/test/kotlin/renderers/defaultSourceSet.kt
new file mode 100644
index 00000000..7358d2c2
--- /dev/null
+++ b/plugins/base/src/test/kotlin/renderers/defaultSourceSet.kt
@@ -0,0 +1,31 @@
+package renderers
+
+import org.jetbrains.dokka.DokkaSourceSetID
+import org.jetbrains.dokka.DokkaSourceSetImpl
+import org.jetbrains.dokka.Platform
+
+val defaultSourceSet = DokkaSourceSetImpl(
+    moduleDisplayName = "DEFAULT",
+    displayName = "DEFAULT",
+    sourceSetID = DokkaSourceSetID("DEFAULT", "DEFAULT"),
+    classpath = emptyList(),
+    sourceRoots = emptyList(),
+    dependentSourceSets = emptySet(),
+    samples = emptyList(),
+    includes = emptyList(),
+    includeNonPublic = false,
+    includeRootPackage = false,
+    reportUndocumented = false,
+    skipEmptyPackages = true,
+    skipDeprecated = false,
+    jdkVersion = 8,
+    sourceLinks = emptyList(),
+    perPackageOptions = emptyList(),
+    externalDocumentationLinks = emptyList(),
+    languageVersion = null,
+    apiVersion = null,
+    noStdlibLink = false,
+    noJdkLink = false,
+    suppressedFiles = emptyList(),
+    analysisPlatform = Platform.DEFAULT
+)
diff --git a/plugins/base/src/test/kotlin/renderers/html/DivergentTest.kt b/plugins/base/src/test/kotlin/renderers/html/DivergentTest.kt
index d4778a8e..f5565b48 100644
--- a/plugins/base/src/test/kotlin/renderers/html/DivergentTest.kt
+++ b/plugins/base/src/test/kotlin/renderers/html/DivergentTest.kt
@@ -8,7 +8,7 @@ import org.jetbrains.dokka.pages.ContentDivergentGroup
 import org.junit.jupiter.api.Test
 import renderers.*
 
-class DivergentTest : RenderingOnlyTestBase() {
+class DivergentTest : HtmlRenderingOnlyTestBase() {
     private val js = defaultSourceSet.copy(
         "root",
         "JS",
diff --git a/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt b/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt
index 43eccae6..59150e18 100644
--- a/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt
+++ b/plugins/base/src/test/kotlin/renderers/html/GroupWrappingTest.kt
@@ -5,7 +5,7 @@ import org.jetbrains.dokka.pages.TextStyle
 import org.junit.jupiter.api.Test
 import renderers.*
 
-class GroupWrappingTest: RenderingOnlyTestBase() {
+class GroupWrappingTest : HtmlRenderingOnlyTestBase() {
 
     @Test
     fun notWrapped() {
diff --git a/plugins/base/src/test/kotlin/renderers/html/HtmlRenderingOnlyTestBase.kt b/plugins/base/src/test/kotlin/renderers/html/HtmlRenderingOnlyTestBase.kt
new file mode 100644
index 00000000..69025947
--- /dev/null
+++ b/plugins/base/src/test/kotlin/renderers/html/HtmlRenderingOnlyTestBase.kt
@@ -0,0 +1,78 @@
+package renderers.html
+
+import org.jetbrains.dokka.DokkaConfiguration
+import org.jetbrains.dokka.DokkaConfigurationImpl
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.renderers.RootCreator
+import org.jetbrains.dokka.base.resolvers.external.DokkaExternalLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.external.JavadocExternalLocationProviderFactory
+import org.jetbrains.dokka.base.resolvers.local.DefaultLocationProviderFactory
+import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
+import org.jetbrains.dokka.model.doc.DocTag
+import org.jetbrains.dokka.model.properties.PropertyContainer
+import org.jetbrains.dokka.pages.*
+import org.jetbrains.dokka.testApi.context.MockContext
+import org.jsoup.Jsoup
+import org.jsoup.nodes.Element
+import org.jsoup.nodes.Node
+import org.jsoup.nodes.TextNode
+import renderers.RenderingOnlyTestBase
+import utils.TestOutputWriter
+
+abstract class HtmlRenderingOnlyTestBase : RenderingOnlyTestBase() {
+
+    val files = TestOutputWriter()
+    override val context = MockContext(
+        DokkaBase().outputWriter to { _ -> files },
+        DokkaBase().locationProviderFactory to ::DefaultLocationProviderFactory,
+        DokkaBase().htmlPreprocessors to { _ -> RootCreator },
+        DokkaBase().externalLocationProviderFactory to { ::JavadocExternalLocationProviderFactory },
+        DokkaBase().externalLocationProviderFactory to { ::DokkaExternalLocationProviderFactory },
+        testConfiguration = DokkaConfigurationImpl(
+            "", "", null, false, emptyList(), emptyList(), emptyMap(), emptyList(), false
+        )
+    )
+
+    protected val renderedContent: Element by lazy {
+        files.contents.getValue("test-page.html").let { Jsoup.parse(it) }.select("#content").single()
+    }
+
+    protected fun linesAfterContentTag() =
+        files.contents.getValue("test-page.html").lines()
+            .dropWhile { !it.contains("""<div id="content">""") }
+            .joinToString(separator = "") { it.trim() }
+}
+
+fun Element.match(vararg matchers: Any): Unit =
+    childNodes()
+        .filter { it !is TextNode || it.text().isNotBlank() }
+        .let { it.drop(it.size - matchers.size) }
+        .zip(matchers)
+        .forEach { (n, m) -> m.accepts(n) }
+
+open class Tag(val name: String, vararg val matchers: Any)
+class Div(vararg matchers: Any) : Tag("div", *matchers)
+class P(vararg matchers: Any) : Tag("p", *matchers)
+class Span(vararg matchers: Any) : Tag("span", *matchers)
+
+private fun Any.accepts(n: Node) {
+    when (this) {
+        is String -> assert(n is TextNode && n.text().trim() == this.trim()) { "\"$this\" expected but found: $n" }
+        is Tag -> {
+            assert(n is Element && n.tagName() == name) { "Tag $name expected but found: $n" }
+            if (n is Element && matchers.isNotEmpty()) n.match(*matchers)
+        }
+        else -> throw IllegalArgumentException("$this is not proper matcher")
+    }
+}
+
+
+internal object EmptyCommentConverter : CommentsToContentConverter {
+    override fun buildContent(
+        docTag: DocTag,
+        dci: DCI,
+        sourceSets: Set<DokkaConfiguration.DokkaSourceSet>,
+        styles: Set<Style>,
+        extras: PropertyContainer<ContentNode>
+    ): List<ContentNode> = emptyList()
+}
\ No newline at end of file
diff --git a/plugins/base/src/test/kotlin/renderers/html/SourceSetDependentHintTest.kt b/plugins/base/src/test/kotlin/renderers/html/SourceSetDependentHintTest.kt
index ea1ea9ae..87c67842 100644
--- a/plugins/base/src/test/kotlin/renderers/html/SourceSetDependentHintTest.kt
+++ b/plugins/base/src/test/kotlin/renderers/html/SourceSetDependentHintTest.kt
@@ -5,12 +5,10 @@ import org.jetbrains.dokka.SourceRootImpl
 import org.jetbrains.dokka.base.renderers.html.HtmlRenderer
 import org.jetbrains.dokka.pages.TextStyle
 import org.junit.jupiter.api.Test
-import renderers.Div
-import renderers.RenderingOnlyTestBase
 import renderers.TestPage
-import renderers.match
+import renderers.defaultSourceSet
 
-class SourceSetDependentHintTest : RenderingOnlyTestBase() {
+class SourceSetDependentHintTest : HtmlRenderingOnlyTestBase() {
 
     private val pl1 = defaultSourceSet.copy(
         "root",
diff --git a/plugins/base/src/test/kotlin/renderers/html/defaultSourceSet.kt b/plugins/base/src/test/kotlin/renderers/html/defaultSourceSet.kt
deleted file mode 100644
index a9be1cfd..00000000
--- a/plugins/base/src/test/kotlin/renderers/html/defaultSourceSet.kt
+++ /dev/null
@@ -1,31 +0,0 @@
-package renderers.html
-
-import org.jetbrains.dokka.DokkaSourceSetID
-import org.jetbrains.dokka.DokkaSourceSetImpl
-import org.jetbrains.dokka.Platform
-
-internal val defaultSourceSet = DokkaSourceSetImpl(
-    moduleDisplayName = "DEFAULT",
-    displayName = "DEFAULT",
-    sourceSetID = DokkaSourceSetID("DEFAULT", "DEFAULT"),
-    classpath = emptyList(),
-    sourceRoots = emptyList(),
-    dependentSourceSets = emptySet(),
-    samples = emptyList(),
-    includes = emptyList(),
-    includeNonPublic = false,
-    includeRootPackage = false,
-    reportUndocumented = false,
-    skipEmptyPackages = true,
-    skipDeprecated = false,
-    jdkVersion = 8,
-    sourceLinks = emptyList(),
-    perPackageOptions = emptyList(),
-    externalDocumentationLinks = emptyList(),
-    languageVersion = null,
-    apiVersion = null,
-    noStdlibLink = false,
-    noJdkLink = false,
-    suppressedFiles = emptyList(),
-    analysisPlatform = Platform.DEFAULT
-)
-- 
cgit