Kotestプロジェクト設定

KotestはKotlinで書かれた強力なテストフレームワークである。プロジェクト設定の方法について説明する。

依存関係の追加

Kotestを使用するには、まずプロジェクトにライブラリを追加する必要がある。 KotestテストフレームワークはJVM、JavaScript、Nativeでサポートされている。複数のプラットフォームでKotestを使用するには、以下で説明するように各プラットフォームに合わせて設定すればよい。

JVM/Gradle

JVM/GradleプロジェクトでのKotestは、JUnit Platform Gradleプラグインを使用する。 Gradle 4.6以上では、テスト型がTestであるタスクにuseJUnitPlatform()を追加し、Kotest JUnit 5ランチャー依存関係を追加するだけでよい。

Gradle + Groovy（ビルドファイル: build.gradle）を使用する場合:

test {
  useJUnitPlatform()
}

またはGradle + Kotlin（ビルドファイル: build.gradle.kts）を使用する場合:

tasks.withType<Test>().configureEach {
   useJUnitPlatform()
}

続いて、次のようにKotest依存関係を追加する。

repositories {
    mavenCentral()
}

dependencies {
    testImplementation("io.kotest:kotest-runner-junit5:${kotestVersion}")
    // 必要に応じて他のモジュールへの依存関係も追加する。
}

JVM/Maven

JVM/Mavenプロジェクトの場合は、ビルドファイル（pom.xml）に次のような構成が必要である。

JUnitテストのためにSurefireプラグインを構成する必要がある。

<plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-surefire-plugin</artifactId>
   <version>2.22.2</version>
</plugin>

その後、Kotest JUnit 5ランナー依存関係を追加する。

<dependencies>
    <dependency>
        <groupId>io.kotest</groupId>
        <artifactId>kotest-runner-junit5</artifactId>
        <version>{kotestVersion}</version>
        <scope>test</scope>
    </dependency>
</dependencies>

Kotlin/JS

TIP

単体テストおよびデータ駆動テストの例とともに、JVM、Native、JavaScriptがすべて構成された動作中のマルチプラットフォームプロジェクトは、以下のサイトで確認できる。 - https://github.com/kotest/kotest-examples-multiplatform ビルドにKotestマルチプラットフォームGradleプラグインを追加する。

例えば、次のようにする。

plugins {
  id("io.kotest.multiplatform") version "5.0.2"
}

エンジン依存関係をcommonTest依存関係ブロックに追加する。

kotlin {
  targets {
    js(IR) { // LEGACY or BOTH are unsupported
      browser() // to compile for the web
      nodejs() // to compile against node
    }
  }

  sourceSets {
    val commonTest by getting {
      dependencies {
        implementation("io.kotest:kotest-framework-engine:$version")
      }
    }
  }
}

CAUTION

Kotlin/JS用の新しいIRコンパイラバックエンドのみがサポートされている。レガシーコンパイラバックエンドでJSをコンパイルする場合、テストにKotestを使用できない。

FunSpec、ShouldSpec、StringSpecを使ってテストを書ける。テストはcommonTestまたはjsTestソースセットに配置できる。gradle checkコマンドを使ってテストを実行する。

JavaScriptテストエンジンは、JVMテストエンジンと比べると機能が制限されている。最大の制限は、Kotlinが実行時にアノテーションをJavaScriptコードへ公開しないため、アノテーションベースの構成が動作しないことである。

NOTE

JavaScript用のテストはネストできない。これは、基盤となるJavaScriptテストランナー（MochaやKarmaなど）が親テストでコルーチンと互換性のあるPromiseをサポートしておらず、Kotestではすべてのテストスコープがコルーチンであるためである。そのため、サポートされるSpecは`FunSpec`、`ShouldSpec`、`StringSpec`に限定される。

INFO

IntelliJ Kotestプラグインは、緑色の実行アイコンを使ってIDEから直接、通常、Native、JSテストを実行することをサポートしていない。Gradle経由での実行のみがサポートされる。

Kotlin/Native

Kotlin/Nativeプロジェクトでも、Kotlin/JSプロジェクトと同様にKotestマルチプラットフォームGradleプラグインを追加する必要がある。

plugins {
  id("io.kotest.multiplatform") version "5.0.2"
}

エンジン依存関係をcommonTest依存関係ブロックに追加する。

kotlin {
  targets {
    linuxX64() // can add any supported native targets such as linux, mac, windows etc
  }
}
sourceSets {
  val commonTest by getting {
    dependencies {
      implementation("io.kotest:kotest-framework-engine:$version")
    }
  }
}

テストはcommonTestまたは特定のNativeソースセットに配置できる。gradle checkコマンドを使ってテストを実行する。

Nativeテストエンジンは、JVMテストエンジンと比べると機能が制限されている。最大の制限は、Kotlinが実行時にアノテーションをNativeコードへ公開しないため、アノテーションベースの構成が動作しないことである。

参考 IntelliJ Kotestプラグインは、IDEから通常、Native、JSテストを実行することをサポートしていない。Gradleのcheckタスクを使用する必要がある。

Android

INFO

現在、KotestではJVMテストのみが公式にサポートされている。次の手順により、通常はモジュールの`src/test`フォルダにある、Androidフレームワークを必要としない、またはモックされるユニットテストおよび統合テストでKotestを使用できる。

AndroidのKotestはJUnit Platform Gradleプラグインを使用する。そのためには、ビルドファイルでAndroidテストオプションブロックを構成し、その後Kotest JUnit 5ランチャー依存関係を追加する必要がある。

android.testOptions {
   unitTests.all {
      it.useJUnitPlatform()
   }
}

dependencies {
   testImplementation 'io.kotest:kotest-runner-junit5:{version}'
}

Kotestバージョン

ここでは${kotestVersion}に使用したいKotestバージョンを指定する。

2024年4月時点で、Kotestの最新バージョンは2024年3月11日にリリースされた5.8.1である。 https://central.sonatype.com/artifact/io.kotest/kotest-runner-junit5

kotest-runner-junit5とkotest-runner-junit5-jvmの違いは？

KotestテストをJUnit 5テストエンジンとして実行するための基本的なランナーには、`jvm`が付いたバージョンと付いていないバージョンの2種類が存在する。この2つのバージョンの違いは、Kotestがどこで使用されるかによって異なる。 - **kotest-runner-junit5**: - このモジュールはKotestテストエンジンとJUnit 5を統合し、KotestテストをJUnit 5テストとして実行できるようにする。このモジュールはKotlin Multiplatformプロジェクトで使用され、複数のプラットフォーム（JVM、JS、Nativeなど）でJUnit 5とともにKotestを実行できるよう支援する。 - **kotest-runner-junit5-jvm**: - このモジュールはJVM上でKotlinで書かれたコードに対するJUnit 5テストを実行するために使用される。このモジュールはJVMプラットフォームに特化しており、KotestテストをJUnit 5で実行するために必要なすべての構成を提供する。各モジュールは、それぞれのプラットフォームに応じてKotestテストをJUnit 5テストとして実行できるよう支援する。この統合により、Kotestをさまざまな環境で使用でき、JUnit 5との互換性を保証して、Kotestを既存のテストフレームワークと統合できる。

IntelliJ IDEAでKotest環境を作る

IntelliJ IDEAでKotestを動かすには、Kotestプラグインをインストールする必要がある。

[Setting]-[Plugins]へ移動し、kotestを検索してインストールする。

Kotest Plugin

参考

Setup | Kotest