kotest-core

alltypes

abstract class AbstractProjectConfig

AbstractProjectConfig()
open fun afterAll(): Unit
open val assertionMode: AssertionMode?
open val autoScanEnabled: Boolean?
open val autoScanIgnoredClasses: List<KClass<*>>
open fun beforeAll(): Unit
open val defaultTestCaseConfig: TestCaseConfig?
open fun extensions(): List<Extension>
open val failOnIgnoredTests: Boolean
open fun filters(): List<Filter>
open val globalAssertSoftly: Boolean?
open fun isolationMode(): IsolationMode?
open val isolationMode: IsolationMode?
open fun listeners(): List<Listener>
open fun parallelism(): Int
open val parallelism: Int
open fun projectListeners(): List<ProjectListener>
open fun specExecutionOrder(): SpecExecutionOrder?
open val specExecutionOrder: SpecExecutionOrder?
open fun testCaseOrder(): TestCaseOrder?
open val testCaseOrder: TestCaseOrder?
open val timeout: Duration?
open fun writeSpecFailureFile(): Boolean
open val writeSpecFailureFile: Boolean?

typealias AfterProject = () -> Unit
class AfterProjectListenerException : RuntimeException

AfterProjectListenerException(message: String, t: Throwable?)
AfterProjectListenerException(message: String)
AfterProjectListenerException(t: Throwable)

typealias AfterSpec = suspend (Spec) -> Unit
typealias AfterTest = suspend (Tuple2<TestCase, TestResult>) -> Unit
abstract class AnnotationSpec : Spec

AnnotationSpec()
annotation class After

After()

annotation class AfterAll

AfterAll()

annotation class AfterClass

AfterClass()

annotation class AfterEach

AfterEach()

open fun afterSpec(spec: Spec): Unit
open fun afterTest(testCase: TestCase, result: TestResult): Unit
annotation class Before

Before()

annotation class BeforeAll

BeforeAll()

annotation class BeforeClass

BeforeClass()

annotation class BeforeEach

BeforeEach()

open fun beforeSpec(spec: Spec): Unit
open fun beforeTest(testCase: TestCase): Unit
annotation class Ignore

Ignore()

protected open fun materializeRootTests(): List<TestCase>
annotation class Test

Test(expected: KClass<out Throwable> = None::class)
val expected: KClass<out Throwable>
object None : Throwable

typealias AnnotationSpec = AnnotationSpec
typealias AroundSpecFn = suspend (Tuple2<KClass<out Spec>, suspend () -> Unit>) -> Unit
typealias AroundTestFn = suspend (Tuple2<TestCase, suspend (TestCase) -> TestResult>) -> TestResult
enum class AssertionMode

Error
None
Warn

interface AutoCloseable

abstract fun close(): Unit

annotation class AutoScan

AutoScan()

class BeforeBeforeListenerException : RuntimeException

BeforeBeforeListenerException(message: String, t: Throwable?)
BeforeBeforeListenerException(message: String)
BeforeBeforeListenerException(t: Throwable)

typealias BeforeSpec = suspend (Spec) -> Unit
typealias BeforeTest = suspend (TestCase) -> Unit
abstract class BehaviorSpec : DslDrivenSpec, BehaviorSpecDsl

