aboutsummaryrefslogtreecommitdiff
path: root/plugins/all-modules-page/src/test/kotlin/templates/MultiModuleDocumentationTest.kt
blob: 64948be8b043352634b2330d7afa391e4bb1d690 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package org.jetbrains.dokka.allModulesPage.templates

import matchers.content.*
import org.jetbrains.dokka.allModulesPage.MultiModuleAbstractTest
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.pages.ContentKind
import org.jetbrains.dokka.pages.ContentResolvedLink
import org.jetbrains.dokka.pages.MultimoduleRootPageNode
import org.junit.Rule
import org.junit.jupiter.api.AfterEach
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import org.junit.rules.TemporaryFolder
import kotlin.test.assertEquals

class MultiModuleDocumentationTest : MultiModuleAbstractTest() {
    @get:Rule
    val folder: TemporaryFolder = TemporaryFolder()

    val documentationContent = """
        # Sample project
        Sample documentation with [external link](https://www.google.pl)
    """.trimIndent()

    @BeforeEach
    fun setup() {
        folder.create()
        folder.root.resolve("README.md").writeText(documentationContent)
    }

    @AfterEach
    fun teardown(){
        folder.root.resolve("README.md").delete()
    }

    @Test
    fun `documentation should be included in all modules page`() {
        val configuration = dokkaConfiguration {
            includes = listOf(folder.root.resolve("README.md"))
        }

        testFromData(configuration, preserveOutputLocation = true) {
            allModulesPageCreationStage = { rootPage ->
                (rootPage as? MultimoduleRootPageNode)?.content?.dfs { it.dci.kind == ContentKind.Cover }?.children?.firstOrNull()
                    ?.assertNode {
                        group {
                            group {
                                group {
                                    header(1) {
                                        +"Sample project"
                                    }
                                    group {
                                        +"Sample documentation with "
                                        link {
                                            +"external link"
                                            check {
                                                assertEquals(
                                                    "https://www.google.pl",
                                                    (this as ContentResolvedLink).address
                                                )
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
            }
        }
    }
}