aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/test/kotlin/basic/FailOnWarningTest.kt
blob: 682a257ed265370f3be07d3c0e0e2e4e6c755b12 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
package basic

import org.jetbrains.dokka.DokkaException
import org.jetbrains.dokka.testApi.logger.TestLogger
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.DokkaLogger
import org.jetbrains.dokka.utilities.LoggingLevel
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertThrows

class FailOnWarningTest : BaseAbstractTest() {

    @Test
    fun `throws exception if one or more warnings were emitted`() {
        val configuration = dokkaConfiguration {
            failOnWarning = true
            sourceSets {
                sourceSet {
                    sourceRoots = listOf("src/main/kotlin")
                }
            }
        }

        assertThrows<DokkaException> {
            testInline(
                """
                |/src/main/kotlin/Bar.kt
                |package sample
                |class Bar {}
                """.trimIndent(), configuration
            ) {
                pluginsSetupStage = {
                    logger.warn("Warning!")
                }
            }
        }
    }

    @Test
    fun `throws exception if one or more error were emitted`() {
        val configuration = dokkaConfiguration {
            failOnWarning = true
            sourceSets {
                sourceSet {
                    sourceRoots = listOf("src/main/kotlin")
                }
            }
        }

        assertThrows<DokkaException> {
            testInline(
                """
                |/src/main/kotlin/Bar.kt
                |package sample
                |class Bar {}
                """.trimIndent(), configuration
            ) {
                pluginsSetupStage = {
                    logger.error("Error!")
                }
            }
        }
    }

    @Test
    fun `does not throw if now warning or error was emitted`() {

        val configuration = dokkaConfiguration {
            failOnWarning = true
            sourceSets {
                sourceSet {
                    sourceRoots = listOf("src/main/kotlin")
                }
            }
        }


        testInline(
            """
                |/src/main/kotlin/Bar.kt
                |package sample
                |class Bar {}
                """.trimIndent(),
            configuration,
            loggerForTest = TestLogger(ZeroErrorOrWarningCountDokkaLogger())
        ) {
            /* We expect no Exception */
        }
    }

    @Test
    fun `does not throw if disabled`() {
        val configuration = dokkaConfiguration {
            failOnWarning = false
            sourceSets {
                sourceSet {
                    sourceRoots = listOf("src/main/kotlin")
                }
            }
        }


        testInline(
            """
                |/src/main/kotlin/Bar.kt
                |package sample
                |class Bar {}
                """.trimIndent(), configuration
        ) {
            pluginsSetupStage = {
                logger.warn("Error!")
                logger.error("Error!")
            }
        }
    }
}

private class ZeroErrorOrWarningCountDokkaLogger(
    logger: DokkaLogger = DokkaConsoleLogger(LoggingLevel.DEBUG)
) : DokkaLogger by logger {
    override var warningsCount: Int = 0
    override var errorsCount: Int = 0
}