kotest-core / io.kotest.core.config / Project

Project

object Project

A central store of project wide configuration. This configuration contains defaults for kotest, and is supplemented by user configuration (if present) as loaded by detectConfig.

Additionally config can be programatically added to this class by using the mutator methods such as registerExtension or setFailOnIgnoredTests.

Functions

autoScanIgnoredClasses

fun autoScanIgnoredClasses(): List<KClass<*>>

constructorExtensions

fun constructorExtensions(): List<ConstructorExtension>

deregisterExtension

fun deregisterExtension(extension: Extension): Unit

discoveryExtensions

fun discoveryExtensions(): List<DiscoveryExtension>

extensions

fun extensions(): <ERROR CLASS>

failOnIgnoredTests

fun failOnIgnoredTests(): Boolean

globalAssertSoftly

fun globalAssertSoftly(): Boolean

isolationMode

fun isolationMode(): IsolationMode

listeners

fun listeners(): <ERROR CLASS>

parallelism

Returns the number of concurrent specs that can be executed. Defaults to 1.

fun parallelism(): Int

projectListeners

fun projectListeners(): List<ProjectListener>

registerExtension

fun registerExtension(extension: Extension): Unit

registerExtensions

fun registerExtensions(vararg extensions: Extension): Unit

registerFilter

fun registerFilter(filter: Filter): Unit

registerFilters

fun registerFilters(filters: Collection<Filter>): Unit
fun registerFilters(vararg filters: Filter): Unit

registerListener

fun registerListener(listener: Listener): Unit

registerListeners

fun registerListeners(vararg listeners: Listener): Unit

registerProjectListener

fun registerProjectListener(listener: Listener): Unit

setAutoScanIgnoredClasses

fun setAutoScanIgnoredClasses(classes: List<KClass<*>>): Unit

setFailOnIgnoredTests

fun setFailOnIgnoredTests(fail: Boolean): Unit

setGlobalAssertSoftly

fun setGlobalAssertSoftly(g: Boolean): Unit

setTimeout

fun setTimeout(duration: Duration): Unit

specExecutionOrder

Returns the SpecExecutionOrder set by the user or defaults to LexicographicSpecExecutionOrder. Note: This has no effect on non-JVM targets.

fun specExecutionOrder(): SpecExecutionOrder

specExtensions

fun specExtensions(): List<SpecExtension>

specFailureFilePath

fun specFailureFilePath(): String

tagExtensions

fun tagExtensions(): List<TagExtension>

tags

Uses the registerd TagExtensions to evaluate the currently included/excluded Tags.

fun tags(): Tags

testCaseConfig

fun testCaseConfig(): TestCaseConfig

testCaseExtensions

fun testCaseExtensions(): List<TestCaseExtension>

testCaseFilters

Returns all registered TestCaseFilter.

fun testCaseFilters(): List<TestCaseFilter>

testCaseOrder

fun testCaseOrder(): TestCaseOrder

testListeners

fun testListeners(): List<TestListener>

timeout

Returns the default timeout for tests as specified in user config. If not specified then defaults to defaultTimeout

fun timeout(): Duration

writeSpecFailureFile

fun writeSpecFailureFile(): Boolean

Extension Functions

createConfigSummary

fun Project.createConfigSummary(): String

dumpProjectConfig

fun Project.dumpProjectConfig(): Unit