Fix issue 1106 - JUnit formatter crashes if test errors in setup_suite #1125
Conversation
| if [[ -z "${name:-}" ]]; then | ||
| # Can be called (after bats_tap_stream_plan) before anything else if the test fails in setup_suite | ||
| bats_tap_stream_suite "setup_suite" | ||
| bats_tap_stream_begin "$1" "$2" | ||
| fi |
There was a problem hiding this comment.
After some debugging, I found that the JUnit formatter got little in the way of information when setup_suite fails.
bats_tap_stream_plangets calledbats_tap_stream_not_okgets called with args1andsetup_suite
...which then lead to the "increment file_count" line failing because file_count hadn't been set to zero by then.
I initially tried initialising every variable that was (later) needed in here, before later refactoring that to just "faking" these two calls, as that initialised the same variables.
I guess it's possible that a "better" fix would be to alter how all formatters are driven in this "setup_suite failed" scenario but I haven't investigated any other formatters.
| class='' | ||
| name='' |
There was a problem hiding this comment.
I figure that, if we're now putting quite a lot of emphasis on "is it empty?", we ought to empty it after we think we're done, just in case we need to start everything all over again.
|
|
||
| @test "don't choke on setup_suite errors (issue #1106)" { | ||
| bats_require_minimum_version 1.5.0 | ||
| local stderr='' # silence shellcheck | ||
| reentrant_run -1 --separate-stderr bats --formatter junit "$FIXTURE_ROOT/../suite_setup_teardown/error_in_setup_suite/test.bats" | ||
| [ "${stderr}" == "" ] | ||
| [[ "${lines[2]}" == '<testsuite name="setup_suite" '*'>' ]] | ||
| [[ "${lines[3]}" == ' <testcase classname="setup_suite" '*'>' ]] | ||
| [[ "${lines[5]}" == *'call-to-undefined-command'* ]] | ||
| } |
There was a problem hiding this comment.
While I would describe my proposed changes to the formatter itself as "speculative", I am more confident in the changes to the unit-test.
- it's using a pre-existing test scenario (
suite_setup_teardown/error_in_setup_suite/test.bats) - it's following the practises employed in earlier tests
I am a puzzled that the previous test does [ "${stderr}" == "" ] instead of using [[ ... ]] - I'd be happy to change both to [[ ... ]] if that would be preferred.
Fixes issue #1106
If a bats test runs setup_suite.bash and errors, the JUnit formatter would crash out with an undefined variable error and fail to produce a useful JUnit report.
This PR: