Added --tags support to the plugin via extension properties and cli

Author: sksamuel

.editorconfig

@@ -0,0 +1,15 @@
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 3
+max_line_length = 120
+trim_trailing_whitespace = true
+ij_kotlin_enum_constants_wrap = on_every_item
+ij_any_space_after_comma = true
+
+[*.yml]
+indent_size = 3
+
+[*.gradle]
+indent_size = 3

.gitignore

@@ -12,6 +12,8 @@
 # BlueJ files
 *.ctxt
 
+build/
+
 # Mobile Tools for Java (J2ME)
 .mtj.tmp/
 

build.gradle.kts

@@ -33,6 +33,25 @@ dependencies {
    compileOnly("io.kotest:kotest-framework-api-jvm:4.4.3")
    implementation("io.kotest:kotest-framework-engine-jvm:4.4.3")
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.3")
+
+   testImplementation(Libs.Kotest.assertions)
+   testImplementation(Libs.Kotest.junit5)
+}
+
+tasks.named<Test>("test") {
+   useJUnitPlatform()
+   filter {
+      isFailOnNoMatchingTests = false
+   }
+   testLogging {
+      showExceptions = true
+      showStandardStreams = true
+      events = setOf(
+         org.gradle.api.tasks.testing.logging.TestLogEvent.FAILED,
+         org.gradle.api.tasks.testing.logging.TestLogEvent.PASSED
+      )
+      exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL
+   }
 }
 
 if (JavaVersion.current() != JavaVersion.VERSION_1_8) {

buildSrc/src/main/kotlin/Libs.kt

@@ -2,4 +2,12 @@ object Libs {
 
    const val KotlinVersion = "1.4.32"
    const val GradlePluginPublishVersion = "0.14.0"
+
+   object Kotest {
+      private const val version = "4.4.3"
+      const val shared = "io.kotest:kotest-assertions-shared:$version"
+      const val assertions = "io.kotest:kotest-assertions-core:$version"
+      const val junit5 = "io.kotest:kotest-runner-junit5:$version"
+   }
+
 }

src/main/kotlin/io/kotest/gradle/Kotest.kt

@@ -8,6 +8,7 @@ import org.gradle.api.internal.file.FileResolver
 import org.gradle.api.internal.tasks.testing.DefaultTestSuiteDescriptor
 import org.gradle.api.internal.tasks.testing.results.DefaultTestResult
 import org.gradle.api.tasks.TaskAction
+import org.gradle.api.tasks.options.Option
 import org.gradle.api.tasks.testing.Test
 import org.gradle.api.tasks.testing.TestListener
 import org.gradle.api.tasks.testing.TestOutputListener
@@ -31,6 +32,7 @@ open class Kotest @Inject constructor(
       private const val IntellijTestListenerClassName = "IJTestEventLogger"
       private const val ReporterArg = "--reporter"
       private const val TermArg = "--termcolor"
+      private const val TagsArg = "--tags"
       private const val TeamCityReporter = "teamcity"
       private const val TaycanReporter = "io.kotest.engine.reporter.TaycanConsoleReporter"
       private const val PlainColours = "ansi16"
@@ -40,6 +42,14 @@ open class Kotest @Inject constructor(
    private val listeners = mutableListOf<TestListener>()
    private val outputListeners = mutableListOf<TestOutputListener>()
 
+   private var tags: String? = null
+
+   // gradle will call this if --tags was specified on the command line
+   @Option(option = "tags", description = "Set tag expression to include or exclude tests")
+   fun setTags(tags: String) {
+      this.tags = tags
+   }
+
    // intellij will call this to register its listeners for the test event run window
    override fun addTestListener(listener: TestListener) {
       listeners.add(listener)
@@ -49,14 +59,29 @@ open class Kotest @Inject constructor(
       outputListeners.add(listener)
    }
 
+   /**
+    * Returns args to be used for the tag expression.
+    *
+    * If --tags was passed as a command line arg, then that takes precedence over the value
+    * set in the gradle build.
+    *
+    * Returns empty list if no tag expression was specified.
+    */
+   private fun tagArgs(): List<String> {
+      tags?.let { return listOf(TagsArg, it) }
+      project.kotest()?.tags?.orNull?.let { return listOf(TagsArg, it) }
+      return emptyList()
+   }
+
    // -- reporter was added in 4.2.1
    private fun args() = when {
-      isIntellij() -> listOf(ReporterArg, TeamCityReporter, TermArg, PlainColours)
-      else -> listOf(ReporterArg, TaycanReporter, TermArg, TrueColours)
+      isIntellij() -> listOf(ReporterArg, TeamCityReporter, TermArg, PlainColours) + tagArgs()
+      else -> listOf(ReporterArg, TaycanReporter, TermArg, TrueColours) + tagArgs()
    }
 
    private fun exec(classpath: FileCollection): JavaExecAction {
-      val exec = DefaultExecActionFactory.of(fileResolver, fileCollectionFactory, executorFactory, null).newJavaExecAction()
+      val exec =
+         DefaultExecActionFactory.of(fileResolver, fileCollectionFactory, executorFactory, null).newJavaExecAction()
       copyTo(exec)
 
       exec.main = "io.kotest.engine.launcher.MainKt"
@@ -80,9 +105,6 @@ open class Kotest @Inject constructor(
       return listeners.map { it::class.java.name }.any { it.contains(IntellijTestListenerClassName) }
    }
 
-   fun setTag(expression: String) {
-   }
-
    private fun rerouteTeamCityListener(exec: JavaExecAction) {
       val input = PipedInputStream()
       exec.standardOutput = PipedOutputStream(input)

src/main/kotlin/io/kotest/gradle/KotestExtension.kt

@@ -0,0 +1,12 @@
+package io.kotest.gradle
+
+import org.gradle.api.Project
+import org.gradle.api.provider.Property
+import javax.inject.Inject
+
+abstract class KotestExtension @Inject constructor(project: Project) {
+
+   private val objects = project.objects
+
+   val tags: Property<String> = objects.property(String::class.java)
+}

src/main/kotlin/io/kotest/gradle/KotestOptions.kt

@@ -7,6 +7,13 @@ import org.gradle.api.plugins.JavaPlugin
 open class KotestPlugin : Plugin<Project> {
 
    override fun apply(project: Project) {
+
+      val extension = project.extensions.create(
+         "kotest",
+         KotestExtension::class.java,
+         project
+      )
+
 //      project.plugins.withId("org.jetbrains.kotlin.multiplatform") {
 //         project.mppTestTargets().forEach { (target, files) ->
 //            applyPlugin(
@@ -49,3 +56,10 @@ open class KotestPlugin : Plugin<Project> {
    }
 }
 
+internal fun Project.kotest(): KotestExtension? {
+   return when (val ext = extensions.findByName("kotest")) {
+      is KotestExtension -> ext
+      null -> null
+      else -> throw IllegalStateException("kotest is not of the correct type")
+   }
+}

src/main/kotlin/io/kotest/gradle/KotestPlugin.kt

@@ -0,0 +1,24 @@
+package io.kotest.gradle
+
+import io.kotest.core.spec.style.WordSpec
+import io.kotest.matchers.shouldNotBe
+import org.gradle.testfixtures.ProjectBuilder
+
+class KotestPluginTest : WordSpec({
+
+   "Using the Plugin ID" should {
+      "Apply the Plugin" {
+         val project = ProjectBuilder.builder().build()
+         project.pluginManager.apply("io.kotest")
+
+         project.plugins.getPlugin(KotestPlugin::class.java) shouldNotBe null
+      }
+      "Register the 'kotest' extension" {
+         val project = ProjectBuilder.builder().build()
+         project.pluginManager.apply(KotestPlugin::class.java)
+
+         project.kotest() shouldNotBe null
+      }
+   }
+
+})