Display success message in Verification Suite Result

[andreaslang]

#371

Display also a success message for verification, seeing the hint and assertOn value makes it easier to see which verification succeeded.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

[twollnik]

Thanks for this contribution, we appreciate the changes. Just one clarification needed.

[twollnik]

Can you clarify why the message contains the hint ("Should ...!") in one case, but not in the other?

[andreaslang]

Sure, the reason is that the first check does not actually have a hint. In that case only the standard message is shown.

The checks are in the same test suite from line 201:

private[this] def getChecks(): Seq[Check] = {
    val checkToSucceed = Check(CheckLevel.Error, "group-1")
      .isComplete("att1")

    val checkToErrorOut = Check(CheckLevel.Error, "group-2-E")
      .hasSize(_ > 5, Some("Should be greater than 5!"))
      .hasCompleteness("att2", _ == 1.0, Some("Should equal 1!"))

    val checkToWarn = Check(CheckLevel.Warning, "group-2-W")
      .hasDistinctness(Seq("item"), _ < 0.8, Some("Should be smaller than 0.8!"))

    checkToSucceed :: checkToErrorOut :: checkToWarn :: Nil
}

The change allows the message and hint to be passed through even if the evaluation was a success, before that the message and the hint was not displayed. Passing it through makes it a bit easier if the verification result is saved, because they can be used to know what the threshold at a given time was.

[twollnik]

Thanks for clarification. One last request: can we change the message for the success case to "... meets the constraint requirement."? We think this would make it easier to distinguish between the success messages and the error messages.

[andreaslang]

Sorry for the delay, was moving house. Makes sense, I updated the message.

[andreaslang]

Thanks for clarification. One last request: can we change the message for the success case to "... meets the constraint requirement."? We think this would make it easier to distinguish between the success messages and the error messages.

Hi @twollnik , given that change is done, just wanted to check if you need anything else. Apologies again for providing the change for that a bit late.