blob: d548b75be529d2686f17b705866232437ae2b886 (
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
|
package basic
import org.jetbrains.dokka.DokkaException
import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.DokkaLogger
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertThrows
import testApi.logger.TestLogger
class FailOnWarningTest : AbstractCoreTest() {
@Test
fun `throws exception if one or more warnings were emitted`() {
val configuration = dokkaConfiguration {
failOnWarning = true
passes {
pass {
sourceRoots = listOf("src/main/kotlin")
}
}
}
assertThrows<DokkaException> {
testInline(
"""
|/src/main/kotlin
|package sample
""".trimIndent(), configuration
) {
pluginsSetupStage = {
logger.warn("Warning!")
}
}
}
}
@Test
fun `throws exception if one or more error were emitted`() {
val configuration = dokkaConfiguration {
failOnWarning = true
passes {
pass {
sourceRoots = listOf("src/main/kotlin")
}
}
}
assertThrows<DokkaException> {
testInline(
"""
|/src/main/kotlin
|package sample
""".trimIndent(), configuration
) {
pluginsSetupStage = {
logger.error("Error!")
}
}
}
}
@Test
fun `does not throw if now warning or error was emitted`() {
logger = TestLogger(ZeroErrorOrWarningCountDokkaLogger())
val configuration = dokkaConfiguration {
failOnWarning = true
passes {
pass {
sourceRoots = listOf("src/main/kotlin")
}
}
}
testInline(
"""
|/src/main/kotlin
|package sample
""".trimIndent(), configuration
) {
/* We expect no Exception */
}
}
@Test
fun `does not throw if disabled`() {
val configuration = dokkaConfiguration {
failOnWarning = false
passes {
pass {
sourceRoots = listOf("src/main/kotlin")
}
}
}
testInline(
"""
|/src/main/kotlin
|package sample
""".trimIndent(), configuration
) {
pluginsSetupStage = {
logger.warn("Error!")
logger.error("Error!")
}
}
}
}
private class ZeroErrorOrWarningCountDokkaLogger(
logger: DokkaLogger = DokkaConsoleLogger
) : DokkaLogger by logger {
override var warningsCount: Int = 0
override var errorsCount: Int = 0
}
|
