atrium-api-infix/ch.tutteli.atrium.api.infix.en_GB/entriesOf

entriesOf

fun <T : MapLike> entriesOf(mapLike: T, reportOptionsInOrderOnly: InOrderOnlyReportingOptions.() -> Unit): WithInOrderOnlyReportingOptions<T>(source)

Helper function to create a WithInOrderOnlyReportingOptions wrapping an MapLike based on the given mapLike and the given reportOptionsInOrderOnly-configuration-lambda.

Since

0.18.0

Parameters

mapLike

The MapLike whose elements this function is referring to.

reportOptionsInOrderOnly

The lambda configuring the InOrderOnlyReportingOptions.

infix fun <K, V, T : MapLike> MapLikeContains.EntryPointStep<K, V, T, InAnyOrderSearchBehaviour>.entriesOf(expectedMapLike: MapLike): Expect<T>(source)

Finishes the specification of the sophisticated to contain expectation where the subject (a MapLike) needs to contain all entries of the given expectedMapLike where it does not matter in which order they appear.

Delegates to keyValue which also means that it does not search for unique matches (see keyValue for more information).

Notice that a runtime check applies which assures that only Iterable, Sequence or one of the Array types are passed. This function expects MapLike (which is a typealias for Any) to avoid cluttering the API.

Return

an Expect for the subject of this expectation.

Since

0.15.0

Parameters

expectedMapLike

The MapLike whose elements are expected to be contained within this MapLike.

Throws

in case expectedMapLike is not a Map, Sequence or one of the Array types or the given expectedMapLike does not have elements (is empty).

Samples

expect(mapOf(1 to "a", 2 to "b")) toContain o inAny order entriesOf mapOf(2 to "b")

fails { // because the value ("a") of key 1 (which exists in the subject) is not "b"
    expect(mapOf(1 to "a", 2 to "b")) toContain o inAny order entriesOf mapOf(1 to "b")
}
infix fun <K, V, T : MapLike> MapLikeContains.EntryPointStep<K, V, T, InAnyOrderOnlySearchBehaviour>.entriesOf(expectedMapLike: MapLike): Expect<T>(source)

Finishes the specification of the sophisticated to contain expectation where the subject (a MapLike) needs to contain only and all entries of the given expectedMapLike where it does not matter in which order they appear.

Delegates to the pairs which also means that it does not search for unique matches (see the pairs for more information).

Notice that a runtime check applies which assures that only Iterable, Sequence or one of the Array types are passed. This function expects MapLike (which is a typealias for Any) to avoid cluttering the API.

Return

an Expect for the subject of this expectation.

Since

0.15.0

Parameters

expectedMapLike

The MapLike whose elements are expected to be contained within this MapLike.

Throws

in case expectedMapLike is not a Map, Sequence or one of the Array types or the given expectedMapLike does not have elements (is empty).

Samples

expect(mapOf(1 to "a", 2 to "b")) toContain o inAny order but only entriesOf mapOf(2 to "b", 1 to "a")

fails { // because subject has additional entries
    expect(mapOf(1 to "a", 2 to "b")) toContain o inAny order but only entriesOf mapOf(1 to "a")
}
infix fun <K, V, T : MapLike> MapLikeContains.EntryPointStep<K, V, T, InOrderOnlySearchBehaviour>.entriesOf(expectedMapLike: MapLike): Expect<T>(source)

Finishes the specification of the sophisticated to contain expectation where the subject (a MapLike) needs to contain only and all entries of the given expectedMapLike in the specified order.

Notice that a runtime check applies which assures that only Map and IterableLike (i.e. Iterable, Sequence or one of the Array types) are passed (this can be changed via MapLikeToIterablePairTransformer and IterableLikeToIterableTransformer). This function expects MapLike (which is a typealias for Any) to avoid cluttering the API.

Return

an Expect for the subject of this expectation.

Since

0.15.0

Throws

in case the given MapLike is an unsupported type, or in other words, if the transformation from the given MapLike to Iterable<Pair<K, V>> fails, or it does not have elements (is empty).

Samples

expect(mapOf(1 to "a", 2 to "b")) toContain o inGiven order and only entriesOf mapOf(1 to "a", 2 to "b")

fails { // because the map entries (which all exist in the subject) do not have the same order
    expect(mapOf(1 to "a", 2 to "b")) toContain o inGiven order and only entriesOf mapOf(
        2 to "b",
        1 to "a",
    )
}