From: "cron2 (Code Review)" Date: Tue, 18 Jun 2024 20:51:30 +0000 In-Reply-To: References: Reply-To: gert@...1296..., arne-openvpn@...1227..., samuli@...515..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: <2c77585970b66251110a3755d72ce592ea1241ee-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="n6GWvUE403w="; 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: mattock Cc: flichtenheld , plaisthos , openvpn-devel --n6GWvUE403w= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable cron2 has submitted this change. ( http://gerrit.openvpn.net/c/openvpn/+/66= 3?usp=3Demail ) Change subject: Add t_server_null test suite ...................................................................... Add t_server_null test suite Change-Id: I1b54da258c7d15551b6c3de7522a0d19afdb66de Signed-off-by: Samuli Sepp=C3=A4nen Acked-by: Frank Lichtenheld Message-Id: <20240613081422.139493-1-frank@...2641...> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28= 750.html Signed-off-by: Gert Doering --- 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, 568 insertions(+), 2 deletions(-) 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..e3a098a --- /dev/null +++ b/doc/t_server_null.rst @@ -0,0 +1,147 @@ +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/39/40 and FreeBSD 14 +* POSIX-compliant +* Tested and known to work with Bash, Dash, Ksh, Yash and FreeBSD's defaul= t /bin/sh +* 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..cfca5ee --- /dev/null +++ b/tests/t_server_null.sh @@ -0,0 +1,72 @@ +#!/usr/bin/env sh +# +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 + +if KILL_EXEC=3D$(which kill); then + export KILL_EXEC +else + 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 + if klist -l 1>/dev/null 2>/dev/null; then + RUN_SUDO=3D"ksu -q -e" + else + # No kerberos ticket found, skip ksu and fallback to RUN_SUDO + PREFER_KSU=3D0 + echo "${0}: No Kerberos ticket available. Will not use ksu." + 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..5d5542b --- /dev/null +++ b/tests/t_server_null_client.sh @@ -0,0 +1,136 @@ +#!/usr/bin/env sh + +launch_client() { + test_name=3D$1 + log=3D"${test_name}.log" + pid=3D"${test_name}.pid" + client_exec=3D$2 + 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 "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 "yes" ]; then + echo "Clients still running" + sleep 1 + fi + done +} + +get_client_test_result() { + test_name=3D$1 + should_pass=3D$2 + log=3D"${test_name}.log" + + grep "Initialization Sequence Completed" "${log}" > /dev/null + 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"" + server_count=3D$(set|grep 'SERVER_NAME_'|wc -l) + + # We need to trim single-quotes because some shells return quoted valu= es + # and some don't. Using "set -o posix" which would resolve this proble= m is + # not supported in all shells. + for i in `set|grep 'SERVER_NAME_'|cut -d "=3D" -f 2|tr -d "[\']"`; do + server_pid=3D$(cat $i.pid 2> /dev/null) + server_pids=3D"${server_pids} ${server_pid}" + done + + servers_up=3D$(ps -p $server_pids 2>/dev/null|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=3D$(( count + 1)) + 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..9bc0c88 --- /dev/null +++ b/tests/t_server_null_server.sh @@ -0,0 +1,78 @@ +#!/usr/bin/env sh + +launch_server() { + server_name=3D$1 + server_exec=3D$2 + server_conf=3D$3 + log=3D"${server_name}.log" + status=3D"${server_name}.status" + 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 + if ls t_server_null_client.sh*.pid > /dev/null 2>&1 + then + count=3D0 + sleep 1 + else + count=3D$(( count + 1)) + 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..1281397 --- /dev/null +++ b/tests/t_server_null_stress.sh @@ -0,0 +1,33 @@ +#!/usr/bin/env sh +# +# Run this stress test as root to avoid sudo authorization from timing out. + +ITERATIONS=3D"${1:-100}" + +. ./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}" + +count=3D0 +while [ $count -lt $ITERATIONS ]; 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: 3 Gerrit-Owner: mattock Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-MessageType: merged --n6GWvUE403w= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

cron2 submitted this change.

View Change

Add t_server_null test suite

Change-Id:= I1b54da258c7d15551b6c3de7522a0d19afdb66de
Signed-off-by: Samuli Sepp=C3= =A4nen <samuli.seppanen@...277...>
Acked-by: Frank Lichtenheld <= ;frank@...2641...>
Message-Id: <20240613081422.139493-1-frank@...1665...= 641...>
URL: https://www.mail-archive.com/openvpn-devel@...1535...= orge.net/msg28750.html
Signed-off-by: Gert Doering <gert@...1296...&g= t;
---
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_nu= ll_default.rc
A tests/t_server_null_server.sh
A tests/t_server_null_s= tress.sh
10 files changed, 568 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 92d65bf..db8b= b73 100644
--- a/.gitignore
+++ b/.gitignor= e
@@ -55,6 +55,7 @@

test= s/t_client.sh
tests/t_client-*-20??????-??????/
= +tests/t_server_null.rc<= br> t_client.rc
t_client_ips.rc
tes= ts/unit_tests/**/*_testdriver
diff --git a/doc/t_server_nul= l.rst b/doc/t_server_null.rst
new file mode 100644index 0000000..e3a098a
--- /dev/null
+++ b/doc/t_server_null.rst
@@ -0,0 +1,147 @@
<= span style=3D"color: hsl(120, 100%, 40%);">+Notes for the --dev null test s= uite
+=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 testi= ng client connections
+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 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/39/40 and FreeBSD 14<= br>+* POSIX-compliant+* Tested and known to work wi= th Bash, Dash, Ksh, Yash and FreeBSD's default /bin/sh
+* Uses the sample certificates and k= eys
+* Supports runni= ng multiple servers and clients
+* Supports running servers directly as root and with sudo
+* Supports using differen= t OpenVPN client versions
+
+ * The "= ;current" (just compiled) version
+ * Any other OpenVPN versions that is present on the fi= lesystem
+
= +* Support testing for success = as well as failure
+*= Test cases (client configurations) and server setups (server configuration= s) are stored in a configuration file, i.e. data and code have been separat= ed
+* Configuration f= ile format is nearly identical to t_client.rc configuration
+* Supports a set of default tests, = overriding default test settings and adding local tests

+
+Prerequisites
+-------------
+
+Running the te= st suite requires the following:
+
+* *bas= h* for running the tests
+* root-level privileges for launching the servers
+
+ * run as root
+ * a privilege escalation tool (sudo, doas, su) and the permis= sion to become root
+=
+Technical implement= ation
+--------------= ----------
++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_se= rver_null_server.sh
+=
+ * Launches th= e compiled OpenVPN server 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.
+
+ * t_s= erver_null_client.sh
= +
+ * Waits unti= l servers have launched. Then launch all clients, wait for 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_serve= r_null_client.sh* has exited. At
+that point *t_server_null_server.sh* is still running, because= it exists only
+afte= r waiting a few seconds for more client connections to potentially appear.<= /span>
+This is a feature an= d not a bug, but means that launching "make check" runs 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 instances can be
+defined like this::
+
+ SERVER_MGMT_PORT_5=3D"11= 195"
+ SERVER_E= XEC_5=3D"${SERVER_EXEC}"
+ SERVER_CONF_5=3D"${SERVER_CONF_BASE} --lport 11195 --= proto udp --management 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_L= IST=3D"1 2 5"
+
+The client inst= ances are added similarly::
+
+ TEST_NAME= _9=3D"t_server_null_client.sh-openvpn_current_udp_custom"<= br>+ 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*<= br>+are defined in *t_server_nu= ll_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
+---------------------------------= -------
+
<= span style=3D"color: hsl(120, 100%, 40%);">+It is very easy to introduce su= btle, difficult to debug issues to the --dev
+null tests when you make changes to it. These issu= es can be difficult to spot:
+based on practical experience a bad change can make the test failu= re 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 whe= n 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|t= ail)'"
+

