aboutsummaryrefslogtreecommitdiff
path: root/plugins/templating/src/test/kotlin/templates/TemplatingDokkaTestGenerator.kt
blob: 50a68efb26220581b730cf741954f79360632e9c (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
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)

        generation.finishProcessing()
        finishProcessingSubmodules(context)
    }

}

open class TemplatingTestMethods(
    open val pluginsSetupStage: (DokkaContext) -> Unit,
    open val submoduleProcessingStage: (DokkaContext) -> Unit,
    open val finishProcessingSubmodules: (DokkaContext) -> Unit,
) : TestMethods

class TemplatingTestBuilder : TestBuilder<TemplatingTestMethods>() {
    var pluginsSetupStage: (DokkaContext) -> Unit = {}
    var submoduleProcessingStage: (DokkaContext) -> Unit = {}
    var finishProcessingSubmodules: (DokkaContext) -> Unit = {}

    override fun build() = TemplatingTestMethods(
        pluginsSetupStage,
        submoduleProcessingStage,
        finishProcessingSubmodules,
    )
}

abstract class TemplatingAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger())) :
    AbstractTest<TemplatingTestMethods, TemplatingTestBuilder, TemplatingDokkaTestGenerator>(
        ::TemplatingTestBuilder,
        ::TemplatingDokkaTestGenerator,
        logger,
    )