mirror of
https://github.com/git/git.git
synced 2024-12-26 18:24:21 +08:00
0cc05b044f
Add a bug() function to use in cases where we'd like to indicate a
runtime BUG(), but would like to defer the BUG() call because we're
possibly accumulating more bug() callers to exhaustively indicate what
went wrong.
We already have this sort of facility in various parts of the
codebase, just in the form of ad-hoc re-inventions of the
functionality that this new API provides. E.g. this will be used to
replace optbug() in parse-options.c, and the 'error("BUG:[...]' we do
in a loop in builtin/receive-pack.c.
Unlike the code this replaces we'll log to trace2 with this new bug()
function (as with other usage.c functions, including BUG()), we'll
also be able to avoid calls to xstrfmt() in some cases, as the bug()
function itself accepts variadic sprintf()-like arguments.
Any caller to bug() can follow up such calls with BUG_if_bug(),
which will BUG() out (i.e. abort()) if there were any preceding calls
to bug(), callers can also decide not to call BUG_if_bug() and leave
the resulting BUG() invocation until exit() time. There are currently
no bug() API users that don't call BUG_if_bug() themselves after a
for-loop, but allowing for not calling BUG_if_bug() keeps the API
flexible. As the tests and documentation here show we'll catch missing
BUG_if_bug() invocations in our exit() wrapper.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
287 lines
8.8 KiB
Bash
Executable File
287 lines
8.8 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
test_description='test trace2 facility (normal target)'
|
|
|
|
TEST_PASSES_SANITIZE_LEAK=true
|
|
. ./test-lib.sh
|
|
|
|
# Turn off any inherited trace2 settings for this test.
|
|
sane_unset GIT_TRACE2 GIT_TRACE2_PERF GIT_TRACE2_EVENT
|
|
sane_unset GIT_TRACE2_BRIEF
|
|
sane_unset GIT_TRACE2_CONFIG_PARAMS
|
|
|
|
# Add t/helper directory to PATH so that we can use a relative
|
|
# path to run nested instances of test-tool.exe (see 004child).
|
|
# This helps with HEREDOC comparisons later.
|
|
TTDIR="$GIT_BUILD_DIR/t/helper/" && export TTDIR
|
|
PATH="$TTDIR:$PATH" && export PATH
|
|
|
|
# Warning: use of 'test_cmp' may run test-tool.exe and/or git.exe
|
|
# Warning: to do the actual diff/comparison, so the HEREDOCs here
|
|
# Warning: only cover our actual calls to test-tool and/or git.
|
|
# Warning: So you may see extra lines in artifact files when
|
|
# Warning: interactively debugging.
|
|
|
|
V=$(git version | sed -e 's/^git version //') && export V
|
|
|
|
# There are multiple trace2 targets: normal, perf, and event.
|
|
# Trace2 events will/can be written to each active target (subject
|
|
# to whatever filtering that target decides to do).
|
|
# This script tests the normal target in isolation.
|
|
#
|
|
# Defer setting GIT_TRACE2 until the actual command line we want to test
|
|
# because hidden git and test-tool commands run by the test harness
|
|
# can contaminate our output.
|
|
|
|
# Enable "brief" feature which turns off "<clock> <file>:<line> " prefix.
|
|
GIT_TRACE2_BRIEF=1 && export GIT_TRACE2_BRIEF
|
|
|
|
# Basic tests of the trace2 normal stream. Since this stream is used
|
|
# primarily with printf-style debugging/tracing, we do limited testing
|
|
# here.
|
|
#
|
|
# We do confirm the following API features:
|
|
# [] the 'version <v>' event
|
|
# [] the 'start <argv>' event
|
|
# [] the 'cmd_name <name>' event
|
|
# [] the 'exit <time> code:<code>' event
|
|
# [] the 'atexit <time> code:<code>' event
|
|
#
|
|
# Fields of the form _FIELD_ are tokens that have been replaced (such
|
|
# as the elapsed time).
|
|
|
|
# Verb 001return
|
|
#
|
|
# Implicit return from cmd_<verb> function propagates <code>.
|
|
|
|
test_expect_success 'normal stream, return code 0' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
GIT_TRACE2="$(pwd)/trace.normal" test-tool trace2 001return 0 &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 001return 0
|
|
cmd_name trace2 (trace2)
|
|
exit elapsed:_TIME_ code:0
|
|
atexit elapsed:_TIME_ code:0
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'normal stream, return code 1' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
test_must_fail env GIT_TRACE2="$(pwd)/trace.normal" test-tool trace2 001return 1 &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 001return 1
|
|
cmd_name trace2 (trace2)
|
|
exit elapsed:_TIME_ code:1
|
|
atexit elapsed:_TIME_ code:1
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'automatic filename' '
|
|
test_when_finished "rm -r traces actual expect" &&
|
|
mkdir traces &&
|
|
GIT_TRACE2="$(pwd)/traces" test-tool trace2 001return 0 &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <"$(ls traces/*)" >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 001return 0
|
|
cmd_name trace2 (trace2)
|
|
exit elapsed:_TIME_ code:0
|
|
atexit elapsed:_TIME_ code:0
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
# Verb 002exit
|
|
#
|
|
# Explicit exit(code) from within cmd_<verb> propagates <code>.
|
|
|
|
test_expect_success 'normal stream, exit code 0' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
GIT_TRACE2="$(pwd)/trace.normal" test-tool trace2 002exit 0 &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 002exit 0
|
|
cmd_name trace2 (trace2)
|
|
exit elapsed:_TIME_ code:0
|
|
atexit elapsed:_TIME_ code:0
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'normal stream, exit code 1' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
test_must_fail env GIT_TRACE2="$(pwd)/trace.normal" test-tool trace2 002exit 1 &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 002exit 1
|
|
cmd_name trace2 (trace2)
|
|
exit elapsed:_TIME_ code:1
|
|
atexit elapsed:_TIME_ code:1
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
# Verb 003error
|
|
#
|
|
# To the above, add multiple 'error <msg>' events
|
|
|
|
test_expect_success 'normal stream, error event' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
GIT_TRACE2="$(pwd)/trace.normal" test-tool trace2 003error "hello world" "this is a test" &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 003error '\''hello world'\'' '\''this is a test'\''
|
|
cmd_name trace2 (trace2)
|
|
error hello world
|
|
error this is a test
|
|
exit elapsed:_TIME_ code:0
|
|
atexit elapsed:_TIME_ code:0
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
# Verb 007bug
|
|
#
|
|
# Check that BUG writes to trace2
|
|
|
|
test_expect_success 'BUG messages are written to trace2' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
test_must_fail env GIT_TRACE2="$(pwd)/trace.normal" test-tool trace2 007bug &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 007bug
|
|
cmd_name trace2 (trace2)
|
|
error the bug message
|
|
exit elapsed:_TIME_ code:99
|
|
atexit elapsed:_TIME_ code:99
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'bug messages with BUG_if_bug() are written to trace2' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
test_expect_code 99 env GIT_TRACE2="$(pwd)/trace.normal" \
|
|
test-tool trace2 008bug 2>err &&
|
|
cat >expect <<-\EOF &&
|
|
a bug message
|
|
another bug message
|
|
an explicit BUG_if_bug() following bug() call(s) is nice, but not required
|
|
EOF
|
|
sed "s/^.*: //" <err >actual &&
|
|
test_cmp expect actual &&
|
|
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 008bug
|
|
cmd_name trace2 (trace2)
|
|
error a bug message
|
|
error another bug message
|
|
error an explicit BUG_if_bug() following bug() call(s) is nice, but not required
|
|
exit elapsed:_TIME_ code:99
|
|
atexit elapsed:_TIME_ code:99
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'bug messages without explicit BUG_if_bug() are written to trace2' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
test_expect_code 99 env GIT_TRACE2="$(pwd)/trace.normal" \
|
|
test-tool trace2 009bug_BUG 2>err &&
|
|
cat >expect <<-\EOF &&
|
|
a bug message
|
|
another bug message
|
|
had bug() call(s) in this process without explicit BUG_if_bug()
|
|
EOF
|
|
sed "s/^.*: //" <err >actual &&
|
|
test_cmp expect actual &&
|
|
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 009bug_BUG
|
|
cmd_name trace2 (trace2)
|
|
error a bug message
|
|
error another bug message
|
|
error on exit(): had bug() call(s) in this process without explicit BUG_if_bug()
|
|
exit elapsed:_TIME_ code:99
|
|
atexit elapsed:_TIME_ code:99
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'bug messages followed by BUG() are written to trace2' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
test_expect_code 99 env GIT_TRACE2="$(pwd)/trace.normal" \
|
|
test-tool trace2 010bug_BUG 2>err &&
|
|
cat >expect <<-\EOF &&
|
|
a bug message
|
|
a BUG message
|
|
EOF
|
|
sed "s/^.*: //" <err >actual &&
|
|
test_cmp expect actual &&
|
|
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 010bug_BUG
|
|
cmd_name trace2 (trace2)
|
|
error a bug message
|
|
error a BUG message
|
|
exit elapsed:_TIME_ code:99
|
|
atexit elapsed:_TIME_ code:99
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
sane_unset GIT_TRACE2_BRIEF
|
|
|
|
# Now test without environment variables and get all Trace2 settings
|
|
# from the global config.
|
|
|
|
test_expect_success 'using global config, normal stream, return code 0' '
|
|
test_when_finished "rm trace.normal actual expect" &&
|
|
test_config_global trace2.normalBrief 1 &&
|
|
test_config_global trace2.normalTarget "$(pwd)/trace.normal" &&
|
|
test-tool trace2 001return 0 &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 001return 0
|
|
cmd_name trace2 (trace2)
|
|
exit elapsed:_TIME_ code:0
|
|
atexit elapsed:_TIME_ code:0
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_expect_success 'using global config with include' '
|
|
test_when_finished "rm trace.normal actual expect real.gitconfig" &&
|
|
test_config_global trace2.normalBrief 1 &&
|
|
test_config_global trace2.normalTarget "$(pwd)/trace.normal" &&
|
|
mv "$(pwd)/.gitconfig" "$(pwd)/real.gitconfig" &&
|
|
test_config_global include.path "$(pwd)/real.gitconfig" &&
|
|
test-tool trace2 001return 0 &&
|
|
perl "$TEST_DIRECTORY/t0210/scrub_normal.perl" <trace.normal >actual &&
|
|
cat >expect <<-EOF &&
|
|
version $V
|
|
start _EXE_ trace2 001return 0
|
|
cmd_name trace2 (trace2)
|
|
exit elapsed:_TIME_ code:0
|
|
atexit elapsed:_TIME_ code:0
|
|
EOF
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_done
|