Test suite hardening

src/Makefile.am

@@ -3,7 +3,7 @@ sbin_PROGRAMS = hitch
 noinst_LIBRARIES = libcfg.a libforeign.a
 
 EXTRA_DIST = \
-	$(top_srcdir)/src/tests/common.sh \
+	$(top_srcdir)/src/tests/hitch_test.sh \
 	$(top_srcdir)/src/tests/test*.sh \
 	$(top_srcdir)/src/tests/certs/* \
 	$(top_srcdir)/src/tests/configs/default.cfg

src/tests/hitch_test.sh

@@ -3,56 +3,68 @@
 # export TESTDIR=`pwd`/; export PATH=$PATH:`pwd`/../:`pwd`/../util/
 #
 
-export LC_ALL=C
 set -e
+set -u
+
+cd "$(mktemp -d)"
+readonly TEST_TMPDIR=$(pwd)
+
+# begin old setup
+
+export LC_ALL=C
 
-LISTENADDR="localhost"
 LISTENPORT=`expr $$ % 62000 + 1024`
-PIDFILE=$(mktemp -u)
-CONFFILE=$(mktemp -u)
-DUMPFILE=$(mktemp -u)
 CERTSDIR="${TESTDIR}/certs"
 CONFDIR="${TESTDIR}/configs"
 
-HITCH_ARGS="--pidfile=$PIDFILE --daemon --quiet"
+# end old setup
+
+dump() {
+	for LOG in *.log
+	do
+		test -f "$LOG" || continue
 
-if [ "$USER" = "root" ]; then
-	HITCH_ARGS="$HITCH_ARGS --user=nobody"
-fi
+		printf '\nFound log file %s:\n\n' "$LOG"
+		cat -v "$LOG" | sed -e 's/^/> /'
+	done >&2
+
+	for DUMP in *.dump
+	do
+		test -f "$DUMP" || continue
+
+		printf '\nFound dump file %s:\n\n' "$DUMP"
+		cat -v "$DUMP" | sed -e 's/^/> /'
+	done >&2
+}
 
 cleanup() {
-        test -f "$CONFFILE" && rm -f "$CONFFILE"
-        test -f "$DUMPFILE" && rm -f "$DUMPFILE"
-        if [ -s $PIDFILE ]; then
-		kill `cat "$PIDFILE"`
-	fi
+	for PID in *.pid
+	do
+		test -f "$PID" &&
+		kill "$(cat "$PID")"
+	done
+
+	rm -rf "$TEST_TMPDIR"
 }
+
 trap cleanup EXIT
 
-die() {
-	echo "FAILED: $*"
-	if [ -r "$DUMPFILE" ]; then
-		cat $DUMPFILE;
-	fi
+fail() {
+	echo "FAIL: $*" >&2
+	dump
 	exit 255
 }
 
 skip() {
-	echo "SKIPPED: $*"
-	if [ -r "$DUMPFILE" ]; then
-		cat $DUMPFILE;
-	fi
+	echo "SKIP: $*" >&2
+	dump
 	exit 77
 }
 
-mk_cfg() {
-	cat > "$CONFFILE"
-}
-
-runcurl() {
-	# Verify that we got a HTTP reply.
-	curl $CURL_EXTRA -I -X GET --max-time 5 --silent --insecure https://$1:$2/
-	test $? -eq 0 || die "Incorrect HTTP response code."
+error() {
+	echo "ERROR: $*" >&2
+	dump
+	exit 99
 }
 
 run_cmd() (
@@ -72,13 +84,109 @@ run_cmd() (
 
 	shift $((OPTIND - 1))
 
-	printf 'Running: %s\n' "$*"
+	printf 'Running: %s\n' "$*" >&2
 
 	RUN_STATUS=0
 	"$@" || RUN_STATUS=$?
 
 	if [ "$RUN_STATUS" -ne "$CMD_STATUS" ]
 	then
-		die "expected exit status $CMD_STATUS got $RUN_STATUS"
+		fail "expected exit status $CMD_STATUS got $RUN_STATUS"
 	fi
 )
+
+start_hitch() {
+	TEST_UID=$(id -u)
+	HITCH_USER=
+	test "$TEST_UID" -eq 0 && HITCH_USER=--user=nobody
+
+	run_cmd hitch \
+		--pidfile="$TEST_TMPDIR/hitch.pid" \
+		--log-filename=hitch.log \
+		--daemon \
+		$HITCH_USER \
+		"$@"
+}
+
+hitch_pid() {
+	cat "$TEST_TMPDIR/hitch.pid"
+}
+
+hitch_hosts() {
+	# XXX: check lsof presence with autoconf
+	lsof -F -P -n -a -p "$(hitch_pid)" -i 4 -i TCP |
+	sed 's/*/localhost/' |
+	awk '/^n/ { print substr($1,2) }'
+}
+
+curl_hitch() {
+	printf 'Running: curl %s\n' "$*" >&2
+
+	HAS_SPECIFIC_ARG=false
+
+	for ARG
+	do
+		test "$ARG" = -- && HAS_SPECIFIC_ARG=true
+
+		# ignore non-option arguments
+		test "${ARG#-}" = "$ARG" && continue
+
+		curl --help |
+		grep -q -e "$ARG" ||
+		skip "curl: unknown option $ARG"
+	done
+
+	if ! $HAS_SPECIFIC_ARG
+	then
+		HITCH_HOST=$(hitch_hosts | sed 1q)
+		curl_hitch "$@" -- "https://$HITCH_HOST/"
+		return $?
+	fi
+
+	CURL_STATUS=${CURL_STATUS:-200}
+	EXIT_STATUS=0
+	RESP_STATUS=$(curl \
+		--head \
+		--max-time 5 \
+		--silent \
+		--verbose \
+		--insecure \
+		--output /dev/null \
+		--write-out '%{http_code}' \
+		"$@") || EXIT_STATUS=$?
+
+	# XXX: how to handle the cases where we expect an error?
+	test $EXIT_STATUS -ne 0 &&
+	error "curl request failed or timed out (exit status: $EXIT_STATUS)"
+
+	test "$CURL_STATUS" = "$RESP_STATUS" ||
+	fail "expected status $CURL_STATUS got $RESP_STATUS"
+}
+
+s_client() {
+	printf 'Running: s_client %s\n' "$*" >&2
+
+	HAS_CONNECT_OPT=false
+
+	for ARG
+	do
+		# ignore non-option arguments
+		test "${ARG#-}" = "$ARG" && continue
+
+		test "$ARG" = -connect && HAS_CONNECT_OPT=true
+
+		openssl s_client -help 2>&1 |
+		grep -q -e "$ARG" ||
+		skip "openssl s_client: unknown option $ARG"
+	done
+
+	if ! $HAS_CONNECT_OPT
+	then
+		HITCH_HOST=$(hitch_hosts | sed 1q)
+		s_client "$@" -connect "$HITCH_HOST"
+		return $?
+	fi
+
+	printf '\n' |
+	openssl s_client -prexit "$@" 2>&1
+}

