Skip to content

Commit

Permalink
Swap round the compare commands in the test suite.
Browse files Browse the repository at this point in the history
The '--compare' option to test-driver.py takes two arguments
indicating things to diff (either files, or the standard output of the
command under test), and diffs them the obvious way round, that is,
with input #1 shown on the '-' side of the unified diff syntax and
input #2 on the '+' side.

When the diff is showing the discrepancy between a program's expected
and real output, I think it's generally sensible to show the real
output on the '+' side, and the expected output as '-'. That
convention matches, for example, what you'd get if you had the true
output committed in source control and ran 'git diff' or similar to
show how the rewritten version differed.

But all the comparisons in tests/CMakeLists.txt were written
backwards, so the convention was opposite. And I just scratched my
head for 20 minutes over a test failure, because I assumed the
convention in the previous paragraph, and was trying to figure out how
the source code I was looking at could possibly produce the text on
the '+' side of the diff! But it hadn't: it had produced the '-' side
instead.

Reversed all the comparisons so that they make sense.
  • Loading branch information
statham-arm committed Jan 26, 2024
1 parent d28ac43 commit b52b3e6
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions tests/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ set(test_driver_cmd ${python_exe} ${CMAKE_CURRENT_SOURCE_DIR}/test-driver.py
# exprtest.ref.
add_test(NAME exprtest
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/exprtest.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/exprtest.ref stdout
${CMAKE_BINARY_DIR}/exprtest --infile ${CMAKE_CURRENT_SOURCE_DIR}/exprtest.txt
)

Expand All @@ -56,12 +56,12 @@ add_test(NAME exprtest
# mode flag.
add_test(NAME parsertest
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/parsertest.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/parsertest.ref stdout
${CMAKE_BINARY_DIR}/parsertest ${CMAKE_CURRENT_SOURCE_DIR}/parsertest.txt
)
add_test(NAME parsertest-implicit-thumb
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/parsertest-implicit-thumb.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/parsertest-implicit-thumb.ref stdout
${CMAKE_BINARY_DIR}/parsertest --implicit-thumb ${CMAKE_CURRENT_SOURCE_DIR}/parsertest-implicit-thumb.txt
)

Expand All @@ -72,13 +72,13 @@ add_test(NAME parsertest-implicit-thumb
add_test(NAME indextest-li
COMMAND ${test_driver_cmd}
--tempfile indextest.tarmac.index
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/indextest-li.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/indextest-li.ref stdout
${CMAKE_BINARY_DIR}/tarmac-indextool --index indextest.tarmac.index --omit-index-offsets --seq-with-mem ${CMAKE_CURRENT_SOURCE_DIR}/indextest.tarmac --li
)
add_test(NAME indextest-bi
COMMAND ${test_driver_cmd}
--tempfile indextest.tarmac.index
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/indextest-bi.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/indextest-bi.ref stdout
${CMAKE_BINARY_DIR}/tarmac-indextool --index indextest.tarmac.index --omit-index-offsets --seq-with-mem ${CMAKE_CURRENT_SOURCE_DIR}/indextest.tarmac --bi
)

Expand Down Expand Up @@ -121,13 +121,13 @@ add_test(NAME callinfo-endianness-mismatch
add_test(NAME calltree-no-symbols
COMMAND ${test_driver_cmd}
--tempfile quicksort.tarmac.index
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/calltree-quicksort-addr.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/calltree-quicksort-addr.ref stdout
${CMAKE_BINARY_DIR}/tarmac-calltree --index quicksort.tarmac.index ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.tarmac
)
add_test(NAME calltree-symbols
COMMAND ${test_driver_cmd}
--tempfile quicksort.tarmac.index
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/calltree-quicksort-symbols.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/calltree-quicksort-symbols.ref stdout
${CMAKE_BINARY_DIR}/tarmac-calltree --index quicksort.tarmac.index --image ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.elf ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.tarmac
)

Expand All @@ -140,13 +140,13 @@ add_test(NAME calltree-symbols
add_test(NAME flamegraph-no-symbols
COMMAND ${test_driver_cmd}
--tempfile quicksort.tarmac.index
--compare outfile:flamegraph-quicksort-addr.txt reffile:${CMAKE_CURRENT_SOURCE_DIR}/flamegraph-quicksort-addr.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/flamegraph-quicksort-addr.ref outfile:flamegraph-quicksort-addr.txt
${CMAKE_BINARY_DIR}/tarmac-flamegraph --index quicksort.tarmac.index ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.tarmac -o flamegraph-quicksort-addr.txt
)
add_test(NAME flamegraph-symbols
COMMAND ${test_driver_cmd}
--tempfile quicksort.tarmac.index
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/flamegraph-quicksort-symbols.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/flamegraph-quicksort-symbols.ref stdout
${CMAKE_BINARY_DIR}/tarmac-flamegraph --index quicksort.tarmac.index --image ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.elf ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.tarmac
)

Expand All @@ -156,13 +156,13 @@ add_test(NAME flamegraph-symbols
add_test(NAME profile-no-symbols
COMMAND ${test_driver_cmd}
--tempfile quicksort.tarmac.index
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/profile-quicksort-addr.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/profile-quicksort-addr.ref stdout
${CMAKE_BINARY_DIR}/tarmac-profile --index quicksort.tarmac.index ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.tarmac
)
add_test(NAME profile-symbols
COMMAND ${test_driver_cmd}
--tempfile quicksort.tarmac.index
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/profile-quicksort-symbols.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/profile-quicksort-symbols.ref stdout
${CMAKE_BINARY_DIR}/tarmac-profile --index quicksort.tarmac.index --image ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.elf ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.tarmac
)

Expand All @@ -173,7 +173,7 @@ add_test(NAME profile-symbols
add_test(NAME vcd-no-date
COMMAND ${test_driver_cmd}
--tempfile quicksort.tarmac.index
--compare outfile:quicksort-nodate.vcd reffile:${CMAKE_CURRENT_SOURCE_DIR}/vcd-quicksort-nodate.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/vcd-quicksort-nodate.ref outfile:quicksort-nodate.vcd
${CMAKE_BINARY_DIR}/tarmac-vcd --index quicksort.tarmac.index ${CMAKE_CURRENT_SOURCE_DIR}/quicksort.tarmac --no-date -o quicksort-nodate.vcd
)

Expand All @@ -189,34 +189,34 @@ add_test(NAME vcd-date
# Test class Argparse.
add_test(NAME Argparse-help
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse-help.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse-help.ref stdout
${CMAKE_BINARY_DIR}/argparsetest --help
)
add_test(NAME Argparse-short
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse.ref stdout
${CMAKE_BINARY_DIR}/argparsetest -s -v 2 arg1 multi1 multi2
)
add_test(NAME Argparse-long
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse.ref stdout
${CMAKE_BINARY_DIR}/argparsetest --switch --value 2 arg1 multi1 multi2
)
add_test(NAME Argparse-via
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse.ref stdout
${CMAKE_BINARY_DIR}/argparsetest --via-file ${CMAKE_CURRENT_SOURCE_DIR}/argparse-via.txt
)
add_test(NAME Argparse-via-override
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse-via-override.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/argparse-via-override.ref stdout
${CMAKE_BINARY_DIR}/argparsetest --via-file ${CMAKE_CURRENT_SOURCE_DIR}/argparse-via.txt --value 10
)

# Test btod.
add_test(NAME btod
COMMAND ${test_driver_cmd}
--compare stdout reffile:${CMAKE_CURRENT_SOURCE_DIR}/btod.ref
--compare reffile:${CMAKE_CURRENT_SOURCE_DIR}/btod.ref stdout
${CMAKE_BINARY_DIR}/btodtest
)

Expand Down

0 comments on commit b52b3e6

Please sign in to comment.