Package-level declarations

Contains all the assertion interfaces (e.g. AnyAssertions) as well as _logic and helper functions for AssertionContainer.

Contains all the assertion interfaces (e.g. AnyAssertions) as well as _logic and helper functions for AssertionContainer.

Types

Link copied to clipboard
interface AnyAssertions

Collection of assertion functions and builders which are applicable to any type (sometimes Any? sometimes Any).

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a BigDecimal type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a CharSequence type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a ChronoLocalDate type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a ChronoLocalDateTime type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a ChronoZonedDateTime type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects which can be transformed to a Collection - intended for types which are Collection like such as Map.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a Comparable type.

Link copied to clipboard

Collection of functions which help to create feature assertions by returning FeatureExtractorBuilder.ExecutionStep.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a floating point number like type (currently Float and Double).

Link copied to clipboard

Collection of assertion functions and builders which are applicable to floating point number like types which are specific to the JVM platform (currently only for BigDecimal).

Link copied to clipboard
interface Fun0Assertions

Collection of assertion functions and builders which are applicable to subjects with a kotlin.Function0 type.

Link copied to clipboard
Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects which can be transformed to an Iterable - intended for types which are Iterable like such as Array or Sequence.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with an Iterator type.

Link copied to clipboard
interface ListAssertions

Collection of assertion functions and builders which are applicable to subjects with a List type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a LocalDate type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a LocalDateTime type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a Map.Entry type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects which can be transformed to a Map - intended for types which are Map like such as IterableLike with an element type Pair.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with an Optional type.

Link copied to clipboard
interface PairAssertions

Collection of assertion functions and builders which are applicable to subjects with a Pair type.

Link copied to clipboard
interface PathAssertions

Collection of assertion functions and builders which are applicable to subjects with a Path type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a Result type.

Link copied to clipboard
Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a Throwable type.

Link copied to clipboard

Collection of assertion functions and builders which are applicable to subjects with a ZonedDateTime type.

Properties

Link copied to clipboard

Turns this ExpectGrouping into an AssertionContainer without known subject type.

Entry point to the logic level of Atrium -- which is one level deeper than the API -- on which assertion functions do not return Expects but Assertions and the like.

Entry point to the logic level of Atrium -- which is one level deeper than the API -- within the building process of a sophisticated contains assertion for CharSequence.

Entry point to the logic level of Atrium -- which is one level deeper than the API -- within the building process of a sophisticated contains assertion for Iterable.

Link copied to clipboard

Functions

Link copied to clipboard

Appends the Assertion the given assertionCreator creates based on this ExpectGrouping.

inline fun <T> Expect<T>._logicAppend(assertionCreator: AssertionContainer<T>.() -> Assertion): Expect<T>

Appends the Assertion the given assertionCreator creates based on this Expect.

Appends the Assertion the given factory creates based on this CharSequenceContains.CheckerStep.

Appends the Assertion the given factory creates based on this IterableLikeContains.CheckerStep.

Appends the Assertion the given factory creates based on this IterableLikeContains.EntryPointStep.

Appends the Assertion the given factory creates based on this MapLikeContains.EntryPointStep.

Link copied to clipboard
fun <T : IterableLike, E : Any> AssertionContainer<T>.all(converter: (T) -> Iterable<E?>, assertionCreatorOrNull: Expect<E>.() -> Unit?): Assertion
Link copied to clipboard
fun <T> AssertionContainer<T>.because(reason: String, assertionCreator: Expect<T>.() -> Unit): Assertion
Link copied to clipboard
inline fun <T> AssertionContainer<T>.collect(noinline assertionCreator: Expect<T>.() -> Unit): Assertion

Use this function if you want to make Assertions about a feature or you perform a type transformation or any other action which results in an Expect being created for a different subject and you do not require this resulting Expect.

Link copied to clipboard

Finishes the transformation process by appending the Assertion which is returned when calling TransformationExecutionStep.collectAndAppend with _logicAppend and the given assertionCreator.

Link copied to clipboard
inline fun <T> AssertionContainer<*>.collectBasedOnSubject(maybeSubject: Option<T>, noinline assertionCreator: Expect<T>.() -> Unit): Assertion

Use this function if you want to make Assertions about a feature or you perform a type transformation or any other action which results in an Expect being created for a different subject and you do not require this resulting Expect.

Link copied to clipboard
inline fun <T> AssertionContainer<T>.collectForComposition(noinline assertionCreator: Expect<T>.() -> Unit): List<Assertion>

Use this function if you want to collect Assertions and use it as part of another Assertion (e.g. as part of an AssertionGroup).

Link copied to clipboard
inline fun <T> AssertionContainer<*>.collectForCompositionBasedOnSubject(maybeSubject: Option<T>, noinline assertionCreator: Expect<T>.() -> Unit): List<Assertion>

