From 6d1e25756c3e8c43ce4d5721e7665f439a19e47c Mon Sep 17 00:00:00 2001
From: Andrzej Ratajczak <andrzej.ratajczak98@gmail.com>
Date: Wed, 8 Jul 2020 10:33:26 +0200
Subject: Move common base test utils to submodule

---
 .../main/kotlin/renderers/RenderingOnlyTestBase.kt |  8 ++++
 .../src/main/kotlin/renderers/TestPage.kt          | 52 ++++++++++++++++++++++
 .../src/main/kotlin/renderers/defaultSourceSet.kt  | 31 +++++++++++++
 .../src/main/kotlin/utils/TestOutputWriter.kt      | 32 +++++++++++++
 4 files changed, 123 insertions(+)
 create mode 100644 plugins/base/test-utils/src/main/kotlin/renderers/RenderingOnlyTestBase.kt
 create mode 100644 plugins/base/test-utils/src/main/kotlin/renderers/TestPage.kt
 create mode 100644 plugins/base/test-utils/src/main/kotlin/renderers/defaultSourceSet.kt
 create mode 100644 plugins/base/test-utils/src/main/kotlin/utils/TestOutputWriter.kt

(limited to 'plugins/base/test-utils/src/main')

diff --git a/plugins/base/test-utils/src/main/kotlin/renderers/RenderingOnlyTestBase.kt b/plugins/base/test-utils/src/main/kotlin/renderers/RenderingOnlyTestBase.kt
new file mode 100644
index 00000000..e5ff8fa8
--- /dev/null
+++ b/plugins/base/test-utils/src/main/kotlin/renderers/RenderingOnlyTestBase.kt
@@ -0,0 +1,8 @@
+package renderers
+
+import org.jetbrains.dokka.testApi.context.MockContext
+
+abstract class RenderingOnlyTestBase<T> {
+    abstract val context: MockContext
+    abstract val renderedContent: T
+}
diff --git a/plugins/base/test-utils/src/main/kotlin/renderers/TestPage.kt b/plugins/base/test-utils/src/main/kotlin/renderers/TestPage.kt
new file mode 100644
index 00000000..0dae8ce6
--- /dev/null
+++ b/plugins/base/test-utils/src/main/kotlin/renderers/TestPage.kt
@@ -0,0 +1,52 @@
+package renderers
+
+import org.jetbrains.dokka.DokkaConfiguration
+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.utilities.DokkaConsoleLogger
+import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
+import org.jetbrains.dokka.base.signatures.KotlinSignatureProvider
+import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
+
+class TestPage(callback: PageContentBuilder.DocumentableContentBuilder.() -> Unit) : RootPageNode(), ContentPage {
+    override val dri: Set<DRI> = setOf(DRI.topLevel)
+    override val documentable: Documentable? = null
+    override val embeddedResources: List<String> = emptyList()
+    override val name: String
+        get() = "testPage"
+    override val children: List<PageNode>
+        get() = emptyList()
+
+    override val content: ContentNode = PageContentBuilder(
+        EmptyCommentConverter,
+        KotlinSignatureProvider(EmptyCommentConverter, DokkaConsoleLogger),
+        DokkaConsoleLogger
+    ).contentFor(
+        DRI.topLevel,
+        emptySet(),
+        block = callback
+    )
+
+    override fun modified(
+        name: String,
+        content: ContentNode,
+        dri: Set<DRI>,
+        embeddedResources: List<String>,
+        children: List<PageNode>
+    ) = this
+
+    override fun modified(name: String, children: List<PageNode>) = this
+}
+
+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/test-utils/src/main/kotlin/renderers/defaultSourceSet.kt b/plugins/base/test-utils/src/main/kotlin/renderers/defaultSourceSet.kt
new file mode 100644
index 00000000..7358d2c2
--- /dev/null
+++ b/plugins/base/test-utils/src/main/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/test-utils/src/main/kotlin/utils/TestOutputWriter.kt b/plugins/base/test-utils/src/main/kotlin/utils/TestOutputWriter.kt
new file mode 100644
index 00000000..00b865b4
--- /dev/null
+++ b/plugins/base/test-utils/src/main/kotlin/utils/TestOutputWriter.kt
@@ -0,0 +1,32 @@
+package utils
+
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.renderers.OutputWriter
+import org.jetbrains.dokka.plugability.DokkaPlugin
+
+class TestOutputWriterPlugin(failOnOverwrite: Boolean = true) : DokkaPlugin() {
+    val writer = TestOutputWriter(failOnOverwrite)
+
+    private val dokkaBase by lazy { plugin<DokkaBase>() }
+
+    val testWriter by extending {
+        (dokkaBase.outputWriter
+                with writer
+                override dokkaBase.fileWriter)
+    }
+}
+
+class TestOutputWriter(private val failOnOverwrite: Boolean = true) : OutputWriter {
+    val contents: Map<String, String> get() = _contents
+
+    private val _contents = mutableMapOf<String, String>()
+    override suspend fun write(path: String, text: String, ext: String) {
+        val fullPath = "$path$ext"
+        _contents.putIfAbsent(fullPath, text)?.also {
+            if (failOnOverwrite) throw AssertionError("File $fullPath is being overwritten.")
+        }
+    }
+
+    override suspend fun writeResources(pathFrom: String, pathTo: String) =
+        write(pathTo, "*** content of $pathFrom ***", "")
+}
-- 
cgit