Blame tests/scripts/common.sh

Packit aea12f
# Copyright (C) 2011-2016 Free Software Foundation, Inc.
Packit aea12f
# Copyright (C) 2015-2016 Red Hat, Inc.
Packit aea12f
#
Packit aea12f
# This file is part of GnuTLS.
Packit aea12f
#
Packit aea12f
# The launch_server() function was contributed by Cedric Arbogast.
Packit aea12f
#
Packit aea12f
# This file is free software; you can redistribute it and/or modify it
Packit aea12f
# under the terms of the GNU General Public License as published by
Packit aea12f
# the Free Software Foundation; either version 3 of the License, or
Packit aea12f
# (at your option) any later version.
Packit aea12f
#
Packit aea12f
# This file is distributed in the hope that it will be useful, but
Packit aea12f
# WITHOUT ANY WARRANTY; without even the implied warranty of
Packit aea12f
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit aea12f
# General Public License for more details.
Packit aea12f
#
Packit aea12f
# You should have received a copy of the GNU General Public License
Packit aea12f
# along with this file; if not, write to the Free Software Foundation,
Packit aea12f
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Packit aea12f
Packit aea12f
export TZ="UTC"
Packit aea12f
Packit aea12f
# Check for a utility to list ports.  Both ss and netstat will list
Packit aea12f
# ports for normal users, and have similar semantics, so put the
Packit aea12f
# command in the caller's PFCMD, or exit, indicating an unsupported
Packit aea12f
# test.  Prefer ss from iproute2 over the older netstat.
Packit aea12f
have_port_finder() {
Packit aea12f
	for file in $(which ss 2> /dev/null) /*bin/ss /usr/*bin/ss /usr/local/*bin/ss;do
Packit aea12f
		if test -x "$file";then
Packit aea12f
			PFCMD="$file";return 0
Packit aea12f
		fi
Packit aea12f
	done
Packit aea12f
Packit aea12f
	if test -z "$PFCMD";then
Packit aea12f
	for file in $(which netstat 2> /dev/null) /bin/netstat /usr/bin/netstat /usr/local/bin/netstat;do
Packit aea12f
		if test -x "$file";then
Packit aea12f
			PFCMD="$file";return 0
Packit aea12f
		fi
Packit aea12f
	done
Packit aea12f
	fi
Packit aea12f
Packit aea12f
	if test -z "$PFCMD";then
Packit aea12f
		echo "neither ss nor netstat found"
Packit aea12f
		exit 1
Packit aea12f
	fi
Packit aea12f
}
Packit aea12f
Packit aea12f
check_if_port_in_use() {
Packit aea12f
	local PORT="$1"
Packit aea12f
	local PFCMD; have_port_finder
Packit aea12f
	$PFCMD -an|grep "[\:\.]$PORT" >/dev/null 2>&1
Packit aea12f
}
Packit aea12f
Packit aea12f
check_if_port_listening() {
Packit aea12f
	local PORT="$1"
Packit aea12f
	local PFCMD; have_port_finder
Packit aea12f
	$PFCMD -anl|grep "[\:\.]$PORT"|grep LISTEN >/dev/null 2>&1
Packit aea12f
}
Packit aea12f
Packit aea12f
# Find a port number not currently in use.
Packit aea12f
GETPORT='
Packit aea12f
    rc=0
Packit aea12f
    unset myrandom
Packit aea12f
    while test $rc = 0; do
Packit aea12f
        if test -n "$RANDOM"; then myrandom=$(($RANDOM + $RANDOM)); fi
Packit aea12f
        if test -z "$myrandom"; then myrandom=$(date +%N | sed s/^0*//); fi
Packit aea12f
        if test -z "$myrandom"; then myrandom=0; fi
Packit aea12f
        PORT="$(((($$<<15)|$myrandom) % 63001 + 2000))"
Packit aea12f
        check_if_port_in_use $PORT;rc=$?
Packit aea12f
    done
