From 6bdd55a9b3d2788004d6dd3f61729caf0891a6f4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20K=C4=99pie=C5=84?= <michal@isc.org>
Date: Wed, 7 Apr 2021 11:41:45 +0200
Subject: [PATCH] Enforce a run time limit on unit test binaries

When a unit test binary hangs, the GitLab CI job in which it is run is
stuck until its run time limit is exceeded.  Furthermore, it is not
trivial to determine which test(s) hung in a given GitLab CI job based
on its log.  To prevent these issues, enforce a run time limit on every
binary executed by the lib/unit-test-driver.sh script.  Use a timeout of
5 minutes for consistency with older BIND 9 branches, which employed
Kyua for running unit tests.  Report an exit code of 124 when the run
time limit is exceeded for a unit test binary, for consistency with the
"timeout" tool included in GNU coreutils.
---
 lib/unit-test-driver.sh.in | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/lib/unit-test-driver.sh.in b/lib/unit-test-driver.sh.in
index 4fbd84b361..c66649c0d1 100644
--- a/lib/unit-test-driver.sh.in
+++ b/lib/unit-test-driver.sh.in
@@ -9,9 +9,24 @@ if [ -z "${1}" ]; then
 fi
 
 TEST_PROGRAM="${1}"
+TIMEOUT=300
 
-"${TEST_PROGRAM}"
-STATUS=${?}
+"${TEST_PROGRAM}" &
+TEST_PROGRAM_PID=${!}
+STATUS=124
+while [ ${TIMEOUT} -gt 0 ]; do
+	if ! kill -0 "${TEST_PROGRAM_PID}" 2>/dev/null; then
+		wait "${TEST_PROGRAM_PID}"
+		STATUS=${?}
+		break
+	fi
+	sleep 1
+	TIMEOUT=$((TIMEOUT - 1))
+done
+if [ ${TIMEOUT} -eq 0 ]; then
+	echo "PID ${TEST_PROGRAM_PID} exceeded run time limit, sending SIGKILL" >&2
+	kill -KILL "${TEST_PROGRAM_PID}" 2>/dev/null
+fi
 
 TEST_PROGRAM_NAME=$(basename "${TEST_PROGRAM}")
 TEST_PROGRAM_WORK_DIR=$(dirname "${TEST_PROGRAM}")