From 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 Mon Sep 17 00:00:00 2001
From: Ignat Beresnev <ignat.beresnev@jetbrains.com>
Date: Fri, 10 Nov 2023 11:46:54 +0100
Subject: Restructure the project to utilize included builds (#3174)

* Refactor and simplify artifact publishing
* Update Gradle to 8.4
* Refactor and simplify convention plugins and build scripts

Fixes #3132

---------

Co-authored-by: Adam <897017+aSemy@users.noreply.github.com>
Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
---
 .../src/test/kotlin/basic/FailOnWarningTest.kt     | 128 +++++++++++++++++++++
 1 file changed, 128 insertions(+)
 create mode 100644 dokka-subprojects/plugin-base/src/test/kotlin/basic/FailOnWarningTest.kt

(limited to 'dokka-subprojects/plugin-base/src/test/kotlin/basic/FailOnWarningTest.kt')

diff --git a/dokka-subprojects/plugin-base/src/test/kotlin/basic/FailOnWarningTest.kt b/dokka-subprojects/plugin-base/src/test/kotlin/basic/FailOnWarningTest.kt
new file mode 100644
index 00000000..ebdf7860
--- /dev/null
+++ b/dokka-subprojects/plugin-base/src/test/kotlin/basic/FailOnWarningTest.kt
@@ -0,0 +1,128 @@
+/*
+ * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package basic
+
+import org.jetbrains.dokka.DokkaException
+import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
+import org.jetbrains.dokka.testApi.logger.TestLogger
+import org.jetbrains.dokka.utilities.DokkaConsoleLogger
+import org.jetbrains.dokka.utilities.DokkaLogger
+import org.jetbrains.dokka.utilities.LoggingLevel
+import kotlin.test.Test
+import kotlin.test.assertFailsWith
+
+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")
+                }
+            }
+        }
+
+        assertFailsWith<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")
+                }
+            }
+        }
+
+        assertFailsWith<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
+}
-- 
cgit