ostree/buildutil/tap-test

#! /bin/bash
#
# Run a test in tap mode, ensuring we have a temporary directory.  We
# always use /var/tmp becuase we might want to use user xattrs, which
# aren't available on tmpfs.
#
# The test binary is passed as $1

srcd=$(cd $(dirname $1) && pwd)
bn=$(basename $1)
TEST_TMPDIR=${TEST_TMPDIR:-/var/tmp}
tempdir=$(mktemp -d $TEST_TMPDIR/tap-test.XXXXXX)
touch ${tempdir}/.testtmp
function cleanup () {
    if test -f ${tempdir}/.testtmp; then
	rm "${tempdir}" -rf
    fi
}
function skip_cleanup() {
    echo "Skipping cleanup of ${tempdir}"
}
cd ${tempdir}
timeout \
    --kill-after=60 \
    --signal=ABRT \
    $(( 600 * ${TEST_TIMEOUT_FACTOR:-1} )) \
    ${srcd}/${bn} -k --tap
rc=$?
case "${TEST_SKIP_CLEANUP:-}" in
    no|"") cleanup ;;
    err)
	if test $rc != 0; then
	    skip_cleanup
	else
	    cleanup
	fi ;;
    *) skip_cleanup  ;;
esac
exit $rc
tests: Port to glib-tap.mk, make `make check` run all of the tests OSTree's code for testing predates the `glib-tap.mk` making its way into GLib. Let's switch to it, as it provides a number of advantages. By far the biggest advantage is that `make check` can start to run most of the tests in addition to having them work installed. This commit keeps the installed tests working, but `make check` turns out to be really broken because...our TAP usage has bitrotted to say the least. Fix that all up. Do some hacks so that the tests work uninstalled as well - in particular, `glib-tap.mk` and the bits encoded into `g_test_build_filename()` assume recursive Automake (blah). Work around that by creating a symlink when installed to loop back. 2016-03-02 10:28:04 -05:00			`#! /bin/bash`
tests: Unify some tmpdir code, add ability for C to use libtest.sh I want to be able to easily test the C API on actual data in an OSTree repo. The shell `libtest.sh` has code to generate it. Bridge the two worlds by introducing a little `libostreetest` library which has a C API which spawns a shell that runs things in `libtest.sh`. Yes, this is about as beautiful as it sounds, which is to say, it's not. But it works! Note while we were here, I realized we were actually now creating two tmpdirs per test in `make check` because the tap driver was already doing that. Unify it so we know the C code can rely on it. 2016-03-02 10:05:08 -05:00			`#`
			`# Run a test in tap mode, ensuring we have a temporary directory. We`
			`# always use /var/tmp becuase we might want to use user xattrs, which`
			`# aren't available on tmpfs.`
			`#`
			`# The test binary is passed as $1`
tests: Port to glib-tap.mk, make `make check` run all of the tests OSTree's code for testing predates the `glib-tap.mk` making its way into GLib. Let's switch to it, as it provides a number of advantages. By far the biggest advantage is that `make check` can start to run most of the tests in addition to having them work installed. This commit keeps the installed tests working, but `make check` turns out to be really broken because...our TAP usage has bitrotted to say the least. Fix that all up. Do some hacks so that the tests work uninstalled as well - in particular, `glib-tap.mk` and the bits encoded into `g_test_build_filename()` assume recursive Automake (blah). Work around that by creating a symlink when installed to loop back. 2016-03-02 10:28:04 -05:00
			`srcd=$(cd $(dirname $1) && pwd)`
			`bn=$(basename $1)`
tests: allow specifying tmpdir Allow developers to override the default /var/tmp dir, which e.g. might be on overlayfs and thus produces reduced coverage. Closes: #1207 Approved by: cgwalters 2017-09-20 17:06:41 +00:00			`TEST_TMPDIR=${TEST_TMPDIR:-/var/tmp}`
			`tempdir=$(mktemp -d $TEST_TMPDIR/tap-test.XXXXXX)`
