From: "mattock (Code Review)" Date: Fri, 7 Jun 2024 11:06:40 +0000 References: Reply-To: samuli@...515..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: <361cb52b57320f43f1f9b2f68c20cda4a436dda7-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="OjBRk6Z4vks="; charset=UTF-8 Subject: [Openvpn-devel] [L] Change in openvpn[master]: Add t_server_null test suite List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos , flichtenheld Cc: openvpn-devel --OjBRk6Z4vks= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, plaisthos. Hello plaisthos, flichtenheld, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/663?usp=3Demail to review the following change. Change subject: Add t_server_null test suite ...................................................................... Add t_server_null test suite Change-Id: I1b54da258c7d15551b6c3de7522a0d19afdb66de Signed-off-by: Samuli Sepp=C3=A4nen --- M .gitignore A doc/t_server_null.rst M tests/Makefile.am A tests/null_client_up.sh A tests/t_server_null.rc-sample A tests/t_server_null.sh A tests/t_server_null_client.sh A tests/t_server_null_default.rc A tests/t_server_null_server.sh A tests/t_server_null_stress.sh 10 files changed, 566 insertions(+), 2 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/63/663/1 diff --git a/.gitignore b/.gitignore index 92d65bf..db8bb73 100644 --- a/.gitignore +++ b/.gitignore @@ -55,6 +55,7 @@ tests/t_client.sh tests/t_client-*-20??????-??????/ +tests/t_server_null.rc t_client.rc t_client_ips.rc tests/unit_tests/**/*_testdriver diff --git a/doc/t_server_null.rst b/doc/t_server_null.rst new file mode 100644 index 0000000..233e659 --- /dev/null +++ b/doc/t_server_null.rst @@ -0,0 +1,146 @@ +Notes for the --dev null test suite +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Introduction +------------ + +The *--dev null test suite* is primary targeted at testing client connecti= ons +to the "just compiled" version of OpenVPN. The name is derived from "null" +device type in OpenVPN. In particular, when *--dev null --ifconfig-noexec*= is +used in OpenVPN client configuration one does not need to run OpenVPN with= root +privileges because interface, routing, etc. configuration is not done at a= ll. +This is still enough to ensure that the OpenVPN client can connect to a se= rver +instance. + +The main features of the test suite: + +* Parallelized for fairly high performance +* Mostly operating-system agnostic +* Tested on Fedora Linux 38 and FreeBSD 14 +* Should be POSIX shell compliant but uses Bash now +* Uses the sample certificates and keys +* Supports running multiple servers and clients +* Supports running servers directly as root and with sudo +* Supports using different OpenVPN client versions + + * The "current" (just compiled) version + * Any other OpenVPN versions that is present on the filesystem + +* Support testing for success as well as failure +* Test cases (client configurations) and server setups (server configurati= ons) are stored in a configuration file, i.e. data and code have been separ= ated +* Configuration file format is nearly identical to t_client.rc configurati= on +* Supports a set of default tests, overriding default test settings and ad= ding local tests + +Prerequisites +------------- + +Running the test suite requires the following: + +* *bash* for running the tests +* root-level privileges for launching the servers + + * run as root + * a privilege escalation tool (sudo, doas, su) and the permission to bec= ome root + +Technical implementation +------------------------ + +The test suite is completely parallelized to allow running a large number = of +server and client combinations quickly. + +A normal test run looks like this: + +#. Server instances start +#. Brief wait +#. Client instances start +#. Tests run +#. Client instances stop +#. Brief wait +#. Server instances stop + +The tests suite is launched via "make check": + +* make check + + * t_server_null.sh + + * t_server_null_server.sh + + * Launches the compiled OpenVPN server instances as root (if necessa= ry with sudo or su) in the background. The servers are killed using their m= anagement interface once all clients have exited. + + * t_server_null_client.sh + + * Waits until servers have launched. Then launch all clients, wait f= or them to exit and then check test results by parsing the client log files= . Each client kills itself after some delay using an "--up" script. + +Note that "make check" moves on once *t_server_null_client.sh* has exited.= At +that point *t_server_null_server.sh* is still running, because it exists o= nly +after waiting a few seconds for more client connections to potentially app= ear. +This is a feature and not a bug, but means that launching "make check" run= s too +quickly might cause test failures or unexpected behavior such as leftover +OpenVPN server processes. + +Configuration +------------- + +The test suite reads its configuration from two files: + +* *tests/t_server_null_defaults.rc:* default test configuration that shoul= d work on any system +* *tests/t_server_null.rc:* a local configuration file; can be used to add= additional tests or override settings from the default test configuration.= Must be present or tests will be skipped, but can be an empty file. + +The configuration syntax is very similar to *t_client.rc*. New server inst= ances can be +defined like this:: + + SERVER_NAME_5=3D"t_server_null_server-11195_udp" + SERVER_MGMT_PORT_5=3D"11195" + SERVER_EXEC_5=3D"${SERVER_EXEC}" + SERVER_CONF_5=3D"${SERVER_CONF_BASE} --lport 11195 --proto udp --managem= ent 127.0.0.1 ${SERVER_MGMT_PORT_5}" + +In this case the server instance identifier is **5**. Variables such as +*SERVER_EXEC* and *SERVER_CONF_BASE* are defined in +*t_server_null_defaults.rc*. To enable this server instance add it to the +server list:: + + TEST_SERVER_LIST=3D"1 2 5" + +The client instances are added similarly:: + + TEST_NAME_9=3D"t_server_null_client.sh-openvpn_current_udp_custom" + SHOULD_PASS_9=3D"yes" + CLIENT_EXEC_9=3D"${CLIENT_EXEC}" + CLIENT_CONF_9=3D"${CLIENT_CONF_BASE} --remote 127.0.0.1 1194 udp --proto= udp" + +In this case the test identifier is **9**. *CLIENT_EXEC* and *CLIENT_CONF_= BASE* +are defined in *t_server_null_defaults.rc*. The variable *SHOULD_PASS* +determines that this particular test is supposed to succeed and not fail. = To +enable this client instance add it to the test list:: + + TEST_RUN_LIST=3D"1 2 5 9" + +Stress-testing the --dev null test suite +---------------------------------------- + +It is very easy to introduce subtle, difficult to debug issues to the --dev +null tests when you make changes to it. These issues can be difficult to s= pot: +based on practical experience a bad change can make the test failure rate = go +from 0% (normal) to anywhere between 1% and 20%. You can spot these issues= with +the provided stress-test script, *t_server_null_stress.sh*. It calls *make= check* +over and over again in a loop and when failures occur it saves the output = under +*tests/make-check*. + +To follow the test flow on Linux you can run this while stress-testing:: + + watch -n 0.5 "ps aux|grep -E '(openvpn|t_server_null_server.sh)'|grep = -vE '(suppress|grep|tail)'" + +Regarding privilege escalation +------------------------------ + +The --dev null test servers need to be launched as root. Either run the te= sts +as root directly, or configure a privilege escalation tool of your choice = in +*t_server_null.rc*. For example, to use sudo:: + + SUDO_EXEC=3D`which sudo` + RUN_SUDO=3D"${SUDO_EXEC} -E" + +If you do stress-testing with *t_server_null_stress.sh* make sure your +privilege escalation authorization does not time out: if it does, then a +reauthorization prompt will interrupt your tests. diff --git a/tests/Makefile.am b/tests/Makefile.am index 5e9ad0a..f26b3b8 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -15,10 +15,10 @@ SUBDIRS =3D unit_tests AM_TESTSUITE_SUMMARY_HEADER =3D ' for $(PACKAGE_STRING) System Tests' -LOG_DRIVER =3D $(SHELL) $(top_srcdir)/forked-test-driver +SH_LOG_DRIVER =3D $(SHELL) $(top_srcdir)/forked-test-driver if !WIN32 -test_scripts =3D t_client.sh t_lpback.sh t_cltsrv.sh +test_scripts =3D t_client.sh t_lpback.sh t_cltsrv.sh t_server_null.sh check_PROGRAMS =3D ntlm_support if HAVE_SITNL @@ -27,6 +27,7 @@ endif TESTS_ENVIRONMENT =3D top_srcdir=3D"$(top_srcdir)" +TEST_EXTENSIONS =3D .sh TESTS =3D $(test_scripts) dist_noinst_SCRIPTS =3D \ @@ -34,8 +35,14 @@ t_cltsrv-down.sh \ t_lpback.sh \ t_net.sh \ + t_server_null.sh \ + t_server_null_client.sh \ + t_server_null_server.sh \ + t_server_null_default.rc \ update_t_client_ips.sh +t_client.log: t_server_null.log + dist_noinst_DATA =3D \ t_client.rc-sample diff --git a/tests/null_client_up.sh b/tests/null_client_up.sh new file mode 100755 index 0000000..d4df0c6 --- /dev/null +++ b/tests/null_client_up.sh @@ -0,0 +1,11 @@ +#!/bin/sh +# +# Stop the parent process (openvpn) gracefully after a small delay + +# Determine the OpenVPN PID from its pid file. This works reliably even wh= en +# the OpenVPN process is backgrounded for parallel tests. +MY_PPID=3D`cat $pid` + +# Allow OpenVPN to finish initializing while waiting in the background and= then +# killing the process gracefully. +(sleep 5 ; kill -15 $MY_PPID) & diff --git a/tests/t_server_null.rc-sample b/tests/t_server_null.rc-sample new file mode 100644 index 0000000..28c3773 --- /dev/null +++ b/tests/t_server_null.rc-sample @@ -0,0 +1,15 @@ +# Uncomment to run tests with sudo +#SUDO_EXEC=3D`which sudo` +#RUN_SUDO=3D"${SUDO_EXEC} -E" + +TEST_RUN_LIST=3D"1 2 3 10 11" + +TEST_NAME_10=3D"t_server_null_client.sh-openvpn_2_6_8_udp" +SHOULD_PASS_10=3D"yes" +CLIENT_EXEC_10=3D"/usr/sbin/openvpn" +CLIENT_CONF_10=3D"${CLIENT_CONF_BASE} --remote 127.0.0.1 1194 udp --proto = udp" + +TEST_NAME_11=3D"t_server_null_client.sh-openvpn_2_6_8_tcp" +SHOULD_PASS_11=3D"yes" +CLIENT_EXEC_11=3D"/usr/sbin/openvpn" +CLIENT_CONF_11=3D"${CLIENT_CONF_BASE} --remote 127.0.0.1 1195 tcp --proto = tcp" diff --git a/tests/t_server_null.sh b/tests/t_server_null.sh new file mode 100755 index 0000000..7ad843a --- /dev/null +++ b/tests/t_server_null.sh @@ -0,0 +1,74 @@ +#!/usr/bin/env bash +# +TSERVER_NULL_SKIP_RC=3D"${TSERVER_NULL_SKIP_RC:-77}" + +if ! [ -r "./t_server_null.rc" ] ; then + echo "$0: cannot find './t_server_null.rc. SKIPPING TEST.'" >&2 + exit "${TSERVER_NULL_SKIP_RC}" +fi + +. ./t_server_null.rc + +export KILL_EXEC=3D`which kill` +if [ $? -ne 0 ]; then + echo "$0: kill not found in \$PATH" >&2 + exit "${TSERVER_NULL_SKIP_RC}" +fi + +# Ensure PREFER_KSU is in a known state +PREFER_KSU=3D"${PREFER_KSU:-0}" + +# make sure we have permissions to run ifconfig/route from OpenVPN +# can't use "id -u" here - doesn't work on Solaris +ID=3D`id` +if expr "$ID" : "uid=3D0" >/dev/null +then : +else + if [ "${PREFER_KSU}" -eq 1 ]; + then + # Check if we have a valid kerberos ticket + klist -l 1>/dev/null 2>/dev/null + if [ $? -ne 0 ]; + then + # No kerberos ticket found, skip ksu and fallback to RUN_SUDO + PREFER_KSU=3D0 + echo "$0: No Kerberos ticket available. Will not use ksu." + else + RUN_SUDO=3D"ksu -q -e" + fi + fi + + if [ -z "$RUN_SUDO" ] + then + echo "$0: this test must run be as root, or RUN_SUDO=3D... " >&2 + echo " must be set correctly in 't_server_null.rc'. SKIP." >&2 + exit "${TSERVER_NULL_SKIP_RC}" + else + # Run a no-op command with privilege escalation (e.g. sudo) so that + # we (hopefully) do not have to ask the users password during the test. + if $RUN_SUDO $KILL_EXEC -0 $$ + then + echo "$0: $RUN_SUDO $KILL_EXEC -0 succeeded, good." + else + echo "$0: $RUN_SUDO $KILL_EXEC -0 failed, cannot go on. SKIP." >&2 + exit "${TSERVER_NULL_SKIP_RC}" + fi + fi +fi + +srcdir=3D"${srcdir:-.}" + + +if [ -z "${RUN_SUDO}" ]; then + "${srcdir}/t_server_null_server.sh" & +else + $RUN_SUDO "${srcdir}/t_server_null_server.sh" & +fi + +"${srcdir}/t_server_null_client.sh" + +# When running make jobs in parallel ("make -j check") we need to ensure +# that this script does not exit before all --dev null servers are dead and +# their network interfaces are gone. Otherwise t_client.sh will fail becau= se +# pre and post ifconfig output does not match. +wait diff --git a/tests/t_server_null_client.sh b/tests/t_server_null_client.sh new file mode 100755 index 0000000..aa71f08 --- /dev/null +++ b/tests/t_server_null_client.sh @@ -0,0 +1,132 @@ +#!/usr/bin/env bash + +launch_client() { + local test_name=3D$1 + local log=3D"${test_name}.log" + local pid=3D"${test_name}.pid" + local client_exec=3D$2 + local client_conf=3D$3 + + # Ensure that old log and pid files are gone + rm -f "${log}" "${pid}" + + "${client_exec}" \ + $client_conf \ + --writepid "${pid}" \ + --setenv pid $pid \ + --log "${log}" & +} + +wait_for_results() { + tests_running=3D"yes" + + # Wait a bit to allow an OpenVPN client process to create a pidfile to + # prevent exiting too early + sleep 1 + + while [ "${tests_running}" =3D=3D "yes" ]; do + tests_running=3D"no" + for t in $test_names; do + if [ -f "${t}.pid" ]; then + tests_running=3D"yes" + fi + done + + if [ "${tests_running}" =3D=3D "yes" ]; then + echo "Clients still running" + sleep 1 + fi + done +} + +get_client_test_result() { + local test_name=3D$1 + local should_pass=3D$2 + local log=3D"${test_name}.log" + + grep "Initialization Sequence Completed" "${log}" > /dev/null + local exit_code=3D$? + + if [ $exit_code -eq 0 ] && [ "${should_pass}" =3D "yes" ]; then + echo "PASS ${test_name}" + elif [ $exit_code -eq 1 ] && [ "${should_pass}" =3D "no" ]; then + echo "PASS ${test_name} (test failure)" + elif [ $exit_code -eq 0 ] && [ "${should_pass}" =3D "no" ]; then + echo "FAIL ${test_name} (test failure)" + cat "${log}" + retval=3D1 + elif [ $exit_code -eq 1 ] && [ "${should_pass}" =3D "yes" ]; then + echo "FAIL ${test_name}" + cat "${log}" + retval=3D1 + fi +} + +# Load basic/default tests +. ${srcdir}/t_server_null_default.rc || exit 1 + +# Load additional local tests, if any +test -r ./t_server_null.rc && . ./t_server_null.rc + +# Return value for the entire test suite. Gets set to 1 if any test fails. +export retval=3D0 + +# Wait until servers are up. This check is based on the presence of proces= ses +# matching the PIDs in each servers PID files +count=3D0 +server_max_wait=3D15 +while [ $count -lt $server_max_wait ]; do + server_pids=3D"" + for i in `(set -o posix; set)|grep 'SERVER_NAME_'|cut -d "=3D" -f 2`; = do + server_pid=3D`cat "${i}.pid"` + server_pids=3D"${server_pids} ${server_pid}" + done + + server_count=3D`echo ${server_pids}|wc -w` + servers_up=3D`ps -p $server_pids|sed '1d'|wc -l` + + echo "OpenVPN test servers up: ${servers_up}/${server_count}" + + if [ $servers_up -ge $server_count ]; then + retval=3D0 + break + else + ((count++)) + sleep 1 + fi + + if [ $count -eq $server_max_wait ]; then + retval=3D1 + fi +done + +# Wait a while to let server processes to settle down +sleep 1 + +# Launch OpenVPN clients. While at it, construct a list of test names. The= list +# is used later to determine when all OpenVPN clients have exited and it is +# safe to check the test results. +test_names=3D"" +for SUF in $TEST_RUN_LIST +do + eval test_name=3D\"\$TEST_NAME_$SUF\" + eval client_exec=3D\"\$CLIENT_EXEC_$SUF\" + eval client_conf=3D\"\$CLIENT_CONF_$SUF\" + + test_names=3D"${test_names} ${test_name}" + launch_client "${test_name}" "${client_exec}" "${client_conf}" +done + +# Wait until all OpenVPN clients have exited +wait_for_results + +# Check test results +for SUF in $TEST_RUN_LIST +do + eval test_name=3D\"\$TEST_NAME_$SUF\" + eval should_pass=3D\"\$SHOULD_PASS_$SUF\" + + get_client_test_result "${test_name}" $should_pass +done + +exit $retval diff --git a/tests/t_server_null_default.rc b/tests/t_server_null_default.rc new file mode 100755 index 0000000..63b6bcd --- /dev/null +++ b/tests/t_server_null_default.rc @@ -0,0 +1,66 @@ +# Notes regarding --dev null server and client configurations: +# +# The t_server_null_server.sh exits when all client pid files have gone +# missing. That is the most reliable and fastest way to detect client +# disconnections in the "everything runs on localhost" context. Checking s= erver +# status files for client connections works, but introduces long delays as +# --explicit-exit-notify does not seem to work on all client configuration= s. +# This means that, by default, there is about 1 minute delay before the se= rver +# purges clients that have already exited and have not reported back. +# +srcdir=3D"${srcdir:-.}" +top_builddir=3D"${top_builddir:-..}" +sample_keys=3D"${srcdir}/../sample/sample-keys" + +DH=3D"${sample_keys}/dh2048.pem" +CA=3D"${sample_keys}/ca.crt" +CLIENT_CERT=3D"${sample_keys}/client.crt" +CLIENT_KEY=3D"${sample_keys}/client.key" +SERVER_CERT=3D"${sample_keys}/server.crt" +SERVER_KEY=3D"${sample_keys}/server.key" +TA=3D"${sample_keys}/ta.key" + +# Test server configurations +MAX_CLIENTS=3D"10" +CLIENT_MATCH=3D"Test-Client" +SERVER_EXEC=3D"${top_builddir}/src/openvpn/openvpn" +SERVER_BASE_OPTS=3D"--daemon --local 127.0.0.1 --dev tun --topology subnet= --server 10.29.41.0 255.255.255.0 --max-clients $MAX_CLIENTS --persist-tun= --verb 3" +SERVER_CIPHER_OPTS=3D"" +SERVER_CERT_OPTS=3D"--ca ${CA} --dh ${DH} --cert ${SERVER_CERT} --key ${SE= RVER_KEY} --tls-auth ${TA} 0" +SERVER_CONF_BASE=3D"${SERVER_BASE_OPTS} ${SERVER_CIPHER_OPTS} ${SERVER_CER= T_OPTS}" + +TEST_SERVER_LIST=3D"1 2" + +SERVER_NAME_1=3D"t_server_null_server-1194_udp" +SERVER_MGMT_PORT_1=3D"11194" +SERVER_EXEC_1=3D"${SERVER_EXEC}" +SERVER_CONF_1=3D"${SERVER_CONF_BASE} --lport 1194 --proto udp --management= 127.0.0.1 ${SERVER_MGMT_PORT_1}" + +SERVER_NAME_2=3D"t_server_null_server-1195_tcp" +SERVER_MGMT_PORT_2=3D"11195" +SERVER_EXEC_2=3D"${SERVER_EXEC}" +SERVER_CONF_2=3D"${SERVER_CONF_BASE} --lport 1195 --proto tcp --management= 127.0.0.1 ${SERVER_MGMT_PORT_2}" + +# Test client configurations +CLIENT_EXEC=3D"${top_builddir}/src/openvpn/openvpn" +CLIENT_BASE_OPTS=3D"--client --dev null --ifconfig-noexec --nobind --remot= e-cert-tls server --persist-tun --verb 3 --resolv-retry infinite --connect-= retry-max 3 --server-poll-timeout 5 --explicit-exit-notify 3 --script-secur= ity 2 --up ${srcdir}/null_client_up.sh" +CLIENT_CIPHER_OPTS=3D"" +CLIENT_CERT_OPTS=3D"--ca ${CA} --cert ${CLIENT_CERT} --key ${CLIENT_KEY} -= -tls-auth ${TA} 1" + +TEST_RUN_LIST=3D"1 2 3" +CLIENT_CONF_BASE=3D"${CLIENT_BASE_OPTS} ${CLIENT_CIPHER_OPTS} ${CLIENT_CER= T_OPTS}" + +TEST_NAME_1=3D"t_server_null_client.sh-openvpn_current_udp" +SHOULD_PASS_1=3D"yes" +CLIENT_EXEC_1=3D"${CLIENT_EXEC}" +CLIENT_CONF_1=3D"${CLIENT_CONF_BASE} --remote 127.0.0.1 1194 udp --proto u= dp" + +TEST_NAME_2=3D"t_server_null_client.sh-openvpn_current_tcp" +SHOULD_PASS_2=3D"yes" +CLIENT_EXEC_2=3D"${CLIENT_EXEC}" +CLIENT_CONF_2=3D"${CLIENT_CONF_BASE} --remote 127.0.0.1 1195 tcp --proto t= cp" + +TEST_NAME_3=3D"t_server_null_client.sh-openvpn_current_udp_fail" +SHOULD_PASS_3=3D"no" +CLIENT_EXEC_3=3D"${CLIENT_EXEC}" +CLIENT_CONF_3=3D"${CLIENT_CONF_BASE} --remote 127.0.0.1 11194 udp --proto = udp" diff --git a/tests/t_server_null_server.sh b/tests/t_server_null_server.sh new file mode 100755 index 0000000..02ff728 --- /dev/null +++ b/tests/t_server_null_server.sh @@ -0,0 +1,80 @@ +#!/usr/bin/env bash + +launch_server() { + local server_name=3D$1 + local server_exec=3D$2 + local server_conf=3D$3 + local log=3D"${server_name}.log" + local status=3D"${server_name}.status" + local pid=3D"${server_name}.pid" + + + # Ensure that old status, log and pid files are gone + rm -f "${status}" "${log}" "${pid}" + + "${server_exec}" \ + $server_conf \ + --status "${status}" 1 \ + --log "${log}" \ + --writepid "${pid}" \ + --explicit-exit-notify 3 + +} + +# Load base/default configuration +. "${srcdir}/t_server_null_default.rc" || exit 1 + +# Load local configuration, if any +test -r ./t_server_null.rc && . ./t_server_null.rc + +# Launch test servers +for SUF in $TEST_SERVER_LIST +do + eval server_name=3D\"\$SERVER_NAME_$SUF\" + eval server_exec=3D\"\$SERVER_EXEC_$SUF\" + eval server_conf=3D\"\$SERVER_CONF_$SUF\" + + launch_server "${server_name}" "${server_exec}" "${server_conf}" +done + +# Create a list of server pid files so that servers can be killed at the e= nd of +# the test run. +# +export server_pid_files=3D"" +for SUF in $TEST_SERVER_LIST +do + eval server_name=3D\"\$SERVER_NAME_$SUF\" + server_pid_files=3D"${server_pid_files} ./${server_name}.pid" +done + +# Wait until clients are no more, based on the presence of their pid files. +# Based on practical testing we have to wait at least four seconds to avoid +# accidentally exiting too early. +count=3D0 +maxcount=3D4 +while [ $count -le $maxcount ]; do + ls t_server_null_client.sh*.pid > /dev/null 2>&1 + + if [ $? -eq 0 ]; then + count=3D0 + sleep 1 + else + ((count++)) + sleep 1 + fi +done + +echo "All clients have disconnected from all servers" + +for PID_FILE in $server_pid_files +do + SERVER_PID=3D`cat $PID_FILE` + $KILL_EXEC $SERVER_PID + + # Make sure that the server processes are truly dead before exiting + while : + do + ps -p $SERVER_PID > /dev/null || break + sleep 0.2 + done +done diff --git a/tests/t_server_null_stress.sh b/tests/t_server_null_stress.sh new file mode 100755 index 0000000..3dc17d9 --- /dev/null +++ b/tests/t_server_null_stress.sh @@ -0,0 +1,32 @@ +#!/usr/bin/env bash +# +# Run this stress test as root to avoid sudo authorization from timing out. + +count=3D0 + +. ./t_server_null_default.rc + +export pid_files=3D"" +for SUF in $TEST_SERVER_LIST +do + eval server_name=3D\"\$SERVER_NAME_$SUF\" + pid_files=3D"${pid_files} ./${server_name}.pid" +done + +LOG_BASEDIR=3D"make-check" +mkdir -p "${LOG_BASEDIR}" + +while [ $count -lt 100 ]; do + count=3D$(( count + 1 )) + make check TESTS=3Dt_server_null.sh SUBDIRS=3D > /dev/null 2>&1 + retval=3D$? + + echo "Iteration ${count}: return value ${retval}" >> "${LOG_BASEDIR}/m= ake-check.log" + if [ $retval -ne 0 ]; then + DIR=3D"${LOG_BASEDIR}/make-check-${count}" + mkdir -p "${DIR}" + cp t_server_null*.log "${DIR}/" + cp test-suite.log "${DIR}/" + ps aux|grep openvpn|grep -vE '(suppress|grep)' > "${DIR}/psaux" + fi +done -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/663?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: I1b54da258c7d15551b6c3de7522a0d19afdb66de Gerrit-Change-Number: 663 Gerrit-PatchSet: 1 Gerrit-Owner: mattock Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: flichtenheld Gerrit-MessageType: newchange --OjBRk6Z4vks= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, plaisthos.