src/tests/test02-simple-request.sh

@@ -3,15 +3,12 @@
 # Test basic argument handling.
 #
 . hitch_test.sh
-set +o errexit
 
-hitch $HITCH_ARGS --backend=[hitch-tls.org]:80 "--frontend=[${LISTENADDR}]:$LISTENPORT" ${CERTSDIR}/site1.example.com
-test $? -eq 0 || die "Hitch did not start."
+start_hitch \
+	--backend="[hitch-tls.org]:80" \
+	--frontend="[localhost]:$LISTENPORT" \
+	"${CERTSDIR}/site1.example.com"
 
-echo -e "\n" | openssl s_client -prexit -connect $LISTENADDR:$LISTENPORT >$DUMPFILE 2>&1
-test $? -eq 0 || die "s_client failed"
-
-grep -q -c "subject=/CN=site1.example.com" $DUMPFILE
-test $? -eq 0 || die "Got wrong certificate."
-
-runcurl $LISTENADDR $LISTENPORT
+s_client >s_client.dump
+run_cmd grep -q "subject=/CN=site1.example.com" s_client.dump
+curl_hitch

src/tests/test03-multiple-listen.sh

@@ -4,22 +4,17 @@
 #
 . hitch_test.sh
 
-PORT2=`expr $$ % 60000 + 3000`
+PORT2=$(expr $$ % 60000 + 3000)
 
