Multimodule tests (#1670)

* Multimodule tests

* Multimodule tests

8 files changed, 588 insertions, 0 deletions

diff --git a/plugins/all-modules-page/src/test/kotlin/MultiModuleDokkaTestGenerator.kt b/plugins/all-modules-page/src/test/kotlin/MultiModuleDokkaTestGenerator.kt
new file mode 100644
index 00000000..c8542dfe
--- /dev/null
+++ b/plugins/all-modules-page/src/test/kotlin/MultiModuleDokkaTestGenerator.kt
@@ -0,0 +1,81 @@
+package org.jetbrains.dokka.allModulesPage
+
+import org.jetbrains.dokka.CoreExtensions
+import org.jetbrains.dokka.DokkaConfiguration
+import org.jetbrains.dokka.DokkaGenerator
+import org.jetbrains.dokka.pages.RootPageNode
+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 MultiModuleDokkaTestGenerator(
+    configuration: DokkaConfiguration,
+    logger: DokkaLogger,
+    testMethods: MultiModuleTestMethods,
+    additionalPlugins: List<DokkaPlugin> = emptyList()
+) : DokkaTestGenerator<MultiModuleTestMethods>(
+    configuration,
+    logger,
+    testMethods,
+    additionalPlugins + AllModulesPagePlugin()
+) {
+    override fun generate() = with(testMethods) {
+        val dokkaGenerator = DokkaGenerator(configuration, logger)
+
+        val context =
+            dokkaGenerator.initializePlugins(configuration, logger, additionalPlugins + AllModulesPagePlugin())
+        pluginsSetupStage(context)
+
+        val generation = context.single(CoreExtensions.generation) as AllModulesPageGeneration
+
+        val allModulesPage = generation.createAllModulesPage()
+        allModulesPageCreationStage(allModulesPage)
+
+        val transformedPages = generation.transformAllModulesPage(allModulesPage)
+        pagesTransformationStage(transformedPages)
+
+        generation.render(transformedPages)
+        renderingStage(transformedPages, context)
+
+        generation.processSubmodules()
+        submoduleProcessingStage(context)
+    }
+
+}
+
+open class MultiModuleTestMethods(
+    open val pluginsSetupStage: (DokkaContext) -> Unit,
+    open val allModulesPageCreationStage: (RootPageNode) -> Unit,
+    open val pagesTransformationStage: (RootPageNode) -> Unit,
+    open val renderingStage: (RootPageNode, DokkaContext) -> Unit,
+    open val submoduleProcessingStage: (DokkaContext) -> Unit,
+) : TestMethods
+
+class MultiModuleTestBuilder : TestBuilder<MultiModuleTestMethods>() {
+    var pluginsSetupStage: (DokkaContext) -> Unit = {}
+    var allModulesPageCreationStage: (RootPageNode) -> Unit = {}
+    var pagesTransformationStage: (RootPageNode) -> Unit = {}
+    var renderingStage: (RootPageNode, DokkaContext) -> Unit = { _, _ -> }
+    var submoduleProcessingStage: (DokkaContext) -> Unit = {}
+
+    override fun build() = MultiModuleTestMethods(
+        pluginsSetupStage,
+        allModulesPageCreationStage,
+        pagesTransformationStage,
+        renderingStage,
+        submoduleProcessingStage,
+    )
+}
+
+abstract class MultiModuleAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger)) :
+    AbstractTest<MultiModuleTestMethods, MultiModuleTestBuilder, MultiModuleDokkaTestGenerator>(
+        ::MultiModuleTestBuilder,
+        ::MultiModuleDokkaTestGenerator,
+        logger,
+    )
diff --git a/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/AddToNavigationCommandResolutionTest.kt b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/AddToNavigationCommandResolutionTest.kt
new file mode 100644
index 00000000..f917916a
--- /dev/null
+++ b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/AddToNavigationCommandResolutionTest.kt
@@ -0,0 +1,137 @@
+package org.jetbrains.dokka.allModulesPage.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.allModulesPage.MultiModuleAbstractTest
+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
+
+class AddToNavigationCommandResolutionTest : MultiModuleAbstractTest() {
+    @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/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/AddToSearchCommandResolutionTest.kt b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/AddToSearchCommandResolutionTest.kt
new file mode 100644
index 00000000..238134c7
--- /dev/null
+++ b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/AddToSearchCommandResolutionTest.kt
@@ -0,0 +1,90 @@
+package org.jetbrains.dokka.allModulesPage.templates
+
+import org.jetbrains.dokka.DokkaModuleDescriptionImpl
+import org.jetbrains.dokka.allModulesPage.MultiModuleAbstractTest
+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 : MultiModuleAbstractTest() {
+    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/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/ResolveLinkCommandResolutionTest.kt b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/ResolveLinkCommandResolutionTest.kt
new file mode 100644
index 00000000..1b4e8638
--- /dev/null
+++ b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/ResolveLinkCommandResolutionTest.kt
@@ -0,0 +1,107 @@
+package org.jetbrains.dokka.allModulesPage.templates
+
+import kotlinx.html.a
+import kotlinx.html.span
+import kotlinx.html.stream.createHTML
+import org.jetbrains.dokka.DokkaModuleDescriptionImpl
+import org.jetbrains.dokka.allModulesPage.MultiModuleAbstractTest
+import org.jetbrains.dokka.base.renderers.html.templateCommand
+import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat
+import org.jetbrains.dokka.base.templating.ResolveLinkCommand
+import org.jetbrains.dokka.links.DRI
+import org.junit.Rule
+import org.junit.jupiter.api.Test
+import org.junit.rules.TemporaryFolder
+import java.io.File
+
+class ResolveLinkCommandResolutionTest : MultiModuleAbstractTest() {
+    @get:Rule
+    val folder: TemporaryFolder = TemporaryFolder()
+
+    fun 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 = folder.root
+    }
+
+    @Test
+    fun `should resolve link to another module`() {
+        val testedDri = DRI(
+            packageName = "package2",
+            classNames = "Sample",
+        )
+        val link = createHTML().templateCommand(ResolveLinkCommand(testedDri)) {
+            span {
+                +"Sample"
+            }
+        }
+
+        val expected = createHTML().a {
+            href = "../../module2/module2/package2/-sample/index.html"
+            span {
+                +"Sample"
+            }
+        }
+
+        val contentFile = setup(link)
+        val configuration = configuration()
+
+        testFromData(configuration, preserveOutputLocation = true) {
+            submoduleProcessingStage = {
+                assertHtmlEqualsIgnoringWhitespace(expected, contentFile.readText())
+            }
+        }
+    }
+
+    @Test
+    fun `should produce content when link is not resolvable`() {
+        val testedDri = DRI(
+            packageName = "not-resolvable-package",
+            classNames = "Sample",
+        )
+        val link = createHTML().templateCommand(ResolveLinkCommand(testedDri)) {
+            span {
+                +"Sample"
+            }
+        }
+
+        val expected = createHTML().span {
+            attributes["data-unresolved-link"] = testedDri.toString()
+            span {
+                +"Sample"
+            }
+        }
+
+        val contentFile = setup(link)
+        val configuration = configuration()
+
+        testFromData(configuration, preserveOutputLocation = true) {
+            submoduleProcessingStage = {
+                assertHtmlEqualsIgnoringWhitespace(expected, contentFile.readText())
+            }
+        }
+    }
+
+    fun setup(content: String): File {
+        folder.create()
+        val innerModule1 = folder.newFolder("module1", "module1")
+        val innerModule2 = folder.newFolder("module2", "module2")
+        val packageList = innerModule2.resolve("package-list")
+        packageList.writeText(mockedPackageListForPackages(RecognizedLinkFormat.DokkaHtml, "package2"))
+        val contentFile = innerModule1.resolve("index.html")
+        contentFile.writeText(content)
+        return contentFile
+    }
+}
\ No newline at end of file
diff --git a/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/ResolveLinkGfmCommandResolutionTest.kt b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/ResolveLinkGfmCommandResolutionTest.kt
new file mode 100644
index 00000000..62aa9338
--- /dev/null
+++ b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/ResolveLinkGfmCommandResolutionTest.kt
@@ -0,0 +1,74 @@
+package org.jetbrains.dokka.allModulesPage.templates
+
+import org.jetbrains.dokka.DokkaModuleDescriptionImpl
+import org.jetbrains.dokka.allModulesPage.MultiModuleAbstractTest
+import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat
+import org.jetbrains.dokka.gfm.GfmCommand.Companion.templateCommand
+import org.jetbrains.dokka.gfm.GfmPlugin
+import org.jetbrains.dokka.gfm.ResolveLinkGfmCommand
+import org.jetbrains.dokka.gfm.templateProcessing.GfmTemplateProcessingPlugin
+import org.jetbrains.dokka.links.DRI
+import org.junit.Rule
+import org.junit.jupiter.api.Test
+import org.junit.rules.TemporaryFolder
+import java.io.File
+import kotlin.test.assertEquals
+
+class ResolveLinkGfmCommandResolutionTest : MultiModuleAbstractTest() {
+    @get:Rule
+    val folder: TemporaryFolder = TemporaryFolder()
+
+    fun 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 = folder.root
+    }
+
+    @Test
+    fun `should resolve link to another module`(){
+        val testedDri = DRI(
+            packageName = "package2",
+            classNames = "Sample",
+        )
+
+        val link = StringBuilder().apply {
+            templateCommand(ResolveLinkGfmCommand(testedDri)){
+                append("Sample text inside")
+            }
+        }.toString()
+
+        val expected = "[Sample text inside](../../module2/module2/package2/-sample/index.md)"
+
+        val content = setup(link)
+        val configuration = configuration()
+
+        testFromData(configuration, pluginOverrides = listOf(GfmTemplateProcessingPlugin(), GfmPlugin()), preserveOutputLocation = true) {
+            submoduleProcessingStage = {
+                assertEquals(expected, content.readText().trim())
+            }
+        }
+    }
+
+    fun setup(content: String): File {
+        folder.create()
+        val innerModule1 = folder.newFolder("module1", "module1")
+        val innerModule2 = folder.newFolder("module2", "module2")
+        val packageList = innerModule2.resolve("package-list")
+        packageList.writeText(mockedPackageListForPackages(RecognizedLinkFormat.DokkaGFM, "package2"))
+        val contentFile = innerModule1.resolve("index.md")
+        contentFile.writeText(content)
+        return contentFile
+    }
+}
\ No newline at end of file
diff --git a/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/SubstitutionCommandResolutionTest.kt b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/SubstitutionCommandResolutionTest.kt
new file mode 100644
index 00000000..89984b46
--- /dev/null
+++ b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/SubstitutionCommandResolutionTest.kt
@@ -0,0 +1,69 @@
+package org.jetbrains.dokka.allModulesPage.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.allModulesPage.MultiModuleAbstractTest
+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 java.io.File
+
+class SubstitutionCommandResolutionTest : MultiModuleAbstractTest() {
+
+    @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/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/assertHtmlEqualsIgnoringWhitespace.kt b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/assertHtmlEqualsIgnoringWhitespace.kt
new file mode 100644
index 00000000..5a9ff531
--- /dev/null
+++ b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/assertHtmlEqualsIgnoringWhitespace.kt
@@ -0,0 +1,18 @@
+package org.jetbrains.dokka.allModulesPage.templates
+
+import junit.framework.Assert.assertEquals
+import org.jsoup.Jsoup
+
+/**
+ * Parses it using JSOUP, trims whitespace at the end of the line and asserts if they are equal
+ * parsing is required to unify the formatting
+ */
+fun assertHtmlEqualsIgnoringWhitespace(expected: String, actual: String) {
+    assertEquals(
+        Jsoup.parse(expected).outerHtml().trimSpacesAtTheEndOfLine(),
+        Jsoup.parse(actual).outerHtml().trimSpacesAtTheEndOfLine()
+    )
+}
+
+private fun String.trimSpacesAtTheEndOfLine(): String =
+    replace(" \n", "\n")
\ No newline at end of file
diff --git a/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/mockedPackageListFactory.kt b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/mockedPackageListFactory.kt
new file mode 100644
index 00000000..7a10041b
--- /dev/null
+++ b/plugins/all-modules-page/src/test/kotlin/org/jetbrains/dokka/allModulesPage/templates/mockedPackageListFactory.kt
@@ -0,0 +1,12 @@
+package org.jetbrains.dokka.allModulesPage.templates
+
+import org.jetbrains.dokka.base.renderers.PackageListService
+import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat
+
+internal fun mockedPackageListForPackages(format: RecognizedLinkFormat, vararg packages: String): String =
+    """
+       ${PackageListService.DOKKA_PARAM_PREFIX}.format:${format.formatName}
+       ${PackageListService.DOKKA_PARAM_PREFIX}.linkExtension:${format.linkExtension}
+       
+       ${packages.sorted().joinToString(separator = "\n", postfix = "\n") { it }}
+    """.trimIndent()
\ No newline at end of file