+Regarding privilege esc= alation
+------------= ------------------
+<= /span>
+The --dev null test = servers need to be launched as root. Either run the tests
+as root directly, or configure a priv= ilege 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&q= uot;
+
+If you do stress-testing with *t_s= erver_null_stress.sh* make sure your

+privilege escalation authorization does not time out: if i= t does, then a
+reaut= horization prompt will interrupt your tests.
diff --git a/t= ests/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_HEAD= ER =3D ' for $(PACKAGE_STRING) System Tests'
-LOG_DRIVER =3D $(SHELL) $(top_srcdir)/forke= d-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_PROG= RAMS =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.s= h \
+ t_server_null_s= erver.sh \
+ t_server= _null_default.rc \
update_t_client_ips.sh

+t_client.log: t_s= erver_null.log
+
dist_noinst_DATA =3D \
t_client.rc-sample

diff --git a/tests/null_client_up.sh b/test= s/null_client_up.sh
new file mode 100755
in= dex 0000000..d4df0c6
--- /dev/null
+++ b/te= sts/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 when
+# the OpenVPN process is backgrounded for parallel tests.<= /span>
+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_nu= ll.rc-sample
new file mode 100644
index 000= 0000..28c3773
--- /dev/null
+++ b/tests/t_s= erver_null.rc-sample
@@ -0,0 +1,15 @@
+# Uncomment to run tests with sudo=
+#SUDO_EXEC=3D`which sudo`<= /span>
+#RUN_SUDO=3D"${= SUDO_EXEC} -E"
+=
+TEST_RUN_LIST=3D&qu= ot;1 2 3 10 11"
= +
+TEST_NAME_10=3D&qu= ot;t_server_null_client.sh-openvpn_2_6_8_udp"
+SHOULD_PASS_10=3D"yes"
<= span style=3D"color: hsl(120, 100%, 40%);">+CLIENT_EXEC_10=3D"/usr/sbi= n/openvpn"

