mirror of
https://github.com/nushell/nushell.git
synced 2024-12-23 23:49:44 +01:00
improve assertion error messages in std assert
(#10551)
should close #10549 # Description this PR is twofold - uses `to nuon --raw` in the error messages to make sure #10549 is solved and makes a difference between `"1"` and `1` - tries to introduce slightly better errors, i.e. by putting left / right on new lines => this should hopefully help when the values become a bit big 😋 # User-Facing Changes the original issue: ```nushell > assert equal {one:1 two:2} {one:"1" two:"2"} Error: × Assertion failed. ╭─[entry #3:1:1] 1 │ assert equal {one:1 two:2} {one:"1" two:"2"} · ───────────────┬─────────────── · ╰── These are not equal. Left : '{one: 1, two: 2}' Right : '{one: "1", two: "2"}' ╰──── ``` a sample for all the assertions and their new messages ```nushell > assert equal {one:1 two:2} {one:"1" two:"2"} Error: × Assertion failed. ╭─[entry #3:1:1] 1 │ assert equal {one:1 two:2} {one:"1" two:"2"} · ───────────────┬─────────────── · ╰── These are not equal. Left : '{one: 1, two: 2}' Right : '{one: "1", two: "2"}' ╰──── ``` ```nushell > assert equal 1 2 Error: × Assertion failed. ╭─[entry #4:1:1] 1 │ assert equal 1 2 · ─┬─ · ╰── These are not equal. Left : '1' Right : '2' ╰──── ``` ```nushell > assert less 3 1 Error: × Assertion failed. ╭─[entry #6:1:1] 1 │ assert less 3 1 · ─┬─ · ╰── The condition *left < right* is not satisfied. Left : '3' Right : '1' ╰──── ``` ```nushell > assert less or equal 3 1 Error: × Assertion failed. ╭─[entry #7:1:1] 1 │ assert less or equal 3 1 · ─┬─ · ╰── The condition *left <= right* is not satisfied. Left : '3' Right : '1' ╰──── ``` ```nushell > assert greater 1 3 Error: × Assertion failed. ╭─[entry #8:1:1] 1 │ assert greater 1 3 · ─┬─ · ╰── The condition *left > right* is not satisfied. Left : '1' Right : '3' ╰──── ``` ```nushell > assert greater or equal 1 3 Error: × Assertion failed. ╭─[entry #9:1:1] 1 │ assert greater or equal 1 3 · ─┬─ · ╰── The condition *left < right* is not satisfied. Left : '1' Right : '3' ╰──── ``` ```nushell > assert length [1 2 3] 2 Error: × Assertion failed. ╭─[entry #10:1:1] 1 │ assert length [1 2 3] 2 · ────┬──── · ╰── This does not have the correct length: value : [1, 2, 3] length : 3 expected : 2 ╰──── ``` ```nushell > assert length [1 "2" 3] 2 Error: × Assertion failed. ╭─[entry #11:1:1] 1 │ assert length [1 "2" 3] 2 · ─────┬───── · ╰── This does not have the correct length: value : [1, "2", 3] length : 3 expected : 2 ╰──── ``` ```nushell > assert str contains "foo" "bar" Error: × Assertion failed. ╭─[entry #13:1:1] 1 │ assert str contains "foo" "bar" · ─────┬───── · ╰── This does not contain '($right)'. value: "foo" ╰──── ``` # Tests + Formatting # After Submitting
This commit is contained in:
parent
28ef14399c
commit
4dbbacc35d
@ -116,7 +116,10 @@ export def error [
|
||||
main ($error_raised) $message --error-label {
|
||||
start: (metadata $code).span.start
|
||||
end: (metadata $code).span.end
|
||||
text: $"There were no error during code execution: (view source $code)"
|
||||
text: (
|
||||
"There were no error during code execution:\n"
|
||||
+ $" (view source $code)"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@ -133,7 +136,11 @@ export def equal [left: any, right: any, message?: string] {
|
||||
main ($left == $right) $message --error-label {
|
||||
start: (metadata $left).span.start
|
||||
end: (metadata $right).span.end
|
||||
text: $"They are not equal. Left = '($left)'. Right = '($right)'."
|
||||
text: (
|
||||
"These are not equal.\n"
|
||||
+ $" Left : '($left | to nuon --raw)'\n"
|
||||
+ $" Right : '($right | to nuon --raw)'"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@ -150,7 +157,7 @@ export def "not equal" [left: any, right: any, message?: string] {
|
||||
main ($left != $right) $message --error-label {
|
||||
start: (metadata $left).span.start
|
||||
end: (metadata $right).span.end
|
||||
text: $"They both are '($left)'."
|
||||
text: $"These are both '($left | to nuon --raw)'."
|
||||
}
|
||||
}
|
||||
|
||||
@ -167,7 +174,11 @@ export def "less or equal" [left: any, right: any, message?: string] {
|
||||
main ($left <= $right) $message --error-label {
|
||||
start: (metadata $left).span.start
|
||||
end: (metadata $right).span.end
|
||||
text: $"Left: '($left)', Right: '($right)'"
|
||||
text: (
|
||||
"The condition *left <= right* is not satisfied.\n"
|
||||
+ $" Left : '($left)'\n"
|
||||
+ $" Right : '($right)'"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@ -183,7 +194,11 @@ export def less [left: any, right: any, message?: string] {
|
||||
main ($left < $right) $message --error-label {
|
||||
start: (metadata $left).span.start
|
||||
end: (metadata $right).span.end
|
||||
text: $"Left: '($left)', Right: '($right)'"
|
||||
text: (
|
||||
"The condition *left < right* is not satisfied.\n"
|
||||
+ $" Left : '($left)'\n"
|
||||
+ $" Right : '($right)'"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@ -199,7 +214,11 @@ export def greater [left: any, right: any, message?: string] {
|
||||
main ($left > $right) $message --error-label {
|
||||
start: (metadata $left).span.start
|
||||
end: (metadata $right).span.end
|
||||
text: $"Left: '($left)', Right: '($right)'"
|
||||
text: (
|
||||
"The condition *left > right* is not satisfied.\n"
|
||||
+ $" Left : '($left)'\n"
|
||||
+ $" Right : '($right)'"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@ -216,7 +235,11 @@ export def "greater or equal" [left: any, right: any, message?: string] {
|
||||
main ($left >= $right) $message --error-label {
|
||||
start: (metadata $left).span.start
|
||||
end: (metadata $right).span.end
|
||||
text: $"Left: '($left)', Right: '($right)'"
|
||||
text: (
|
||||
"The condition *left < right* is not satisfied.\n"
|
||||
+ $" Left : '($left)'\n"
|
||||
+ $" Right : '($right)'"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@ -233,7 +256,12 @@ export def length [left: list, right: int, message?: string] {
|
||||
main (($left | core length) == $right) $message --error-label {
|
||||
start: (metadata $left).span.start
|
||||
end: (metadata $right).span.end
|
||||
text: $"Length of ($left) is ($left | core length), not ($right)"
|
||||
text: (
|
||||
"This does not have the correct length:\n"
|
||||
+ $" value : ($left | to nuon --raw)\n"
|
||||
+ $" length : ($left | core length)\n"
|
||||
+ $" expected : ($right)"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@ -250,6 +278,9 @@ export def "str contains" [left: string, right: string, message?: string] {
|
||||
main ($left | core str contains $right) $message --error-label {
|
||||
start: (metadata $left).span.start
|
||||
end: (metadata $right).span.end
|
||||
text: $"'($left)' does not contain '($right)'."
|
||||
text: (
|
||||
$"This does not contain '($right)'.\n"
|
||||
+ $" value: ($left | to nuon --raw)"
|
||||
)
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user