kotest-core / io.kotest.core.spec.style / WordSpec

WordSpec

abstract class WordSpec : DslDrivenSpec, WordSpecDsl

Constructors

<init>

WordSpec(body: WordSpec.() -> Unit = {})

Properties

addListener

open val addListener: KFunction1<TestListener, Unit>

addTest

open val addTest: KFunction4<String, suspend TestContext.() -> Unit, TestCaseConfig, TestType, Unit>

Functions

defaultConfig

open fun defaultConfig(): TestCaseConfig

Extension Functions

autoClose

Closes an AutoCloseable when the spec is completed by registering an afterSpec listener which invokes the AutoCloseable.close method.

fun <T : AutoCloseable> TestConfiguration.autoClose(closeable: T): T

Closes a lazy AutoCloseable when the spec is completed by registering an afterSpec listener which invokes the AutoCloseable.close method.

fun <T : AutoCloseable> TestConfiguration.autoClose(closeable: Lazy<T>): Lazy<T>

createTestCase

fun Spec.createTestCase(name: String, test: suspend TestContext.() -> Unit, config: TestCaseConfig, type: TestType): TestCase

focusTests

Returns the focused root tests for this Spec. A focused test is one whose name begins with "f:".

fun Spec.focusTests(): List<TestCase>

invokeAfterSpec

Notifies the user listeners that a Spec has finished. This will be invoked for every instance of a spec.

suspend fun Spec.invokeAfterSpec(): Try<Spec>

invokeBeforeSpec

Notifies the user listeners that a Spec is starting. This will be invoked for every instance of a spec.

suspend fun Spec.invokeBeforeSpec(): Try<Spec>

resolvedAssertionMode

fun Spec.resolvedAssertionMode(): AssertionMode

resolvedExtensions

fun Spec.resolvedExtensions(): List<Extension>

resolvedIsolationMode

fun Spec.resolvedIsolationMode(): IsolationMode

resolvedTestCaseOrder

fun Spec.resolvedTestCaseOrder(): TestCaseOrder

resolvedTestListeners

Returns the resolved listeners for a given Spec. That is, the listeners defined directly on the spec, listeners generated from the callback-dsl methods, and listeners defined in any included test factories.

fun Spec.resolvedTestListeners(): List<TestListener>

tempfile

fun TestConfiguration.tempfile(prefix: String? = null, suffix: String? = ".tmp"): File