Update to Kotest 6.1 to align with updated API changes. (#559)

Author: nedtwigg

jvm/example-kotest/build.gradle.kts

@@ -17,6 +17,7 @@ dependencies {
 }
 tasks.test {
   useJUnitPlatform()
+  systemProperty("kotest.framework.config.fqn", "com.example.kotest.KotestConfig")
   environment(properties.filter { it.key == "selfie" || it.key == "OPENAI_API_KEY" })
   inputs.files(fileTree("src/test") {
     include("**/*.ss")

jvm/example-kotest/src/test/kotlin/com/example/kotest/KotestConfig.kt

@@ -3,5 +3,5 @@ package com.example.kotest
 import com.diffplug.selfie.kotest.SelfieExtension
 
 class KotestConfig : io.kotest.core.config.AbstractProjectConfig() {
-    override fun extensions() = listOf(SelfieExtension(this))
+    override val extensions = listOf(SelfieExtension(this))
 }

jvm/gradle.properties

@@ -9,7 +9,7 @@ ver_JUNIT_PIONEER=2.3.0
 ver_OKIO=3.16.0
 ver_KOTLIN_TEST=2.0.0
 ver_KOTLIN_SERIALIZATION=1.9.0
-# Kotest 5.6.0 is the oldest that we support
-ver_KOTEST=5.6.0
+# Kotest 6.0.0 is the oldest that we support
+ver_KOTEST=6.1.4
 
 ver_JVM_TARGET=11

jvm/selfie-runner-junit5/src/main/kotlin/com/diffplug/selfie/junit5/SelfieExtension.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2024 DiffPlug
+ * Copyright (C) 2024-2026 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ import io.kotest.core.listeners.BeforeSpecListener
 import io.kotest.core.listeners.FinalizeSpecListener
 import io.kotest.core.spec.Spec
 import io.kotest.core.test.TestCase
-import io.kotest.core.test.TestResult
+import io.kotest.engine.test.TestResult
 import kotlin.reflect.KClass
 import kotlinx.coroutines.currentCoroutineContext
 import kotlinx.coroutines.withContext
@@ -43,11 +43,12 @@ class SelfieExtension(projectConfig: AbstractProjectConfig) :
       execute: suspend (TestCase) -> TestResult
   ): TestResult {
     val file = SnapshotSystemJUnit5.forClass(testCase.spec::class.java.name)
-    val coroutineLocal = CoroutineDiskStorage(DiskStorageJUnit5(file, testCase.name.testName))
+    val name = testCase.name.name
+    val coroutineLocal = CoroutineDiskStorage(DiskStorageJUnit5(file, name))
     return withContext(currentCoroutineContext() + coroutineLocal) {
-      file.startTest(testCase.name.testName, false)
+      file.startTest(name, false)
       val result = execute(testCase)
-      file.finishedTestWithSuccess(testCase.name.testName, false, result.isSuccess)
+      file.finishedTestWithSuccess(name, false, result.isSuccess)
       result
     }
   }
@@ -58,8 +59,8 @@ class SelfieExtension(projectConfig: AbstractProjectConfig) :
     val file = SnapshotSystemJUnit5.forClass(kclass.java.name)
     results.entries.forEach {
       if (it.value.isIgnored) {
-        file.startTest(it.key.name.testName, false)
-        file.finishedTestWithSuccess(it.key.name.testName, false, false)
+        file.startTest(it.key.name.name, false)
+        file.finishedTestWithSuccess(it.key.name.name, false, false)
       }
     }
     SnapshotSystemJUnit5.forClass(kclass.java.name)

jvm/selfie-runner-kotest/src/commonMain/kotlin/com/diffplug/selfie/kotest/FSOkio.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2024 DiffPlug
+ * Copyright (C) 2024-2026 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,18 +18,19 @@ package com.diffplug.selfie.kotest
 import com.diffplug.selfie.guts.FS
 import com.diffplug.selfie.guts.TypedPath
 import io.kotest.assertions.Actual
-import io.kotest.assertions.Exceptions
+import io.kotest.assertions.AssertionErrorBuilder
 import io.kotest.assertions.Expected
 import io.kotest.assertions.print.Printed
 import okio.FileSystem
 import okio.Path.Companion.toPath
 
-expect internal val FS_SYSTEM: FileSystem
+internal expect val FS_SYSTEM: FileSystem
 internal fun TypedPath.toPath(): okio.Path = absolutePath.toPath()
 
 internal object FSOkio : FS {
   override fun fileExists(typedPath: TypedPath): Boolean =
       FS_SYSTEM.metadataOrNull(typedPath.toPath())?.isRegularFile ?: false
+
   /** Walks the files (not directories) which are children and grandchildren of the given path. */
   override fun <T> fileWalk(typedPath: TypedPath, walk: (Sequence<TypedPath>) -> T): T =
       walk(
@@ -40,9 +41,11 @@ internal object FSOkio : FS {
       FS_SYSTEM.read(typedPath.toPath()) { readByteArray() }
   override fun fileWriteBinary(typedPath: TypedPath, content: ByteArray): Unit =
       FS_SYSTEM.write(typedPath.toPath()) { write(content) }
+
   /** Creates an assertion failed exception to throw. */
   override fun assertFailed(message: String, expected: Any?, actual: Any?): Throwable =
-      if (expected == null && actual == null) Exceptions.createAssertionError(message, null)
+      if (expected == null && actual == null)
+          AssertionErrorBuilder.create().withMessage(message).build()
       else {
         val expectedStr = nullableToString(expected, "")
         val actualStr = nullableToString(actual, "")
@@ -55,10 +58,11 @@ internal object FSOkio : FS {
           comparisonAssertion(message, expectedStr, actualStr)
         }
       }
-  private fun nullableToString(any: Any?, onNull: String): String =
-      any?.let { it.toString() } ?: onNull
+  private fun nullableToString(any: Any?, onNull: String): String = any?.toString() ?: onNull
   private fun comparisonAssertion(message: String, expected: String, actual: String): Throwable {
-    return Exceptions.createAssertionError(
-        message, null, Expected(Printed((expected))), Actual(Printed((actual))))
+    return AssertionErrorBuilder.create()
+        .withMessage(message)
+        .withValues(Expected(Printed((expected))), Actual(Printed((actual))))
+        .build()
   }
 }

jvm/selfie-runner-kotest/src/commonMain/kotlin/com/diffplug/selfie/kotest/SelfieExtension.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2024 DiffPlug
+ * Copyright (C) 2024-2026 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@ import io.kotest.core.listeners.FinalizeSpecListener
 import io.kotest.core.source.SourceRef
 import io.kotest.core.spec.Spec
 import io.kotest.core.test.TestCase
-import io.kotest.core.test.TestResult
+import io.kotest.engine.test.TestResult
 import kotlin.jvm.JvmStatic
 import kotlin.reflect.KClass
 import kotlinx.coroutines.currentCoroutineContext
@@ -62,18 +62,19 @@ class SelfieExtension(
     val classOrFilename: String =
         when (val source = testCase.source) {
           is SourceRef.ClassSource -> source.fqn
-          is SourceRef.FileSource -> source.fileName
+          is SourceRef.ClassLineSource -> source.fqn
           is SourceRef.None -> TODO("Handle SourceRef.None")
         }
     return system.forClassOrFilename(classOrFilename)
   }
+
   /** Called for every test method. */
   override suspend fun intercept(
       testCase: TestCase,
       execute: suspend (TestCase) -> TestResult
   ): TestResult {
     val file = snapshotFileFor(testCase)
-    val testName = testCase.name.testName
+    val testName = testCase.name.name
     val coroutineLocal = CoroutineDiskStorage(DiskStorageKotest(file, testName))
     return withContext(currentCoroutineContext() + coroutineLocal) {
       file.startTest(testName)
@@ -89,8 +90,9 @@ class SelfieExtension(
     val file = results.keys.map { snapshotFileFor(it) }.firstOrNull() ?: return
     results.entries.forEach {
       if (it.value.isIgnored) {
-        file.startTest(it.key.name.testName)
-        file.finishedTestWithSuccess(it.key.name.testName, false)
+        val name = it.key.name.name
+        file.startTest(name)
+        file.finishedTestWithSuccess(name, false)
       }
     }
     file.finishedClassWithSuccess(results.entries.all { it.value.isSuccess })

jvm/selfie-runner-kotest/src/commonTest/kotlin/com/diffplug/selfie/kotest/HarnessKotest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2023-2025 DiffPlug
+ * Copyright (C) 2023-2026 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -177,13 +177,13 @@ open class HarnessKotest() : FunSpec() {
       fun content() = lines.subList(startInclusive, endInclusive + 1).joinToString("\n")
       fun setContent(mustBe: String) {
         FS_SYSTEM.write(subprojectFolder.resolve(subpath)) {
-          for (i in 0 ..< startInclusive) {
+          for (i in 0..<startInclusive) {
             writeUtf8(lines[i])
             writeUtf8("\n")
           }
           writeUtf8(mustBe)
           writeUtf8("\n")
-          for (i in endInclusive + 1 ..< lines.size) {
+          for (i in endInclusive + 1..<lines.size) {
             writeUtf8(lines[i])
             writeUtf8("\n")
           }
@@ -223,7 +223,25 @@ open class HarnessKotest() : FunSpec() {
       return FS_SYSTEM.read(pathStr.toPath()) { AssertionError(readUtf8()) }
     }
   }
-  private fun testName() = "UT_${thisClassName()}"
+  private fun testName(): String {
+    val simpleClassName = "UT_${thisClassName()}"
+    val matches =
+        FS_SYSTEM.listRecursively(subprojectFolder)
+            .filter { it.name == "$simpleClassName.kt" && !it.toString().contains("build") }
+            .toList()
+    if (matches.size == 1) {
+      FS_SYSTEM.read(matches[0]) {
+        while (!exhausted()) {
+          val line = readUtf8Line() ?: break
+          if (line.startsWith("package ")) {
+            val pkg = line.removePrefix("package ").trim()
+            return "$pkg.$simpleClassName"
+          }
+        }
+      }
+    }
+    return simpleClassName
+  }
   fun gradleWriteSS() {
     gradlew("test", "-PunderTest=true", "-Pselfie=overwrite", "--tests", testName())?.let {
       throw AssertionError("Expected write snapshots to succeed, but it failed", it)

jvm/settings.gradle

@@ -29,6 +29,8 @@ plugins {
   id 'org.jetbrains.kotlin.multiplatform' version '2.2.20' apply false
   // https://github.com/adamko-dev/dokkatoo/releases
   id 'dev.adamko.dokkatoo-html' version '2.4.0' apply false
+  // https://plugins.gradle.org/plugin/io.kotest
+  id 'io.kotest' version '6.1.4' apply false
 }
 
 blowdryerSetup {

jvm/undertest-junit5-kotest/build.gradle

@@ -39,4 +39,5 @@ test {
   // defaults to 'write'
   systemProperty 'selfie', findProperty('selfie')
   systemProperty 'selfie.settings', findProperty('selfie.settings')
+  systemProperty 'kotest.framework.config.fqn', 'undertest.junit5.JunitKotestProjectConfig'
 }

jvm/undertest-junit5-kotest/harness/gradle.properties

@@ -9,4 +9,4 @@ ver_JUNIT_PIONEER=2.2.0
 ver_OKIO=3.7.0
 ver_KOTLIN_TEST=1.9.22
 ver_KOTLIN_SERIALIZATION=1.6.3
-ver_KOTEST=5.8.0
+ver_KOTEST=6.1.4