+CLIE= NT_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&= quot;
+CLIENT_CONF_11= =3D"${CLIENT_CONF_BASE} --remote 127.0.0.1 1195 tcp --proto tcp"<= /span>
diff --git a/tests/t_server_null.sh b/tests/t_server_null.s= h
new file mode 100755
index 0000000..cfca5= ee
--- /dev/null
+++ b/tests/t_server_null.= sh
@@ -0,0 +1,72 @@
+#!/usr/bin/env sh
+#
+TSER= VER_NULL_SKIP_RC=3D"${TSERVER_NULL_SKIP_RC:-77}"
+
+if ! [ -r "./t_server_null.rc" ] ; then
+ echo "${0}: cann= ot find './t_server_null.rc. SKIPPING TEST.'" >&2
+ exit "${TSERVER_= NULL_SKIP_RC}"
+= fi
+
+. ./t_server_null.rc
+

+if KILL_EXEC=3D$(which kill); then
+ export KILL_EXEC
+else
+ echo "${0}: kill not found in \$PATH" &= gt;&2
+ exit &= quot;${TSERVER_NULL_SKIP_RC}"
+fi
+
+# Ensure PREFER_KSU i= s in a known state
+P= REFER_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 k= erberos ticket
+ = if klist -l 1>/dev/null 2>/dev/null; then
+ RUN_SUDO=3D"ksu -q -e"=
+ else=
+ # No kerberos = ticket found, skip ksu and fallback to RUN_SUDO
+ PREFER_KSU=3D0
+ echo "${0}: No Kerberos= ticket available. Will not use ksu."
+ fi
+ fi
+
+ if [ -z "= ;$RUN_SUDO" ]
+ = then
+ echo= "${0}: this test must run be as root, or RUN_SUDO=3D... " >&a= mp;2
+ echo &q= uot; must be set correctly in 't_server_null.rc'. SKIP." = >&2
+ e= xit "${TSERVER_NULL_SKIP_RC}"
+ else
+ # Run a no-op command with privilege escalation (e.g. sudo) so th= at
+ # we (hopefully)= do not have to ask the users password during the test.
+ if $RUN_SUDO "${KILL_EXEC}" = -0 $$
+ then+ echo "${0}: $RUN_S= UDO $KILL_EXEC -0 succeeded, good."
+ else
+ echo "${0}: $RUN_SUDO $KILL_EXEC -0 failed, cannot go on. = SKIP." >&2
+ 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<x&g= t; check") we need to ensure
+# that this script does not exit before all --dev null server= s are dead and
+# the= ir 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 100755
index 0000000..5d5542b