-hitch $HITCH_ARGS --backend=[hitch-tls.org]:80 \
-	"--frontend=[${LISTENADDR}]:$LISTENPORT" \
-	"--frontend=[${LISTENADDR}]:$PORT2" \
-	${CERTSDIR}/site1.example.com
-test $? -eq 0 || die "Hitch did not start."
+start_hitch \
+	--backend=[hitch-tls.org]:80 \
+	--frontend="[localhost]:$LISTENPORT" \
+	--frontend="[localhost]:$PORT2" \
+	"${CERTSDIR}/site1.example.com"
 
-echo -e "\n" | openssl s_client -prexit -connect $LISTENADDR:$LISTENPORT >$DUMPFILE 2>&1
-test $? -eq 0 || die "s_client failed"
-grep -q -c "subject=/CN=site1.example.com" $DUMPFILE
-
-# Second listen port.
-echo -e "\n" | openssl s_client -prexit -connect $LISTENADDR:$PORT2 >$DUMPFILE 2>&1
-test $? -eq 0 || die "s_client failed"
-grep -q -c "subject=/CN=site1.example.com" $DUMPFILE
-
-runcurl $LISTENADDR $LISTENPORT
-runcurl $LISTENADDR $PORT2
+for host in $(hitch_hosts)
+do
+	s_client -connect "$host" >"$host.dump"
+	run_cmd grep -q "subject=/CN=site1.example.com" "$host.dump"
+	curl_hitch -- "https://$host/"
+done

src/tests/test04-listen-with-own-certs.sh

@@ -3,24 +3,23 @@
 # Test multiple listening sockets, each with their own certificate.
 #
 . hitch_test.sh
-set +o errexit
 
-PORT2=`expr $$ % 60000 + 4000`
+PORT2=$(expr $$ % 60000 + 4000)
 
-hitch $HITCH_ARGS --backend=[hitch-tls.org]:80 \
-	"--frontend=[${LISTENADDR}]:$LISTENPORT+${CERTSDIR}/site1.example.com" \
-	"--frontend=[${LISTENADDR}]:$PORT2+${CERTSDIR}/site2.example.com" \
-	${CERTSDIR}/default.example.com
-test $? -eq 0 || die "Hitch did not start."
+start_hitch \
+	--backend='[hitch-tls.org]:80' \
+	--frontend="[localhost]:$LISTENPORT+${CERTSDIR}/site1.example.com" \
+	--frontend="[localhost]:$PORT2+${CERTSDIR}/site2.example.com" \
+	"${CERTSDIR}/default.example.com"
 
-echo -e "\n" | openssl s_client -prexit -connect $LISTENADDR:$LISTENPORT >$DUMPFILE 2>&1 || die "s_client failed"
-grep -q -c "subject=/CN=site1.example.com" $DUMPFILE
-test $? -eq 0 || die "s_client got wrong certificate on listen port #1"
+s_client -connect localhost:$LISTENPORT >s_client1.dump
+run_cmd grep -q 'subject=/CN=site1.example.com' s_client1.dump
 
 # Second listen port.
-echo -e "\n" | openssl s_client -prexit -connect $LISTENADDR:$PORT2 >$DUMPFILE 2>&1 || die "s_client failed"
-grep -q -c "subject=/CN=site2.example.com" $DUMPFILE
-test $? -eq 0 || die "s_client got wrong certificate in listen port #2"
+s_client -connect localhost:$PORT2 >s_client2.dump
+run_cmd grep -q 'subject=/CN=site2.example.com' s_client2.dump
 
