Files
git/t/helper/test-example-tap.c
René Scharfe 1f452d6c68 unit-tests: show location of checks outside of tests
Checks outside of tests are caught at runtime and reported like this:

 Assertion failed: (ctx.running), function test_assert, file test-lib.c, line 267.

The assert() call aborts the unit test and doesn't reveal the location
or even the type of the offending check, as test_assert() is called by
all of them.

Handle it like the opposite case, a test without any checks: Don't
abort, but report the location of the actual check, along with a message
explaining the situation.  The output for example above becomes:

 # BUG: check outside of test at t/helper/test-example-tap.c:75

... and the unit test program continues and indicates the error in its
exit code at the end.

Signed-off-by: René Scharfe <l.s.r@web.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2024-07-30 13:32:43 -07:00

99 lines
2.6 KiB
C

#include "test-tool.h"
#include "t/unit-tests/test-lib.h"
/*
* The purpose of this "unit test" is to verify a few invariants of the unit
* test framework itself, as well as to provide examples of output from actually
* failing tests. As such, it is intended that this test fails, and thus it
* should not be run as part of `make unit-tests`. Instead, we verify it behaves
* as expected in the integration test t0080-unit-test-output.sh
*/
/* Used to store the return value of check_int(). */
static int check_res;
/* Used to store the return value of TEST(). */
static int test_res;
static void t_res(int expect)
{
check_int(check_res, ==, expect);
check_int(test_res, ==, expect);
}
static void t_todo(int x)
{
check_res = TEST_TODO(check(x));
}
static void t_skip(void)
{
check(0);
test_skip("missing prerequisite");
check(1);
}
static int do_skip(void)
{
test_skip("missing prerequisite");
return 1;
}
static void t_skip_todo(void)
{
check_res = TEST_TODO(do_skip());
}
static void t_todo_after_fail(void)
{
check(0);
TEST_TODO(check(0));
}
static void t_fail_after_todo(void)
{
check(1);
TEST_TODO(check(0));
check(0);
}
static void t_messages(void)
{
check_str("\thello\\", "there\"\n");
check_str("NULL", NULL);
check_char('a', ==, '\n');
check_char('\\', ==, '\'');
}
static void t_empty(void)
{
; /* empty */
}
int cmd__example_tap(int argc, const char **argv)
{
check(1);
test_res = TEST(check_res = check_int(1, ==, 1), "passing test");
TEST(t_res(1), "passing test and assertion return 1");
test_res = TEST(check_res = check_int(1, ==, 2), "failing test");
TEST(t_res(0), "failing test and assertion return 0");
test_res = TEST(t_todo(0), "passing TEST_TODO()");
TEST(t_res(1), "passing TEST_TODO() returns 1");
test_res = TEST(t_todo(1), "failing TEST_TODO()");
TEST(t_res(0), "failing TEST_TODO() returns 0");
test_res = TEST(t_skip(), "test_skip()");
TEST(check_int(test_res, ==, 1), "skipped test returns 1");
test_res = TEST(t_skip_todo(), "test_skip() inside TEST_TODO()");
TEST(t_res(1), "test_skip() inside TEST_TODO() returns 1");
test_res = TEST(t_todo_after_fail(), "TEST_TODO() after failing check");
TEST(check_int(test_res, ==, 0), "TEST_TODO() after failing check returns 0");
test_res = TEST(t_fail_after_todo(), "failing check after TEST_TODO()");
TEST(check_int(test_res, ==, 0), "failing check after TEST_TODO() returns 0");
TEST(t_messages(), "messages from failing string and char comparison");
test_res = TEST(t_empty(), "test with no checks");
TEST(check_int(test_res, ==, 0), "test with no checks returns 0");
return test_done();
}