add option to show diff in assert_output and assert_equal

[justinledford]

fixes #60

[martin-schulze-vireso]

This could be a breaking change for some users that want to check if something is -d/--diff

Unfortunately, we don't have a -- interface established here. I think at minimum we should check that there are still (at least) two parameters left after the shift.

[justinledford]

done

[martin-schulze-vireso]

Again, --diff might be a valid output to check for. At least, we have -- here to differentiate options from output but we should at least check that there still is a trailing output.

[justinledford]

done

[gioele]

Why an option? The diffing could happen automatically if diff is available.

[gioele]

The unified file format is more common than the so called normal format. It would be better to use diff -u instead of just diff here.

[justinledford]

good idea, done

[gioele]

Perhaps batslib_print_kv_single_or_multi` could grow support for diffing expected and actual?

For instance it could use wdiff instead of diff if it detects single-line text.

[justinledford]

Thank you for the comments. I have addressed them and also added test cases for the new functionality.

[justinledford]

done

[justinledford]

good idea, done

[justinledford]

done

[jasonkarns]

Is there an opportunity here instead of trying to bake this into the matcher, to instead have a form of assert_output | diff? (diff here being function we own, not the command)

Having a generic diff utility would be more composable to other existing and future matchers. And allow multiple types of formatters to coexist. (Rather than an explosion of matcher options.)

This would require having a structured format/spec the assertions can construct that "renders" can consume as an api.

[mmetc]

I'm just giving my 2c as a happy bats user

For TUI output, I find it way faster to reconcile the differences with a tool like github.com/dandavison/delta

So I know what you mean about colors and the meaning of red, but it would be very useful to customize the diff command in some way.

Then when it comes to comparing contents, I would welcome anything that makes it easier to write stuff like this. I am not proud but it makes tests more compact and readable. That's what you mean by matcher I suppose

# Compare ignoring the key order, and allow "expected" without quoted identifiers.
# Preserve the output variable in case the following commands require it.
assert_json() {
    local oldout="${output}"
    # validate actual, sort
    run -0 jq -Sen "${output}"
    local actual="${output}"

    # handle stdin, quote identifiers, sort
    local expected="$1"
    if [[ "${expected}" == "-" ]]; then
        expected="$(cat)"
    fi
    run -0 jq -Sn "${expected}"
    expected="${output}"

    #shellcheck disable=SC2016
    run jq -ne --argjson a "${actual}" --argjson b "${expected}" '$a == $b'
    #shellcheck disable=SC2154
    if [[ "${status}" -ne 0 ]]; then
        echo "expect: $(jq -c <<<"${expected}")"
        echo "actual: $(jq -c <<<"${actual}")"
        diff <(echo "${actual}") <(echo "${expected}")
        fail "json does not match"
    fi
    output="${oldout}"
}
export -f assert_json

[jakub-bochenski]

@mmetc a bit off topic, but re json you might want to take a look at #76
using jq expressions lets you do very concise checks on Json documents

[jakub-bochenski]

I like the suggestion by @jasonkarns

Also it would be nice if there was option to output the difference in Idea-friendly format.

No need to use a diff directly, if the console output matches

expected:<expected_value> but was:<actual_value>

Idea will pick it up and let you review this in a diff view.
https://www.jetbrains.com/help/idea/viewing-and-exploring-test-results.html