--- /dev/null
+++= b/tests/t_server_null_client.sh
@@ -0,0 +1,136 @@+#!/usr/bin/env sh
= +
+launch_client() {
+ test_name=3D$1
+ log=3D"${test_name}.log"
+ pid=3D"${test_name}.pid&= quot;

+ client_exe= c=3D$2
+ client_co= nf=3D$3
+
<= span style=3D"color: hsl(120, 100%, 40%);">+ # Ensure that old log and p= id files are gone

+ = rm -f "${log}" "${pid}"
+
+ "${client_exec}" \
+ $client_conf \
+ --writepid "${pid}" \
+ --setenv pid $pid \
+ --log "${lo= g}" &
+}
+
+wait_for_results() {
+ tests_running=3D"yes"
+
+ # Wait a bit to allow an OpenVPN clie= nt process to create a pidfile to
+ # prevent exiting too early
+ sleep 1
+
+ = while [ "${tests_running}" =3D "yes" ]; do+ tests_running=3D"= ;no"
+ fo= r t in $test_names; do
+ tests_running=3D"yes= "
+ f= i
+ done
+
+ if [ "${tests_running}" = =3D "yes" ]; then
+ echo "Clients still running"
+ sleep 1
+ fi
+ done
+}
= +
+get_client_test_re= sult() {
+ test_na= me=3D$1
+ should_p= ass=3D$2
+ log=3D&= quot;${test_name}.log"
+
+ grep &q= uot;Initialization Sequence Completed" "${log}" > /dev/nu= ll
+ exit_code=3D$= ?
+
+ if [ $exit_code -eq 0 ] &&= ; [ "${should_pass}" =3D "yes" ]; then
+ echo "PASS ${test_name}= "
+ elif [ $e= xit_code -eq 1 ] && [ "${should_pass}" =3D "no"= ]; then
+ ech= o "PASS ${test_name} (test failure)"
+ elif [ $exit_code -eq 0 ] && [ "= ;${should_pass}" =3D "no" ]; then
+ echo "FAIL ${test_name} (test fai= lure)"
+ = cat "${log}"
+ elif [ $exit_code -eq 1 ] && [ "${should_pass}" =3D= "yes" ]; then
+ echo "FAIL ${test_name}"
+ cat "${log}"
+ retval=3D1
+ fi
+}
+
+# Load basic= /default tests
+. ${s= rcdir}/t_server_null_default.rc || exit 1
+
+test -r ./t_server_null.rc && . ./t_server_nul= l.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 process= es
+# matching the PI= Ds in each servers PID files
+count=3D0
+s= erver_max_wait=3D15
+= while [ $count -lt $server_max_wait ]; do
+ server_pids=3D""
+ server_count=3D$(set|grep 'SERVER= _NAME_'|wc -l)
+<= /span>
+ # We need to tri= m single-quotes because some shells return quoted values
+ # and some don't. Using "= set -o posix" which would resolve this problem is
+ # not supported in all shells.
+ for i in `set|grep &#= 39;SERVER_NAME_'|cut -d "=3D" -f 2|tr -d "[\']"= `; do
+ server= _pid=3D$(cat $i.pid 2> /dev/null)
+ server_pids=3D"${server_pids} ${server_pid}&q= uot;
+ done=
+
+ servers_up=3D$(ps -p $server_pids 2>/d= ev/null|sed '1d'|wc -l)
+
+ ech= o "OpenVPN test servers up: ${servers_up}/${server_count}"=
+
+ if [ $servers_up -ge $server_count ]; the= n
+ retval=3D0=
+ break
+ else
+ count=3D$(( count + 1))
+ 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
+
+# Lau= nch OpenVPN clients. While at it, construct a list of test names. The list<= /span>
+# is used later to d= etermine when all OpenVPN clients have exited and it is
+# safe to check the test results.
+test_names=3D""=
+for SUF in $TEST_RU= N_LIST
+do
= + eval test_name=3D\"\$= TEST_NAME_$SUF\"
+ eval client_exec=3D\"\$CLIENT_EXEC_$SUF\"
+ eval client_conf=3D\"\$CLIEN= T_CONF_$SUF\"
+<= /span>
+ test_names=3D&qu= ot;${test_names} ${test_name}"
+ (launch_client "${test_name}" "${client_= exec}" "${client_conf}")
+done
+
+# Wait until a= ll OpenVPN clients have exited
+(wait_for_results)
+
+# Check t= est 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_nam= e}" "${should_pass}")
+done
+
+exit $retval
diff --git a/tests/t_server_null_default.rc b/tests/t_server_nu= ll_default.rc
new file mode 100755
index 00= 00000..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&quo= t; context. Checking server
+# status files for client connections works, but introduces long de= lays as
+# --explicit= -exit-notify does not seem to work on all client configurations.
= +# This means that, by default,= there is about 1 minute delay before the server
+# 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-k= eys"
++DH=3D"${sample_keys}/dh2= 048.pem"
+CA=3D&= quot;${sample_keys}/ca.crt"
+CLIENT_CERT=3D"${sample_keys}/client.crt"
= +CLIENT_KEY=3D"${sample_ke= ys}/client.key"
= +SERVER_CERT=3D"${sample_keys}/server.crt"
+SERVER_KEY=3D"${sample_keys}/server.= key"
+TA=3D"= ;${sample_keys}/ta.key"
+
+# Test ser= ver configurations
+M= AX_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 ${SERVER_KEY} --tls-auth ${TA} 0"
+SERVER_CONF_BASE=3D"${SERVER_BASE_OPTS} ${S= ERVER_CIPHER_OPTS} ${SERVER_CERT_OPTS}"
+
+TEST_SERVER_LIST=3D"1 2"
+
+SERVER_NAME_1=3D"t_server_null_server-1194_udp"
+SERVER_MGMT_PORT_1=3D"11194&qu= ot;

