KotlinTest

Build Status Build status kotlintest by kotlintest GitHub license kotlintest by kotlintest

KotlinTest is a flexible and comprehensive testing tool for Kotlin.
Full documentation

For latest updates see Changelog

Community

Test with Style

Write simple and beautiful tests with the StringSpec style:

class MyTests : StringSpec({
  "length should return size of string" {
    "hello".length shouldBe 5
  }
  "startsWith should test for a prefix" {
    "world" should startWith("wor")
  }
})

KotlinTest comes with several testing styles so you can choose one that fits your needs.

Multitude of Matchers

Use over 120 provided matchers to test assertions on many different types:

"substring".shouldContain("str")

user.email.shouldBeLowerCase()

myImageFile.shouldHaveExtension(".jpg")

cityMap.shouldContainKey("London")

The withClue and asClue helpers can add extra context to assertions so failures are self explanatory:

withClue("Name should be present") { user.name shouldNotBe null }

data class HttpResponse(val status: Int, body: String)
val response = HttpResponse(200, "the content")
response.asClue {
    it.status shouldBe 200
    it.body shouldBe "the content"
}

Nesting is allowed in both cases and will show all available clues.

Matchers are extension methods and so your IDE will auto complete. See the full list of matchers or write your own.

Let the Computer Generate Your Test Data

Use property based testing to test your code with automatically generated test data:

class PropertyExample: StringSpec() {
  init {
    "String size" {
      assertAll { a: String, b: String ->
        (a + b) should haveLength(a.length + b.length)
      }
    }
}

Check all the Tricky Cases With Data Driven Testing

Handle even an enormous amount of input parameter combinations easily with data driven tests:

class StringSpecExample : StringSpec({
  "maximum of two numbers" {
    forall(
        row(1, 5, 5),
        row(1, 0, 1),
        row(0, 0, 0)
    ) { a, b, max ->
      Math.max(a, b) shouldBe max
    }
  }
})

Test Exceptions

Testing for exceptions is easy with KotlinTest:

val exception = shouldThrow<IllegalAccessException> {
  // code in here that you expect to throw an IllegalAccessException
}
exception.message should startWith("Something went wrong")

Fine Tune Test Execution

You can specify the number of invocations, parallelism, and a timeout for each test or for all tests. And you can group tests by tags or disable them conditionally. All you need is config:

class MySpec : StringSpec() {

  override val defaultTestCaseConfig = TestCaseConfig(invocations = 3)

  init {
    "should use config".config(timeout = 2.seconds, invocations = 10, threads = 2, tags = setOf(Database, Linux)) {
      // ...
    }
  }
}

And More …

This page gives you just a short overview of KotlinTest. There are many more features:

See full documentation.

Use

Gradle

To use in gradle, configure your build to use the JUnit Platform. For Gradle 4.6 and higher this is as simple as adding useJUnitPlatform() inside the tasks with type Test and then adding the KotlinTest dependency.

Groovy (build.gradle) ```groovy test { useJUnitPlatform() } dependencies { testImplementation 'io.kotlintest:kotlintest-runner-junit5:3.3.2' } ```
Android Project (Groovy) ```groovy android.testOptions { unitTests.all { useJUnitPlatform() } } dependencies { testImplementation 'io.kotlintest:kotlintest-runner-junit5:3.3.2' } ```

If you are using Gradle+Kotlin, this works for both Android and non-Android projects:

Kotlin (build.gradle.kts) ```kotlin tasks.withType { useJUnitPlatform() } dependencies { testImplementation("io.kotlintest:kotlintest-runner-junit5:3.3.0") } ``` </details> #### Maven For maven you must configure the surefire plugin for junit tests. ```xml org.apache.maven.plugins maven-surefire-plugin 2.22.2 ``` And then add the KotlinTest JUnit5 runner to your build. ```xml io.kotlintest kotlintest-runner-junit5 3.3.2 test ```
compile "io.kotlintest:kotlintest:2.0.7"

Related Libraries

expekt

BDD assertion library for Kotlin

Last updated 3 mins ago

assertk

assertions for kotlin inspired by assertj

Last updated 3 mins ago

atrium

A multiplatform assertion library for Kotlin

Last updated 3 mins ago

hamkrest

Hamcrest for Kotlin

Last updated 3 mins ago

mockito-kotlin

Using Mockito with Kotlin

Last updated 3 mins ago