Packit aea12f
'
Packit aea12f
Packit aea12f
check_for_datefudge() {
Packit aea12f
	# On certain platforms running datefudge date fails (e.g., x86 datefudge
Packit aea12f
	# with x86-64 date app).
Packit aea12f
	if test "${SKIP_DATEFUDGE_CHECK}" = 1;then
Packit aea12f
		return
Packit aea12f
	fi
Packit aea12f
Packit aea12f
	TSTAMP=`datefudge -s "2006-09-23" "${top_builddir}/tests/datefudge-check" || true`
Packit aea12f
	if test "$TSTAMP" != "1158969600" || test "$WINDOWS" = 1; then
Packit aea12f
	echo $TSTAMP
Packit aea12f
		echo "You need datefudge to run this test"
Packit aea12f
		exit 77
Packit aea12f
	fi
Packit aea12f
}
Packit aea12f
Packit aea12f
fail() {
Packit aea12f
   PID="$1"
Packit aea12f
   shift
Packit aea12f
   echo "Failure: $1" >&2
Packit aea12f
   [ -n "${PID}" ] && kill ${PID}
Packit aea12f
   exit 1
Packit aea12f
}
Packit aea12f
Packit aea12f
exit_if_non_x86()
Packit aea12f
{
Packit aea12f
which lscpu >/dev/null 2>&1
Packit aea12f
if test $? = 0;then
Packit aea12f
        $(which lscpu)|grep Architecture|grep x86
Packit aea12f
        if test $? != 0;then
Packit aea12f
                echo "non-x86 CPU detected"
Packit aea12f
                exit 0
Packit aea12f
        fi
Packit aea12f
fi
Packit aea12f
}
Packit aea12f
Packit aea12f
exit_if_non_padlock()
Packit aea12f
{
Packit aea12f
which lscpu >/dev/null 2>&1
Packit aea12f
if test $? = 0;then
Packit aea12f
        $(which lscpu)|grep Flags|grep phe
Packit aea12f
        if test $? != 0;then
Packit aea12f
                echo "non-Via padlock CPU detected"
Packit aea12f
                exit 0
Packit aea12f
        fi
Packit aea12f
fi
Packit aea12f
}
Packit aea12f
Packit aea12f
wait_for_port()
Packit aea12f
{
Packit aea12f
	local ret
Packit aea12f
	local PORT="$1"
Packit aea12f
	sleep 1
Packit aea12f
Packit aea12f
	for i in 1 2 3 4 5 6;do
Packit aea12f
		check_if_port_listening ${PORT}
Packit aea12f
		ret=$?
Packit aea12f
		if test $ret != 0;then
Packit aea12f
		check_if_port_in_use ${PORT}
Packit aea12f
			echo try $i
Packit aea12f
			sleep 2
Packit aea12f
		else
Packit aea12f
			break
Packit aea12f
		fi
Packit aea12f
	done
Packit aea12f
	return $ret
Packit aea12f
}
Packit aea12f
Packit aea12f
wait_for_free_port()
Packit aea12f
{
Packit aea12f
	local ret
Packit aea12f
	local PORT="$1"
Packit aea12f
Packit aea12f
	for i in 1 2 3 4 5 6;do
Packit aea12f
		check_if_port_in_use ${PORT}
Packit aea12f
		ret=$?
Packit aea12f
		if test $ret != 0;then
Packit aea12f
			break
Packit aea12f
		else
Packit aea12f
			sleep 2
Packit aea12f
		fi
Packit aea12f
	done
Packit aea12f
	return $ret
Packit aea12f
}
Packit aea12f
Packit aea12f
launch_server() {
Packit aea12f
	PARENT="$1"
Packit aea12f
	shift
Packit aea12f
Packit aea12f
	wait_for_free_port ${PORT}
Packit aea12f
	${SERV} ${DEBUG} -p "${PORT}" $* >${LOGFILE-/dev/null} &
Packit aea12f
}
Packit aea12f
Packit aea12f
launch_pkcs11_server() {
Packit aea12f
	PARENT="$1"
Packit aea12f
	shift
Packit aea12f
	PROVIDER="$1"
Packit aea12f
	shift
Packit aea12f
Packit aea12f
	wait_for_free_port ${PORT}
Packit aea12f
Packit aea12f
	${VALGRIND} ${SERV} ${PROVIDER} ${DEBUG} -p "${PORT}" $* &
Packit aea12f
}
Packit aea12f
Packit aea12f
launch_bare_server() {
Packit aea12f
	PARENT="$1"
Packit aea12f
	shift
Packit aea12f
Packit aea12f
	wait_for_free_port ${PORT}
Packit aea12f
	${SERV} $* >${LOGFILE-/dev/null} &
Packit aea12f
}
Packit aea12f
Packit Service b88974
launch_bare_server2() {
Packit Service b88974
	wait_for_free_port "$PORT"
Packit Service b88974
	"$@" >${LOGFILE-/dev/null} &
Packit Service b88974
}
Packit Service b88974
Packit aea12f
wait_server() {
Packit aea12f
	local PID=$1
Packit aea12f
	trap "test -n \"${PID}\" && kill ${PID};exit 1" 1 15 2
Packit aea12f
	wait_for_port $PORT
Packit aea12f
	if test $? != 0;then
Packit aea12f
		echo "Server $PORT did not come up"
Packit aea12f
		kill $PID
Packit aea12f
		exit 1
Packit aea12f
	fi
Packit aea12f
}
Packit aea12f
Packit aea12f
wait_udp_server() {
Packit aea12f
	local PID=$1
Packit aea12f
	trap "test -n \"${PID}\" && kill ${PID};exit 1" 1 15 2
Packit aea12f
	sleep 4
Packit aea12f
}
Packit aea12f
Packit aea12f
if test -x /usr/bin/lockfile-create;then
Packit aea12f
LOCKFILE="lockfile-create global"
Packit aea12f
UNLOCKFILE="lockfile-remove global"
Packit aea12f
else
Packit aea12f
LOCKFILE="lockfile global.lock"
Packit aea12f
UNLOCKFILE="rm -f global.lock"
Packit aea12f
fi
Packit aea12f
Packit aea12f
create_testdir() {
Packit aea12f
	local PREFIX=$1
Packit aea12f
	d=`mktemp -d -t ${PREFIX}.XXXXXX`
Packit aea12f
	if test $? -ne 0; then
Packit aea12f
		d=${TMPDIR}/${PREFIX}.$$
Packit aea12f
		mkdir "$d" || exit 1
Packit aea12f
	fi
Packit aea12f
	trap "test -e \"$d\" && rm -rf \"$d\"" 1 15 2
Packit aea12f
	echo "$d"
Packit aea12f
}
Packit aea12f
Packit aea12f
wait_for_file() {
Packit aea12f
	local filename="$1"
Packit aea12f
	local timeout="$2"
Packit aea12f
Packit aea12f
	local loops=$((timeout * 10)) loop=0
Packit aea12f
Packit aea12f
	while test $loop -lt $loops; do
Packit aea12f
		[ -f "$filename" ] && {
Packit aea12f
			#allow file to be written to
Packit aea12f
			sleep 0.2
Packit aea12f
			return 1
Packit aea12f
		}
Packit aea12f
		sleep 0.1
Packit aea12f
		loop=$((loop+1))
Packit aea12f
	done
Packit aea12f
	return 0
Packit aea12f
}
Packit aea12f
Packit aea12f
# Kill a process quietly
Packit aea12f
# @1: signal, e.g. -9
Packit aea12f
# @2: pid
Packit aea12f
kill_quiet() {
Packit aea12f
	local sig="$1"
Packit aea12f
	local pid="$2"
Packit aea12f
Packit aea12f
	sh -c "kill $sig $pid 2>/dev/null"
Packit aea12f
	return $?
Packit aea12f
}
Packit aea12f
Packit aea12f
# Terminate a process first using SIGTERM, wait 1s and if still avive use
Packit aea12f
# SIGKILL
Packit aea12f
# @1: pid
Packit aea12f
terminate_proc() {
Packit aea12f
	local pid="$1"
Packit aea12f
Packit aea12f
	local ctr=0
Packit aea12f
Packit aea12f
	kill_quiet -15 $pid
Packit aea12f
	while [ $ctr -lt 10 ]; do
Packit aea12f
		sleep 0.1
Packit aea12f
		kill -0 $pid 2>/dev/null
Packit aea12f
		[ $? -ne 0 ] && return
Packit aea12f
		ctr=$((ctr + 1))
Packit aea12f
	done
Packit aea12f
	kill_quiet -9 $pid
Packit aea12f
	sleep 0.1
Packit aea12f
}
Packit aea12f
Packit aea12f
# $1, $2: the two files to check for equality
Packit aea12f
# $3: Strings to be ignored, separated by |
Packit aea12f
check_if_equal() {
Packit aea12f
	if test -n "$3"; then
Packit aea12f
		local tmp1=`basename "$1"`"1.tmp"
Packit aea12f
		local tmp2=`basename "$2"`"2.tmp"
Packit aea12f
		egrep -v "$3" "$1" | tr -d '\r' >"$tmp1"
Packit aea12f
		egrep -v "$3" "$2" | tr -d '\r' >"$tmp2"
Packit aea12f
		diff -b -B "$tmp1" "$tmp2"
Packit aea12f
		local rc=$?
Packit aea12f
		rm -f "$tmp1" "$tmp2"
Packit aea12f
		return $rc
Packit aea12f
	fi
Packit aea12f
Packit aea12f
	diff -b -B "$1" "$2"
Packit aea12f
	return $?
Packit aea12f
}