First steps

1. Add the TestBalloon Gradle plugin to your build script:

   plugins {
       id("de.infix.testBalloon") version "$testBalloonVersion"
   }
   

   Info

   To choose a $testBalloonVersion, please check the compatibility sections in the CHANGELOG.

2. Add a dependency for the TestBalloon framework core library:

   Kotlin MultiplatformKotlin JVM

   commonTest {
       dependencies {
           implementation("de.infix.testBalloon:testBalloon-framework-core:$testBalloonVersion")
       }
   }
   

   dependencies {
       testImplementation("de.infix.testBalloon:testBalloon-framework-core:$testBalloonVersion")
   }
   

   Info

   The repository contains a Multiplatform configuration example.

3. Add extra dependencies for Android (optional):

   Kotlin Multiplatform with Android host-side testsKotlin Multiplatform with Android device-side testsAndroid-only host-side testsAndroid-only device-side tests

   named("androidHostTest") { // (1)!
       dependencies {
           implementation("junit:junit:$junit4Version")
       }
   }
   

   1. Using the com.android.kotlin.multiplatform.library plugin.

   named("androidDeviceTest") { // (1)!
       dependencies {
           implementation("androidx.test:runner:$androidxRunnerVersion")
       }
   }
   

   1. Using the com.android.kotlin.multiplatform.library plugin.

   dependencies {
       testImplementation("de.infix.testBalloon:testBalloon-framework-core:$testBalloonVersion")
       testImplementation("junit:junit:$junit4Version")
   }
   

   dependencies {
       androidTestImplementation("de.infix.testBalloon:testBalloon-framework-core:$testBalloonVersion")
       androidTestImplementation("androidx.test:runner:$androidxRunnerVersion")
   }
   

   Info

   The repository contains configuration examples for Android and Multiplatform library with Android.

4. Add a dependency for the assertion library of your choice:

   kotlin.test assertionsKotest assertions

   implementation(kotlin("test"))
   

   implementation("de.infix.testBalloon:testBalloon-integration-kotest-assertions:$testBalloonVersion")
   

   Info

   The above is for a Kotlin Multiplatform test source set. For Kotlin JVM or Android, use testImplementation(...) or androidTestImplementation(...) as usual.

5. Write a test:

   val MyFirstTestSuite by testSuite {
       test("string length") {
           assertEquals(8, "Test me!".length)
       }
   }
   

6. Run tests via the familiar Gradle test tasks.

7. Install the TestBalloon plugin for IntelliJ IDEA from the JetBrains Marketplace to run individual tests or test suites via the editor’s gutter icons.