BehaviorSpec(body: BehaviorSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias BehaviorSpec = BehaviorSpec
interface BehaviorSpecDsl : SpecDsl

open fun Given(name: String, test: suspend GivenContext.() -> Unit): Unit
open fun given(name: String, test: suspend GivenContext.() -> Unit): Unit
class TestScope

TestScope(name: String, context: TestContext, dsl: BehaviorSpecDsl)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val context: TestContext
val dsl: BehaviorSpecDsl
val name: String

class BehaviorSpecTestFactoryConfiguration : TestFactoryConfiguration, BehaviorSpecDsl

BehaviorSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

object CallingThreadExecutionContext : TimeoutExecutionContext

suspend fun <T> executeWithTimeoutInterruption(timeout: Duration, f: suspend () -> T): T

abstract class CompositeSpec : Spec

CompositeSpec(vararg factories: TestFactory)
protected open fun materializeRootTests(): List<TestCase>

interface ConstructorExtension : Extension

abstract fun <T : Spec> instantiate(clazz: KClass<T>): Spec?

class ContextScope

ContextScope(description: Description, context: TestContext, spec: ShouldSpecDsl)
fun afterTest(f: AfterTest): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun context(name: String, init: suspend ContextScope.() -> Unit): Unit
fun should(name: String): TestBuilder
suspend fun should(name: String, test: suspend TestContext.() -> Unit): Unit
inner class TestBuilder

TestBuilder(name: String)
suspend fun config(enabled: Boolean? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val name: String

abstract class DescribeSpec : DslDrivenSpec, DescribeSpecDsl

DescribeSpec(body: DescribeSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias DescribeSpec = DescribeSpec
interface DescribeSpecDsl : SpecDsl

open fun describe(name: String, test: suspend DescribeScope.() -> Unit): Unit
class DescribeScope

DescribeScope(description: Description, context: TestContext, spec: DescribeSpecDsl)
fun afterTest(f: AfterTest): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun context(name: String, test: suspend DescribeScope.() -> Unit): Unit
suspend fun describe(name: String, test: suspend DescribeScope.() -> Unit): Unit
fun it(name: String): TestBuilder
suspend fun it(name: String, test: suspend TestContext.() -> Unit): Unit
suspend fun xdescribe(name: String, test: suspend DescribeScope.() -> Unit): Unit
fun xit(name: String): TestBuilder
suspend fun xit(name: String, test: suspend TestContext.() -> Unit): Unit

class TestBuilder

TestBuilder(context: TestContext, name: String, dsl: DescribeSpecDsl, xdisabled: Boolean? = null)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val context: TestContext
val dsl: DescribeSpecDsl
val name: String

open fun xdescribe(name: String, test: suspend DescribeScope.() -> Unit): Unit

class DescribeSpecTestFactoryConfiguration : TestFactoryConfiguration, DescribeSpecDsl

DescribeSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

data class Description

Description(parents: List<String>, name: String)
fun append(name: String): Description
fun depth(): Int
fun fullName(): String
fun hasParent(description: Description): Boolean
fun id(): String
fun isAncestorOf(description: Description): Boolean
fun isDescendentOf(description: Description): Boolean
fun isOnPath(description: Description): Boolean
fun isParentOf(description: Description): Boolean
fun isSpec(): Boolean
fun isTopLevel(): Boolean
val name: String
fun names(): List<String>
fun parent(): Description
val parents: List<String>
fun spec(): Description
fun spec(name: String): Description
fun spec(spec: Spec): Description
fun specUnsafe(spec: Any): Description
fun tail(): Description
fun test(name: String): Description

object Discovery

fun discover(request: DiscoveryRequest): DiscoveryResult

interface DiscoveryExtension : Extension

abstract fun afterScan(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

sealed class DiscoveryFilter

data class ClassModifierDiscoveryFilter : DiscoveryFilter

ClassModifierDiscoveryFilter(modifiers: Set<Modifier>)
val modifiers: Set<Modifier>
fun test(kclass: KClass<out Spec>): Boolean

data class ClassNameDiscoveryFilter : DiscoveryFilter

ClassNameDiscoveryFilter(f: (FullyQualifiedClassName) -> Boolean)
val f: (FullyQualifiedClassName) -> Boolean
fun test(kclass: KClass<out Spec>): Boolean

data class PackageNameDiscoveryFilter : DiscoveryFilter

PackageNameDiscoveryFilter(f: (PackageName) -> Boolean)
val f: (PackageName) -> Boolean
fun test(kclass: KClass<out Spec>): Boolean

abstract fun test(kclass: KClass<out Spec>): Boolean

interface DiscoveryListener

open fun afterDiscovery(descriptions: List<Description>): Unit

data class DiscoveryRequest

DiscoveryRequest(selectors: List<DiscoverySelector> = emptyList(), filters: List<DiscoveryFilter> = emptyList())
val filters: List<DiscoveryFilter>
val selectors: List<DiscoverySelector>

data class DiscoveryResult

DiscoveryResult(specs: List<KClass<out Spec>>)
val specs: List<KClass<out Spec>>

sealed class DiscoverySelector

data class ClassDiscoverySelector : DiscoverySelector

ClassDiscoverySelector(className: String)
val className: String
fun test(kclass: KClass<out Spec>): Boolean

data class PackageDiscoverySelector : DiscoverySelector

PackageDiscoverySelector(packageName: String)
val packageName: String
fun test(kclass: KClass<out Spec>): Boolean

abstract fun test(kclass: KClass<out Spec>): Boolean

@Target([AnnotationTarget.CLASS]) annotation class DisplayName

DisplayName(name: String)
val name: String

@Target([AnnotationTarget.CLASS]) annotation class DoNotParallelize

DoNotParallelize()

abstract class DslDrivenSpec : Spec

DslDrivenSpec()
protected fun addRootTestCase(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType): Unit
protected open fun materializeRootTests(): List<TestCase>

data class DynamicTest

DynamicTest(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType, source: SourceRef)
val config: TestCaseConfig
val name: String
val source: SourceRef
val test: suspend TestContext.() -> Unit
val type: TestType

typealias EnabledIf = (TestCase) -> Boolean
object ExecutorExecutionContext : TimeoutExecutionContext

suspend fun <T> executeWithTimeoutInterruption(timeout: Duration, f: suspend () -> T): T

class ExpectScope

ExpectScope(context: TestContext, dsl: ExpectSpecDsl)
suspend fun context(name: String, test: suspend ExpectScope.() -> Unit): Unit
val context: TestContext
suspend fun expect(name: String, test: suspend TestContext.() -> Unit): Unit
fun expect(name: String): TestBuilder

abstract class ExpectSpec : DslDrivenSpec, ExpectSpecDsl

ExpectSpec(body: ExpectSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias ExpectSpec = ExpectSpec
interface ExpectSpecDsl : SpecDsl

open fun context(name: String, test: suspend ExpectScope.() -> Unit): Unit
class TestBuilder

TestBuilder(context: TestContext, name: String, dsl: SpecDsl)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val context: TestContext
val name: String

class ExpectSpecTestFactoryConfiguration : TestFactoryConfiguration, ExpectSpecDsl

ExpectSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

interface Extension
object FailureFirstSpecExecutionOrder : SpecExecutionOrder

fun sort(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

class FeatureScope

FeatureScope(context: TestContext, dsl: SpecDsl)
suspend fun and(name: String, init: suspend FeatureScope.() -> Unit): Unit
val context: TestContext
suspend fun feature(name: String, init: suspend FeatureScope.() -> Unit): Unit
suspend fun scenario(name: String, test: suspend TestContext.() -> Unit): Unit
fun scenario(name: String): ScenarioBuilder

abstract class FeatureSpec : DslDrivenSpec, FeatureSpecDsl

FeatureSpec(body: FeatureSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias FeatureSpec = FeatureSpec
interface FeatureSpecDsl : SpecDsl

open fun feature(name: String, init: suspend FeatureScope.() -> Unit): Unit

class FeatureSpecTestFactoryConfiguration : TestFactoryConfiguration, FeatureSpecDsl

FeatureSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

interface Filter
typealias FinalizeSpec = suspend (Tuple2<KClass<out Spec>, Map<TestCase, TestResult>>) -> Unit
abstract class FreeSpec : DslDrivenSpec, FreeSpecDsl

FreeSpec(body: FreeSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias FreeSpec = FreeSpec
interface FreeSpecDsl : SpecDsl

open fun String.config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
open infix operator fun String.invoke(test: suspend TestContext.() -> Unit): Unit
open infix operator fun String.minus(test: suspend FreeSpecScope.() -> Unit): Unit

class FreeSpecScope

FreeSpecScope(context: TestContext, dsl: FreeSpecDsl)
suspend fun String.config(enabled: Boolean? = null, timeout: Duration? = null, tags: Set<Tag>? = null, extensions: List<TestCaseExtension>? = null, test: suspend FreeSpecScope.() -> Unit): Unit
val context: TestContext
suspend infix operator fun String.invoke(test: suspend TestContext.() -> Unit): Unit
suspend infix operator fun String.minus(test: suspend FreeSpecScope.() -> Unit): Unit

class FreeSpecTestFactoryConfiguration : TestFactoryConfiguration, FreeSpecDsl

FreeSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

data class FullyQualifiedClassName

FullyQualifiedClassName(value: String)
val value: String

abstract class FunSpec : DslDrivenSpec, FunSpecDsl

FunSpec(body: FunSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias FunSpec = FunSpec
interface FunSpecDsl : SpecDsl

open fun context(name: String, init: suspend ContextScope.() -> Unit): Unit
class ContextScope

ContextScope(description: Description, context: TestContext, spec: FunSpecDsl)
fun afterTest(f: AfterTest): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun context(name: String, init: suspend ContextScope.() -> Unit): Unit
fun test(name: String): TestBuilder
suspend fun test(name: String, test: suspend TestContext.() -> Unit): Unit
inner class TestBuilder

TestBuilder(name: String)
suspend fun config(enabled: Boolean? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val name: String

open fun test(name: String): TestBuilder
open fun test(name: String, test: suspend TestContext.() -> Unit): Unit
class TestBuilder

TestBuilder(name: String, spec: FunSpecDsl)
fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit

class FunSpecTestFactoryConfiguration : TestFactoryConfiguration, FunSpecDsl

FunSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

class GivenAndContext

GivenAndContext(description: Description, context: TestContext, spec: BehaviorSpecDsl)
fun afterTest(f: AfterTest): Unit
suspend fun And(name: String, test: suspend GivenAndContext.() -> Unit): Unit
suspend fun and(name: String, test: suspend GivenAndContext.() -> Unit): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun Then(name: String, test: suspend ThenContext.() -> Unit): Unit
suspend fun then(name: String, test: suspend ThenContext.() -> Unit): Unit
fun then(name: String): TestScope
suspend fun When(name: String, test: suspend WhenContext.() -> Unit): Unit
suspend fun when(name: String, test: suspend WhenContext.() -> Unit): Unit

class GivenContext

GivenContext(description: Description, context: TestContext, spec: BehaviorSpecDsl)
fun afterTest(f: AfterTest): Unit
suspend fun And(name: String, test: suspend GivenAndContext.() -> Unit): Unit
suspend fun and(name: String, test: suspend GivenAndContext.() -> Unit): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun Then(name: String, test: suspend ThenContext.() -> Unit): Unit
suspend fun then(name: String, test: suspend ThenContext.() -> Unit): Unit
fun then(name: String): TestScope
suspend fun When(name: String, test: suspend WhenContext.() -> Unit): Unit
suspend fun when(name: String, test: suspend WhenContext.() -> Unit): Unit

@Target([AnnotationTarget.CLASS]) annotation class Ignored

Ignored()

object IgnoredSpecDiscoveryExtension : DiscoveryExtension

fun afterScan(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

class InstancePerLeafSpecRunner : SpecRunner

InstancePerLeafSpecRunner(listener: TestEngineListener)
data class Enqueued

Enqueued(testCase: TestCase, count: Int)
val count: Int
val testCase: TestCase

suspend fun execute(spec: Spec): Try<Map<TestCase, TestResult>>

@ExperimentalTime class InstancePerTestSpecRunner : SpecRunner

InstancePerTestSpecRunner(listener: TestEngineListener)
suspend fun execute(spec: Spec): Try<Map<TestCase, TestResult>>

enum class IsolationMode

InstancePerLeaf
InstancePerTest
SingleInstance

class IsolationTestEngineListener : TestEngineListener

IsolationTestEngineListener(listener: TestEngineListener)
fun engineFinished(t: Throwable?): Unit
fun engineStarted(classes: List<KClass<out Spec>>): Unit
val listener: TestEngineListener
fun specFinished(kclass: KClass<out Spec>, t: Throwable?, results: Map<TestCase, TestResult>): Unit
fun specInstantiated(spec: Spec): Unit
fun specInstantiationError(kclass: KClass<out Spec>, t: Throwable): Unit
fun specStarted(kclass: KClass<out Spec>): Unit
fun testFinished(testCase: TestCase, result: TestResult): Unit
fun testIgnored(testCase: TestCase, reason: String?): Unit
fun testStarted(testCase: TestCase): Unit

annotation class JsTest

JsTest()

annotation class Junit5EnabledIfSystemProperty

Junit5EnabledIfSystemProperty(named: String, matches: String)
val matches: String
val named: String

annotation class Junit5TestFactory

Junit5TestFactory()

object KotestAdapter

fun suite(name: String, ignored: Boolean, suiteFn: () -> Unit): Unit
fun test(name: String, ignored: Boolean, testFn: () -> Any?): Unit

@Target([AnnotationTarget.CLASS, AnnotationTarget.FUNCTION]) @DslMarker annotation class KotestDsl

KotestDsl()

class KotestEngine

KotestEngine(classes: List<KClass<out Spec>>, filters: List<TestCaseFilter>, parallelism: Int, tags: Tags?, listener: TestEngineListener, listeners: List<Listener> = emptyList())
val classes: List<KClass<out Spec>>
fun execute(): Unit
val listener: TestEngineListener
val listeners: List<Listener>
val parallelism: Int

kotlin.collections.List

fun List<Listener>.afterProject(): Try<Unit>
fun List<Listener>.beforeProject(): Try<Unit>

kotlin.collections.List

fun List<TestCase>.ordered(spec: TestCaseOrder): List<TestCase>

kotlin.reflect.KClass

fun KClass<*>.description(): Description
fun KClass<*>.isDoNotParallelize(): Boolean

kotlin.reflect.KClass

fun KClass<out AnnotationSpec>.findAfterSpecFunctions(): List<KFunction<*>>
fun KClass<out AnnotationSpec>.findAfterTestFunctions(): List<KFunction<*>>
fun KClass<out AnnotationSpec>.findBeforeSpecFunctions(): List<KFunction<*>>
fun KClass<out AnnotationSpec>.findBeforeTestFunctions(): List<KFunction<*>>
fun KClass<out AnnotationSpec>.findTestFunctions(): List<KFunction<*>>

kotlin.reflect.KFunction

fun KFunction<*>.isIgnoredTest(): Boolean

kotlin.Throwable

fun Throwable.unwrapIfReflectionCall(): Throwable

object LexicographicSpecExecutionOrder : SpecExecutionOrder

fun sort(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

interface Listener
enum class Modifier

Internal
Private
Public

class NamedThreadFactory : ThreadFactory

NamedThreadFactory(name: String)
val name: String
fun newThread(r: Runnable): Thread

data class NestedTest

NestedTest(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType, sourceRef: SourceRef)
val config: TestCaseConfig
val name: String
val sourceRef: SourceRef
val test: suspend TestContext.() -> Unit
val type: TestType

data class PackageName

PackageName(value: String)
val value: String

typealias PrepareSpec = suspend (KClass<out Spec>) -> Unit
object Project

fun autoScanIgnoredClasses(): List<KClass<*>>
fun constructorExtensions(): List<ConstructorExtension>
fun deregisterExtension(extension: Extension): Unit
fun discoveryExtensions(): List<DiscoveryExtension>
fun extensions(): <ERROR CLASS>
fun failOnIgnoredTests(): Boolean
fun globalAssertSoftly(): Boolean
fun isolationMode(): IsolationMode
fun listeners(): <ERROR CLASS>
fun parallelism(): Int
fun projectListeners(): List<ProjectListener>
fun registerExtension(extension: Extension): Unit
fun registerExtensions(vararg extensions: Extension): Unit
fun registerFilter(filter: Filter): Unit
fun registerFilters(filters: Collection<Filter>): Unit
fun registerFilters(vararg filters: Filter): Unit
fun registerListener(listener: Listener): Unit
fun registerListeners(vararg listeners: Listener): Unit
fun registerProjectListener(listener: Listener): Unit
fun setAutoScanIgnoredClasses(classes: List<KClass<*>>): Unit
fun setFailOnIgnoredTests(fail: Boolean): Unit
fun setGlobalAssertSoftly(g: Boolean): Unit
fun setTimeout(duration: Duration): Unit
fun specExecutionOrder(): SpecExecutionOrder
fun specExtensions(): List<SpecExtension>
fun specFailureFilePath(): String
fun tagExtensions(): List<TagExtension>
fun tags(): Tags
fun testCaseConfig(): TestCaseConfig
fun testCaseExtensions(): List<TestCaseExtension>
fun testCaseFilters(): List<TestCaseFilter>
fun testCaseOrder(): TestCaseOrder
fun testListeners(): List<TestListener>
fun timeout(): Duration
fun writeSpecFailureFile(): Boolean

data class ProjectConf

ProjectConf(extensions: List<Extension> = emptyList(), listeners: List<Listener> = emptyList(), filters: List<Filter> = emptyList(), isolationMode: IsolationMode? = null, assertionMode: AssertionMode? = null, testCaseOrder: TestCaseOrder? = null, specExecutionOrder: SpecExecutionOrder? = null, failOnIgnoredTests: Boolean? = null, globalAssertSoftly: Boolean? = null, autoScanEnabled: Boolean = true, autoScanIgnoredClasses: List<KClass<*>> = emptyList(), writeSpecFailureFile: Boolean? = null, specFailureFilePath: String? = null, parallelism: Int? = null, timeout: Duration? = null, testCaseConfig: TestCaseConfig? = null)
val assertionMode: AssertionMode?
val autoScanEnabled: Boolean
val autoScanIgnoredClasses: List<KClass<*>>
val extensions: List<Extension>
val failOnIgnoredTests: Boolean?
val filters: List<Filter>
val globalAssertSoftly: Boolean?
val isolationMode: IsolationMode?
val listeners: List<Listener>
val parallelism: Int?
val specExecutionOrder: SpecExecutionOrder?
val specFailureFilePath: String?
val testCaseConfig: TestCaseConfig?
val testCaseOrder: TestCaseOrder?
val timeout: Duration?
val writeSpecFailureFile: Boolean?

interface ProjectListener : Listener

open fun afterProject(): Unit
open fun beforeProject(): Unit

object RandomSpecExecutionOrder : SpecExecutionOrder

fun sort(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

data class RootTest

RootTest(testCase: TestCase, order: Int)
val order: Int
val testCase: TestCase

object RuntimeTagExtension : TagExtension

val excluded: MutableSet<Tag>
val included: MutableSet<Tag>
fun tags(): Tags

class ScenarioBuilder

ScenarioBuilder(name: String, context: TestContext, dsl: SpecDsl)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val context: TestContext
val dsl: SpecDsl
val name: String

class ShouldScope

ShouldScope(context: TestContext, dsl: SpecDsl)
val context: TestContext
suspend operator fun String.invoke(init: suspend ShouldScope.() -> Unit): Unit
suspend fun should(name: String, test: suspend TestContext.() -> Unit): Unit
suspend fun should(name: String): Testbuilder
inner class Testbuilder

Testbuilder(register: suspend (suspend TestContext.() -> Unit, TestCaseConfig) -> Unit)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val register: suspend (suspend TestContext.() -> Unit, TestCaseConfig) -> Unit

abstract class ShouldSpec : DslDrivenSpec, ShouldSpecDsl

ShouldSpec(body: ShouldSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias ShouldSpec = ShouldSpec
interface ShouldSpecDsl : SpecDsl

open fun context(name: String, init: suspend ContextScope.() -> Unit): Unit
open operator fun String.invoke(init: suspend ShouldScope.() -> Unit): Unit
open fun should(name: String, test: suspend TestContext.() -> Unit): Unit
open fun should(name: String): Testbuilder
class Testbuilder

Testbuilder(specDsl: SpecDsl, register: (suspend TestContext.() -> Unit, TestCaseConfig) -> Unit)
fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit

class ShouldSpecTestFactoryConfiguration : TestFactoryConfiguration, ShouldSpecDsl

ShouldSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

@ExperimentalTime class SingleInstanceSpecRunner : SpecRunner

SingleInstanceSpecRunner(listener: TestEngineListener)
inner class Context : TestContext

Context(testCase: TestCase, coroutineContext: CoroutineContext)
val coroutineContext: CoroutineContext
suspend fun registerTestCase(nested: NestedTest): Unit
val testCase: TestCase

suspend fun execute(spec: Spec): Try<Map<TestCase, TestResult>>

data class SourceRef

SourceRef(lineNumber: Int, fileName: String)
val fileName: String
val lineNumber: Int

abstract class Spec : TestConfiguration, SpecConfigurationMethods

Spec()
open fun afterTest(f: AfterTest): Unit
open fun beforeTest(f: BeforeTest): Unit
var isolation: IsolationMode?
fun javascriptTestInterceptor(): Unit
protected abstract fun materializeRootTests(): List<TestCase>
fun rootTests(): List<RootTest>
var testOrder: TestCaseOrder?

typealias Spec = Spec
interface SpecConfigurationMethods

open fun afterSpec(spec: Spec): Unit
open fun afterTest(testCase: TestCase, result: TestResult): Unit
open fun assertionMode(): AssertionMode?
open fun beforeSpec(spec: Spec): Unit
open fun beforeTest(testCase: TestCase): Unit
open fun defaultTestCaseConfig(): TestCaseConfig?
open fun extensions(): List<Extension>
open fun isolationMode(): IsolationMode?
open fun listeners(): List<TestListener>
open fun tags(): Set<Tag>
open fun testCaseOrder(): TestCaseOrder?

interface SpecDsl

abstract val addListener: (TestListener) -> Unit
abstract val addTest: (name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType) -> Unit
abstract fun defaultConfig(): TestCaseConfig

interface SpecExecutionOrder

abstract fun sort(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

class SpecExecutor

SpecExecutor(listener: TestEngineListener)
suspend fun execute(kclass: KClass<out Spec>): Unit

interface SpecExtension : Extension

abstract suspend fun intercept(spec: KClass<out Spec>, process: suspend () -> Unit): Unit

class SpecifiedTagsTagExtension : TagExtension

SpecifiedTagsTagExtension(included: Set<Tag>, excluded: Set<Tag>)
SpecifiedTagsTagExtension(tags: Tags)
fun tags(): Tags

abstract class SpecRunner

SpecRunner(listener: TestEngineListener)
protected fun createInstance(kclass: KClass<out Spec>): Try<Spec>
abstract suspend fun execute(spec: Spec): Try<Map<TestCase, TestResult>>
val listener: TestEngineListener

abstract class StringSpec : DslDrivenSpec, StringSpecDsl

StringSpec(body: StringSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias StringSpec = StringSpec
interface StringSpecDsl : SpecDsl

open fun String.config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
open operator fun String.invoke(test: suspend TestContext.() -> Unit): Unit

class StringSpecTestFactoryConfiguration : TestFactoryConfiguration, StringSpecDsl

StringSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

class StringTag : Tag

StringTag(name: String)
val name: String

class SynchronizedTestEngineListener : TestEngineListener

SynchronizedTestEngineListener(listener: TestEngineListener)
fun engineFinished(t: Throwable?): Unit
fun engineStarted(classes: List<KClass<out Spec>>): Unit
fun specFinished(kclass: KClass<out Spec>, t: Throwable?, results: Map<TestCase, TestResult>): Unit
fun specInstantiated(spec: Spec): Unit
fun specInstantiationError(kclass: KClass<out Spec>, t: Throwable): Unit
fun specStarted(kclass: KClass<out Spec>): Unit
fun testFinished(testCase: TestCase, result: TestResult): Unit
fun testIgnored(testCase: TestCase, reason: String?): Unit
fun testStarted(testCase: TestCase): Unit

object SystemPropertyTagExtension : TagExtension

fun tags(): Tags

abstract class Tag

Tag()
operator fun invoke(name: String): StringTag
open val name: String
open fun toString(): String

interface TagExtension : Extension

abstract fun tags(): Tags

object TagFilteredDiscoveryExtension : DiscoveryExtension

fun afterScan(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

data class Tags

Tags(included: Set<Tag>, excluded: Set<Tag>)
fun combine(other: Tags): Tags
val Empty: Tags
fun exclude(vararg tags: Tag): Tags
val excluded: Set<Tag>
fun include(vararg tags: Tag): Tags
val included: Set<Tag>
fun isActive(tag: Tag): Boolean
fun isActive(tags: Set<Tag>): Boolean

@Target([AnnotationTarget.CLASS]) annotation class Tags

Tags(vararg values: String)
vararg val values: Array<out String>

typealias Test = Test
@Target([AnnotationTarget.CLASS]) annotation class Testable

Testable()

object TestBuilders

var state: String?

data class TestCase

TestCase(description: Description, spec: Spec, test: suspend TestContext.() -> Unit, source: SourceRef, type: TestType, config: TestCaseConfig = TestCaseConfig(), factoryId: TestFactoryId? = null, assertionMode: AssertionMode? = null)
val assertionMode: AssertionMode?
val config: TestCaseConfig
fun container(description: Description, spec: Spec, test: suspend TestContext.() -> Unit): TestCase
val description: Description
val factoryId: TestFactoryId?
fun getLine(): Int
fun isTopLevel(): Boolean
val name: String
val source: SourceRef
val spec: Spec
val test: suspend TestContext.() -> Unit
fun test(description: Description, spec: Spec, test: suspend TestContext.() -> Unit): TestCase
val type: TestType

data class TestCaseConfig

TestCaseConfig(enabled: Boolean = true, invocations: Int = 1, threads: Int = 1, timeout: Duration? = null, tags: Set<Tag> = emptySet(), listeners: List<TestListener> = emptyList(), extensions: List<TestCaseExtension> = emptyList(), enabledIf: EnabledIf = { true })
val enabled: Boolean
val enabledIf: EnabledIf
val extensions: List<TestCaseExtension>
val invocations: Int
val listeners: List<TestListener>
val tags: Set<Tag>
val threads: Int
val timeout: Duration?

interface TestCaseExtension : Extension

abstract suspend fun intercept(testCase: TestCase, execute: suspend (TestCase) -> TestResult): TestResult

typealias TestCaseExtensionFn = suspend (Tuple2<TestCase, suspend (TestCase) -> TestResult>) -> TestResult
interface TestCaseFilter : Filter

abstract fun filter(description: Description): TestFilterResult

enum class TestCaseOrder

Lexicographic
Random
Sequential

abstract class TestConfiguration

TestConfiguration()
fun afterProject(f: AfterProject): Unit
fun afterSpec(f: AfterSpec): Unit
abstract fun afterTest(f: AfterTest): Unit
fun aroundSpec(aroundSpecFn: AroundSpecFn): Unit
fun aroundTest(aroundTestFn: AroundTestFn): Unit
var assertions: AssertionMode?
fun beforeSpec(f: BeforeSpec): Unit
abstract fun beforeTest(f: BeforeTest): Unit
var defaultTestConfig: TestCaseConfig?
fun extension(f: TestCaseExtensionFn): Unit
fun extensions(vararg extensions: TestCaseExtension): Unit
fun finalizeSpec(f: FinalizeSpec): Unit
fun include(factory: TestFactory): Unit
fun include(prefix: String, factory: TestFactory): Unit
fun listener(listener: TestListener): Unit
fun listeners(vararg listener: TestListener): Unit
fun prepareSpec(f: PrepareSpec): Unit
fun tags(vararg tags: Tag): Unit

abstract class TestContext : CoroutineScope

TestContext()
infix operator fun String.invoke(ignored: suspend TestContext.() -> Unit): Unit
suspend fun registerTestCase(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType): Unit
abstract suspend fun registerTestCase(nested: NestedTest): Unit
abstract val testCase: TestCase

interface TestEngineListener

open fun engineFinished(t: Throwable?): Unit
open fun engineStarted(classes: List<KClass<out Spec>>): Unit
open fun specFinished(kclass: KClass<out Spec>, t: Throwable?, results: Map<TestCase, TestResult>): Unit
open fun specInstantiated(spec: Spec): Unit
open fun specInstantiationError(kclass: KClass<out Spec>, t: Throwable): Unit
open fun specStarted(kclass: KClass<out Spec>): Unit
open fun testFinished(testCase: TestCase, result: TestResult): Unit
open fun testIgnored(testCase: TestCase, reason: String?): Unit
open fun testStarted(testCase: TestCase): Unit

interface TestExecutionListener

open fun testFinished(testCase: TestCase, result: TestResult): Unit
open fun testIgnored(testCase: TestCase): Unit
open fun testStarted(testCase: TestCase): Unit

class TestExecutor

TestExecutor(listener: TestExecutionListener, executionContext: TimeoutExecutionContext, validateTestCase: (TestCase) -> Unit = {})
suspend fun execute(testCase: TestCase, context: TestContext): TestResult

data class TestFactory

TestFactory(factoryId: TestFactoryId, tests: List<DynamicTest>, tags: Set<Tag>, assertionMode: AssertionMode?, listeners: List<TestListener>, extensions: List<Extension>, factories: List<TestFactory>)
val assertionMode: AssertionMode?
val extensions: List<Extension>
val factories: List<TestFactory>
val factoryId: TestFactoryId
val listeners: List<TestListener>
val tags: Set<Tag>
val tests: List<DynamicTest>

abstract class TestFactoryConfiguration : TestConfiguration

TestFactoryConfiguration()
protected fun addDynamicTest(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType): Unit
open fun afterTest(f: AfterTest): Unit
open fun beforeTest(f: BeforeTest): Unit

data class TestFactoryId

TestFactoryId(value: Int)
fun next(): TestFactoryId
val value: Int

enum class TestFilterResult

Exclude
Include

interface TestListener : Listener

open suspend fun afterInvocation(testCase: TestCase, iteration: Int): Unit
open suspend fun afterSpec(spec: Spec): Unit
open suspend fun afterTest(testCase: TestCase, result: TestResult): Unit
open suspend fun beforeInvocation(testCase: TestCase, iteration: Int): Unit
open suspend fun beforeSpec(spec: Spec): Unit
open suspend fun beforeTest(testCase: TestCase): Unit
open suspend fun finalizeSpec(kclass: KClass<out Spec>, results: Map<TestCase, TestResult>): Unit
open suspend fun prepareSpec(kclass: KClass<out Spec>): Unit

data class TestResult

TestResult(status: TestStatus, error: Throwable?, reason: String?, duration: Duration)
val duration: Duration
val error: Throwable?
val Ignored: TestResult
fun ignored(reason: String?): TestResult
val reason: String?
val status: TestStatus
fun success(duration: Duration): TestResult
fun throwable(e: Throwable?, duration: Duration): TestResult

enum class TestStatus

Error
Failure
Ignored
Success

enum class TestType

Container
Test

class ThenContext

ThenContext(context: TestContext)
val context: TestContext

data class TimeoutException : Exception

TimeoutException(duration: Duration)
val duration: Duration

interface TimeoutExecutionContext

abstract suspend fun <T> executeWithTimeoutInterruption(timeout: Duration, f: suspend () -> T): T

class WhenAndContext

WhenAndContext(context: TestContext, dsl: BehaviorSpecDsl)
suspend fun And(name: String, test: suspend WhenAndContext.() -> Unit): Unit
suspend fun and(name: String, test: suspend WhenAndContext.() -> Unit): Unit
val context: TestContext
suspend fun Then(name: String, test: suspend ThenContext.() -> Unit): Unit
suspend fun then(name: String, test: suspend ThenContext.() -> Unit): Unit
fun then(name: String): TestScope

class WhenContext

WhenContext(description: Description, context: TestContext, spec: BehaviorSpecDsl)
fun afterTest(f: AfterTest): Unit
suspend fun And(name: String, test: suspend WhenAndContext.() -> Unit): Unit
suspend fun and(name: String, test: suspend WhenAndContext.() -> Unit): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun Then(name: String, test: suspend ThenContext.() -> Unit): Unit
suspend fun then(name: String, test: suspend ThenContext.() -> Unit): Unit
fun then(name: String): TestScope

abstract class WordSpec : DslDrivenSpec, WordSpecDsl

WordSpec(body: WordSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

typealias WordSpec = WordSpec
interface WordSpecDsl : SpecDsl

class FinalTestContext : TestContext

FinalTestContext(context: TestContext)
val context: TestContext
val coroutineContext: CoroutineContext
suspend fun registerTestCase(nested: NestedTest): Unit
infix fun String.should(init: () -> Unit): () -> Unit
val testCase: TestCase

open infix fun String.should(init: suspend WordScope.() -> Unit): Unit
open infix fun String.When(init: suspend WhenContext.() -> Unit): Unit
open infix fun String.when(init: suspend WhenContext.() -> Unit): Unit
class WhenContext

WhenContext(context: TestContext, dsl: WordSpecDsl)
val context: TestContext
val dsl: WordSpecDsl
suspend infix fun String.Should(test: suspend WordScope.() -> Unit): Unit
suspend infix fun String.should(test: suspend WordScope.() -> Unit): Unit

class WordScope

WordScope(context: TestContext, dsl: WordSpecDsl)
suspend fun String.config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
suspend infix operator fun String.invoke(test: suspend FinalTestContext.() -> Unit): Unit
infix fun String.should(init: () -> Unit): Unit

class WordSpecTestFactoryConfiguration : TestFactoryConfiguration, WordSpecDsl

WordSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

class ZeroAssertionsError : AssertionError

ZeroAssertionsError(message: String)

package io.kotest.core

data class SourceRef

SourceRef(lineNumber: Int, fileName: String)
val fileName: String
val lineNumber: Int

fun sourceRef(): SourceRef
class StringTag : Tag

StringTag(name: String)
val name: String

abstract class Tag

Tag()
operator fun invoke(name: String): StringTag
open val name: String
open fun toString(): String

data class Tags

Tags(included: Set<Tag>, excluded: Set<Tag>)
fun combine(other: Tags): Tags
val Empty: Tags
fun exclude(vararg tags: Tag): Tags
val excluded: Set<Tag>
fun include(vararg tags: Tag): Tags
val included: Set<Tag>
fun isActive(tag: Tag): Boolean
fun isActive(tags: Set<Tag>): Boolean

package io.kotest.core.annotation

@Target([AnnotationTarget.CLASS]) annotation class Ignored

Ignored()

@Target([AnnotationTarget.CLASS]) annotation class Tags

Tags(vararg values: String)
vararg val values: Array<out String>

package io.kotest.core.config

abstract class AbstractProjectConfig

AbstractProjectConfig()
open fun afterAll(): Unit
open val assertionMode: AssertionMode?
open val autoScanEnabled: Boolean?
open val autoScanIgnoredClasses: List<KClass<*>>
open fun beforeAll(): Unit
open val defaultTestCaseConfig: TestCaseConfig?
open fun extensions(): List<Extension>
open val failOnIgnoredTests: Boolean
open fun filters(): List<Filter>
open val globalAssertSoftly: Boolean?
open fun isolationMode(): IsolationMode?
open val isolationMode: IsolationMode?
open fun listeners(): List<Listener>
open fun parallelism(): Int
open val parallelism: Int
open fun projectListeners(): List<ProjectListener>
open fun specExecutionOrder(): SpecExecutionOrder?
open val specExecutionOrder: SpecExecutionOrder?
open fun testCaseOrder(): TestCaseOrder?
open val testCaseOrder: TestCaseOrder?
open val timeout: Duration?
open fun writeSpecFailureFile(): Boolean
open val writeSpecFailureFile: Boolean?

fun Project.createConfigSummary(): String
fun detectConfig(): ProjectConf
fun Project.dumpProjectConfig(): Unit
object Project

fun autoScanIgnoredClasses(): List<KClass<*>>
fun constructorExtensions(): List<ConstructorExtension>
fun deregisterExtension(extension: Extension): Unit
fun discoveryExtensions(): List<DiscoveryExtension>
fun extensions(): <ERROR CLASS>
fun failOnIgnoredTests(): Boolean
fun globalAssertSoftly(): Boolean
fun isolationMode(): IsolationMode
fun listeners(): <ERROR CLASS>
fun parallelism(): Int
fun projectListeners(): List<ProjectListener>
fun registerExtension(extension: Extension): Unit
fun registerExtensions(vararg extensions: Extension): Unit
fun registerFilter(filter: Filter): Unit
fun registerFilters(filters: Collection<Filter>): Unit
fun registerFilters(vararg filters: Filter): Unit
fun registerListener(listener: Listener): Unit
fun registerListeners(vararg listeners: Listener): Unit
fun registerProjectListener(listener: Listener): Unit
fun setAutoScanIgnoredClasses(classes: List<KClass<*>>): Unit
fun setFailOnIgnoredTests(fail: Boolean): Unit
fun setGlobalAssertSoftly(g: Boolean): Unit
fun setTimeout(duration: Duration): Unit
fun specExecutionOrder(): SpecExecutionOrder
fun specExtensions(): List<SpecExtension>
fun specFailureFilePath(): String
fun tagExtensions(): List<TagExtension>
fun tags(): Tags
fun testCaseConfig(): TestCaseConfig
fun testCaseExtensions(): List<TestCaseExtension>
fun testCaseFilters(): List<TestCaseFilter>
fun testCaseOrder(): TestCaseOrder
fun testListeners(): List<TestListener>
fun timeout(): Duration
fun writeSpecFailureFile(): Boolean

data class ProjectConf

ProjectConf(extensions: List<Extension> = emptyList(), listeners: List<Listener> = emptyList(), filters: List<Filter> = emptyList(), isolationMode: IsolationMode? = null, assertionMode: AssertionMode? = null, testCaseOrder: TestCaseOrder? = null, specExecutionOrder: SpecExecutionOrder? = null, failOnIgnoredTests: Boolean? = null, globalAssertSoftly: Boolean? = null, autoScanEnabled: Boolean = true, autoScanIgnoredClasses: List<KClass<*>> = emptyList(), writeSpecFailureFile: Boolean? = null, specFailureFilePath: String? = null, parallelism: Int? = null, timeout: Duration? = null, testCaseConfig: TestCaseConfig? = null)
val assertionMode: AssertionMode?
val autoScanEnabled: Boolean
val autoScanIgnoredClasses: List<KClass<*>>
val extensions: List<Extension>
val failOnIgnoredTests: Boolean?
val filters: List<Filter>
val globalAssertSoftly: Boolean?
val isolationMode: IsolationMode?
val listeners: List<Listener>
val parallelism: Int?
val specExecutionOrder: SpecExecutionOrder?
val specFailureFilePath: String?
val testCaseConfig: TestCaseConfig?
val testCaseOrder: TestCaseOrder?
val timeout: Duration?
val writeSpecFailureFile: Boolean?

package io.kotest.core.engine

class InstancePerLeafSpecRunner : SpecRunner

InstancePerLeafSpecRunner(listener: TestEngineListener)
data class Enqueued

Enqueued(testCase: TestCase, count: Int)
val count: Int
val testCase: TestCase

suspend fun execute(spec: Spec): Try<Map<TestCase, TestResult>>

@ExperimentalTime class InstancePerTestSpecRunner : SpecRunner

InstancePerTestSpecRunner(listener: TestEngineListener)
suspend fun execute(spec: Spec): Try<Map<TestCase, TestResult>>

fun <T : Spec> instantiateSpec(clazz: KClass<T>): Try<Spec>
class IsolationTestEngineListener : TestEngineListener

IsolationTestEngineListener(listener: TestEngineListener)
fun engineFinished(t: Throwable?): Unit
fun engineStarted(classes: List<KClass<out Spec>>): Unit
val listener: TestEngineListener
fun specFinished(kclass: KClass<out Spec>, t: Throwable?, results: Map<TestCase, TestResult>): Unit
fun specInstantiated(spec: Spec): Unit
fun specInstantiationError(kclass: KClass<out Spec>, t: Throwable): Unit
fun specStarted(kclass: KClass<out Spec>): Unit
fun testFinished(testCase: TestCase, result: TestResult): Unit
fun testIgnored(testCase: TestCase, reason: String?): Unit
fun testStarted(testCase: TestCase): Unit

fun <T : Spec> javaReflectNewInstance(clazz: KClass<T>): Spec
class KotestEngine

KotestEngine(classes: List<KClass<out Spec>>, filters: List<TestCaseFilter>, parallelism: Int, tags: Tags?, listener: TestEngineListener, listeners: List<Listener> = emptyList())
val classes: List<KClass<out Spec>>
fun execute(): Unit
val listener: TestEngineListener
val listeners: List<Listener>
val parallelism: Int

@ExperimentalTime class SingleInstanceSpecRunner : SpecRunner

SingleInstanceSpecRunner(listener: TestEngineListener)
inner class Context : TestContext

Context(testCase: TestCase, coroutineContext: CoroutineContext)
val coroutineContext: CoroutineContext
suspend fun registerTestCase(nested: NestedTest): Unit
val testCase: TestCase

suspend fun execute(spec: Spec): Try<Map<TestCase, TestResult>>

class SpecExecutor

SpecExecutor(listener: TestEngineListener)
suspend fun execute(kclass: KClass<out Spec>): Unit

abstract class SpecRunner

SpecRunner(listener: TestEngineListener)
protected fun createInstance(kclass: KClass<out Spec>): Try<Spec>
abstract suspend fun execute(spec: Spec): Try<Map<TestCase, TestResult>>
val listener: TestEngineListener

class SynchronizedTestEngineListener : TestEngineListener

SynchronizedTestEngineListener(listener: TestEngineListener)
fun engineFinished(t: Throwable?): Unit
fun engineStarted(classes: List<KClass<out Spec>>): Unit
fun specFinished(kclass: KClass<out Spec>, t: Throwable?, results: Map<TestCase, TestResult>): Unit
fun specInstantiated(spec: Spec): Unit
fun specInstantiationError(kclass: KClass<out Spec>, t: Throwable): Unit
fun specStarted(kclass: KClass<out Spec>): Unit
fun testFinished(testCase: TestCase, result: TestResult): Unit
fun testIgnored(testCase: TestCase, reason: String?): Unit
fun testStarted(testCase: TestCase): Unit

interface TestEngineListener

open fun engineFinished(t: Throwable?): Unit
open fun engineStarted(classes: List<KClass<out Spec>>): Unit
open fun specFinished(kclass: KClass<out Spec>, t: Throwable?, results: Map<TestCase, TestResult>): Unit
open fun specInstantiated(spec: Spec): Unit
open fun specInstantiationError(kclass: KClass<out Spec>, t: Throwable): Unit
open fun specStarted(kclass: KClass<out Spec>): Unit
open fun testFinished(testCase: TestCase, result: TestResult): Unit
open fun testIgnored(testCase: TestCase, reason: String?): Unit
open fun testStarted(testCase: TestCase): Unit

package io.kotest.core.engine.discovery

object Discovery

fun discover(request: DiscoveryRequest): DiscoveryResult

sealed class DiscoveryFilter

data class ClassModifierDiscoveryFilter : DiscoveryFilter

ClassModifierDiscoveryFilter(modifiers: Set<Modifier>)
val modifiers: Set<Modifier>
fun test(kclass: KClass<out Spec>): Boolean

data class ClassNameDiscoveryFilter : DiscoveryFilter

ClassNameDiscoveryFilter(f: (FullyQualifiedClassName) -> Boolean)
val f: (FullyQualifiedClassName) -> Boolean
fun test(kclass: KClass<out Spec>): Boolean

data class PackageNameDiscoveryFilter : DiscoveryFilter

PackageNameDiscoveryFilter(f: (PackageName) -> Boolean)
val f: (PackageName) -> Boolean
fun test(kclass: KClass<out Spec>): Boolean

abstract fun test(kclass: KClass<out Spec>): Boolean

data class DiscoveryRequest

DiscoveryRequest(selectors: List<DiscoverySelector> = emptyList(), filters: List<DiscoveryFilter> = emptyList())
val filters: List<DiscoveryFilter>
val selectors: List<DiscoverySelector>

data class DiscoveryResult

DiscoveryResult(specs: List<KClass<out Spec>>)
val specs: List<KClass<out Spec>>

sealed class DiscoverySelector

data class ClassDiscoverySelector : DiscoverySelector

ClassDiscoverySelector(className: String)
val className: String
fun test(kclass: KClass<out Spec>): Boolean

data class PackageDiscoverySelector : DiscoverySelector

PackageDiscoverySelector(packageName: String)
val packageName: String
fun test(kclass: KClass<out Spec>): Boolean

abstract fun test(kclass: KClass<out Spec>): Boolean

data class FullyQualifiedClassName

FullyQualifiedClassName(value: String)
val value: String

enum class Modifier

Internal
Private
Public

data class PackageName

PackageName(value: String)
val value: String

package io.kotest.core.extensions

interface ConstructorExtension : Extension

abstract fun <T : Spec> instantiate(clazz: KClass<T>): Spec?

interface DiscoveryExtension : Extension

abstract fun afterScan(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

interface Extension
object IgnoredSpecDiscoveryExtension : DiscoveryExtension

fun afterScan(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

object RuntimeTagExtension : TagExtension

val excluded: MutableSet<Tag>
val included: MutableSet<Tag>
fun tags(): Tags

interface SpecExtension : Extension

abstract suspend fun intercept(spec: KClass<out Spec>, process: suspend () -> Unit): Unit

class SpecifiedTagsTagExtension : TagExtension

SpecifiedTagsTagExtension(included: Set<Tag>, excluded: Set<Tag>)
SpecifiedTagsTagExtension(tags: Tags)
fun tags(): Tags

object SystemPropertyTagExtension : TagExtension

fun tags(): Tags

interface TagExtension : Extension

abstract fun tags(): Tags

object TagFilteredDiscoveryExtension : DiscoveryExtension

fun afterScan(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

interface TestCaseExtension : Extension

abstract suspend fun intercept(testCase: TestCase, execute: suspend (TestCase) -> TestResult): TestResult

package io.kotest.core.factory

fun TestFactoryConfiguration.build(): TestFactory
data class DynamicTest

DynamicTest(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType, source: SourceRef)
val config: TestCaseConfig
val name: String
val source: SourceRef
val test: suspend TestContext.() -> Unit
val type: TestType

fun TestFactory.generate(description: Description, spec: Spec): List<TestCase>
data class TestFactory

TestFactory(factoryId: TestFactoryId, tests: List<DynamicTest>, tags: Set<Tag>, assertionMode: AssertionMode?, listeners: List<TestListener>, extensions: List<Extension>, factories: List<TestFactory>)
val assertionMode: AssertionMode?
val extensions: List<Extension>
val factories: List<TestFactory>
val factoryId: TestFactoryId
val listeners: List<TestListener>
val tags: Set<Tag>
val tests: List<DynamicTest>

abstract class TestFactoryConfiguration : TestConfiguration

TestFactoryConfiguration()
protected fun addDynamicTest(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType): Unit
open fun afterTest(f: AfterTest): Unit
open fun beforeTest(f: BeforeTest): Unit

data class TestFactoryId

TestFactoryId(value: Int)
fun next(): TestFactoryId
val value: Int

package io.kotest.core.filters

interface Filter
interface TestCaseFilter : Filter

abstract fun filter(description: Description): TestFilterResult

enum class TestFilterResult

Exclude
Include

fun TestCaseFilter.toExtension(): TestCaseExtension

package io.kotest.core.internal

kotlin.Throwable

fun Throwable.unwrapIfReflectionCall(): Throwable

class NamedThreadFactory : ThreadFactory

NamedThreadFactory(name: String)
val name: String
fun newThread(r: Runnable): Thread

fun writeSpecFailures(failures: Set<KClass<out Spec>>, filename: String): Try<Path!>

package io.kotest.core.listeners

interface DiscoveryListener

open fun afterDiscovery(descriptions: List<Description>): Unit

interface Listener
interface ProjectListener : Listener

open fun afterProject(): Unit
open fun beforeProject(): Unit

data class RootTest

RootTest(testCase: TestCase, order: Int)
val order: Int
val testCase: TestCase

interface TestListener : Listener

open suspend fun afterInvocation(testCase: TestCase, iteration: Int): Unit
open suspend fun afterSpec(spec: Spec): Unit
open suspend fun afterTest(testCase: TestCase, result: TestResult): Unit
open suspend fun beforeInvocation(testCase: TestCase, iteration: Int): Unit
open suspend fun beforeSpec(spec: Spec): Unit
open suspend fun beforeTest(testCase: TestCase): Unit
open suspend fun finalizeSpec(kclass: KClass<out Spec>, results: Map<TestCase, TestResult>): Unit
open suspend fun prepareSpec(kclass: KClass<out Spec>): Unit

package io.kotest.core.runtime

class AfterProjectListenerException : RuntimeException

AfterProjectListenerException(message: String, t: Throwable?)
AfterProjectListenerException(message: String)
AfterProjectListenerException(t: Throwable)

class BeforeBeforeListenerException : RuntimeException

BeforeBeforeListenerException(message: String, t: Throwable?)
BeforeBeforeListenerException(message: String)
BeforeBeforeListenerException(t: Throwable)

object CallingThreadExecutionContext : TimeoutExecutionContext

suspend fun <T> executeWithTimeoutInterruption(timeout: Duration, f: suspend () -> T): T

fun configureRuntime(): Unit
fun describe(name: String, fn: () -> Unit): Unit
fun executeSpec(spec: Spec): Unit
object ExecutorExecutionContext : TimeoutExecutionContext

suspend fun <T> executeWithTimeoutInterruption(timeout: Duration, f: suspend () -> T): T

fun TestCase.extensions(): List<TestCaseExtension>
suspend fun TestCase.invokeAfterInvocation(k: Int): Unit
suspend fun Spec.invokeAfterSpec(): Try<Spec>
suspend fun TestCase.invokeAfterTest(result: TestResult): Try<TestCase>
suspend fun TestCase.invokeBeforeInvocation(k: Int): Unit
suspend fun Spec.invokeBeforeSpec(): Try<Spec>
suspend fun TestCase.invokeBeforeTest(): Try<TestCase>
fun it(name: String, fn: (dynamic) -> Any?): Unit
object KotestAdapter

fun suite(name: String, ignored: Boolean, suiteFn: () -> Unit): Unit
fun test(name: String, ignored: Boolean, testFn: () -> Any?): Unit

kotlin.collections.List

fun List<Listener>.afterProject(): Try<Unit>
fun List<Listener>.beforeProject(): Try<Unit>

suspend fun replay(times: Int, threads: Int, before: suspend (Int) -> Unit, after: suspend (Int) -> Unit, action: suspend (Int) -> Unit): Unit
fun setAdapter(adapter: dynamic): Unit
interface TestExecutionListener

open fun testFinished(testCase: TestCase, result: TestResult): Unit
open fun testIgnored(testCase: TestCase): Unit
open fun testStarted(testCase: TestCase): Unit

class TestExecutor

TestExecutor(listener: TestExecutionListener, executionContext: TimeoutExecutionContext, validateTestCase: (TestCase) -> Unit = {})
suspend fun execute(testCase: TestCase, context: TestContext): TestResult

data class TimeoutException : Exception

TimeoutException(duration: Duration)
val duration: Duration

interface TimeoutExecutionContext

abstract suspend fun <T> executeWithTimeoutInterruption(timeout: Duration, f: suspend () -> T): T

fun xdescribe(name: String, fn: () -> Unit): Unit
fun xit(name: String, fn: () -> Any?): Unit

package io.kotest.core.spec

typealias AfterProject = () -> Unit
typealias AfterSpec = suspend (Spec) -> Unit
typealias AfterTest = suspend (Tuple2<TestCase, TestResult>) -> Unit
typealias AroundSpecFn = suspend (Tuple2<KClass<out Spec>, suspend () -> Unit>) -> Unit
typealias AroundTestFn = suspend (Tuple2<TestCase, suspend (TestCase) -> TestResult>) -> TestResult
fun <T : AutoCloseable> TestConfiguration.autoClose(closeable: T): T
fun <T : AutoCloseable> TestConfiguration.autoClose(closeable: Lazy<T>): Lazy<T>
interface AutoCloseable

abstract fun close(): Unit

annotation class AutoScan

AutoScan()

typealias BeforeSpec = suspend (Spec) -> Unit
typealias BeforeTest = suspend (TestCase) -> Unit
abstract class CompositeSpec : Spec

CompositeSpec(vararg factories: TestFactory)
protected open fun materializeRootTests(): List<TestCase>

fun Spec.createTestCase(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType): TestCase
@Target([AnnotationTarget.CLASS]) annotation class DisplayName

DisplayName(name: String)
val name: String

@Target([AnnotationTarget.CLASS]) annotation class DoNotParallelize

DoNotParallelize()

object FailureFirstSpecExecutionOrder : SpecExecutionOrder

fun sort(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

typealias FinalizeSpec = suspend (Tuple2<KClass<out Spec>, Map<TestCase, TestResult>>) -> Unit
fun Spec.focusTests(): List<TestCase>
val initializeRuntime: <ERROR CLASS>
enum class IsolationMode

InstancePerLeaf
InstancePerTest
SingleInstance

annotation class JsTest

JsTest()

annotation class Junit5EnabledIfSystemProperty

Junit5EnabledIfSystemProperty(named: String, matches: String)
val matches: String
val named: String

annotation class Junit5TestFactory

Junit5TestFactory()

kotlin.collections.List

fun List<TestCase>.ordered(spec: TestCaseOrder): List<TestCase>

kotlin.reflect.KClass

fun KClass<*>.description(): Description
fun KClass<*>.isDoNotParallelize(): Boolean

object LexicographicSpecExecutionOrder : SpecExecutionOrder

fun sort(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

typealias PrepareSpec = suspend (KClass<out Spec>) -> Unit
object RandomSpecExecutionOrder : SpecExecutionOrder

fun sort(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

fun Spec.resolvedExtensions(): List<Extension>
fun Spec.resolvedIsolationMode(): IsolationMode
fun Spec.resolvedTestCaseOrder(): TestCaseOrder
fun Spec.resolvedTestListeners(): List<TestListener>
abstract class Spec : TestConfiguration, SpecConfigurationMethods

Spec()
open fun afterTest(f: AfterTest): Unit
open fun beforeTest(f: BeforeTest): Unit
var isolation: IsolationMode?
fun javascriptTestInterceptor(): Unit
protected abstract fun materializeRootTests(): List<TestCase>
fun rootTests(): List<RootTest>
var testOrder: TestCaseOrder?

interface SpecConfigurationMethods

open fun afterSpec(spec: Spec): Unit
open fun afterTest(testCase: TestCase, result: TestResult): Unit
open fun assertionMode(): AssertionMode?
open fun beforeSpec(spec: Spec): Unit
open fun beforeTest(testCase: TestCase): Unit
open fun defaultTestCaseConfig(): TestCaseConfig?
open fun extensions(): List<Extension>
open fun isolationMode(): IsolationMode?
open fun listeners(): List<TestListener>
open fun tags(): Set<Tag>
open fun testCaseOrder(): TestCaseOrder?

interface SpecDsl

abstract val addListener: (TestListener) -> Unit
abstract val addTest: (name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType) -> Unit
abstract fun defaultConfig(): TestCaseConfig

interface SpecExecutionOrder

abstract fun sort(classes: List<KClass<out Spec>>): List<KClass<out Spec>>

fun TestConfiguration.tempfile(prefix: String? = null, suffix: String? = ".tmp"): File
@Target([AnnotationTarget.CLASS]) annotation class Testable

Testable()

typealias TestCaseExtensionFn = suspend (Tuple2<TestCase, suspend (TestCase) -> TestResult>) -> TestResult
abstract class TestConfiguration

TestConfiguration()
fun afterProject(f: AfterProject): Unit
fun afterSpec(f: AfterSpec): Unit
abstract fun afterTest(f: AfterTest): Unit
fun aroundSpec(aroundSpecFn: AroundSpecFn): Unit
fun aroundTest(aroundTestFn: AroundTestFn): Unit
var assertions: AssertionMode?
fun beforeSpec(f: BeforeSpec): Unit
abstract fun beforeTest(f: BeforeTest): Unit
var defaultTestConfig: TestCaseConfig?
fun extension(f: TestCaseExtensionFn): Unit
fun extensions(vararg extensions: TestCaseExtension): Unit
fun finalizeSpec(f: FinalizeSpec): Unit
fun include(factory: TestFactory): Unit
fun include(prefix: String, factory: TestFactory): Unit
fun listener(listener: TestListener): Unit
fun listeners(vararg listener: TestListener): Unit
fun prepareSpec(f: PrepareSpec): Unit
fun tags(vararg tags: Tag): Unit

package io.kotest.core.spec.style

abstract class AnnotationSpec : Spec

AnnotationSpec()
annotation class After

After()

annotation class AfterAll

AfterAll()

annotation class AfterClass

AfterClass()

annotation class AfterEach

AfterEach()

open fun afterSpec(spec: Spec): Unit
open fun afterTest(testCase: TestCase, result: TestResult): Unit
annotation class Before

Before()

annotation class BeforeAll

BeforeAll()

annotation class BeforeClass

BeforeClass()

annotation class BeforeEach

BeforeEach()

open fun beforeSpec(spec: Spec): Unit
open fun beforeTest(testCase: TestCase): Unit
annotation class Ignore

Ignore()

protected open fun materializeRootTests(): List<TestCase>
annotation class Test

Test(expected: KClass<out Throwable> = None::class)
val expected: KClass<out Throwable>
object None : Throwable

fun behaviorSpec(block: BehaviorSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class BehaviorSpec : DslDrivenSpec, BehaviorSpecDsl

BehaviorSpec(body: BehaviorSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface BehaviorSpecDsl : SpecDsl

open fun Given(name: String, test: suspend GivenContext.() -> Unit): Unit
open fun given(name: String, test: suspend GivenContext.() -> Unit): Unit
class TestScope

TestScope(name: String, context: TestContext, dsl: BehaviorSpecDsl)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val context: TestContext
val dsl: BehaviorSpecDsl
val name: String

class BehaviorSpecTestFactoryConfiguration : TestFactoryConfiguration, BehaviorSpecDsl

BehaviorSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

class ContextScope

ContextScope(description: Description, context: TestContext, spec: ShouldSpecDsl)
fun afterTest(f: AfterTest): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun context(name: String, init: suspend ContextScope.() -> Unit): Unit
fun should(name: String): TestBuilder
suspend fun should(name: String, test: suspend TestContext.() -> Unit): Unit
inner class TestBuilder

TestBuilder(name: String)
suspend fun config(enabled: Boolean? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val name: String

fun describeSpec(block: DescribeSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class DescribeSpec : DslDrivenSpec, DescribeSpecDsl

DescribeSpec(body: DescribeSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface DescribeSpecDsl : SpecDsl

open fun describe(name: String, test: suspend DescribeScope.() -> Unit): Unit
class DescribeScope

DescribeScope(description: Description, context: TestContext, spec: DescribeSpecDsl)
fun afterTest(f: AfterTest): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun context(name: String, test: suspend DescribeScope.() -> Unit): Unit
suspend fun describe(name: String, test: suspend DescribeScope.() -> Unit): Unit
fun it(name: String): TestBuilder
suspend fun it(name: String, test: suspend TestContext.() -> Unit): Unit
suspend fun xdescribe(name: String, test: suspend DescribeScope.() -> Unit): Unit
fun xit(name: String): TestBuilder
suspend fun xit(name: String, test: suspend TestContext.() -> Unit): Unit

class TestBuilder

TestBuilder(context: TestContext, name: String, dsl: DescribeSpecDsl, xdisabled: Boolean? = null)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val context: TestContext
val dsl: DescribeSpecDsl
val name: String

open fun xdescribe(name: String, test: suspend DescribeScope.() -> Unit): Unit

class DescribeSpecTestFactoryConfiguration : TestFactoryConfiguration, DescribeSpecDsl

DescribeSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

abstract class DslDrivenSpec : Spec

DslDrivenSpec()
protected fun addRootTestCase(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType): Unit
protected open fun materializeRootTests(): List<TestCase>

class ExpectScope

ExpectScope(context: TestContext, dsl: ExpectSpecDsl)
suspend fun context(name: String, test: suspend ExpectScope.() -> Unit): Unit
val context: TestContext
suspend fun expect(name: String, test: suspend TestContext.() -> Unit): Unit
fun expect(name: String): TestBuilder

fun expectSpec(block: ExpectSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class ExpectSpec : DslDrivenSpec, ExpectSpecDsl

ExpectSpec(body: ExpectSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface ExpectSpecDsl : SpecDsl

open fun context(name: String, test: suspend ExpectScope.() -> Unit): Unit
class TestBuilder

TestBuilder(context: TestContext, name: String, dsl: SpecDsl)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val context: TestContext
val name: String

class ExpectSpecTestFactoryConfiguration : TestFactoryConfiguration, ExpectSpecDsl

ExpectSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

class FeatureScope

FeatureScope(context: TestContext, dsl: SpecDsl)
suspend fun and(name: String, init: suspend FeatureScope.() -> Unit): Unit
val context: TestContext
suspend fun feature(name: String, init: suspend FeatureScope.() -> Unit): Unit
suspend fun scenario(name: String, test: suspend TestContext.() -> Unit): Unit
fun scenario(name: String): ScenarioBuilder

fun featureSpec(block: FeatureSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class FeatureSpec : DslDrivenSpec, FeatureSpecDsl

FeatureSpec(body: FeatureSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface FeatureSpecDsl : SpecDsl

open fun feature(name: String, init: suspend FeatureScope.() -> Unit): Unit

class FeatureSpecTestFactoryConfiguration : TestFactoryConfiguration, FeatureSpecDsl

FeatureSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

fun freeSpec(block: FreeSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class FreeSpec : DslDrivenSpec, FreeSpecDsl

FreeSpec(body: FreeSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface FreeSpecDsl : SpecDsl

open fun String.config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
open infix operator fun String.invoke(test: suspend TestContext.() -> Unit): Unit
open infix operator fun String.minus(test: suspend FreeSpecScope.() -> Unit): Unit

class FreeSpecScope

FreeSpecScope(context: TestContext, dsl: FreeSpecDsl)
suspend fun String.config(enabled: Boolean? = null, timeout: Duration? = null, tags: Set<Tag>? = null, extensions: List<TestCaseExtension>? = null, test: suspend FreeSpecScope.() -> Unit): Unit
val context: TestContext
suspend infix operator fun String.invoke(test: suspend TestContext.() -> Unit): Unit
suspend infix operator fun String.minus(test: suspend FreeSpecScope.() -> Unit): Unit

class FreeSpecTestFactoryConfiguration : TestFactoryConfiguration, FreeSpecDsl

FreeSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

fun funSpec(block: FunSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class FunSpec : DslDrivenSpec, FunSpecDsl

FunSpec(body: FunSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface FunSpecDsl : SpecDsl

open fun context(name: String, init: suspend ContextScope.() -> Unit): Unit
class ContextScope

ContextScope(description: Description, context: TestContext, spec: FunSpecDsl)
fun afterTest(f: AfterTest): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun context(name: String, init: suspend ContextScope.() -> Unit): Unit
fun test(name: String): TestBuilder
suspend fun test(name: String, test: suspend TestContext.() -> Unit): Unit
inner class TestBuilder

TestBuilder(name: String)
suspend fun config(enabled: Boolean? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val name: String

open fun test(name: String): TestBuilder
open fun test(name: String, test: suspend TestContext.() -> Unit): Unit
class TestBuilder

TestBuilder(name: String, spec: FunSpecDsl)
fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit

class FunSpecTestFactoryConfiguration : TestFactoryConfiguration, FunSpecDsl

FunSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

class GivenAndContext

GivenAndContext(description: Description, context: TestContext, spec: BehaviorSpecDsl)
fun afterTest(f: AfterTest): Unit
suspend fun And(name: String, test: suspend GivenAndContext.() -> Unit): Unit
suspend fun and(name: String, test: suspend GivenAndContext.() -> Unit): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun Then(name: String, test: suspend ThenContext.() -> Unit): Unit
suspend fun then(name: String, test: suspend ThenContext.() -> Unit): Unit
fun then(name: String): TestScope
suspend fun When(name: String, test: suspend WhenContext.() -> Unit): Unit
suspend fun when(name: String, test: suspend WhenContext.() -> Unit): Unit

class GivenContext

GivenContext(description: Description, context: TestContext, spec: BehaviorSpecDsl)
fun afterTest(f: AfterTest): Unit
suspend fun And(name: String, test: suspend GivenAndContext.() -> Unit): Unit
suspend fun and(name: String, test: suspend GivenAndContext.() -> Unit): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun Then(name: String, test: suspend ThenContext.() -> Unit): Unit
suspend fun then(name: String, test: suspend ThenContext.() -> Unit): Unit
fun then(name: String): TestScope
suspend fun When(name: String, test: suspend WhenContext.() -> Unit): Unit
suspend fun when(name: String, test: suspend WhenContext.() -> Unit): Unit

@Target([AnnotationTarget.CLASS, AnnotationTarget.FUNCTION]) @DslMarker annotation class KotestDsl

KotestDsl()

kotlin.reflect.KClass

fun KClass<out AnnotationSpec>.findAfterSpecFunctions(): List<KFunction<*>>
fun KClass<out AnnotationSpec>.findAfterTestFunctions(): List<KFunction<*>>
fun KClass<out AnnotationSpec>.findBeforeSpecFunctions(): List<KFunction<*>>
fun KClass<out AnnotationSpec>.findBeforeTestFunctions(): List<KFunction<*>>
fun KClass<out AnnotationSpec>.findTestFunctions(): List<KFunction<*>>

kotlin.reflect.KFunction

fun KFunction<*>.isIgnoredTest(): Boolean

class ScenarioBuilder

ScenarioBuilder(name: String, context: TestContext, dsl: SpecDsl)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val context: TestContext
val dsl: SpecDsl
val name: String

class ShouldScope

ShouldScope(context: TestContext, dsl: SpecDsl)
val context: TestContext
suspend operator fun String.invoke(init: suspend ShouldScope.() -> Unit): Unit
suspend fun should(name: String, test: suspend TestContext.() -> Unit): Unit
suspend fun should(name: String): Testbuilder
inner class Testbuilder

Testbuilder(register: suspend (suspend TestContext.() -> Unit, TestCaseConfig) -> Unit)
suspend fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
val register: suspend (suspend TestContext.() -> Unit, TestCaseConfig) -> Unit

fun shouldSpec(block: ShouldSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class ShouldSpec : DslDrivenSpec, ShouldSpecDsl

ShouldSpec(body: ShouldSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface ShouldSpecDsl : SpecDsl

open fun context(name: String, init: suspend ContextScope.() -> Unit): Unit
open operator fun String.invoke(init: suspend ShouldScope.() -> Unit): Unit
open fun should(name: String, test: suspend TestContext.() -> Unit): Unit
open fun should(name: String): Testbuilder
class Testbuilder

Testbuilder(specDsl: SpecDsl, register: (suspend TestContext.() -> Unit, TestCaseConfig) -> Unit)
fun config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit

class ShouldSpecTestFactoryConfiguration : TestFactoryConfiguration, ShouldSpecDsl

ShouldSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

fun stringSpec(block: StringSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class StringSpec : DslDrivenSpec, StringSpecDsl

StringSpec(body: StringSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface StringSpecDsl : SpecDsl

open fun String.config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
open operator fun String.invoke(test: suspend TestContext.() -> Unit): Unit

class StringSpecTestFactoryConfiguration : TestFactoryConfiguration, StringSpecDsl

StringSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

typealias Test = Test
object TestBuilders

var state: String?

class ThenContext

ThenContext(context: TestContext)
val context: TestContext

class WhenAndContext

WhenAndContext(context: TestContext, dsl: BehaviorSpecDsl)
suspend fun And(name: String, test: suspend WhenAndContext.() -> Unit): Unit
suspend fun and(name: String, test: suspend WhenAndContext.() -> Unit): Unit
val context: TestContext
suspend fun Then(name: String, test: suspend ThenContext.() -> Unit): Unit
suspend fun then(name: String, test: suspend ThenContext.() -> Unit): Unit
fun then(name: String): TestScope

class WhenContext

WhenContext(description: Description, context: TestContext, spec: BehaviorSpecDsl)
fun afterTest(f: AfterTest): Unit
suspend fun And(name: String, test: suspend WhenAndContext.() -> Unit): Unit
suspend fun and(name: String, test: suspend WhenAndContext.() -> Unit): Unit
fun beforeTest(f: BeforeTest): Unit
suspend fun Then(name: String, test: suspend ThenContext.() -> Unit): Unit
suspend fun then(name: String, test: suspend ThenContext.() -> Unit): Unit
fun then(name: String): TestScope

fun wordSpec(block: WordSpecTestFactoryConfiguration.() -> Unit): TestFactory
abstract class WordSpec : DslDrivenSpec, WordSpecDsl

WordSpec(body: WordSpec.() -> Unit = {})
open val addListener: KFunction1<TestListener, Unit>
open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
open fun defaultConfig(): TestCaseConfig

interface WordSpecDsl : SpecDsl

class FinalTestContext : TestContext

FinalTestContext(context: TestContext)
val context: TestContext
val coroutineContext: CoroutineContext
suspend fun registerTestCase(nested: NestedTest): Unit
infix fun String.should(init: () -> Unit): () -> Unit
val testCase: TestCase

open infix fun String.should(init: suspend WordScope.() -> Unit): Unit
open infix fun String.When(init: suspend WhenContext.() -> Unit): Unit
open infix fun String.when(init: suspend WhenContext.() -> Unit): Unit
class WhenContext

WhenContext(context: TestContext, dsl: WordSpecDsl)
val context: TestContext
val dsl: WordSpecDsl
suspend infix fun String.Should(test: suspend WordScope.() -> Unit): Unit
suspend infix fun String.should(test: suspend WordScope.() -> Unit): Unit

class WordScope

WordScope(context: TestContext, dsl: WordSpecDsl)
suspend fun String.config(enabled: Boolean? = null, invocations: Int? = null, threads: Int? = null, tags: Set<Tag>? = null, timeout: Duration? = null, extensions: List<TestCaseExtension>? = null, enabledIf: EnabledIf? = null, test: suspend TestContext.() -> Unit): Unit
suspend infix operator fun String.invoke(test: suspend FinalTestContext.() -> Unit): Unit
infix fun String.should(init: () -> Unit): Unit

class WordSpecTestFactoryConfiguration : TestFactoryConfiguration, WordSpecDsl

WordSpecTestFactoryConfiguration()
val addListener: KFunction1<TestListener, Unit>
val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>
fun defaultConfig(): TestCaseConfig

package io.kotest.core.test

enum class AssertionMode

Error
None
Warn

fun createTestName(prefix: String, name: String): String
val DefaultTestCaseOrder: TestCaseOrder
fun TestCaseConfig.deriveTestConfig(enabled: Boolean? = null, tags: Set<Tag>? = null, extensions: List<TestCaseExtension>? = null, timeout: Duration? = null, enabledIf: EnabledIf? = null, invocations: Int? = null, threads: Int? = null, listeners: List<TestListener>? = null): TestCaseConfig
data class Description

Description(parents: List<String>, name: String)
fun append(name: String): Description
fun depth(): Int
fun fullName(): String
fun hasParent(description: Description): Boolean
fun id(): String
fun isAncestorOf(description: Description): Boolean
fun isDescendentOf(description: Description): Boolean
fun isOnPath(description: Description): Boolean
fun isParentOf(description: Description): Boolean
fun isSpec(): Boolean
fun isTopLevel(): Boolean
val name: String
fun names(): List<String>
fun parent(): Description
val parents: List<String>
fun spec(): Description
fun spec(name: String): Description
fun spec(spec: Spec): Description
fun specUnsafe(spec: Any): Description
fun tail(): Description
fun test(name: String): Description

typealias EnabledIf = (TestCase) -> Boolean
suspend fun AssertionMode.executeWithAssertionsCheck(name: String, run: suspend () -> Unit): Unit
fun TestCase.isActive(): Boolean
fun TestCase.isBang(): Boolean
fun TestCase.isFocused(): Boolean
data class NestedTest

NestedTest(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType, sourceRef: SourceRef)
val config: TestCaseConfig
val name: String
val sourceRef: SourceRef
val test: suspend TestContext.() -> Unit
val type: TestType

fun Spec.resolvedAssertionMode(): AssertionMode
fun TestCaseConfig.resolvedTimeout(): Duration
data class TestCase

TestCase(description: Description, spec: Spec, test: suspend TestContext.() -> Unit, source: SourceRef, type: TestType, config: TestCaseConfig = TestCaseConfig(), factoryId: TestFactoryId? = null, assertionMode: AssertionMode? = null)
val assertionMode: AssertionMode?
val config: TestCaseConfig
fun container(description: Description, spec: Spec, test: suspend TestContext.() -> Unit): TestCase
val description: Description
val factoryId: TestFactoryId?
fun getLine(): Int
fun isTopLevel(): Boolean
val name: String
val source: SourceRef
val spec: Spec
val test: suspend TestContext.() -> Unit
fun test(description: Description, spec: Spec, test: suspend TestContext.() -> Unit): TestCase
val type: TestType

data class TestCaseConfig

TestCaseConfig(enabled: Boolean = true, invocations: Int = 1, threads: Int = 1, timeout: Duration? = null, tags: Set<Tag> = emptySet(), listeners: List<TestListener> = emptyList(), extensions: List<TestCaseExtension> = emptyList(), enabledIf: EnabledIf = { true })
val enabled: Boolean
val enabledIf: EnabledIf
val extensions: List<TestCaseExtension>
val invocations: Int
val listeners: List<TestListener>
val tags: Set<Tag>
val threads: Int
val timeout: Duration?

enum class TestCaseOrder

Lexicographic
Random
Sequential

abstract class TestContext : CoroutineScope

TestContext()
infix operator fun String.invoke(ignored: suspend TestContext.() -> Unit): Unit
suspend fun registerTestCase(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType): Unit
abstract suspend fun registerTestCase(nested: NestedTest): Unit
abstract val testCase: TestCase

data class TestResult

TestResult(status: TestStatus, error: Throwable?, reason: String?, duration: Duration)
val duration: Duration
val error: Throwable?
val Ignored: TestResult
fun ignored(reason: String?): TestResult
val reason: String?
val status: TestStatus
fun success(duration: Duration): TestResult
fun throwable(e: Throwable?, duration: Duration): TestResult

enum class TestStatus

Error
Failure
Ignored
Success

enum class TestType

Container
Test

fun NestedTest.toTestCase(spec: Spec, parent: Description): TestCase
class ZeroAssertionsError : AssertionError

ZeroAssertionsError(message: String)

package io.kotlintest

typealias Spec = Spec

package io.kotlintest.specs

typealias AnnotationSpec = AnnotationSpec
typealias BehaviorSpec = BehaviorSpec
typealias DescribeSpec = DescribeSpec
typealias ExpectSpec = ExpectSpec
typealias FeatureSpec = FeatureSpec
typealias FreeSpec = FreeSpec
typealias FunSpec = FunSpec
typealias ShouldSpec = ShouldSpec
typealias StringSpec = StringSpec
typealias WordSpec = WordSpec