Fix tag inheritance. Fixes #3231

documentation/docs/framework/config_props.md

@@ -121,6 +121,11 @@ object KotestEngineProperties {
     * */
    const val testNameAppendTags = "kotest.framework.testname.append.tags"
 
+   /**
+    * Controls whether classes will inherit tags from their supertypes. Default false
+    */
+   const val tagInheritance = "kotest.framework.tag.inheritance"
+
    /**
     * Controls the [io.kotest.core.names.DuplicateTestNameMode] mode.
     */

kotest-framework/kotest-framework-api/src/commonMain/kotlin/io/kotest/core/config/AbstractProjectConfig.kt

@@ -226,6 +226,8 @@ abstract class AbstractProjectConfig {
 
    open val testNameAppendTags: Boolean? = null
 
+   open val tagInheritance: Boolean? = null
+
    /**
     * Controls what to do when a duplicated test name is discovered.
     * See possible settings in [DuplicateTestNameMode].

kotest-framework/kotest-framework-api/src/commonMain/kotlin/io/kotest/core/internal/KotestEngineProperties.kt

@@ -111,6 +111,11 @@ object KotestEngineProperties {
     * */
    const val testNameAppendTags = "kotest.framework.testname.append.tags"
 
+   /**
+    * Controls whether classes will inherit tags from their supertypes. Default false
+    */
+   const val tagInheritance = "kotest.framework.tag.inheritance"
+
    /**
     * Controls the [io.kotest.core.names.DuplicateTestNameMode] mode.
     */

kotest-framework/kotest-framework-engine/src/commonMain/kotlin/io/kotest/engine/config/applyConfigFromAbstractProjectConfig.kt

@@ -48,6 +48,7 @@ internal fun applyConfigFromProjectConfig(config: AbstractProjectConfig, configu
    // config
    config.defaultTestCaseConfig?.let { configuration.defaultTestConfig = it }
    config.logLevel?.let { configuration.logLevel = it }
+   config.tagInheritance?.let { configuration.tagInheritance = it }
 
    // coroutines
    config.coroutineDebugProbes?.let { configuration.coroutineDebugProbes = it }

kotest-framework/kotest-framework-engine/src/jvmMain/kotlin/io/kotest/engine/config/applyConfigFromSystemProperties.kt

@@ -30,6 +30,7 @@ internal actual fun applyConfigFromSystemProperties(configuration: ProjectConfig
    allowMultilineTestName()?.let { configuration.removeTestNameWhitespace = it }
    globalAssertSoftly()?.let { configuration.globalAssertSoftly = it }
    testNameAppendTags()?.let { configuration.testNameAppendTags = it }
+   tagInheritance()?.let { configuration.tagInheritance = it }
    duplicateTestNameMode()?.let { configuration.duplicateTestNameMode = it }
    projectTimeout()?.let { configuration.projectTimeout = it }
    logLevel(configuration.logLevel).let { configuration.logLevel = it }
@@ -65,6 +66,9 @@ internal fun globalAssertSoftly(): Boolean? =
 internal fun testNameAppendTags(): Boolean? =
    sysprop(KotestEngineProperties.testNameAppendTags)?.let { it.uppercase() == "TRUE" }
 
+internal fun tagInheritance(): Boolean? =
+   syspropOrEnv(KotestEngineProperties.tagInheritance)?.let { it.uppercase() == "TRUE" }
+
 internal fun duplicateTestNameMode(): DuplicateTestNameMode? =
    sysprop(KotestEngineProperties.duplicateTestNameMode)?.let { DuplicateTestNameMode.valueOf(it) }
 

kotest-framework/kotest-framework-engine/src/jvmTest/kotlin/com/sksamuel/kotest/engine/config/ApplyTagInheritanceConfigTest.kt

@@ -0,0 +1,69 @@
+package com.sksamuel.kotest.engine.config
+
+import io.kotest.core.config.AbstractProjectConfig
+import io.kotest.core.config.LogLevel
+import io.kotest.core.config.ProjectConfiguration
+import io.kotest.core.internal.KotestEngineProperties
+import io.kotest.core.spec.Isolate
+import io.kotest.core.spec.style.FunSpec
+import io.kotest.engine.config.applyConfigFromProjectConfig
+import io.kotest.engine.config.applyConfigFromSystemProperties
+import io.kotest.extensions.system.OverrideMode
+import io.kotest.extensions.system.withEnvironment
+import io.kotest.extensions.system.withSystemProperty
+import io.kotest.matchers.shouldBe
+
+private const val key = KotestEngineProperties.tagInheritance
+
+@Isolate
+class ApplyTagInheritanceConfigTest : FunSpec({
+   test("tag inheritance can come from sys props") {
+      val config = ProjectConfiguration()
+
+      config.tagInheritance shouldBe false
+
+      withEnvironment(key, "false", OverrideMode.SetOrOverride) {
+         withSystemProperty(key, "true", OverrideMode.SetOrOverride) {
+            applyConfigFromSystemProperties(config)
+         }
+      }
+
+      config.tagInheritance shouldBe true
+   }
+
+   test("tag inheritance can come from env vars with dots in name") {
+      val config = ProjectConfiguration()
+
+      config.tagInheritance shouldBe false
+
+      withEnvironment(key, "true", OverrideMode.SetOrOverride) {
+         applyConfigFromSystemProperties(config)
+      }
+
+      config.tagInheritance shouldBe true
+   }
+
+   test("tag inheritance can come from env vars with underscores in name") {
+      val config = ProjectConfiguration()
+
+      config.tagInheritance shouldBe false
+
+      withEnvironment(key.replace('.', '_'), "TRUE", OverrideMode.SetOrOverride) {
+         applyConfigFromSystemProperties(config)
+      }
+
+      config.tagInheritance shouldBe true
+   }
+
+   test("Tag inheritance can come from AbstractProjectConfig") {
+      val config = ProjectConfiguration()
+
+      config.tagInheritance shouldBe false
+
+      applyConfigFromProjectConfig(object : AbstractProjectConfig() {
+         override val tagInheritance = true
+      }, config)
+
+      config.tagInheritance shouldBe true
+   }
+})