aboutsummaryrefslogtreecommitdiff
path: root/plugins/templating/src/test/kotlin/templates/SubstitutionCommandResolutionTest.kt
blob: 44acf340613df7a877b62f357b6f33f8018e8a9a (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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.renderers.html.templateCommandAsHtmlComment
import org.jetbrains.dokka.base.templating.PathToRootSubstitutionCommand
import org.junit.Rule
import org.junit.jupiter.api.Test
import org.junit.rules.TemporaryFolder
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"
            }
        }
        checkSubstitutedResult(template, expected)
    }

    @Test
    fun `should handle PathToRootCommand as HTML comment`() {
        val template = createHTML().span {
            templateCommandAsHtmlComment(PathToRootSubstitutionCommand(pattern = "###", default = "default")) {
                this@span.a {
                    href = "###index.html"
                    div {
                        id = "logo"
                    }
                }
                templateCommandAsHtmlComment(PathToRootSubstitutionCommand(pattern = "####", default = "default")) {
                    this@span.a {
                        href = "####index.html"
                        div {
                            id = "logo"
                        }
                    }
                }
            }
        }

        val expected = createHTML().span {
            a {
                href = "../index.html"
                div {
                    id = "logo"
                }
            }
            a {
                href = "../index.html"
                div {
                    id = "logo"
                }
            }
        }
        checkSubstitutedResult(template, expected)
    }

    private fun createDirectoriesAndWriteContent(content: String): File {
        folder.create()
        val module1 = folder.newFolder("module1")
        val module1Content = module1.resolve("index.html")
        module1Content.writeText(content)
        return module1Content
    }

    private fun checkSubstitutedResult(template: String, expected:String) {
        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){
            finishProcessingSubmodules = {
                assertHtmlEqualsIgnoringWhitespace(expected, testedFile.readText())
            }
        }
    }
}