Skip to content

Fix ParameterizeFailedError not showing parameter names #41

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

Merged
BenWoodworth merged 2 commits into from
Nov 19, 2025
Merged

Fix ParameterizeFailedError not showing parameter names #41

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
3e0e675
Fix `ParameterizeFailedError` not showing parameter names
BenWoodworth Oct 25, 2025
8f35ba8
Fix `ParameterizeFailedError` docs
BenWoodworth Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions parameterize-core/src/commonMain/kotlin/ParameterizeFailedError.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ import com.benwoodworth.parameterize.ParameterizeConfiguration.OnCompleteScope
* [completedEarly][OnCompleteScope.completedEarly] was true in [onComplete][Builder.onComplete].
*
* The [suppressedExceptions] include [recordedFailures][OnCompleteScope.recordedFailures] from the
* [onComplete][Builder.onComplete] handler, with each being decorated with a message to include a list of the
* [arguments][ParameterizeFailure.arguments] that caused it.
* [onComplete][Builder.onComplete] handler, each being decorated with a message to include a list of the
* [parameter arguments][ParameterizeFailure.parameters] that caused it.
*
* Can only be constructed from [onComplete][Builder.onComplete].
*/
Expand Down Expand Up @@ -63,6 +63,9 @@ internal expect class Failure : AssertionError {
override val cause: Throwable
}

private fun ParameterizeScope.DeclaredParameter<*>.toErrorString(): String =
"${property.name} = $argument"

@Suppress("NOTHING_TO_INLINE")
internal inline fun ParameterizeFailedError.Companion.commonShouldCaptureStackTrace(
recordedFailures: List<ParameterizeFailure>
Expand Down Expand Up @@ -111,7 +114,7 @@ internal inline val ParameterizeFailedError.commonMessage

failure.parameters.forEach { parameter ->
append("\n\t\t")
append(parameter.argument)
append(parameter.toErrorString())
}
}

Expand All @@ -125,14 +128,16 @@ internal inline val Failure.commonMessage: String
get() = when (failure.parameters.size) {
0 -> "Failed with no arguments"

1 -> failure.parameters.single().let { argument ->
"Failed with argument:\n\t\t$argument"
1 -> failure.parameters.single().let { parameter ->
"Failed with argument:\n\t\t${parameter.toErrorString()}"
}

else -> failure.parameters.joinToString(
prefix = "Failed with arguments:\n\t\t",
separator = "\n\t\t"
)
) { parameter ->
parameter.toErrorString()
}
}

internal inline val Failure.commonCause: Throwable
Expand Down
29 changes: 13 additions & 16 deletions parameterize-core/src/commonTest/kotlin/ParameterizeFailedErrorSpec.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import kotlin.test.assertEquals
import kotlin.test.assertNotEquals

class ParameterizeFailedErrorSpec {
private val arguments = run {
private val parameters = run {
val properties = object : Any() {
val propertyA = "argumentA"
val propertyB = "argumentB"
Expand All @@ -38,9 +38,6 @@ class ParameterizeFailedErrorSpec {
)
}

private val argumentA = arguments[0]
private val argumentB = arguments[1]

@Test
fun message_should_have_failure_count_and_total() {
val error = ParameterizeFailedError(
Expand Down Expand Up @@ -194,7 +191,7 @@ class ParameterizeFailedErrorSpec {
)

val error = ParameterizeFailedError(
failures.mapIndexed { index, it -> ParameterizeFailure(it, arguments.take(index)) },
failures.mapIndexed { index, it -> ParameterizeFailure(it, parameters.take(index)) },
successCount = 4,
failureCount = 3,
completedEarly = false
Expand All @@ -206,10 +203,10 @@ class ParameterizeFailedErrorSpec {
Failed 3/7 cases
${'\t'}${failures[0]::class.simpleName}: Failure 0
${'\t'}${failures[1]::class.simpleName}: Failure 1
${'\t'}${'\t'}${arguments[0]}
${'\t'}${'\t'}${parameters[0].property.name} = ${parameters[0].argument}
${'\t'}${failures[2]::class.simpleName}: Failure 2
${'\t'}${'\t'}${arguments[0]}
${'\t'}${'\t'}${arguments[1]}
${'\t'}${'\t'}${parameters[0].property.name} = ${parameters[0].argument}
${'\t'}${'\t'}${parameters[1].property.name} = ${parameters[1].argument}
""".trimIndent()

assertEquals(expectedMessage, error.message)
Expand All @@ -220,7 +217,7 @@ class ParameterizeFailedErrorSpec {
val failures = List(20) { i -> Throwable("Failure $i") }

val error = ParameterizeFailedError(
failures.map { ParameterizeFailure(it, arguments) },
failures.map { ParameterizeFailure(it, parameters) },
successCount = 4,
failureCount = 3,
completedEarly = false
Expand Down Expand Up @@ -249,7 +246,7 @@ class ParameterizeFailedErrorSpec {
@Test
fun recorded_failure_message_with_one_used_parameter_should_list_its_argument() {
val error = ParameterizeFailedError(
listOf(ParameterizeFailure(Throwable(), arguments.take(1))),
listOf(ParameterizeFailure(Throwable(), parameters.take(1))),
successCount = 0,
failureCount = 1,
completedEarly = false
Expand All @@ -260,7 +257,7 @@ class ParameterizeFailedErrorSpec {
// Double indent, since the suppressed exceptions get an extra level of indentation
val expectedMessage = """
Failed with argument:
${"\t\t"}$argumentA
${'\t'}${'\t'}${parameters[0].property.name} = ${parameters[0].argument}
""".trimIndent()

assertEquals(expectedMessage, augmentedFailure.message)
Expand All @@ -269,7 +266,7 @@ class ParameterizeFailedErrorSpec {
@Test
fun recorded_failure_message_with_two_used_parameters_should_list_their_arguments() {
val error = ParameterizeFailedError(
listOf(ParameterizeFailure(Throwable(), arguments)),
listOf(ParameterizeFailure(Throwable(), parameters)),
successCount = 0,
failureCount = 1,
completedEarly = false
Expand All @@ -279,8 +276,8 @@ class ParameterizeFailedErrorSpec {

val expectedMessage = """
Failed with arguments:
${"\t\t"}$argumentA
${"\t\t"}$argumentB
${'\t'}${'\t'}${parameters[0].property.name} = ${parameters[0].argument}
${'\t'}${'\t'}${parameters[1].property.name} = ${parameters[1].argument}
""".trimIndent()

assertEquals(expectedMessage, augmentedFailure.message)
Expand All @@ -305,7 +302,7 @@ class ParameterizeFailedErrorSpec {
val failure = Throwable("Failure message")

val error = ParameterizeFailedError(
listOf(ParameterizeFailure(failure, arguments)),
listOf(ParameterizeFailure(failure, parameters)),
successCount = 0,
failureCount = 1,
completedEarly = false
Expand All @@ -320,7 +317,7 @@ class ParameterizeFailedErrorSpec {
val failure = Throwable("Failure message")

val error = ParameterizeFailedError(
listOf(ParameterizeFailure(failure, arguments)),
listOf(ParameterizeFailure(failure, parameters)),
successCount = 0,
failureCount = 1,
completedEarly = false
Expand Down