mattock would like plaisthos and flichtenheld to review= this change.

Vi= ew Change

Add t_server_null test suite

Change-Id: I1b54da258c7d1= 5551b6c3de7522a0d19afdb66de
Signed-off-by: Samuli Sepp=C3=A4nen <samu= li.seppanen@...277...>
---
M .gitignore
A doc/t_server_null.rst=
M tests/Makefile.am
A tests/null_client_up.sh
A tests/t_server_nu= ll.rc-sample
A tests/t_server_null.sh
A tests/t_server_null_client.sh=
A tests/t_server_null_default.rc
A tests/t_server_null_server.sh
= A tests/t_server_null_stress.sh
10 files changed, 566 insertions(+), 2 d= eletions(-)

git pull ssh://gerrit.openvpn.net:29418/openvpn refs/=
changes/63/663/1
diff --git a/.gitignore b/.gitignore
index 92d65bf..db8bb73 100644
--- a/.gitignore+++ b/.gitignore
@@ -55,6 +55,7 @@
=
tests/t_client.sh
tests/t_client-*-20???= ???-??????/
+tests/t_= server_null.rc
t_client.rc
t_client_ips.r= c
tests/unit_tests/**/*_testdriver
diff --= git a/doc/t_server_null.rst b/doc/t_server_null.rst
new fil= e mode 100644
index 0000000..233e659
--- /d= ev/null
+++ b/doc/t_server_null.rst
@@ -0,0= +1,146 @@
+Notes for= the --dev null test suite
+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
+
= +Introduction
+------= ------
+
+The *--dev null test suite* is p= rimary targeted at testing client connections
+to the "just compiled" version of OpenV= PN. The name is derived from "null"
+device type in OpenVPN. In particular, when *--de= v null --ifconfig-noexec* is
+used in OpenVPN client configuration one does not need to run Open= VPN with root
+privil= eges because interface, routing, etc. configuration is not done at all.

