Implement "failOnWarning" option

1 files changed, 118 insertions, 0 deletions

diff --git a/plugins/base/src/test/kotlin/basic/FailOnWarningTest.kt b/plugins/base/src/test/kotlin/basic/FailOnWarningTest.kt
new file mode 100644
index 00000000..2c805110
--- /dev/null
+++ b/plugins/base/src/test/kotlin/basic/FailOnWarningTest.kt
@@ -0,0 +1,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
+            ) {
+                analysisSetupStage = {
+                    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
+            ) {
+                analysisSetupStage = {
+                    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
+        ) {
+            analysisSetupStage = {
+                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
+}
\ No newline at end of file