doc / ch.tutteli.atrium.assertions.builders / AssertionBuilder / createDescriptive

createDescriptive

open fun createDescriptive(description: String, representation: Any?, test: () -> Boolean): DescriptiveAssertion (source)
open fun createDescriptive(description: Translatable, representation: Any?, test: () -> Boolean): DescriptiveAssertion (source)

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

Notice, if you want to use text (a String which is treated as raw string in reporting) as representation, then wrap it into a Text and pass it instead.

Shortcut for:

descriptive
  .withTest(test)
  .withDescriptionAndRepresentation(description, representation)
  .build()

Parameters

description - The description of the assertion, e.g. to Be

representation - The representation of the expected outcome

test - The test which checks whether the assertion holds