+This is still enough to= ensure that the OpenVPN client can connect to a server
+instance.
+
+The main features of the test suite:
+
+* Parallelized for fairly high performance
+* Mostly operating-system agnostic
+* Tested on Fedora Linux 38 and = FreeBSD 14
+* Should = be POSIX shell compliant but uses Bash now
+* Uses the sample certificates and keys
+* Supports running multiple serv= ers and clients
+* Su= pports running servers directly as root and with sudo
+* Supports using different OpenVPN client= versions
++ * The "current" (= just compiled) version
+
+* Support testing for success as well as failu= re
+* Test cases (cli= ent configurations) and server setups (server configurations) are stored in= a configuration file, i.e. data and code have been separated
+* Configuration file format is ne= arly identical to t_client.rc configuration
+* Supports a set of default tests, overriding defau= lt test settings and adding local tests
+
= +Prerequisites
+-----= --------
+
= +Running the test suite require= s the following:
+

+* *bash* for running t= he tests
+* root-leve= l privileges for launching the servers
+
+= * run as root
+ * = a privilege escalation tool (sudo, doas, su) and the permission to become r= oot
+
+Technical implementation
= +------------------------

+
+The test suite is completely parallelized to= allow running a large number of
+server and client combinations quickly.
+
+A normal test run looks like this:
+
+#. Server instances start
+#. Brief wait
+#. Client instances start
+#. Tests run
+#. Client instances stop
+#. Brief wait
+#. Server instances stop
+
+The t= ests suite is launched via "make check":
+
+* make check
+
+ * t_server_n= ull.sh
+
+ * t_server_null_server.sh
+
+ * Launches the compiled OpenVPN ser= ver instances as root (if necessary with sudo or su) in the background. The= servers are killed using their management interface once all clients have = exited.
+
<= span style=3D"color: hsl(120, 100%, 40%);">+ * t_server_null_client.sh
+
+ * Waits until servers have launche= d. Then launch all clients, wait for them to exit and then check test resul= ts by parsing the client log files. Each client kills itself after some del= ay using an "--up" script.
+
+No= te that "make check" moves on once *t_server_null_client.sh* has = exited. At
+that poin= t *t_server_null_server.sh* is still running, because it exists only=
+after waiting a few second= s for more client connections to potentially appear.
+This is a feature and not a bug, but mean= s that launching "make check" runs too
+quickly might cause test failures or unexpecte= d behavior such as leftover
+OpenVPN server processes.
+
+Confi= guration
+-----------= --
+
+The test suite reads its configurati= on from two files:
+<= /span>
+* *tests/t_server_nu= ll_defaults.rc:* default test configuration that should work on any system<= /span>
+* *tests/t_server_nu= ll.rc:* a local configuration file; can be used to add additional tests or = override settings from the default test configuration. Must be present or t= ests will be skipped, but can be an empty file.
+
+The configuration syntax is very similar to *t_client.rc*. New ser= ver instances can be
= +defined like this::
= +
+ SERVER_NAME_5=3D= "t_server_null_server-11195_udp"
+ SERVER_MGMT_PORT_5=3D"11195"
<= span style=3D"color: hsl(120, 100%, 40%);">+ SERVER_EXEC_5=3D"${SERVE= R_EXEC}"