+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 --pr= oto tcp --management 127.0.0.1 ${SERVER_MGMT_PORT_2}"
+
+# Test client configurations
+CLIENT_EXEC=3D"${top_builddir}/src/openvp= n/openvpn"
+CLIE= NT_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_CERT_OPTS}"

+

+TEST_NAME_1=3D"t_server_null_client.sh-openvpn_cu= rrent_udp"
+SHOU= LD_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"
+
+TEST_NAME_2=3D"t_server_null_client.sh-openvpn_current_tcp"<= /span>
+SHOULD_PASS_2=3D&quo= t;yes"
+CLIENT_E= XEC_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_fail"
<= span style=3D"color: hsl(120, 100%, 40%);">+SHOULD_PASS_3=3D"no"<= /span>
+CLIENT_EXEC_3=3D&quo= t;${CLIENT_EXEC}"
+#!/usr/bin/env sh
+
+launch_server() {
+ server_name=3D$1
+ server_exec=3D$2
+ server_conf=3D$3
+ log=3D"${server_name}.log&quo= t;
+ status=3D&quo= t;${server_name}.status"
+ pid=3D"${server_name}.pid"
+
+ # Ensure that old status, log and pid files are gone=
+ rm -f "${status}&= quot; "${log}" "${pid}"
+
+ "${server_exec}" \
+ $server_conf \
+ --status "${status}" 1 \
<= span style=3D"color: hsl(120, 100%, 40%);">+ --log "${log}"= ; \

+ --writep= id "${pid}" \
+ --explicit-exit-notify 3
+
+}<= /span>
+
+# Load base/default configuration
+. "${srcdir}/t_serve= r_null_default.rc" || exit 1
+
+# Loa= d 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 serv= er_exec=3D\"\$SERVER_EXEC_$SUF\"
+ eval server_conf=3D\"\$SERVER_CONF_$SUF\&qu= ot;
+
+ (launch_server "${server_n= ame}" "${server_exec}" "${server_conf}")
+done
+
+# Create a list of server pid files so that servers can be kill= ed at the end of
+# t= he test run.
+#
+export server_pid_files= =3D""
+for = SUF in $TEST_SERVER_LIST
+do
+ eval ser= ver_name=3D\"\$SERVER_NAME_$SUF\"
+ server_pid_files=3D"${server_pid_files} ./= ${server_name}.pid"
+done
++# Wait until clients are no m= ore, 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
+ if ls t_server_null_client.sh*.pid > /dev/null 2= >&1
+ then<= /span>
+ count=3D0

+ sleep 1=
+ else
+ count=3D$(( count + 1))
+ sleep 1

+ fi
+done
+
+echo &qu= ot;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= }"

+
<= span style=3D"color: hsl(120, 100%, 40%);">+ # Make sure that the server= processes are truly dead before exiting

+ while :
+ do
+= ps -p "${SERVER_PID}" > /dev/null || break
<= span style=3D"color: hsl(120, 100%, 40%);">+ sleep 0.2

+ done

+done
diff --git a/tests/t_se= rver_null_stress.sh b/tests/t_server_null_stress.sh
new fil= e mode 100755
index 0000000..1281397
--- /d= ev/null
+++ b/tests/t_server_null_stress.sh
@@ -0,0 +1,33 @@

+#!= /usr/bin/env sh
+#
+# Run this stress test= as root to avoid sudo authorization from timing out.
+
+ITERATIONS=3D"${1:-100}"
+
+. ./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-c= heck"
+mkdir -p = "${LOG_BASEDIR}"
+
+count=3D0
+while [ $count -lt $IT= ERATIONS ]; do
+ c= ount=3D$(( count + 1 ))
+ make check TESTS=3Dt_server_null.sh SUBDIRS=3D > /dev/null 2>= &1
+ retval=3D= $?
+
+ echo "Iteration ${count}: r= eturn value ${retval}" >> "${LOG_BASEDIR}/make-check.log&qu= ot;
+ 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 '(suppr= ess|grep)' > "${DIR}/psaux"
+ 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: 3
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-MessageType: merged
--n6GWvUE403w=--