commonMain.ch.tutteli.atrium.specs.reporting.TextIndentBasedAssertionGroupFormatterSpec.kt Maven / Gradle / Ivy
//TODO 1.4.0 remove file
@file:Suppress("DEPRECATION")
package ch.tutteli.atrium.specs.reporting
import ch.tutteli.atrium.api.fluent.en_GB.feature
import ch.tutteli.atrium.api.fluent.en_GB.toEqual
import ch.tutteli.atrium.api.verbs.internal.expect
import ch.tutteli.atrium.assertions.*
import ch.tutteli.atrium.assertions.builders.assertionBuilder
import ch.tutteli.atrium.reporting.AssertionFormatter
import ch.tutteli.atrium.reporting.AssertionFormatterController
import ch.tutteli.atrium.reporting.impl.DefaultAssertionFormatterController
import ch.tutteli.atrium.specs.DummyTranslatables
import ch.tutteli.atrium.specs.describeFunTemplate
import ch.tutteli.atrium.specs.lineSeparator
import org.spekframework.spek2.style.specification.Suite
import kotlin.reflect.KClass
abstract class TextIndentBasedAssertionGroupFormatterSpec(
testeeFactory: (Map, String>, AssertionFormatterController) -> AssertionFormatter,
assertionGroupTypeClass: KClass,
anonymousAssertionGroupType: T,
groupFactory: (List) -> AssertionGroup,
describePrefix: String = "[Atrium] ",
withIndent: Boolean = true
) : AssertionFormatterSpecBase({
fun describeFun(vararg funName: String, body: Suite.() -> Unit) =
describeFunTemplate(describePrefix, funName, body = body)
val indentBulletPoint = " +"
val indentIndentBulletPoint = " ".repeat(indentBulletPoint.length + 1)
val facade = createFacade(assertionGroupTypeClass to "$indentBulletPoint ") { bulletPoints, controller, _ ->
testeeFactory(bulletPoints, controller)
}
describeFun(AssertionFormatter::canFormat.name) {
val testee = testeeFactory(bulletPoints, DefaultAssertionFormatterController())
it("returns true for an ${AssertionGroup::class.simpleName} with type object: ${assertionGroupTypeClass.simpleName}") {
expect(testee).feature {
// TODO 1.3.0 replace with representable and remove suppression
@Suppress("DEPRECATION")
f(
it::canFormat, assertionBuilder.customType(anonymousAssertionGroupType)
.withDescriptionAndRepresentation(ch.tutteli.atrium.reporting.translating.Untranslatable.EMPTY, 1)
.withAssertions(emptyList())
.build()
)
}.toEqual(true)
}
}
describeFun(AssertionFormatter::formatGroup.name) {
context("${AssertionGroup::class.simpleName} of type ${assertionGroupTypeClass.simpleName}") {
val assertions = listOf(
assertionBuilder.descriptive.holding.withDescriptionAndRepresentation(
DummyTranslatables.EXPECT,
1
).build(),
assertionBuilder.descriptive.holding.withDescriptionAndRepresentation(
DummyTranslatables.EXPECT_THROWN,
2
).build()
)
val indentAssertionGroup = groupFactory(assertions)
context("format directly the group (no prefix given)") {
it("puts the assertions one under the other including a prefix") {
facade.format(
indentAssertionGroup,
sb,
alwaysTrueAssertionFilter
)
expect(sb.toString()).toEqual(
lineSeparator
+ "$indentBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 1$lineSeparator"
+ "$indentBulletPoint ${DummyTranslatables.EXPECT_THROWN.getDefault()}: 2"
)
}
}
context("in an ${AssertionGroup::class.simpleName} of type ${FeatureAssertionGroupType::class.simpleName}") {
it("puts the assertions one under the other including a prefix ${if(withIndent) "and indent" else "but without indent"}") {
val featureAssertions = listOf(
indentAssertionGroup,
assertionBuilder.descriptive.failing.withDescriptionAndRepresentation(
DummyTranslatables.EXPECT,
20
).build()
)
val featureAssertionGroup = assertionBuilder.feature
.withDescriptionAndRepresentation(DummyTranslatables.EXPECT, 10)
.withAssertions(featureAssertions)
.build()
facade.format(
featureAssertionGroup,
sb,
alwaysTrueAssertionFilter
)
val indent = if(withIndent) indentFeatureBulletPoint else ""
expect(sb.toString()).toEqual(
lineSeparator
+ "$arrow ${DummyTranslatables.EXPECT.getDefault()}: 10$lineSeparator"
+ "$indentArrow$indent$indentBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 1$lineSeparator"
+ "$indentArrow$indent$indentBulletPoint ${DummyTranslatables.EXPECT_THROWN.getDefault()}: 2$lineSeparator"
+ "$indentArrow$featureBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 20"
)
}
}
context("in an ${AssertionGroup::class.simpleName} of type ${ListAssertionGroupType::class.simpleName}") {
val listAssertions = listOf(
indentAssertionGroup,
assertionBuilder.descriptive.failing.withDescriptionAndRepresentation(
DummyTranslatables.EXPECT,
20
).build()
)
val listAssertionGroup = assertionBuilder.list
.withDescriptionAndRepresentation(DummyTranslatables.EXPECT, 10)
.withAssertions(listAssertions)
.build()
val indent = if(withIndent) indentListBulletPoint else ""
it("puts the assertions one under the other including a prefix ${if(withIndent) "and indent" else "but without indent"}") {
facade.format(
listAssertionGroup,
sb,
alwaysTrueAssertionFilter
)
expect(sb.toString()).toEqual(
lineSeparator
+ "${DummyTranslatables.EXPECT.getDefault()}: 10$lineSeparator"
+ "$indent$indentBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 1$lineSeparator"
+ "$indent$indentBulletPoint ${DummyTranslatables.EXPECT_THROWN.getDefault()}: 2$lineSeparator"
+ "$listBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 20"
)
}
context("in another ${AssertionGroup::class.simpleName} of type ${ListAssertionGroupType::class.simpleName}") {
it("puts the assertions one under the other and indents as the other assertions but ${if(withIndent) "adds an extra indent including a prefix" else "uses a different prefix"} ") {
val listAssertions2 = listOf(
listAssertionGroup,
assertionBuilder.descriptive.failing.withDescriptionAndRepresentation(
DummyTranslatables.EXPECT_THROWN,
30
).build()
)
val listAssertionGroup2 = assertionBuilder.list
.withDescriptionAndRepresentation(DummyTranslatables.EXPECT, 5)
.withAssertions(listAssertions2)
.build()
facade.format(
listAssertionGroup2,
sb,
alwaysTrueAssertionFilter
)
expect(sb.toString()).toEqual(
lineSeparator
+ "${DummyTranslatables.EXPECT.getDefault()}: 5$lineSeparator"
+ "$listBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 10$lineSeparator"
+ "$indentListBulletPoint$indent$indentBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 1$lineSeparator"
+ "$indentListBulletPoint$indent$indentBulletPoint ${DummyTranslatables.EXPECT_THROWN.getDefault()}: 2$lineSeparator"
+ "$indentListBulletPoint$listBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 20$lineSeparator"
+ "$listBulletPoint ${DummyTranslatables.EXPECT_THROWN.getDefault()}: 30"
)
}
}
}
context("in another ${AssertionGroup::class.simpleName} of type object: ${assertionGroupTypeClass::class.simpleName}") {
val indentAssertions = listOf(
assertionBuilder.descriptive.failing.withDescriptionAndRepresentation(
DummyTranslatables.EXPECT,
21
).build(), indentAssertionGroup,
assertionBuilder.descriptive.failing.withDescriptionAndRepresentation(
DummyTranslatables.EXPECT,
20
).build()
)
val indentAssertionGroup2 = assertionBuilder.customType(anonymousAssertionGroupType)
.withDescriptionAndRepresentation(DummyTranslatables.EXPECT, 10)
.withAssertions(indentAssertions)
.build()
val indent = if(withIndent) indentIndentBulletPoint else ""
it("puts the assertions one under the other ${if(withIndent) "but adds an extra indent including" else ""}") {
facade.format(
indentAssertionGroup2,
sb,
alwaysTrueAssertionFilter
)
expect(sb.toString()).toEqual(
lineSeparator
+ "$indentBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 21$lineSeparator"
+ "$indent$indentBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 1$lineSeparator"
+ "$indent$indentBulletPoint ${DummyTranslatables.EXPECT_THROWN.getDefault()}: 2$lineSeparator"
+ "$indentBulletPoint ${DummyTranslatables.EXPECT.getDefault()}: 20"
)
}
}
}
}
})
© 2015 - 2025 Weber Informatics LLC | Privacy Policy