+ SERV= ER_CONF_5=3D"${SERVER_CONF_BASE} --lport 11195 --proto udp --managemen= t 127.0.0.1 ${SERVER_MGMT_PORT_5}"
+
= +In this case the server instance identifier is **5**. Variables such as

+*SERVER_EXEC* and *SER= VER_CONF_BASE* are defined in
+*t_server_null_defaults.rc*. To enable this server instance add i= t to the
+server list= ::
+
+ TEST_SERVER_LIST=3D"1 2 5&quo= t;
+
+The client instances are added simil= arly::
+
+ TEST_NAME_9=3D"t_server_n= ull_client.sh-openvpn_current_udp_custom"
+ SHOULD_PASS_9=3D"yes"
+ CLIENT_EXEC_9=3D"${CLIENT_E= XEC}"
+ CLIENT_= CONF_9=3D"${CLIENT_CONF_BASE} --remote 127.0.0.1 1194 udp --proto udp&= quot;
+
+In this case the test identifier = is **9**. *CLIENT_EXEC* and *CLIENT_CONF_BASE*
+are defined in *t_server_null_defaults.rc*. The = variable *SHOULD_PASS*
+enable this cl= ient instance add it to the test list::
+
= + TEST_RUN_LIST=3D"1 2 5 9"
+
+= Stress-testing the --dev null test suite
+----------------------------------------
+
+It is very easy to introduce subtle, difficult to de= bug issues to the --dev
+null tests when you make changes to it. These issues can be difficult t= o spot:
+based on pra= ctical experience a bad change can make the test failure rate go
= +from 0% (normal) to anywhere b= etween 1% and 20%. You can spot these issues with
+the provided stress-test script, *t_server_nu= ll_stress.sh*. It calls *make check*
+over and over again in a loop and when failures occur it s= aves the output under
+*tests/make-check*.
+
+To follow the tes= t flow on Linux you can run this while stress-testing::
+
+ watch -n 0.5 "ps aux|grep -E '(openvpn|t_serv= er_null_server.sh)'|grep -vE '(suppress|grep|tail)'"
+
+Regarding privilege escalation
+------------------------------

