Versioning (#1654)

* Adding versioning mechanism for multimodule

* Versioning improvement

* Refactor configuration, add ordering

* Fix integration tests

* Change packages, unignore test

Co-authored-by: Marcin Aman <marcin.aman@gmail.com>

6 files changed, 396 insertions, 0 deletions

diff --git a/plugins/templating/src/test/kotlin/templates/AddToNavigationCommandResolutionTest.kt b/plugins/templating/src/test/kotlin/templates/AddToNavigationCommandResolutionTest.kt
new file mode 100644
index 00000000..19c940c2
--- /dev/null
+++ b/plugins/templating/src/test/kotlin/templates/AddToNavigationCommandResolutionTest.kt
@@ -0,0 +1,137 @@
+package org.jetbrains.dokka.templates
+
+import kotlinx.html.a
+import kotlinx.html.div
+import kotlinx.html.id
+import kotlinx.html.span
+import kotlinx.html.stream.createHTML
+import org.jetbrains.dokka.DokkaModuleDescriptionImpl
+import org.jetbrains.dokka.base.renderers.html.templateCommand
+import org.jetbrains.dokka.base.templating.AddToNavigationCommand
+import org.jetbrains.dokka.plugability.DokkaContext
+import org.junit.Rule
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.ValueSource
+import org.junit.rules.TemporaryFolder
+import utils.assertHtmlEqualsIgnoringWhitespace
+
+class AddToNavigationCommandResolutionTest : TemplatingAbstractTest() {
+    @get:Rule
+    val folder: TemporaryFolder = TemporaryFolder()
+
+    @Test
+    fun `should substitute AddToNavigationCommand in root directory`() =
+        addToNavigationTest {
+            val output = folder.root.resolve("navigation.html").readText()
+            val expected = expectedOutput(
+                ModuleWithPrefix("module1"),
+                ModuleWithPrefix("module2")
+            )
+            assertHtmlEqualsIgnoringWhitespace(expected, output)
+        }
+
+    @ParameterizedTest
+    @ValueSource(strings = ["module1", "module2"])
+    fun `should substitute AddToNavigationCommand in modules directory`(moduleName: String) =
+        addToNavigationTest {
+            val output = folder.root.resolve(moduleName).resolve("navigation.html").readText()
+            val expected = expectedOutput(
+                ModuleWithPrefix("module1", ".."),
+                ModuleWithPrefix("module2", "..")
+            )
+            assertHtmlEqualsIgnoringWhitespace(expected, output)
+        }
+
+    private fun expectedOutput(vararg modulesWithPrefix: ModuleWithPrefix) = createHTML(prettyPrint = true)
+        .div("sideMenu") {
+            modulesWithPrefix.forEach { (moduleName, prefix) ->
+                val relativePrefix = prefix?.let { "$it/" } ?: ""
+                div("sideMenuPart") {
+                    id = "$moduleName-nav-submenu"
+                    div("overview") {
+                        a {
+                            href = "$relativePrefix$moduleName/module-page.html"
+                            span {
+                                +"module-$moduleName"
+                            }
+                        }
+                    }
+                    div("sideMenuPart") {
+                        id = "$moduleName-nav-submenu-0"
+                        div("overview") {
+                            a {
+                                href = "$relativePrefix$moduleName/$moduleName/package-page.html"
+                                span {
+                                    +"package-$moduleName"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+
+    private fun inputForModule(moduleName: String) = createHTML()
+        .templateCommand(AddToNavigationCommand(moduleName)) {
+            div("sideMenuPart") {
+                id = "$moduleName-nav-submenu"
+                div("overview") {
+                    a {
+                        href = "module-page.html"
+                        span {
+                            +"module-$moduleName"
+                        }
+                    }
+                }
+                div("sideMenuPart") {
+                    id = "$moduleName-nav-submenu-0"
+                    div("overview") {
+                        a {
+                            href = "$moduleName/package-page.html"
+                            span {
+                                +"package-$moduleName"
+                            }
+                        }
+                    }
+                }
+            }
+        }
+
+    private fun addToNavigationTest(test: (DokkaContext) -> Unit) {
+        folder.create()
+        val module1 = folder.newFolder("module1")
+        val module2 = folder.newFolder("module2")
+
+        val configuration = dokkaConfiguration {
+            modules = listOf(
+                DokkaModuleDescriptionImpl(
+                    name = "module1",
+                    relativePathToOutputDirectory = module1,
+                    includes = emptySet(),
+                    sourceOutputDirectory = module1,
+                ),
+                DokkaModuleDescriptionImpl(
+                    name = "module2",
+                    relativePathToOutputDirectory = module2,
+                    includes = emptySet(),
+                    sourceOutputDirectory = module2,
+                ),
+            )
+            this.outputDir = folder.root
+        }
+
+        val module1Navigation = module1.resolve("navigation.html")
+        module1Navigation.writeText(inputForModule("module1"))
+        val module2Navigation = module2.resolve("navigation.html")
+        module2Navigation.writeText(inputForModule("module2"))
+
+        testFromData(configuration, preserveOutputLocation = true) {
+            submoduleProcessingStage = { ctx ->
+                test(ctx)
+            }
+        }
+    }
+
+    private data class ModuleWithPrefix(val moduleName: String, val prefix: String? = null)
+}
\ No newline at end of file
diff --git a/plugins/templating/src/test/kotlin/templates/AddToSearchCommandResolutionTest.kt b/plugins/templating/src/test/kotlin/templates/AddToSearchCommandResolutionTest.kt
new file mode 100644
index 00000000..a962d524
--- /dev/null
+++ b/plugins/templating/src/test/kotlin/templates/AddToSearchCommandResolutionTest.kt
@@ -0,0 +1,89 @@
+package org.jetbrains.dokka.templates
+
+import org.jetbrains.dokka.DokkaModuleDescriptionImpl
+import org.jetbrains.dokka.base.renderers.html.SearchRecord
+import org.jetbrains.dokka.base.templating.AddToSearch
+import org.jetbrains.dokka.base.templating.parseJson
+import org.jetbrains.dokka.base.templating.toJsonString
+import org.junit.Rule
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.ValueSource
+import org.junit.rules.TemporaryFolder
+import java.io.File
+import kotlin.test.assertEquals
+
+class AddToSearchCommandResolutionTest : TemplatingAbstractTest() {
+    companion object {
+        val elements = listOf(
+            SearchRecord(name = "name1", location = "location1"),
+            SearchRecord(name = "name2", location = "location2")
+        )
+        val fromModule1 = AddToSearch(
+            moduleName = "module1",
+            elements = elements
+        )
+        val fromModule2 = AddToSearch(
+            moduleName = "module2",
+            elements = elements
+        )
+    }
+
+    @get:Rule
+    val folder: TemporaryFolder = TemporaryFolder()
+
+    @ParameterizedTest
+    @ValueSource(strings = ["navigation-pane.json", "pages.json"])
+    fun `should merge navigation templates`(fileName: String) {
+        val (module1Navigation, module2Navigation) = setupTestDirectoriesWithContent(fileName)
+
+        val outputDir = folder.root
+        val configuration = dokkaConfiguration {
+            modules = listOf(
+                DokkaModuleDescriptionImpl(
+                    name = "module1",
+                    relativePathToOutputDirectory = folder.root.resolve("module1"),
+                    includes = emptySet(),
+                    sourceOutputDirectory = folder.root.resolve("module1"),
+                ),
+                DokkaModuleDescriptionImpl(
+                    name = "module2",
+                    relativePathToOutputDirectory = folder.root.resolve("module2"),
+                    includes = emptySet(),
+                    sourceOutputDirectory = folder.root.resolve("module2"),
+                ),
+            )
+            this.outputDir = outputDir
+        }
+
+        testFromData(configuration, preserveOutputLocation = true) {
+            submoduleProcessingStage = { _ ->
+                val expected = elements.map { it.copy(location = "module1/${it.location}") } +
+                        elements.map { it.copy(location = "module2/${it.location}") }
+
+                val output =
+                    parseJson<List<SearchRecord>>(outputDir.resolve("scripts/${fileName}").readText())
+                assertEquals(expected, output.sortedBy { it.location })
+
+                val outputFromModule1 = parseJson<List<SearchRecord>>(module1Navigation.readText())
+                assertEquals(expected, outputFromModule1.sortedBy { it.location })
+
+                val outputFromModule2 = parseJson<List<SearchRecord>>(module2Navigation.readText())
+                assertEquals(expected, outputFromModule2.sortedBy { it.location })
+            }
+        }
+    }
+
+    private fun setupTestDirectoriesWithContent(fileName: String): List<File> {
+        folder.create()
+        val scriptsForModule1 = folder.newFolder("module1", "scripts")
+        val scriptsForModule2 = folder.newFolder("module2", "scripts")
+        folder.newFolder("scripts")
+
+        val module1Navigation = scriptsForModule1.resolve(fileName)
+        module1Navigation.writeText(toJsonString(fromModule1))
+        val module2Navigation = scriptsForModule2.resolve(fileName)
+        module2Navigation.writeText(toJsonString(fromModule2))
+
+        return listOf(module1Navigation, module2Navigation)
+    }
+}
\ No newline at end of file
diff --git a/plugins/templating/src/test/kotlin/templates/SubstitutionCommandResolutionTest.kt b/plugins/templating/src/test/kotlin/templates/SubstitutionCommandResolutionTest.kt
new file mode 100644
index 00000000..d7143f11
--- /dev/null
+++ b/plugins/templating/src/test/kotlin/templates/SubstitutionCommandResolutionTest.kt
@@ -0,0 +1,69 @@
+package org.jetbrains.dokka.templates
+
+import kotlinx.html.a
+import kotlinx.html.div
+import kotlinx.html.id
+import kotlinx.html.stream.createHTML
+import org.jetbrains.dokka.DokkaModuleDescriptionImpl
+import org.jetbrains.dokka.base.renderers.html.templateCommand
+import org.jetbrains.dokka.base.templating.PathToRootSubstitutionCommand
+import org.junit.Rule
+import org.junit.rules.TemporaryFolder
+import org.junit.jupiter.api.Test
+import utils.assertHtmlEqualsIgnoringWhitespace
+import java.io.File
+
+class SubstitutionCommandResolutionTest : TemplatingAbstractTest() {
+
+    @get:Rule
+    val folder: TemporaryFolder = TemporaryFolder()
+
+    @Test
+    fun `should handle PathToRootCommand`() {
+        val template = createHTML()
+            .templateCommand(PathToRootSubstitutionCommand(pattern = "###", default = "default")) {
+                a {
+                    href = "###index.html"
+                    div {
+                        id = "logo"
+                    }
+                }
+            }
+
+        val expected = createHTML().a {
+            href = "../index.html"
+            div {
+                id = "logo"
+            }
+        }
+
+        val testedFile = createDirectoriesAndWriteContent(template)
+
+        val configuration = dokkaConfiguration {
+            modules = listOf(
+                DokkaModuleDescriptionImpl(
+                    name = "module1",
+                    relativePathToOutputDirectory = folder.root.resolve("module1"),
+                    includes = emptySet(),
+                    sourceOutputDirectory = folder.root.resolve("module1"),
+                )
+            )
+            this.outputDir = folder.root
+        }
+
+        testFromData(configuration, preserveOutputLocation = true){
+            submoduleProcessingStage = {
+                assertHtmlEqualsIgnoringWhitespace(expected, testedFile.readText())
+            }
+        }
+    }
+
+    private fun createDirectoriesAndWriteContent(content: String): File {
+        folder.create()
+        val module1 = folder.newFolder("module1")
+        val module1Content = module1.resolve("index.html")
+        module1Content.writeText(content)
+        return module1Content
+    }
+
+}
\ No newline at end of file
diff --git a/plugins/templating/src/test/kotlin/templates/TemplatingDokkaTestGenerator.kt b/plugins/templating/src/test/kotlin/templates/TemplatingDokkaTestGenerator.kt
new file mode 100644
index 00000000..906fb1ea
--- /dev/null
+++ b/plugins/templating/src/test/kotlin/templates/TemplatingDokkaTestGenerator.kt
@@ -0,0 +1,63 @@
+package org.jetbrains.dokka.templates
+
+import org.jetbrains.dokka.CoreExtensions
+import org.jetbrains.dokka.DokkaConfiguration
+import org.jetbrains.dokka.DokkaGenerator
+import org.jetbrains.dokka.plugability.DokkaContext
+import org.jetbrains.dokka.plugability.DokkaPlugin
+import org.jetbrains.dokka.testApi.logger.TestLogger
+import org.jetbrains.dokka.testApi.testRunner.AbstractTest
+import org.jetbrains.dokka.testApi.testRunner.DokkaTestGenerator
+import org.jetbrains.dokka.testApi.testRunner.TestBuilder
+import org.jetbrains.dokka.testApi.testRunner.TestMethods
+import org.jetbrains.dokka.utilities.DokkaConsoleLogger
+import org.jetbrains.dokka.utilities.DokkaLogger
+
+class TemplatingDokkaTestGenerator(
+    configuration: DokkaConfiguration,
+    logger: DokkaLogger,
+    testMethods: TemplatingTestMethods,
+    additionalPlugins: List<DokkaPlugin> = emptyList()
+) : DokkaTestGenerator<TemplatingTestMethods>(
+    configuration,
+    logger,
+    testMethods,
+    additionalPlugins + TemplatingPlugin() + TestTemplatingPlugin()
+) {
+    override fun generate() = with(testMethods) {
+        val dokkaGenerator = DokkaGenerator(configuration, logger)
+
+        val context =
+            dokkaGenerator.initializePlugins(configuration, logger, additionalPlugins)
+
+        pluginsSetupStage(context)
+
+        val generation = context.single(CoreExtensions.generation) as TestTemplatingGeneration
+
+        generation.processSubmodules()
+        submoduleProcessingStage(context)
+    }
+
+}
+
+open class TemplatingTestMethods(
+    open val pluginsSetupStage: (DokkaContext) -> Unit,
+    open val submoduleProcessingStage: (DokkaContext) -> Unit,
+) : TestMethods
+
+class TemplatingTestBuilder : TestBuilder<TemplatingTestMethods>() {
+    var pluginsSetupStage: (DokkaContext) -> Unit = {}
+    var submoduleProcessingStage: (DokkaContext) -> Unit = {}
+
+    override fun build() = TemplatingTestMethods(
+        pluginsSetupStage,
+        submoduleProcessingStage,
+    )
+}
+
+abstract class TemplatingAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger)) :
+    AbstractTest<TemplatingTestMethods, TemplatingTestBuilder, TemplatingDokkaTestGenerator>(
+        ::TemplatingTestBuilder,
+        ::TemplatingDokkaTestGenerator,
+        logger,
+    )
diff --git a/plugins/templating/src/test/kotlin/templates/TestTemplatingGeneration.kt b/plugins/templating/src/test/kotlin/templates/TestTemplatingGeneration.kt
new file mode 100644
index 00000000..0a5bae4b
--- /dev/null
+++ b/plugins/templating/src/test/kotlin/templates/TestTemplatingGeneration.kt
@@ -0,0 +1,22 @@
+package org.jetbrains.dokka.templates
+
+import org.jetbrains.dokka.Timer
+import org.jetbrains.dokka.generation.Generation
+import org.jetbrains.dokka.plugability.DokkaContext
+import org.jetbrains.dokka.plugability.plugin
+import org.jetbrains.dokka.plugability.querySingle
+
+class TestTemplatingGeneration(context: DokkaContext): Generation {
+
+    val templatingPlugin by lazy { context.plugin<TemplatingPlugin>() }
+
+    override fun Timer.generate() {
+        report("Processing submodules")
+        processSubmodules()
+    }
+
+    fun processSubmodules() =
+        templatingPlugin.querySingle { templateProcessor }.process()
+
+    override val generationName = "test template generation"
+}
\ No newline at end of file
diff --git a/plugins/templating/src/test/kotlin/templates/TestTemplatingPlugin.kt b/plugins/templating/src/test/kotlin/templates/TestTemplatingPlugin.kt
new file mode 100644
index 00000000..1ed961b8
--- /dev/null
+++ b/plugins/templating/src/test/kotlin/templates/TestTemplatingPlugin.kt
@@ -0,0 +1,16 @@
+package org.jetbrains.dokka.templates
+
+import org.jetbrains.dokka.CoreExtensions
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.plugability.DokkaPlugin
+
+class TestTemplatingPlugin: DokkaPlugin() {
+
+    val dokkaBase by lazy { plugin<DokkaBase>() }
+
+    val allModulesPageGeneration by extending {
+        (CoreExtensions.generation
+                providing ::TestTemplatingGeneration
+                override dokkaBase.singleGeneration)
+    }
+}
\ No newline at end of file