Suite • opensavvy.prepared.suite.config • Ignored

Ignored

object Ignored : TestConfig.Element, TestConfig.Key.Unique<Ignored> 

Marks a test or an entire suite as disabled.

Example

Mark a suite as disabled:

suite("Suite name", Ignored) {
    // …
}

Mark a test as disabled:

test("Some kind of test", config = Ignored) {
    // …
}

See also

• Ignored.If Conditionally ignore a test or suite.

Properties

coroutineContext

val TestConfig.coroutineContext: CoroutineContext

The coroutine context configured for this test through the Context configuration.

key

open override val key: Ignored

The identifier for this test configuration element.

uniqueness

open override val uniqueness: TestConfig.Uniqueness.Unique

Marker for the uniqueness of the elements denoted by this key.

Functions

get

operator fun <E : TestConfig.Element> TestConfig.get(key: TestConfig.Key<E, TestConfig.Uniqueness.Multi>): List<E>

Finds the elements identified by key in the current TestConfig.

operator fun <E : TestConfig.Element> TestConfig.get(key: TestConfig.Key<E, TestConfig.Uniqueness.Unique>): E?

Finds the Element identified by key in the current TestConfig.

If

inline fun If(predicate: () -> Boolean): TestConfig

Marks this test or an entire suite as disabled if predicate returns true.

plus

operator fun TestConfig.plus(other: TestConfig): TestConfig

Combines two TestConfig instances.