e137fe3b29
This patch contains an implementation for writing unit tests with TAP
output. Each test is a function that contains one or more checks. The
test is run with the TEST() macro and if any of the checks fail then the
test will fail. A complete program that tests STRBUF_INIT would look
like
#include "test-lib.h"
#include "strbuf.h"
static void t_static_init(void)
{
struct strbuf buf = STRBUF_INIT;
check_uint(buf.len, ==, 0);
check_uint(buf.alloc, ==, 0);
check_char(buf.buf[0], ==, '\0');
}
int main(void)
{
TEST(t_static_init(), "static initialization works);
return test_done();
}
The output of this program would be
ok 1 - static initialization works
1..1
If any of the checks in a test fail then they print a diagnostic message
to aid debugging and the test will be reported as failing. For example a
failing integer check would look like
# check "x >= 3" failed at my-test.c:102
# left: 2
# right: 3
not ok 1 - x is greater than or equal to three
There are a number of check functions implemented so far. check() checks
a boolean condition, check_int(), check_uint() and check_char() take two
values to compare and a comparison operator. check_str() will check if
two strings are equal. Custom checks are simple to implement as shown in
the comments above test_assert() in test-lib.h.
Tests can be skipped with test_skip() which can be supplied with a
reason for skipping which it will print. Tests can print diagnostic
messages with test_msg(). Checks that are known to fail can be wrapped
in TEST_TODO().
There are a couple of example test programs included in this
patch. t-basic.c implements some self-tests and demonstrates the
diagnostic output for failing test. The output of this program is
checked by t0080-unit-test-output.sh. t-strbuf.c shows some example
unit tests for strbuf.c
The unit tests will be built as part of the default "make all" target,
to avoid bitrot. If you wish to build just the unit tests, you can run
"make build-unit-tests". To run the tests, you can use "make unit-tests"
or run the test binaries directly, as in "./t/unit-tests/bin/t-strbuf".
Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk>
Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
59 lines
2.0 KiB
Bash
Executable File
59 lines
2.0 KiB
Bash
Executable File
#!/bin/sh
|
|
|
|
test_description='Test the output of the unit test framework'
|
|
|
|
. ./test-lib.sh
|
|
|
|
test_expect_success 'TAP output from unit tests' '
|
|
cat >expect <<-EOF &&
|
|
ok 1 - passing test
|
|
ok 2 - passing test and assertion return 1
|
|
# check "1 == 2" failed at t/unit-tests/t-basic.c:76
|
|
# left: 1
|
|
# right: 2
|
|
not ok 3 - failing test
|
|
ok 4 - failing test and assertion return 0
|
|
not ok 5 - passing TEST_TODO() # TODO
|
|
ok 6 - passing TEST_TODO() returns 1
|
|
# todo check ${SQ}check(x)${SQ} succeeded at t/unit-tests/t-basic.c:25
|
|
not ok 7 - failing TEST_TODO()
|
|
ok 8 - failing TEST_TODO() returns 0
|
|
# check "0" failed at t/unit-tests/t-basic.c:30
|
|
# skipping test - missing prerequisite
|
|
# skipping check ${SQ}1${SQ} at t/unit-tests/t-basic.c:32
|
|
ok 9 - test_skip() # SKIP
|
|
ok 10 - skipped test returns 1
|
|
# skipping test - missing prerequisite
|
|
ok 11 - test_skip() inside TEST_TODO() # SKIP
|
|
ok 12 - test_skip() inside TEST_TODO() returns 1
|
|
# check "0" failed at t/unit-tests/t-basic.c:48
|
|
not ok 13 - TEST_TODO() after failing check
|
|
ok 14 - TEST_TODO() after failing check returns 0
|
|
# check "0" failed at t/unit-tests/t-basic.c:56
|
|
not ok 15 - failing check after TEST_TODO()
|
|
ok 16 - failing check after TEST_TODO() returns 0
|
|
# check "!strcmp("\thello\\\\", "there\"\n")" failed at t/unit-tests/t-basic.c:61
|
|
# left: "\011hello\\\\"
|
|
# right: "there\"\012"
|
|
# check "!strcmp("NULL", NULL)" failed at t/unit-tests/t-basic.c:62
|
|
# left: "NULL"
|
|
# right: NULL
|
|
# check "${SQ}a${SQ} == ${SQ}\n${SQ}" failed at t/unit-tests/t-basic.c:63
|
|
# left: ${SQ}a${SQ}
|
|
# right: ${SQ}\012${SQ}
|
|
# check "${SQ}\\\\${SQ} == ${SQ}\\${SQ}${SQ}" failed at t/unit-tests/t-basic.c:64
|
|
# left: ${SQ}\\\\${SQ}
|
|
# right: ${SQ}\\${SQ}${SQ}
|
|
not ok 17 - messages from failing string and char comparison
|
|
# BUG: test has no checks at t/unit-tests/t-basic.c:91
|
|
not ok 18 - test with no checks
|
|
ok 19 - test with no checks returns 0
|
|
1..19
|
|
EOF
|
|
|
|
! "$GIT_BUILD_DIR"/t/unit-tests/bin/t-basic >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_done
|