Contains different types of Assertion -- e.g. BasicDescriptiveAssertion -- as well as assertion function templates which can be used in API modules such as ch.tutteli.atrium.api.cc.en_UK.
interface Assertion
The base interface of all assertions, providing the method holds. |
|
interface AssertionGroup : Assertion
The base interface for Assertion groups, providing a default implementation for Assertion.holds
which returns |
|
interface AssertionGroupType : BulletPointIdentifier
Represents a type of an AssertionGroup. |
|
data class BasicAssertionGroup : AssertionGroup
A default implementation for AssertionGroup -- it has a certain type, a name, a subject and of course assertions. |
|
class BasicDescriptiveAssertion : DescriptiveAssertion
A default implementation for DescriptiveAssertion which lazily evaluates holds. |
|
class BasicExplanatoryAssertion : ExplanatoryAssertion
A default implementation for ExplanatoryAssertion -- an assertion which only wants to give an explanation. |
|
interface BulletPointIdentifier
A marker interface for types which can be used to identify bullet points in IAtriumFactory.registerTextAssertionFormatterCapabilities. |
|
object DefaultExplanatoryAssertionGroupType : ExplanatoryAssertionGroupType
The AssertionGroupType for AssertionGroups whose assertions are used to explain
something rather than pointing something out -- accordingly the AssertionGroup.holds should always return |
|
object DefaultFeatureAssertionGroupType : FeatureAssertionGroupType
The AssertionGroupType for AssertionGroups which contain any kind of feature assertions. |
|
object DefaultIndentAssertionGroupType : IndentAssertionGroupType
The AssertionGroupType for AssertionGroups whose assertions should be displayed with an extra indent. |
|
object DefaultInvisibleAssertionGroupType : InvisibleAssertionGroupType
The AssertionGroupType for AssertionGroups whose grouping behaviour should be kind of invisible to the user. |
|
object DefaultListAssertionGroupType : ListAssertionGroupType
The AssertionGroupType for AssertionGroups whose assertions should be displayed in a list. |
|
object DefaultSummaryAssertionGroupType : SummaryAssertionGroupType
The AssertionGroupType for AssertionGroups whose assertions should not be filtered (by a Reporter) and for which an AssertionFormatter should state whether they hold or not. |
|
enum class DescriptionAnyAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which are applicable to Any. |
|
enum class DescriptionBasic : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions which are so basic that one does not want to use a different wording in a two different assertion functions. |
|
enum class DescriptionBigDecimalAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which are applicable to BigDecimal. |
|
enum class DescriptionCharSequenceAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which are applicable to CharSequence. |
|
enum class DescriptionCollectionAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which are applicable to Collection. |
|
enum class DescriptionComparableAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which are applicable to Comparable. |
|
enum class DescriptionFloatingPointAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which are applicable to Float, Double and BigDecimal. |
|
enum class DescriptionIterableAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which are applicable to Iterable. |
|
enum class DescriptionThrowableAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which are applicable to Throwable. |
|
enum class DescriptionTypeTransformationAssertion : StringBasedTranslatable
Contains the DescriptiveAssertion.descriptions of the assertion functions which postulate that a
AssertionPlant.subject of type |
|
interface DescriptiveAssertion : Assertion
The base interface for Assertions which only consists of the expected result with a complementary description. |
|
interface DoNotFilterAssertionGroupType : AssertionGroupType
An AssertionGroupType which indicates that a Reporter should not filter its AssertionGroup.assertions. |
|
abstract class EmptyNameAndSubjectAssertionGroup : AssertionGroup
Represents a base class for AssertionGroups which have an empty name and subject. |
|
interface ExplanatoryAssertion : Assertion
Represents an Assertion which is typically used in an AssertionGroup with a ExplanatoryAssertionGroupType and provides an explanation which is typically formatted by an ObjectFormatter in reporting. |
|
class ExplanatoryAssertionGroup : EmptyNameAndSubjectAssertionGroup
Represents an AssertionGroup with an ExplanatoryAssertionGroupType, which means a Reporter should not
show whether the assertions hold or not -- moreover holds always returns |
|
interface ExplanatoryAssertionGroupType : DoNotFilterAssertionGroupType
Represents the AssertionGroupType for AssertionGroups whose assertions are mainly
used to explain something -- it is not of importance whether they hold or not and thus such AssertionGroups should
always return |
|
interface FeatureAssertionGroupType : AssertionGroupType
Represents the AssertionGroupType for AssertionGroups which contain some kind of feature assertions. |
|
data class FixHoldsAssertionGroup : AssertionGroup
Represents a group of Assertions -- it has a certain type, a name, a subject, assertions and a fixed value for holds which does not depend on assertions (usually indirectly). |
|
class IndentAssertionGroup : EmptyNameAndSubjectAssertionGroup
Represents an AssertionGroup with an DefaultIndentAssertionGroupType, which means the assertions shall be indented one extra level and name and subject shall be neglected (not reported to the output). |
|
interface IndentAssertionGroupType : AssertionGroupType
Represents the AssertionGroupType for AssertionGroups whose assertions should be displayed with an extra indent. Such a group might have a AssertionGroup.name and AssertionGroup.subject (by accident) but should not be mentioned in reporting. |
|
class InvisibleAssertionGroup : EmptyNameAndSubjectAssertionGroup
Represents an AssertionGroup with a DefaultInvisibleAssertionGroupType, which means the grouping should be invisible in reporting. |
|
interface InvisibleAssertionGroupType : AssertionGroupType
Represents the AssertionGroupType for AssertionGroups whose assertions should be displayed in a manner that the user does not even notice that the Assertions have been grouped. |
|
class LazyThreadUnsafeAssertionGroup : AssertionGroup
Represents an AssertionGroup which is evaluated lazily where the lazy loading is not thread safe. |
|
class LazyThreadUnsafeBasicAssertion : DescriptiveAssertion
Represents a DescriptiveAssertion which is evaluated lazily where the lazy loading is not thread safe. |
|
interface ListAssertionGroupType : AssertionGroupType
Represents the AssertionGroupType for AssertionGroups whose assertions should be displayed in a list (up to the Reporter if it is a list with bullets, squares etc.). |
|
class PrefixFailingSummaryAssertion : BulletPointIdentifier
Represents the identifier for bullet points used to prefix Assertions which do not hold, in context of an AssertionGroup with type SummaryAssertionGroupType. |
|
class PrefixFeatureAssertionGroupHeader : BulletPointIdentifier
This class is only used as identifier for IAtriumFactory.registerTextAssertionFormatterCapabilities. |
|
class PrefixSuccessfulSummaryAssertion : BulletPointIdentifier
Represents the identifier for bullet points used to prefix Assertions which hold, in context of an AssertionGroup with type SummaryAssertionGroupType. |
|
object RootAssertionGroupType : AssertionGroupType
The AssertionGroupType for AssertionGroups which are the root of all assertions. |
|
interface SummaryAssertionGroupType : DoNotFilterAssertionGroupType
Represents the AssertionGroupType for AssertionGroups whose assertions should all be reported in reporting (no filtering by a Reporter) since it represents a summary which itself will point out which assertions hold and which do not. |
|
object WarningAssertionGroupType : ExplanatoryAssertionGroupType
The AssertionGroupType for AssertionGroups whose assertions are used to state a warning rather than making an assumption. |
fun <T : CharSequence> _containsBuilder(plant: AssertionPlant<T>): CharSequenceContainsBuilder<T, CharSequenceContainsNoOpSearchBehaviour> |
|
fun <T : CharSequence> _containsNotBuilder(plant: AssertionPlant<T>): CharSequenceContainsBuilder<T, CharSequenceContainsNotSearchBehaviour> |
|
fun <T : Any, TSub : T> _downCast(description: Translatable, subType: KClass<TSub>, subjectPlant: BaseAssertionPlant<T?, *>, assertionCreator: AssertionPlant<TSub>.() -> Unit): Unit |
|
fun <T : CharSequence> _endsNotWith(plant: AssertionPlant<T>, expected: CharSequence): Assertion |
|
fun <T : CharSequence> _endsWith(plant: AssertionPlant<T>, expected: CharSequence): Assertion |
|
fun <T : Collection<*>> _hasSize(plant: AssertionPlant<T>, size: Int): Assertion |
|
fun <TSub : Any> _isA(plant: AssertionPlant<Any>, assertionCreator: AssertionPlant<TSub>.() -> Unit): Unit |
|
fun <T : CharSequence> _isEmpty(plant: AssertionPlant<T>): Assertion |
|
fun <T : BigDecimal> _isEqualIncludingScale(plant: AssertionPlant<T>, expected: T, nameOfIsNumericallyEqualTo: String): Assertion |
|
fun <T : Comparable<T>> _isGreaterOrEquals(plant: AssertionPlant<T>, expected: T): BasicDescriptiveAssertion |
|
fun <T : Comparable<T>> _isGreaterThan(plant: AssertionPlant<T>, expected: T): BasicDescriptiveAssertion |
|
fun <T : Comparable<T>> _isLessOrEquals(plant: AssertionPlant<T>, expected: T): BasicDescriptiveAssertion |
|
fun <T : Comparable<T>> _isLessThan(plant: AssertionPlant<T>, expected: T): BasicDescriptiveAssertion |
|
fun <T : CharSequence> _isNotEmpty(plant: AssertionPlant<T>): Assertion |
|
fun <T : BigDecimal> _isNotEqualIncludingScale(plant: AssertionPlant<T>, expected: T): BasicDescriptiveAssertion |
|
fun <T : Any> _isNotNull(plant: AssertionPlantNullable<T?>, assertionCreator: AssertionPlant<T>.() -> Unit): Unit |
|
fun <T : BigDecimal> _isNotNumericallyEqualTo(plant: AssertionPlant<T>, expected: T): BasicDescriptiveAssertion |
|
fun <T : Any> _isNotSame(plant: AssertionPlant<T>, expected: T): Assertion |
|
fun <T> _isNull(plant: AssertionPlantNullable<T>): Assertion |
|
fun <T : BigDecimal> _isNumericallyEqualTo(plant: AssertionPlant<T>, expected: T): BasicDescriptiveAssertion |
|
fun <T : Any> _isSame(plant: AssertionPlant<T>, expected: T): Assertion |
|
fun <T : Any, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: () -> TReturnValue): AssertionPlant<TReturnValue> fun <T : Any, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: () -> TReturnValue, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1) -> TReturnValue, arg1: T1): AssertionPlant<TReturnValue> fun <T : Any, T1, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1) -> TReturnValue, arg1: T1, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1, T2) -> TReturnValue, arg1: T1, arg2: T2): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1, T2) -> TReturnValue, arg1: T1, arg2: T2, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1, T2, T3) -> TReturnValue, arg1: T1, arg2: T2, arg3: T3): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1, T2, T3) -> TReturnValue, arg1: T1, arg2: T2, arg3: T3, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, T4, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1, T2, T3, T4) -> TReturnValue, arg1: T1, arg2: T2, arg3: T3, arg4: T4): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, T4, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1, T2, T3, T4) -> TReturnValue, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, T4, T5, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1, T2, T3, T4, T5) -> TReturnValue, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, T4, T5, TReturnValue : Any> _method(plant: AssertionPlant<T>, name: String, method: (T1, T2, T3, T4, T5) -> TReturnValue, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> |
|
fun <T : Any> _notToBe(plant: AssertionPlant<T>, expected: T): Assertion |
|
fun <T : Any, TProperty : Any> _property(plant: AssertionPlant<T>, property: KProperty0<TProperty>): AssertionPlant<TProperty> fun <T : Any, TProperty : Any> _property(plant: AssertionPlant<T>, property: KProperty0<TProperty>, assertionCreator: AssertionPlant<TProperty>.() -> Unit): AssertionPlant<TProperty> |
|
fun <T : Any, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction0<TReturnValue>): AssertionPlant<TReturnValue> fun <T : Any, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction0<TReturnValue>, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction1<T1, TReturnValue>, arg1: T1): AssertionPlant<TReturnValue> fun <T : Any, T1, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction1<T1, TReturnValue>, arg1: T1, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction2<T1, T2, TReturnValue>, arg1: T1, arg2: T2): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction2<T1, T2, TReturnValue>, arg1: T1, arg2: T2, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction3<T1, T2, T3, TReturnValue>, arg1: T1, arg2: T2, arg3: T3): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction3<T1, T2, T3, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, T4, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction4<T1, T2, T3, T4, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, T4, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction4<T1, T2, T3, T4, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, T4, T5, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction5<T1, T2, T3, T4, T5, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): AssertionPlant<TReturnValue> fun <T : Any, T1, T2, T3, T4, T5, TReturnValue : Any> _returnValueOf(plant: AssertionPlant<T>, method: KFunction5<T1, T2, T3, T4, T5, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue> |
|
fun <T : CharSequence> _startsNotWith(plant: AssertionPlant<T>, expected: CharSequence): Assertion |
|
fun <T : CharSequence> _startsWith(plant: AssertionPlant<T>, expected: CharSequence): Assertion |
|
fun <T : Any> _toBe(plant: AssertionPlant<T>, expected: T): Assertion |
|
fun _toBeWithErrorTolerance(plant: AssertionPlant<Float>, expected: Float, tolerance: Float): Assertion fun _toBeWithErrorTolerance(plant: AssertionPlant<Double>, expected: Double, tolerance: Double): Assertion fun <T : BigDecimal> _toBeWithErrorTolerance(plant: AssertionPlant<T>, expected: T, tolerance: T): Assertion |
|
fun <TExpected : Throwable> _toThrow(throwableThrownBuilder: ThrowableThrownBuilder, assertionCreator: AssertionPlant<TExpected>.() -> Unit): Unit |
|
fun <T : Any, TSub : Any> _typeTransformation(description: Translatable, representation: Any, subjectPlant: BaseAssertionPlant<T?, *>, assertionCreator: AssertionPlant<TSub>.() -> Unit, warningTransformationFailed: Translatable, canBeTransformed: (T) -> Boolean, transform: (T) -> TSub): Unit |
|
fun <T : BigDecimal> failToBeWithHint(expected: T, nameOfIsNumericallyEqualTo: String): Assertion |