atrium-assertions

alltypes

object AtriumFactory : IAtriumFactory

fun <T : Any> newCheckImmediately(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlant<T>
fun <T : Any> newCheckImmediately(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
fun <T : Any> newCheckImmediately(commonFields: CommonFields<T>): IAssertionPlant<T>
fun <T : Any> newCheckLazily(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlant<T>
fun <T : Any> newCheckLazily(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
fun <T : Any> newCheckLazily(commonFields: CommonFields<T>): IAssertionPlant<T>
inline fun <T : Any> newCheckLazilyAtTheEnd(assertionVerb: String, subject: T, reporter: IReporter, createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>
fun newDetailedObjectFormatter(): IObjectFormatter
inline fun <reified TSub : T, T : Any> newDownCastBuilder(description: String, commonFields: CommonFields<T?>): DownCastBuilder<T, TSub>
fun <TSub : T, T : Any> newDownCastBuilder(description: String, clazz: KClass<TSub>, commonFields: CommonFields<T?>): DownCastBuilder<T, TSub>
fun <T : Any> newFeatureAssertionChecker(subjectPlant: IAssertionPlant<T>): IAssertionChecker
fun <T> newNullable(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlantNullable<T>
fun <T> newNullable(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlantNullable<T>
fun <T> newNullable(commonFields: CommonFields<T>): IAssertionPlantNullable<T>
fun newOnlyFailureReporter(assertionFormatter: IAssertionFormatter): IReporter
fun newSameLineAssertionFormatter(objectFormatter: IObjectFormatter): IAssertionFormatter
fun newThrowableFluent(assertionVerb: String, act: () -> Unit, reporter: IReporter): ThrowableFluent
fun newThrowableFluent(assertionVerb: String, act: () -> Unit, assertionChecker: IAssertionChecker): ThrowableFluent
fun newThrowingAssertionChecker(reporter: IReporter): IAssertionChecker

class DownCastBuilder<out T : Any, out TSub : T>

DownCastBuilder(description: String, subType: KClass<TSub>, commonFields: CommonFields<T?>)
fun cast(): IAssertionPlant<TSub>
fun withLazyAssertions(createAssertions: IAssertionPlant<TSub>.() -> Unit): DownCastBuilder<T, TSub>
fun withNullRepresentation(representation: String): DownCastBuilder<T, TSub>

interface IAssertion

abstract fun holds(): Boolean

interface IAssertionChecker

abstract fun check(assertionVerb: String, subject: Any, assertions: List<IAssertion>): Unit
abstract fun fail(assertionVerb: String, subject: Any, assertion: IAssertion): Unit

interface IAssertionFormatter

abstract fun format(sb: StringBuilder, assertion: IAssertion, assertionFilter: (IAssertion) -> Boolean, messageFilter: (Message) -> Boolean): Unit

interface IAssertionGroup : IAssertion

abstract val assertions: List<IAssertion>
open fun holds(): Boolean
abstract val name: String
abstract val subject: Any

interface IAssertionPlant<out T : Any> : IAssertionPlantWithCommonFields<T>

abstract fun addAssertion(assertion: IAssertion): IAssertionPlant<T>
open val and: IAssertionPlant<T>
abstract fun checkAssertions(): IAssertionPlant<T>
abstract fun createAndAddAssertion(description: String, expected: Any, test: () -> Boolean): IAssertionPlant<T>

interface IAssertionPlantNullable<out T> : IAssertionPlantWithCommonFields<T>

abstract fun isNull(): Unit

interface IAssertionPlantWithCommonFields<out T>

data class CommonFields<out T>

CommonFields(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker)
val assertionChecker: IAssertionChecker
val assertionVerb: String
fun check(assertions: List<IAssertion>): Unit
fun fail(assertion: IAssertion): Unit
val subject: T

abstract val commonFields: CommonFields<T>
open val subject: T

interface IAtriumFactory

abstract fun <T : Any> newCheckImmediately(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlant<T>
abstract fun <T : Any> newCheckImmediately(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
abstract fun <T : Any> newCheckImmediately(commonFields: CommonFields<T>): IAssertionPlant<T>
abstract fun <T : Any> newCheckLazily(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlant<T>
abstract fun <T : Any> newCheckLazily(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
abstract fun <T : Any> newCheckLazily(commonFields: CommonFields<T>): IAssertionPlant<T>
abstract fun newDetailedObjectFormatter(): IObjectFormatter
abstract fun <T : Any> newFeatureAssertionChecker(subjectPlant: IAssertionPlant<T>): IAssertionChecker
abstract fun <T> newNullable(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlantNullable<T>
abstract fun <T> newNullable(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlantNullable<T>
abstract fun <T> newNullable(commonFields: CommonFields<T>): IAssertionPlantNullable<T>
abstract fun newOnlyFailureReporter(assertionFormatter: IAssertionFormatter): IReporter
abstract fun newSameLineAssertionFormatter(objectFormatter: IObjectFormatter): IAssertionFormatter
abstract fun newThrowingAssertionChecker(reporter: IReporter): IAssertionChecker

interface IFeatureAssertionGroup : IAssertion

abstract val assertions: List<IAssertion>
abstract val feature: Any
abstract val featureName: String
open fun holds(): Boolean

interface IMultiMessageAssertion : IAssertion

open fun holds(): Boolean
abstract val messages: List<Message>

interface IObjectFormatter

abstract fun format(value: Any?): String

interface IOneMessageAssertion : IAssertion

open fun holds(): Boolean
abstract val message: Message

interface IReporter

abstract fun format(sb: StringBuilder, assertion: IAssertion): Unit

data class Message

Message(description: String, representation: Any, holds: Boolean)
val description: String
val holds: Boolean
val representation: Any

data class RawString

RawString(string: String)
val NULL: RawString
val string: String
fun toString(): String

class ReporterBuilder

ReporterBuilder(assertionFormatter: IAssertionFormatter)
class AssertionMessageBuilder

AssertionMessageBuilder(objectFormatter: IObjectFormatter)
fun withSameLineAssertionMessageFormatter(): ReporterBuilder

fun buildOnlyFailureReporting(): IReporter
fun withDetailedObjectFormatter(): AssertionMessageBuilder

class ThrowableFluent

val commonFields: CommonFields<Throwable?>
inline fun <reified TExpected : Throwable> toThrow(): IAssertionPlant<TExpected>
fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>): IAssertionPlant<TExpected>
inline fun <reified TExpected : Throwable> toThrow(noinline createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>
fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>, createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>

package ch.tutteli.atrium

object AtriumFactory : IAtriumFactory

fun <T : Any> newCheckImmediately(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlant<T>
fun <T : Any> newCheckImmediately(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
fun <T : Any> newCheckImmediately(commonFields: CommonFields<T>): IAssertionPlant<T>
fun <T : Any> newCheckLazily(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlant<T>
fun <T : Any> newCheckLazily(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
fun <T : Any> newCheckLazily(commonFields: CommonFields<T>): IAssertionPlant<T>
inline fun <T : Any> newCheckLazilyAtTheEnd(assertionVerb: String, subject: T, reporter: IReporter, createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>
fun newDetailedObjectFormatter(): IObjectFormatter
inline fun <reified TSub : T, T : Any> newDownCastBuilder(description: String, commonFields: CommonFields<T?>): DownCastBuilder<T, TSub>
fun <TSub : T, T : Any> newDownCastBuilder(description: String, clazz: KClass<TSub>, commonFields: CommonFields<T?>): DownCastBuilder<T, TSub>
fun <T : Any> newFeatureAssertionChecker(subjectPlant: IAssertionPlant<T>): IAssertionChecker
fun <T> newNullable(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlantNullable<T>
fun <T> newNullable(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlantNullable<T>
fun <T> newNullable(commonFields: CommonFields<T>): IAssertionPlantNullable<T>
fun newOnlyFailureReporter(assertionFormatter: IAssertionFormatter): IReporter
fun newSameLineAssertionFormatter(objectFormatter: IObjectFormatter): IAssertionFormatter
fun newThrowableFluent(assertionVerb: String, act: () -> Unit, reporter: IReporter): ThrowableFluent
fun newThrowableFluent(assertionVerb: String, act: () -> Unit, assertionChecker: IAssertionChecker): ThrowableFluent
fun newThrowingAssertionChecker(reporter: IReporter): IAssertionChecker

interface IAtriumFactory

abstract fun <T : Any> newCheckImmediately(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlant<T>
abstract fun <T : Any> newCheckImmediately(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
abstract fun <T : Any> newCheckImmediately(commonFields: CommonFields<T>): IAssertionPlant<T>
abstract fun <T : Any> newCheckLazily(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlant<T>
abstract fun <T : Any> newCheckLazily(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlant<T>
abstract fun <T : Any> newCheckLazily(commonFields: CommonFields<T>): IAssertionPlant<T>
abstract fun newDetailedObjectFormatter(): IObjectFormatter
abstract fun <T : Any> newFeatureAssertionChecker(subjectPlant: IAssertionPlant<T>): IAssertionChecker
abstract fun <T> newNullable(assertionVerb: String, subject: T, reporter: IReporter): IAssertionPlantNullable<T>
abstract fun <T> newNullable(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker): IAssertionPlantNullable<T>
abstract fun <T> newNullable(commonFields: CommonFields<T>): IAssertionPlantNullable<T>
abstract fun newOnlyFailureReporter(assertionFormatter: IAssertionFormatter): IReporter
abstract fun newSameLineAssertionFormatter(objectFormatter: IObjectFormatter): IAssertionFormatter
abstract fun newThrowingAssertionChecker(reporter: IReporter): IAssertionChecker

fun <T : CharSequence> IAssertionPlant<T>.contains(expected: CharSequence): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.contains(expected: CharSequence, vararg otherExpected: CharSequence): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.contains(expected: Any, vararg otherExpected: Any): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.containsNot(expected: CharSequence): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.containsNot(expected: CharSequence, vararg otherExpected: CharSequence): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.containsNot(expected: Any, vararg otherExpected: Any): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.endsNotWith(expected: CharSequence): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.endsWith(expected: CharSequence): IAssertionPlant<T>
fun <T : Any> IAssertionPlant<T>.genericCheck(feature: KProperty0<Boolean>): IAssertionPlant<T>
fun <T : Any> IAssertionPlant<T>.genericNotCheck(feature: KProperty0<Boolean>): IAssertionPlant<T>
fun <T : Collection<*>> IAssertionPlant<T>.hasSize(size: Int): IAssertionPlant<T>
inline fun <reified TSub : Any> IAssertionPlant<Any>.isA(): IAssertionPlant<TSub>
inline fun <reified TSub : Any> IAssertionPlant<Any>.isA(noinline createAssertions: IAssertionPlant<TSub>.() -> Unit): IAssertionPlant<TSub>
fun <T : CharSequence> IAssertionPlant<T>.isEmpty(): IAssertionPlant<T>
fun <T : Collection<*>> IAssertionPlant<T>.isEmpty(): IAssertionPlant<T>
fun IAssertionPlant<Int>.isGreaterOrEquals(expected: Int): IAssertionPlant<Int>
fun IAssertionPlant<Int>.isGreaterThan(expected: Int): IAssertionPlant<Int>
fun <T : CharSequence> IAssertionPlant<T>.isNotEmpty(): IAssertionPlant<T>
inline fun <reified T : Any> IAssertionPlantNullable<T?>.isNotNull(): IAssertionPlant<T>
inline fun <reified T : Any> IAssertionPlantNullable<T?>.isNotNull(noinline createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>
fun <T : Any> IAssertionPlant<T>.isNotSame(expected: T): IAssertionPlant<T>
fun <T : Any> IAssertionPlant<T>.isSame(expected: T): IAssertionPlant<T>
fun IAssertionPlant<Int>.isSmallerOrEquals(expected: Int): IAssertionPlant<Int>
fun IAssertionPlant<Int>.isSmallerThan(expected: Int): IAssertionPlant<Int>
fun <T : Any, TFeature : Any> IAssertionPlant<T>.its(feature: KProperty0<TFeature>): IAssertionPlant<TFeature>
fun <T : Any, TFeature : Any> IAssertionPlant<T>.its(feature: KProperty0<TFeature>, createAssertions: IAssertionPlant<TFeature>.() -> Unit): IAssertionPlant<TFeature>
fun <T : Any, TFeature> IAssertionPlant<T>.its(feature: KProperty0<TFeature>): IAssertionPlantNullable<TFeature>
val <T : Throwable> IAssertionPlant<T>.message: IAssertionPlant<String>
fun <T : Throwable> IAssertionPlant<T>.message(createAssertions: IAssertionPlant<String>.() -> Unit): IAssertionPlant<String>
fun <T : Any> IAssertionPlant<T>.notToBe(expected: T): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.startsNotWith(expected: CharSequence): IAssertionPlant<T>
fun <T : CharSequence> IAssertionPlant<T>.startsWith(expected: CharSequence): IAssertionPlant<T>
fun <T : Any> IAssertionPlant<T>.toBe(expected: T): IAssertionPlant<T>

package ch.tutteli.atrium.assertions

interface IAssertion

abstract fun holds(): Boolean

interface IAssertionGroup : IAssertion

abstract val assertions: List<IAssertion>
open fun holds(): Boolean
abstract val name: String
abstract val subject: Any

interface IFeatureAssertionGroup : IAssertion

abstract val assertions: List<IAssertion>
abstract val feature: Any
abstract val featureName: String
open fun holds(): Boolean

interface IMultiMessageAssertion : IAssertion

open fun holds(): Boolean
abstract val messages: List<Message>

interface IOneMessageAssertion : IAssertion

open fun holds(): Boolean
abstract val message: Message

data class Message

Message(description: String, representation: Any, holds: Boolean)
val description: String
val holds: Boolean
val representation: Any

package ch.tutteli.atrium.checking

interface IAssertionChecker

abstract fun check(assertionVerb: String, subject: Any, assertions: List<IAssertion>): Unit
abstract fun fail(assertionVerb: String, subject: Any, assertion: IAssertion): Unit

package ch.tutteli.atrium.creating

class DownCastBuilder<out T : Any, out TSub : T>

DownCastBuilder(description: String, subType: KClass<TSub>, commonFields: CommonFields<T?>)
fun cast(): IAssertionPlant<TSub>
fun withLazyAssertions(createAssertions: IAssertionPlant<TSub>.() -> Unit): DownCastBuilder<T, TSub>
fun withNullRepresentation(representation: String): DownCastBuilder<T, TSub>

interface IAssertionPlant<out T : Any> : IAssertionPlantWithCommonFields<T>

abstract fun addAssertion(assertion: IAssertion): IAssertionPlant<T>
open val and: IAssertionPlant<T>
abstract fun checkAssertions(): IAssertionPlant<T>
abstract fun createAndAddAssertion(description: String, expected: Any, test: () -> Boolean): IAssertionPlant<T>

interface IAssertionPlantNullable<out T> : IAssertionPlantWithCommonFields<T>

abstract fun isNull(): Unit

interface IAssertionPlantWithCommonFields<out T>

data class CommonFields<out T>

CommonFields(assertionVerb: String, subject: T, assertionChecker: IAssertionChecker)
val assertionChecker: IAssertionChecker
val assertionVerb: String
fun check(assertions: List<IAssertion>): Unit
fun fail(assertion: IAssertion): Unit
val subject: T

abstract val commonFields: CommonFields<T>
open val subject: T

class ThrowableFluent

val commonFields: CommonFields<Throwable?>
inline fun <reified TExpected : Throwable> toThrow(): IAssertionPlant<TExpected>
fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>): IAssertionPlant<TExpected>
inline fun <reified TExpected : Throwable> toThrow(noinline createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>
fun <TExpected : Throwable> toThrow(expectedType: KClass<TExpected>, createAssertions: IAssertionPlant<TExpected>.() -> Unit): IAssertionPlant<TExpected>

inline fun <T : Any> IAssertionPlant<T>.createAssertionsAndCheckThem(createAssertions: IAssertionPlant<T>.() -> Unit): IAssertionPlant<T>

package ch.tutteli.atrium.reporting

interface IAssertionFormatter

abstract fun format(sb: StringBuilder, assertion: IAssertion, assertionFilter: (IAssertion) -> Boolean, messageFilter: (Message) -> Boolean): Unit

interface IObjectFormatter

abstract fun format(value: Any?): String

interface IReporter

abstract fun format(sb: StringBuilder, assertion: IAssertion): Unit

data class RawString

RawString(string: String)
val NULL: RawString
val string: String
fun toString(): String

class ReporterBuilder

ReporterBuilder(assertionFormatter: IAssertionFormatter)
class AssertionMessageBuilder

AssertionMessageBuilder(objectFormatter: IObjectFormatter)
fun withSameLineAssertionMessageFormatter(): ReporterBuilder

fun buildOnlyFailureReporting(): IReporter
fun withDetailedObjectFormatter(): AssertionMessageBuilder