+
+The --dev null test servers need to be la= unched as root. Either run the tests
+as root directly, or configure a privilege escalation tool= of your choice in
+*= t_server_null.rc*. For example, to use sudo::
+
+ SUDO_EXEC=3D`which sudo`
+ RUN_SUDO=3D"${SUDO_EXEC} -E"
+
+If you do stress-testing with *t_server_null_stress.sh*= make sure your
+priv= ilege escalation authorization does not time out: if it does, then a=
+reauthorization prompt wil= l interrupt your tests.
diff --git a/tests/Makefile.am b/te= sts/Makefile.am
index 5e9ad0a..f26b3b8 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am@@ -15,10 +15,10 @@
SUBDIRS =3D unit_tests<= br>
AM_TESTSUITE_SUMMARY_HEADER =3D ' for $(PAC= KAGE_STRING) System Tests'
-LOG_DRIVER =3D $(SHELL) $(top_srcdir)/forked-test-driver+SH_LOG_DRIVER =3D $(SHELL) $(= top_srcdir)/forked-test-driver

if !WIN32=
-test_scripts =3D t_cl= ient.sh t_lpback.sh t_cltsrv.sh
+test_scripts =3D t_client.sh t_lpback.sh t_cltsrv.sh t_server_n= ull.sh

check_PROGRAMS =3D ntlm_support
if HAVE_SITNL
@@ -27,6 +27,7 @@
<= span> endif


TESTS_ENVIRONMENT =3D top_sr= cdir=3D"$(top_srcdir)"
+TEST_EXTENSIONS =3D .sh
TESTS =3D $(test_scri= pts)