tests: Unify some tmpdir code, add ability for C to use libtest.sh I want to be able to easily test the C API on actual data in an OSTree repo. The shell `libtest.sh` has code to generate it. Bridge the two worlds by introducing a little `libostreetest` library which has a C API which spawns a shell that runs things in `libtest.sh`. Yes, this is about as beautiful as it sounds, which is to say, it's not. But it works! Note while we were here, I realized we were actually now creating two tmpdirs per test in `make check` because the tap driver was already doing that. Unify it so we know the C code can rely on it. 2016-03-02 10:05:08 -05:00			`touch ${tempdir}/.testtmp`
tests: Port to glib-tap.mk, make `make check` run all of the tests OSTree's code for testing predates the `glib-tap.mk` making its way into GLib. Let's switch to it, as it provides a number of advantages. By far the biggest advantage is that `make check` can start to run most of the tests in addition to having them work installed. This commit keeps the installed tests working, but `make check` turns out to be really broken because...our TAP usage has bitrotted to say the least. Fix that all up. Do some hacks so that the tests work uninstalled as well - in particular, `glib-tap.mk` and the bits encoded into `g_test_build_filename()` assume recursive Automake (blah). Work around that by creating a symlink when installed to loop back. 2016-03-02 10:28:04 -05:00			`function cleanup () {`
tests: Support TEST_SKIP_CLEANUP=err I find myself often wanting to debug interactively failing tests. This makes it more convenient to keep around the temporary directories just for those tests, rather than accumulating tons of tempdirs from the successful tests as well. Closes: #588 Approved by: jlebon 2016-11-18 15:07:52 -05:00			`if test -f ${tempdir}/.testtmp; then`
tests: Unify some tmpdir code, add ability for C to use libtest.sh I want to be able to easily test the C API on actual data in an OSTree repo. The shell `libtest.sh` has code to generate it. Bridge the two worlds by introducing a little `libostreetest` library which has a C API which spawns a shell that runs things in `libtest.sh`. Yes, this is about as beautiful as it sounds, which is to say, it's not. But it works! Note while we were here, I realized we were actually now creating two tmpdirs per test in `make check` because the tap driver was already doing that. Unify it so we know the C code can rely on it. 2016-03-02 10:05:08 -05:00			`rm "${tempdir}" -rf`
			`fi`
tests: Port to glib-tap.mk, make `make check` run all of the tests OSTree's code for testing predates the `glib-tap.mk` making its way into GLib. Let's switch to it, as it provides a number of advantages. By far the biggest advantage is that `make check` can start to run most of the tests in addition to having them work installed. This commit keeps the installed tests working, but `make check` turns out to be really broken because...our TAP usage has bitrotted to say the least. Fix that all up. Do some hacks so that the tests work uninstalled as well - in particular, `glib-tap.mk` and the bits encoded into `g_test_build_filename()` assume recursive Automake (blah). Work around that by creating a symlink when installed to loop back. 2016-03-02 10:28:04 -05:00			`}`
tests: Support TEST_SKIP_CLEANUP=err I find myself often wanting to debug interactively failing tests. This makes it more convenient to keep around the temporary directories just for those tests, rather than accumulating tons of tempdirs from the successful tests as well. Closes: #588 Approved by: jlebon 2016-11-18 15:07:52 -05:00			`function skip_cleanup() {`
			`echo "Skipping cleanup of ${tempdir}"`
			`}`
tests: Port to glib-tap.mk, make `make check` run all of the tests OSTree's code for testing predates the `glib-tap.mk` making its way into GLib. Let's switch to it, as it provides a number of advantages. By far the biggest advantage is that `make check` can start to run most of the tests in addition to having them work installed. This commit keeps the installed tests working, but `make check` turns out to be really broken because...our TAP usage has bitrotted to say the least. Fix that all up. Do some hacks so that the tests work uninstalled as well - in particular, `glib-tap.mk` and the bits encoded into `g_test_build_filename()` assume recursive Automake (blah). Work around that by creating a symlink when installed to loop back. 2016-03-02 10:28:04 -05:00			`cd ${tempdir}`
Terminate individual tests after (10 * $TEST_TIMEOUT_FACTOR) minutes While using the Automake parallel test harness, if a test hangs for long enough for an external watchdog to kill the entire build process (as happens in Debian sbuild after 150 minutes with no activity on stdout/stderr), the logs will not be shown. If we make an individual test time out sooner, logs are more likely to be shown. We use SIGABRT so that the process(es) under test will dump core, allowing the point at which ostree is blocking to be analyzed. After 1 minute, if any have not died, we kill them again with SIGKILL. To support slow platforms and slow debugging tools, if TEST_TIMEOUT_FACTOR is set, multiply the 10 minute timeout by that. Signed-off-by: Simon McVittie <smcv@debian.org> Closes: #607 Approved by: cgwalters 2016-12-01 16:28:27 +00:00			`timeout \`
			`--kill-after=60 \`
			`--signal=ABRT \`
			`$(( 600 * ${TEST_TIMEOUT_FACTOR:-1} )) \`
			`${srcd}/${bn} -k --tap`
tests: Support TEST_SKIP_CLEANUP=err I find myself often wanting to debug interactively failing tests. This makes it more convenient to keep around the temporary directories just for those tests, rather than accumulating tons of tempdirs from the successful tests as well. Closes: #588 Approved by: jlebon 2016-11-18 15:07:52 -05:00			`rc=$?`
			`case "${TEST_SKIP_CLEANUP:-}" in`
			`no\|"") cleanup ;;`
			`err)`
			`if test $rc != 0; then`
			`skip_cleanup`
			`else`
			`cleanup`
			`fi ;;`
			`*) skip_cleanup ;;`
			`esac`
			`exit $rc`