Add metadata strings for operators and improve CLI output #102
Conversation
yane3628
commented
May 4, 2021
yane3628
commented
- Add failure message for each operator (Closes Add metadata to result to help identify exactly what part of the check was violated #33)
- Add tests for failure message generation
- Add line number, file path, and failure message to CLI output
|
Structured expression messages still need to be implemented. |
JohnathonMohr
left a comment
JohnathonMohr
left a comment
There was a problem hiding this comment.
I think changing the design to have messages finalized inside the Expression and Operator (when the Result is populated) will help the code flow more smoothly. I'm also thinking about what the messaging for the not operator would look like. I'm not sure how best to represent that yet, but something we need to decide before committing to a design here.
| internal static string InFailureMessage = $"Value \"{ExpectedValuePlaceholder}\" is not in the list at path \"{PathPlaceholder}\"."; | ||
|
|
||
| internal static string AnyOfFailureMessage = $"No evaluations evaluted to true for the following json property: \"{PathPlaceholder}\"."; | ||
| internal static string AllOfFailureMessage = $"One or more evaluations were false for the following json property: \"{PathPlaceholder}\"."; |
There was a problem hiding this comment.
I think it would be better if each of these was implemented as a method directly in the corresponding Operator, and the placeholders would be filled in using parameters to the method.
There was a problem hiding this comment.
Alternatively, maybe we could update how EvaluateExpression() works, and either create the string and have it ready in another property after evaluation, or return the string as part of the function call.
| /// <summary> | ||
| /// Gets the messsage which explains why the evaluation failed. | ||
| /// </summary> | ||
| public string FailureMessage() |
There was a problem hiding this comment.
As much as possible, I think all this logic should be in the Operators and Expressions. I think it would be easier to understand and write if the failure messages were built right where the evaluations happen.