dist_noinst_SCRIPTS =3D \@@ -34,8 +35,14 @@
t_cltsrv-down.sh \
t_lpback.sh \
t_net.sh \
+ t_server_null.sh \
+ t_server_null_client.sh \
+ t_server_null_server.sh \
+ t_server_null_default.rc \
update_t_client_ips.sh

+t_client.log: t_server_null.log+
dist_noins= t_DATA =3D \
t_client.rc-sample
<= br>diff --git a/tests/null_client_up.sh b/tests/null_client_up.sh

new file mode 100755
index 0000000..d4df0c6
--- /dev/null
+++ b/tests/null_client_up.sh
@@ -0,0 +1,11 @@
+#!/bin/sh
+#
+# Stop the paren= t process (openvpn) gracefully after a small delay
+
+# Determine the OpenVPN PID from its pid file. This works relia= bly even when
+# the = OpenVPN process is backgrounded for parallel tests.
+MY_PPID=3D`cat $pid`
+
+# Allow OpenVPN to finish initializing while waiting in the= background and then
= +# killing the process gracefully.
+(sleep 5 ; kill -15 $MY_PPID) &
diff --g= it a/tests/t_server_null.rc-sample b/tests/t_server_null.rc-samplenew file mode 100644
index 0000000..28c3773<= br>--- /dev/null
+++ b/tests/t_server_null.rc-sample<= /span>
@@ -0,0 +1,15 @@
+# Uncomment to run tests with sudo
+#SUDO_EXEC=3D`which sudo`
+#RUN_SUDO=3D"${SUDO_EXEC} -E"
+
+TEST_RUN_LIST=3D"1 2 3 10 11"<= /span>
+
+TEST_NAME_10=3D"t_server_null_clie= nt.sh-openvpn_2_6_8_udp"
+SHOULD_PASS_10=3D"yes"
+CLIENT_EXEC_10=3D"/usr/sbin/openvpn"
+CLIENT_CONF_10=3D"${= CLIENT_CONF_BASE} --remote 127.0.0.1 1194 udp --proto udp"
<= span style=3D"color: hsl(120, 100%, 40%);">+

+TEST_NAME_11=3D"t_server_null_client.sh-openv= pn_2_6_8_tcp"
+S= HOULD_PASS_11=3D"yes"
+CLIENT_EXEC_11=3D"/usr/sbin/openvpn"
+CLIENT_CONF_11=3D"${CLIENT_CONF= _BASE} --remote 127.0.0.1 1195 tcp --proto tcp"
diff -= -git a/tests/t_server_null.sh b/tests/t_server_null.sh
new = file mode 100755
index 0000000..7ad843a
---= /dev/null
+++ b/tests/t_server_null.sh
@@ = -0,0 +1,74 @@
+#!/usr= /bin/env bash
+#
+TSERVER_NULL_SKIP_RC=3D&= quot;${TSERVER_NULL_SKIP_RC:-77}"
+
+= if ! [ -r "./t_server_null.rc" ] ; then
+ echo "$0: cannot find './t_serve= r_null.rc. SKIPPING TEST.'" >&2
+ exit "${TSERVER_NULL_SKIP_RC}"
+fi
+
+. ./t_server_null.rc
+
+e= xport KILL_EXEC=3D`which kill`
+if [ $? -ne 0 ]; then
+ echo "$0: kill not found in \$PATH" >&2
+ exit "${TSER= VER_NULL_SKIP_RC}"
+fi
+
+# Ensure PREFER_KSU is in a know= n state

+PREFER_KSU= =3D"${PREFER_KSU:-0}"
+
+# make = sure we have permissions to run ifconfig/route from OpenVPN
+# can't use "id -u" h= ere - doesn't work on Solaris

+ID=3D`id`
+if expr "$ID" : "uid=3D0" >/dev/null
<= span style=3D"color: hsl(120, 100%, 40%);">+then :

+else
+ if [ "${PREFER_KSU}" -eq 1 ];
+ then

+ # Check if we have a valid kerberos ti= cket
+ klist -= l 1>/dev/null 2>/dev/null
+ if [ $? -ne 0 ];
+ then
+ # No kerberos ticket found, skip ksu and fallback to = RUN_SUDO
+ = PREFER_KSU=3D0
+ = echo "$0: No Kerberos ticket available. Will not use ksu.&quo= t;
+ else
+ RUN_SUDO=3D&= quot;ksu -q -e"
= + fi
+ fi
+
+ if [ -z "$RUN_SUDO" ]
+ then
+ echo "$0: this test mu= st run be as root, or RUN_SUDO=3D... " >&2

+ echo " must be set cor= rectly in 't_server_null.rc'. SKIP." >&2
+ exit "${TSERVER_NULL_= SKIP_RC}"

+ e= lse
+ # Run a no-op c= ommand with privilege escalation (e.g. sudo) so that
+ # we (hopefully) do not have to ask the = users password during the test.
+ if $RUN_SUDO $KILL_EXEC -0 $$
+ then
+ echo "$0: $RUN_SUDO $KILL_EXEC -0 succeeded, good."=
+ else
+ echo "$0: $RUN_SUDO $KI= LL_EXEC -0 failed, cannot go on. SKIP." >&2