Use this function if you want to collect Assertions and use it as part of another Assertion (e.g. as part of an AssertionGroup).

Link copied to clipboard

Starts the building process of a sophisticated contains assertions.

Link copied to clipboard
fun <K, T : MapLike> AssertionContainer<T>.containsKey(converter: (T) -> Map<out K, *>, key: K): Assertion
Link copied to clipboard
Link copied to clipboard

Starts the building process of a sophisticated contains assertions and already applies a NotCheckerStep with a NotSearchBehaviour.

Link copied to clipboard
fun <K, T : MapLike> AssertionContainer<T>.containsNotKey(converter: (T) -> Map<out K, *>, key: K): Assertion
Link copied to clipboard
fun <T> AssertionContainer<T>.createDescriptiveAssertion(description: Translatable, representation: Any?, test: (T) -> Boolean): Assertion

Creates a DescriptiveAssertion based on the given description, representation and test.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <T : Path> AssertionContainer<T>.exists(linkOption: LinkOption? = null): Assertion
Link copied to clipboard
fun <T : Path> AssertionContainer<T>.existsNot(linkOption: LinkOption? = null): Assertion
Link copied to clipboard
fun <T> AssertionContainer<T>.extractSubject(failureDescription: String?, assertionCreator: Expect<T>.(T) -> Unit): Expect<T>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <T, A1, A2, A3, R> AssertionContainer<T>.f3(f: (T, A1, A2, A3) -> R, a1: A1, a2: A2, a3: A3): FeatureExtractorBuilder.ExecutionStep<T, R>
Link copied to clipboard
fun <T, A1, A2, A3, A4, R> AssertionContainer<T>.f4(f: (T, A1, A2, A3, A4) -> R, a1: A1, a2: A2, a3: A3, a4: A4): FeatureExtractorBuilder.ExecutionStep<T, R>
Link copied to clipboard
fun <T, A1, A2, A3, A4, A5, R> AssertionContainer<T>.f5(f: (T, A1, A2, A3, A4, A5) -> R, a1: A1, a2: A2, a3: A3, a4: A4, a5: A5): FeatureExtractorBuilder.ExecutionStep<T, R>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <T> AssertionContainer<T>.group(description: String, representationProvider: () -> Any?, assertionCreator: Expect<T>.() -> Unit): Assertion
Link copied to clipboard
fun <T> AssertionContainer<T>.grouping(description: String, representationProvider: () -> Any?, groupingActions: ExpectGrouping.() -> Unit): Assertion
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <T : IterableLike, E : Any> AssertionContainer<T>.hasNotNextOrAll(converter: (T) -> Iterable<E?>, assertionCreatorOrNull: Expect<E>.() -> Unit?): Assertion
Link copied to clipboard
fun <T : IterableLike, E : Any> AssertionContainer<T>.hasNotNextOrAny(converter: (T) -> Iterable<E?>, assertionCreatorOrNull: Expect<E>.() -> Unit?): Assertion
Link copied to clipboard
fun <T : IterableLike, E : Any> AssertionContainer<T>.hasNotNextOrNone(converter: (T) -> Iterable<E?>, assertionCreatorOrNull: Expect<E>.() -> Unit?): Assertion
Link copied to clipboard
Link copied to clipboard
fun <T : Path> AssertionContainer<T>.hasSameTextualContentAs(targetPath: Path, sourceCharset: Charset, targetCharset: Charset): Assertion
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <T : BigDecimal> AssertionContainer<T>.isEqualIncludingScale(expected: T, nameOfIsNumericallyEqualTo: String): Assertion
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <K, V, T : Map.Entry<K, V>> AssertionContainer<T>.isKeyValue(key: K, value: V): Assertion
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Convenience method to pass a String as description which is wrapped into an Untranslatable instead of passing a Translatable.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Casts this Expect to an AssertionContainer so that you have access to the functionality provided on the logic level.

Link copied to clipboard
Link copied to clipboard
fun <T> AssertionContainer<T>.toBe(expected: T): Assertion
Link copied to clipboard
fun <T : Any> AssertionContainer<T?>.toBeNullIfNullGivenElse(assertionCreatorOrNull: Expect<T>.() -> Unit?): Assertion
Link copied to clipboard

Casts this AssertionContainer back to an Expect so that you can use it in places where an Expect is used.

Link copied to clipboard

Casts this Expect back to an ExpectGrouping so that you can use it in places where an ExpectGrouping is used.

Link copied to clipboard
fun <T> AssertionContainer<T>.toHoldThirdPartyExpectation(description: String, representation: Any?, expectationExecutor: (T) -> Unit): Assertion
Link copied to clipboard