aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest2.kt
blob: e209a170e4815af3dac146cea2c50db55f3b3eac (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
package transformers

import org.jetbrains.dokka.base.transformers.documentables.ModuleAndPackageDocumentationReader
import org.jetbrains.dokka.model.DModule
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.junit.jupiter.api.Assertions.*
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import testApi.testRunner.dokkaConfiguration
import testApi.testRunner.sourceSet


class ContextModuleAndPackageDocumentationReaderTest2: AbstractContextModuleAndPackageDocumentationReaderTest() {

    private val include by lazy { temporaryDirectory.resolve("include.md").toFile() }

    @BeforeEach
    fun materializeInclude() {
        include.writeText(
            """
            # Module MyModuleDisplayName
            Matching: moduleDisplayName
            
            # Module myModuleName
            Matching: moduleName
            """.trimIndent()
        )
    }

    private val sourceSet by lazy {
        sourceSet {
            moduleName = "myModuleName"
            moduleDisplayName = "MyModuleDisplayName"
            includes = listOf(include.canonicalPath)
        }
    }

    private val context by lazy {
        DokkaContext.create(
            configuration = dokkaConfiguration {
                sourceSets {
                    add(sourceSet)
                }
            },
            logger = DokkaConsoleLogger,
            pluginOverrides = emptyList()
        )
    }

    private val reader by lazy { ModuleAndPackageDocumentationReader(context) }


    @Test
    fun `module matches for moduleName and moduleDisplayName`() {
        val documentation = reader[DModule("myModuleName", sourceSets = setOf(sourceSet))]
        assertEquals(1, documentation.keys.size, "Expected only one entry from sourceSet")
        assertEquals(sourceSet, documentation.keys.single(), "Expected only one entry from sourceSet")
        assertEquals(
            listOf("Matching: moduleDisplayName", "Matching: moduleName"), documentation.texts
        )
    }
}