+ exit "${TSERVER_NULL_SKIP_RC}= "
+ fi+ fi
+fi
+
+sr= cdir=3D"${srcdir:-.}"
+
+=
+if [ -z "${RUN_SUDO}&= quot; ]; then
+ &q= uot;${srcdir}/t_server_null_server.sh" &
+else
+ $RUN_SUDO "${srcdir}/t_server_null_server.sh" = &
+fi
<= span style=3D"color: hsl(120, 100%, 40%);">+

+"${srcdir}/t_server_null_client.sh"
+
+# When running make jobs in parallel (&qu= ot;make -j<x> check") we need to ensure
+# that this script does not exit before all = --dev null servers are dead and
+# their network interfaces are gone. Otherwise t_client.sh will= fail because
+# pre = and post ifconfig output does not match.
+wait
diff --git a/tests/t_server_null_= client.sh b/tests/t_server_null_client.sh
new file mode 100= 755
index 0000000..aa71f08
--- /dev/null
+++ b/tests/t_server_null_client.sh
@@ -0,0 += 1,132 @@
+#!/usr/bin/= env bash
+
= +launch_client() {
+ local test_name=3D$1
<= br>+ local log=3D"${tes= t_name}.log"
+ = local pid=3D"${test_name}.pid"
+ local client_exec=3D$2
+ local client_conf=3D$3
+
+ # Ensure that old log and pid files are gone+ rm -f "${log}"= "${pid}"
+=
+ "${client_= exec}" \
+ = $client_conf \
+ = --writepid "${pid}" \
+ --setenv pid $pid \
+ --log "${log}" &
<= span style=3D"color: hsl(120, 100%, 40%);">+}

+
+wait_for_results() {
+ tests_running=3D"yes"
+
+ # Wait a bit to allow an OpenVPN client process to create a pidfil= e to
+ # prevent e= xiting too early
+ = sleep 1
+
= + while [ "${tests_runn= ing}" =3D=3D "yes" ]; do
+ tests_running=3D"no"
+ for t in $test_names; do
+ if [ -f &qu= ot;${t}.pid" ]; then
+ tests_running=3D"yes"
+ fi
+ done
+
+ echo &q= uot;Clients still running"
+ sleep 1
+ fi
+}=
+
+get_client_test_result() {
+ local test_name=3D$1
+ local should_pass=3D$2
=
+ local log=3D"${te= st_name}.log"
+<= /span>
+ grep "Initi= alization Sequence Completed" "${log}" > /dev/null=
+ local exit_code=3D$?
+
+ if [ $exit_code -eq 0 ] && [= "${should_pass}" =3D "yes" ]; then
+ echo "PASS ${test_name}&qu= ot;
+ elif [ $exit= _code -eq 1 ] && [ "${should_pass}" =3D "no" ];= then
+ echo &= quot;PASS ${test_name} (test failure)"
+ elif [ $exit_code -eq 0 ] && [ "${= should_pass}" =3D "no" ]; then
+ echo "FAIL ${test_name} (test failur= e)"
+ cat= "${log}"
+= retval=3D1
+ = elif [ $exit_code -eq 1 ] && [ "${should_pass}" =3D &q= uot;yes" ]; then
+ echo "FAIL ${test_name}"
+ cat "${log}"
+ retval=3D1
+ fi
+}
+
+# Load basic/de= fault tests
+. ${srcd= ir}/t_server_null_default.rc || exit 1
+
+= # Load additional local tests, if any
+test -r ./t_server_null.rc && . ./t_server_null.r= c
+
+# Return value for the entire test su= ite. Gets set to 1 if any test fails.
+export retval=3D0
+
+# W= ait until servers are up. This check is based on the presence of processes<= /span>
+# matching the PIDs = in each servers PID files
+count=3D0
+serv= er_max_wait=3D15
+whi= le [ $count -lt $server_max_wait ]; do
+ server_pids=3D""
+ for i in `(set -o posix; set)|grep 'S= ERVER_NAME_'|cut -d "=3D" -f 2`; do
+ server_pid=3D`cat "${i}.pid"= ;`
+ server_pi= ds=3D"${server_pids} ${server_pid}"
+ done
+
+ = server_count=3D`echo ${server_pids}|wc -w`
+ servers_up=3D`ps -p $server_pids|sed '1d'= ;|wc -l`
+
= + echo "OpenVPN test se= rvers up: ${servers_up}/${server_count}"
+
+ if [ $servers_up -ge $server_count ]; then
+ retval=3D0
+ break
+ else
+ ((count++))
+ sleep 1
+ fi
+=
+ if [ $count -eq= $server_max_wait ]; then
+ retval=3D1
+ fi
+done
+
+# Wait a while to let server processes to= settle down
+sleep 1=
+
+# Launch OpenVPN clients. While at it,= construct a list of test names. The list
+# is used later to determine when all OpenVPN clients= have exited and it is
+test_names=3D""
+for SUF in $TEST_RUN_LIST
+do
+ eval test_name=3D\"\$TEST_NAME_$SUF\"
<= span style=3D"color: hsl(120, 100%, 40%);">+ eval client_exec=3D\"\= $CLIENT_EXEC_$SUF\"

+ eval client_conf=3D\"\$CLIENT_CONF_$SUF\"
+

+ test_names=3D"${test_names} ${test_name}&quo= t;
+ launch_client= "${test_name}" "${client_exec}" "${client_conf}&q= uot;
+done
= +
+# Wait until all OpenVPN clients have exited
+wait_for_results<= br>+
+# Check test results
+for SUF in $TEST_RUN_LIST
+do
+ eval test_name=3D\"\$TEST_NAME_$SUF\"
+ eval should_pass=3D\= "\$SHOULD_PASS_$SUF\"
+
+ get= _client_test_result "${test_name}" $should_pass
+done
+
+exit $retval
diff --git a/tests/t_server_null_default.r= c b/tests/t_server_null_default.rc
new file mode 100755
index 0000000..63b6bcd
--- /dev/null+++ b/tests/t_server_null_default.rc
@@ -0,0 +1,66 @= @
+# Notes regarding = --dev null server and client configurations:
+#
+# The t_server_null_server.sh exits when all client pid files have g= one
+# missing. That = is the most reliable and fastest way to detect client
+# disconnections in the "everything = runs on localhost" context. Checking server
+# status files for client connections works, b= ut introduces long delays as
+# --explicit-exit-notify does not seem to work on all client confi= gurations.
+# This me= ans that, by default, there is about 1 minute delay before the server
+# purges clients that hav= e already exited and have not reported back.
+#
+srcdir=3D"${srcdir:-.}"
+top_builddir=3D"${top_builddir:-..}"<= br>+sample_keys=3D"${srcdi= r}/../sample/sample-keys"
+
+DH=3D&qu= ot;${sample_keys}/dh2048.pem"
+CA=3D"${sample_keys}/ca.crt"
+CLIENT_CERT=3D"${sample_keys}/client= .crt"
+CLIENT_KE= Y=3D"${sample_keys}/client.key"
+SERVER_CERT=3D"${sample_keys}/server.crt"
+SERVER_KEY=3D"${= sample_keys}/server.key"
+TA=3D"${sample_keys}/ta.key"
+
+# Test server configurations
+MAX_CLIENTS=3D"10"
+CLIENT_MATCH=3D"Test-Client"+SERVER_EXEC=3D"${top_bu= ilddir}/src/openvpn/openvpn"
+SERVER_BASE_OPTS=3D"--daemon --local 127.0.0.1 --dev tun= --topology subnet --server 10.29.41.0 255.255.255.0 --max-clients $MAX_CLI= ENTS --persist-tun --verb 3"
+SERVER_CIPHER_OPTS=3D""
+SERVER_CERT_OPTS=3D"--ca ${CA} --dh ${DH} = --cert ${SERVER_CERT} --key ${SERVER_KEY} --tls-auth ${TA} 0"+SERVER_CONF_BASE=3D"${S= ERVER_BASE_OPTS} ${SERVER_CIPHER_OPTS} ${SERVER_CERT_OPTS}"
= +
+TEST_SERVER_LIST=3D"1 2"
+

+SERVER_NAME_1=3D"t_server_null_server-1194_udp&q= uot;
+SERVER_MGMT_POR= T_1=3D"11194"
+SERVER_EXEC_1=3D"${SERVER_EXEC}"
+SERVER_CONF_1=3D"${SERVER_CONF_BASE} --lpor= t 1194 --proto udp --management 127.0.0.1 ${SERVER_MGMT_PORT_1}"
+
+SERVER_NAME_2=3D"t_server_null_server-1= 195_tcp"
+SERVER= _MGMT_PORT_2=3D"11195"
+SERVER_EXEC_2=3D"${SERVER_EXEC}"
+SERVER_CONF_2=3D"${SERVER_CONF_BAS= E} --lport 1195 --proto tcp --management 127.0.0.1 ${SERVER_MGMT_PORT_2}&qu= ot;
+
+# Test client configurations
=
+CLIENT_EXEC=3D"${top_= builddir}/src/openvpn/openvpn"
+CLIENT_BASE_OPTS=3D"--client --dev null --ifconfig-noe= xec --nobind --remote-cert-tls server --persist-tun --verb 3 --resolv-retry= infinite --connect-retry-max 3 --server-poll-timeout 5 --explicit-exit-not= ify 3 --script-security 2 --up ${srcdir}/null_client_up.sh"
= +CLIENT_CIPHER_OPTS=3D"&qu= ot;
+CLIENT_CERT_OPTS= =3D"--ca ${CA} --cert ${CLIENT_CERT} --key ${CLIENT_KEY} --tls-auth ${= TA} 1"
+<= br>+TEST_RUN_LIST=3D"1 2 3= "
+CLIENT_CONF_B= ASE=3D"${CLIENT_BASE_OPTS} ${CLIENT_CIPHER_OPTS} ${CLIENT_CERT_OPTS}&q= uot;
+
+TEST_NAME_1=3D"t_server_null_= client.sh-openvpn_current_udp"

+SHOULD_PASS_1=3D"yes"
+CLIENT_EXEC_1=3D"${CLIENT_EXEC}"
+CLIENT_CONF_1=3D"${= CLIENT_CONF_BASE} --remote 127.0.0.1 1194 udp --proto udp"
<= span style=3D"color: hsl(120, 100%, 40%);">+

+TEST_NAME_2=3D"t_server_null_client.sh-openvp= n_current_tcp"
+= SHOULD_PASS_2=3D"yes"
+CLIENT_EXEC_2=3D"${CLIENT_EXEC}"
+CLIENT_CONF_2=3D"${CLIENT_CONF_BASE= } --remote 127.0.0.1 1195 tcp --proto tcp"
+
+TEST_NAME_3=3D"t_server_null_client.sh-openvpn_current_udp_fa= il"
+SHOULD_PASS= _3=3D"no"
+= CLIENT_EXEC_3=3D"${CLIENT_EXEC}"
+CLIENT_CONF_3=3D"${CLIENT_CONF_BASE} --remote 1= 27.0.0.1 11194 udp --proto udp"
diff --git a/tests/t_s= erver_null_server.sh b/tests/t_server_null_server.sh
new fi= le mode 100755
index 0000000..02ff728
--- /= dev/null
+++ b/tests/t_server_null_server.sh
@@ -0,0 +1,80 @@

+#= !/usr/bin/env bash
+<= /span>
+launch_server() {
+ local server_name= =3D$1
+ local serv= er_exec=3D$2
+ loc= al server_conf=3D$3
+= local log=3D"${server_name}.log"
+ local status=3D"${server_name}.status&q= uot;
+ local pid= =3D"${server_name}.pid"
+
+
+ # Ensure that old st= atus, log and pid files are gone
+ rm -f "${status}" "${log}" "${pid= }"
+
<= span style=3D"color: hsl(120, 100%, 40%);">+ "${server_exec}" = \

+ $server_co= nf \
+ --statu= s "${status}" 1 \
+ --log "${log}" \
+ --writepid "${pid}" \
+ --explicit-exit-notify 3=

+
+}
+
+= # Load base/default configuration
+. "${srcdir}/t_server_null_default.rc" || exit 1
+
+# Load local configuration, if any=
+test -r ./t_server_null.rc= && . ./t_server_null.rc
+
+# Laun= ch test servers
+for = SUF in $TEST_SERVER_LIST
+do
+ eval ser= ver_name=3D\"\$SERVER_NAME_$SUF\"
+ eval server_exec=3D\"\$SERVER_EXEC_$SUF\&q= uot;
+ eval server= _conf=3D\"\$SERVER_CONF_$SUF\"
+
+ launch_server "${server_name}" "${server_exec}" &= quot;${server_conf}"
+done
++# Create a list of server pi= d files so that servers can be killed at the end of
+# the test run.
+#
+export server_pid_files=3D""
+for SUF in $TEST_SERVER_LIST
+do

+ eval server_name=3D\"\$SERVER_NAME_$SUF\&qu= ot;
+ server_pid_f= iles=3D"${server_pid_files} ./${server_name}.pid"
+done

+
+# Wait until clients are no more, based on the presence of their pid = files.
+# Based on pr= actical testing we have to wait at least four seconds to avoid
+# accidentally exiting too early= .

+count=3D0+maxcount=3D4
+while [ $count -le $maxcount ]; do<= /span>
+ ls t_server_null= _client.sh*.pid > /dev/null 2>&1
+
+ if [ $? -eq 0 ]; then
+ count=3D0
+ sleep 1
+ else
+ = ((count++))
+ = sleep 1
+ fi
+done
+
+echo "All clients have disconnected from all servers&= quot;
+
+for PID_FILE in $server_pid_files=

+do
+ SERVER_PID=3D`cat $PID_FILE`
+ $KILL_EXEC $SERVER_= PID
+
+ # Make sure that the server pro= cesses are truly dead before exiting

+ while :
+ do
+ = ps -p $SERVER_PID > /dev/null || break
+ sleep 0.2
+ done
+done
diff --git a/tests/t_server_null_stress.s= h b/tests/t_server_null_stress.sh
new file mode 100755
index 0000000..3dc17d9
--- /dev/null
= +++ b/tests/t_server_null_stress.sh
@@ -0,0 +1,32 @@<= /span>
+#!/usr/bin/env bash<= /span>
+#
+# Run this stress test as root to avoi= d sudo authorization from timing out.
+
+c= ount=3D0
+
= +. ./t_server_null_default.rc
+
+export pid_files=3D""+for SUF in $TEST_SERVER_LIST=
+do
+ eval server_name=3D\"\$SERV= ER_NAME_$SUF\"
+= pid_files=3D"${pid_files} ./${server_name}.pid"
+done

+
+LOG_BASEDIR=3D"make-check"
+mkdir -p "${LOG_BASEDIR}"
+

+while [ $count -lt 100 ]; do
+ count=3D$(( count + 1 ))
+ make check TESTS=3Dt_server_nul= l.sh SUBDIRS=3D > /dev/null 2>&1

+ retval=3D$?
+
+= echo "Iteration ${count}: return value ${retval}" >> &q= uot;${LOG_BASEDIR}/make-check.log"
+ if [ $retval -ne 0 ]; then
+ DIR=3D"${LOG_BASEDIR}/make-check-${cou= nt}"
+ mk= dir -p "${DIR}"
+ cp t_server_null*.log "${DIR}/"
+ cp test-suite.log "${DIR}/= "
+ ps au= x|grep openvpn|grep -vE '(suppress|grep)' > "${DIR}/psaux&q= uot;
+ fi+done
=

To view, visit change 663. To unsubscribe, or for help writing mail= filters, visit settings= .

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I1b54da258c7d15551b6c3de7522= a0d19afdb66de
Gerrit-Change-Number: 663
Gerrit-PatchSet: 1
Gerrit-Owner: mattock <samuli@...515...>=
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: flichtenheld <frank@...2375...= 41...>
Gerrit-MessageType: newchange
--OjBRk6Z4vks=--