-runcurl $LISTENADDR $LISTENPORT
-runcurl $LISTENADDR $PORT2
+for host in $(hitch_hosts)
+do
+	curl_hitch -- "https://$host/"
+done

src/tests/test05-multiple-listen-SNI.sh

@@ -1,23 +1,21 @@
 #!/bin/sh
 #
 # Test multiple certificates (SNI) on a listening socket.
-#
+
 . hitch_test.sh
-set +o errexit
 
-hitch $HITCH_ARGS --backend=[hitch-tls.org]:80 "--frontend=[${LISTENADDR}]:$LISTENPORT" \
-	${CERTSDIR}/site1.example.com ${CERTSDIR}/site2.example.com ${CERTSDIR}/default.example.com
-test $? -eq 0 || die "Hitch did not start."
+start_hitch \
+	--backend='[hitch-tls.org]:80' \
+	--frontend="[localhost]:$LISTENPORT" \
+	"${CERTSDIR}/site1.example.com" \
+	"${CERTSDIR}/site2.example.com" \
+	"${CERTSDIR}/default.example.com"
 
-echo -e "\n" | openssl s_client -prexit -connect $LISTENADDR:$LISTENPORT >$DUMPFILE 2>&1
-test $? -eq 0 || die "s_client failed"
-grep -q -c "subject=/CN=default.example.com" $DUMPFILE
-test $? -eq 0 || die "s_client got wrong certificate on listen port #1"
+s_client >no-sni.dump
+run_cmd grep -q 'subject=/CN=default.example.com' no-sni.dump
 
 # send a SNI request
-echo -e "\n" | openssl s_client -servername site1.example.com -prexit -connect $LISTENADDR:$LISTENPORT >$DUMPFILE 2>&1
-test $? -eq 0 || die "s_client failed"
-grep -q -c "subject=/CN=site1.example.com" $DUMPFILE
-test $? -eq 0 || die "s_client got wrong certificate in listen port #2"
+s_client -servername site1.example.com >sni.dump
+run_cmd grep -q 'subject=/CN=site1.example.com' sni.dump
 
-runcurl $LISTENADDR $LISTENPORT
+curl_hitch

src/tests/test06-ticket-resume.sh

@@ -3,26 +3,15 @@
 # Test resuming a session via a session ticket
 
 . hitch_test.sh
-set +o errexit
 
-SESSFILE=`mktemp`
-rmsess() {
-	rm -f $SESSFILE
-	cleanup
-}
-trap rmsess EXIT
+start_hitch \
+	--backend="[hitch-tls.org]:80" \
+	--frontend="[localhost]:$LISTENPORT" \
+	"${CERTSDIR}/site1.example.com"
 
-hitch $HITCH_ARGS --backend=[hitch-tls.org]:80 "--frontend=[${LISTENADDR}]:$LISTENPORT" \
-	${CERTSDIR}/site1.example.com
-test $? -eq 0 || die "Hitch did not start."
+s_client -sess_out sess_ticket.txt >out.dump
+s_client -sess_in  sess_ticket.txt >in.dump
 
-echo -e "\n" | openssl s_client -prexit -sess_out $SESSFILE -connect $LISTENADDR:$LISTENPORT
-test $? -eq 0 || die "s_client failed (1)"
+run_cmd grep Reused, in.dump
 
-echo -e "\n" | openssl s_client -prexit -sess_in $SESSFILE -connect $LISTENADDR:$LISTENPORT >$DUMPFILE 2>&1
-test $? -eq 0 || die "s_client failed (2)"
-
-grep -q -c "Reused, " $DUMPFILE
-test $? -eq 0 || die "Unable to resume session via session ticket."
-
-runcurl $LISTENADDR $LISTENPORT
+curl_hitch