Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add similarity to contain exactly in any order #3938

Merged
merged 2 commits into from
May 9, 2024
Merged

Add similarity to contain exactly in any order #3938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0dd445f
Add similarity to contain exactly in any order draft (#51)
AlexCue987 Mar 14, 2024
d8b4ff6
Merge branch 'master' into add-similarity-to-containExactlyInAnyOrder
AlexCue987 Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions ...ons-core/src/commonMain/kotlin/io/kotest/matchers/collections/containExactlyInAnyOrder.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import io.kotest.matchers.neverNullMatcher
import io.kotest.matchers.nulls.shouldNotBeNull
import io.kotest.matchers.should
import io.kotest.matchers.shouldNot
import io.kotest.similarity.possibleMatchesDescription


/**
Expand Down Expand Up @@ -130,6 +131,10 @@ fun <T, C : Collection<T>> containExactlyInAnyOrder(
expected.any { verifier?.verify(it, t)?.areEqual() ?: (t == it) }
}
val countMismatch = countMismatch(expectedGroupedCounts, valueGroupedCounts)
val possibleMatches = extra
.map { possibleMatchesDescription(expected.toSet(), it) }
.filter { it.isNotEmpty() }
.joinToString("\n")

val failureMessage = {
buildString {
Expand All @@ -142,6 +147,10 @@ fun <T, C : Collection<T>> containExactlyInAnyOrder(
if(countMismatch.isNotEmpty()) {
append("CountMismatches: ${countMismatch.joinToString(", ")}")
}
if(possibleMatches.isNotEmpty()) {
appendLine()
append("Possible matches for unexpected elements:\n$possibleMatches")
}
}
}

Expand Down
15 changes: 15 additions & 0 deletions ...e/src/jvmTest/kotlin/com/sksamuel/kotest/matchers/collections/ShouldContainExactlyTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import io.kotest.matchers.collections.shouldNotContainExactlyInAnyOrder
import io.kotest.matchers.should
import io.kotest.matchers.shouldBe
import io.kotest.matchers.shouldNot
import io.kotest.matchers.string.shouldContain
import io.kotest.matchers.throwable.shouldHaveMessage
import io.kotest.property.Arb
import io.kotest.property.Exhaustive
Expand Down Expand Up @@ -354,6 +355,20 @@ class ShouldContainExactlyTest : WordSpec() {
)
}

"find similar elements for unexpected key" {
val message = shouldThrow<AssertionError> {
listOf(sweetGreenApple, sweetRedApple).shouldContainExactlyInAnyOrder(listOf(sweetGreenApple, sweetGreenPear))
}.message
message shouldContain """
|Possible matches for unexpected elements:
|
| expected: Fruit(name=apple, color=green, taste=sweet),
| but was: Fruit(name=apple, color=red, taste=sweet),
| The following fields did not match:
| "color" expected: <"green">, but was: <"red">
""".trimMargin()
}

"disambiguate when using optional expected value" {
val actual: List<String> = listOf("A", "B", "C")
val expected: List<String>? = listOf("A", "B", "C")
Expand Down