com.github.mvysny.kaributesting.v10.BinderUtils.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of karibu-testing-v10 Show documentation
Karibu Testing, support for browserless Vaadin testing in Kotlin
There is a newer version: 2.1.8
package com.github.mvysny.kaributesting.v10

import com.github.mvysny.kaributools.caption
import com.github.mvysny.kaributools.label
import com.vaadin.flow.component.Component
import com.vaadin.flow.data.binder.*
import kotlin.test.expect

/**
 * Formats the [BinderValidationStatus.getFieldValidationErrors] and [BinderValidationStatus.getBeanValidationErrors]
 * in a nice way: shows the component caption (and ID if it's set), the value and the validation message.
 *
 * Example of the message:
 * ```
 * field validation errors: [Name: ERROR must not be null, value=''], bean validation errors: []
 * ```
 * * The 'Name' part refers to [field][BindingValidationStatus.getField]'s label;
 * * The 'ERROR' part refers to [BindingValidationStatus.Status]
 * * The 'must not be null' part refers to [BindingValidationStatus.getMessage] which contains the validation error message
 * * The 'value=' part refers to [field][BindingValidationStatus.getField]'s value's `toString()`.
 *
 * Workaround for https://github.com/vaadin/flow/issues/7081
 */
public val ValidationException.verboseMessage: String get() =
    "${message}: ${getVerboseMessage(fieldValidationErrors, beanValidationErrors)}"

private fun getVerboseMessage(
    fieldValidationErrors: List>,
    beanValidationErrors: List
): String {
    val fieldValidationErrorsString: String = fieldValidationErrors.joinToString(", ") {
        val component = it.field as Component
        var componentCaption: String = component.label.ifBlank { component._text } ?: ""
        if (!component.id_.isNullOrBlank()) {
            componentCaption = "$componentCaption(#${component.id_})"
        }
        "$componentCaption: ${it.status} ${it.message.orElse("")}, value='${it.field.value}'"
    }
    val beanValidationErrorsString: String = beanValidationErrors.joinToString(", ") {
        "${it.errorLevel.orElse(null)}: ${it.errorMessage}"
    }
    return "field validation errors: [$fieldValidationErrorsString], bean validation errors: [$beanValidationErrorsString]"
}

/**
 * Formats the [BinderValidationStatus.getFieldValidationErrors] and [BinderValidationStatus.getBeanValidationErrors]
 * in a nice way: shows the component caption (and ID if it's set), the value and the validation message.
 *
 * Workaround for https://github.com/vaadin/flow/issues/7081
 */
public val BinderValidationStatus<*>.verboseMessage: String get() =
    getVerboseMessage(fieldValidationErrors, beanValidationErrors)

/**
 * Fails if this status is not valid ([isOk][BinderValidationStatus.isOk] returns false).
 */
public fun BinderValidationStatus<*>._expectValid() {
    expect(true, "The binder was expected to be valid but is invalid: $verboseMessage") { isOk }
}

/**
 * Fails if this status is valid ([isOk][BinderValidationStatus.isOk] returns true).
 * @param expectedVerboseMessage the [verboseMessage] should contain this string as its substring.
 * For example `Name: ERROR must not be null, value=''` which says that the field with label 'Name' must not be null.
 */
public fun BinderValidationStatus<*>._expectInvalid(expectedVerboseMessage: String = "") {
    val vm = verboseMessage
    expect(false, "The binder was expected to be invalid but is valid: $vm") { isOk }
    expect(true, "Expected '$expectedVerboseMessage' but got '$vm'") {
        vm.contains(expectedVerboseMessage)
    }
}

/**
 * Fails if this binder is not valid.
 */
public fun Binder<*>._expectValid() {
    validate()._expectValid()
}

/**
 * Fails if the binder is valid.
 * @param expectedVerboseMessage the [verboseMessage] should contain this string as its substring.
 * For example `Name: ERROR must not be null, value=''` which says that the field with label 'Name' must not be null.
 */
public fun Binder<*>._expectInvalid(expectedVerboseMessage: String = "") {
    validate()._expectInvalid(expectedVerboseMessage)
}