Bug in `assert_file_contains` and `assert_equals`

[Fethbita]

Q	A
OS	macOS
Shell & version	bash 5.3.15
bashunit version	0.47.0

Summary

Current behavior

grep will fail in assert_file_contains, and assert_equals can't distinguish between backslashes or escaped control characters.

How to reproduce

function test_file_contains_with_leading_dash_pattern() {
 local log
 log=$(mktemp)
 printf 'ssh -o BatchMode=yes host uptime\n' > "$log"
 assert_file_contains "$log" "-o BatchMode=yes"
 rm -f "$log"
}

function test_equals_cannot_distinguish_backslashes() {
 assert_equals 'C:\' 'C:\\'
}

function test_equals_cannot_distinguish_escape_from_literal() {
 assert_equals 'a\tb' "$(printf 'a\tb')"
}

function test_same_distinguishes_them_correctly() {
 assert_same 'C:\' 'C:\\'
}

Expected behavior

First test should pass, second and third tests should fail.

Output:

There were 2 failures:

|1) test.sh:1
|✗ Failed: File contains with leading dash pattern
| Expected '/var/folders/z8/gsfp0t4n0fl8mp5xyrz5xptc0000gr/T/tmp.QRjrbletxK'
| to contain '-o BatchMode=yes'
| at test.sh:1
| Output:
|grep: invalid option --
|usage: grep [-abcdDEFGHhIiJLlMmnOopqRSsUVvwXxZz] [-A num] [-B num] [-C[num]]
| [-e pattern] [-f file] [--binary-files=value] [--color=when]
| [--context[=num]] [--directories=action] [--label] [--line-buffered]
| [--null] [pattern] [file ...]
| Source:
| 5: assert_file_contains "$log" "-o BatchMode=yes"
|2) test.sh:17
|✗ Failed: Same distinguishes them correctly
| Expected 'C:\'
| but got 'C:\'
| at test.sh:17
| Source:
| 18: assert_same 'C:\' 'C:\'

Tests: 2 passed, 2 failed, 4 total
Assertions: 2 passed, 2 failed, 4 total

 Some tests failed
Time taken: 646ms

[Chemaclass]

Thanks for the report — both are real, and both are fixed in #1115.

assert_file_contains with a dash-leading needle. The needle went to
grep as a bare argument, so -o BatchMode=yes was parsed as options. It goes
through -e and -- now. While there: assert_file_not_contains was missing
the -F its counterpart has, so a.c matched abc when you asserted absence
but not when you asserted presence.

assert_equals and backslashes. It normalizes ANSI sequences and control
characters, and did that by piping through echo -e — which interprets
escapes. That is why C:\ and C:\\ compared equal and a literal \t
equalled a real tab. It uses printf '%s' now, so normalization no longer
rewrites the values it is comparing.

Your four cases now behave as you specified: the first passes, the second and
third fail, and assert_same keeps distinguishing them.

One nuance worth stating, since it is the part that is easy to trip over: the
"special chars" assert_equals ignores are characters, not escape sequences.
A real tab or a colour sequence is stripped; a backslash followed by t is two
ordinary characters and stays that way. The docs say so now.

[Chemaclass]

Fixed in #1115 (merged). Thanks for the report — both cases are covered by tests now.