Changeset 4fb510d in mod_gnutls

Timestamp:

Mar 5, 2017, 11:55:51 AM (6 years ago)

Author:

Thomas Klute <thomas2.klute@…>

Branches:

asyncio, debian/master, debian/stretch-backports, main, master, proxy-ticket, upstream

Children:

339a49d

Parents:

5f3222b

Message:

Test suite: Add generic function to wait for a command to succeed

The command is retried with a configurable wait time until it
succeeds, or a timeout expires. This is intended to wait for a service
to become ready, e.g. the OCSP responder or MSVA service used in
tests.

The MSVA and OCSP responder availability tests are modified to use the
new function.

Location:

test

Files:

• Makefile.am (modified) (2 diffs)
• common.bash (modified) (1 diff)
• runtests (modified) (3 diffs)

test/Makefile.am

@@ -209 +209 @@
 endif
 # maximum time to wait for MSVA startup (milliseconds)
-TEST_MSVA_MAX_WAIT ?= 10000
+TEST_SERVICE_MAX_WAIT ?= 10000
 # wait loop time for MSVA startup (milliseconds)
-TEST_MSVA_WAIT ?= 400
+TEST_SERVICE_WAIT ?= 400
 
 AM_TESTS_ENVIRONMENT = export APACHE2=@APACHE2@; \
@@ -219 +219 @@
         export TEST_PORT="$(TEST_PORT)"; \
         export MSVA_PORT="$(MSVA_PORT)"; \
-        export TEST_MSVA_MAX_WAIT="$(TEST_MSVA_MAX_WAIT)"; \
-        export TEST_MSVA_WAIT="$(TEST_MSVA_WAIT)"; \
+        export TEST_SERVICE_MAX_WAIT="$(TEST_SERVICE_MAX_WAIT)"; \
+        export TEST_SERVICE_WAIT="$(TEST_SERVICE_WAIT)"; \
         export TEST_QUERY_TIMEOUT="@TEST_QUERY_TIMEOUT@"; \
         export BACKEND_HOST="@TEST_HOST@"; \

test/common.bash

@@ -15 +15 @@
         sleep 1
     done
+}
+
+
+
+# Usage: verbose_log [...]
+#
+# If VERBOSE is not empty, write a log message prefixed with the name
+# of the calling function. The function is defined to a no-op
+# otherwise.
+if [ -n "${VERBOSE}" ]; then
+    function verbose_log
+    {
+        echo "${FUNCNAME[1]}: ${@}"
+    }
+else
+    function verbose_log
+    {
+        return
+    }
+fi
+
+
+
+# Usage: wait_ready COMMAND [TIMEOUT] [STEP]
+#
+# Wait until COMMAND terminates with success (zero exit code), or
+# until the TIMEOUT (in milliseconds) expires. TIMEOUT defaults to
+# $TEST_SERVICE_MAX_WAIT if unset. A TIMEOUT of zero means to try
+# once.
+#
+# COMMAND is retried every STEP milliseconds, the default is
+# $TEST_SERVICE_WAIT. Note that the last try may happen a little after
+# TIMEOUT expires if STEP does not evenly divide it.
+function wait_ready
+{
+    local command="${1}"
+    if [ -z "${2}" ]; then
+        local -i timeout="${TEST_SERVICE_MAX_WAIT}"
+    else
+        local -i timeout="${2}"
+    fi
+    local -i step="${3}"
+    [ ${step} -gt 0 ] || step="${TEST_SERVICE_WAIT}"
+    # convert step to seconds because that's what "sleep" needs
+    local sec_step="$((${step} / 1000)).$((${step} % 1000))"
+
+    verbose_log "Waiting for \"${command}\" ..."
+    local -i waited=0
+    until eval "${command}"; do
+        if [ "${waited}" -ge "${timeout}" ]; then
+            echo "${FUNCNAME[0]}: Timed out waiting for \"${command}\"" \
+                 "to succeed (waited ${waited} ms)." >&2
+            return 1
+        fi
+        waited=$((waited + step));
+        sleep "${sec_step}"
+        verbose_log "waiting (${waited} ms)"
+    done
+    verbose_log "done (waited ${waited} ms)"
 }
 

test/runtests

@@ -19 +19 @@
 
 BADVARS=0
-for v in APACHE2 TEST_HOST TEST_PORT TEST_QUERY_TIMEOUT TEST_MSVA_WAIT \
+for v in APACHE2 TEST_HOST TEST_PORT TEST_QUERY_TIMEOUT TEST_SERVICE_WAIT \
                  MSVA_PORT; do
     if [ ! -v "$v" ]; then
@@ -127 +127 @@
 
     printf "TESTING: initial MSVA verification\n"
-    # set to 0 if MSVA is up
-    ret=1
     export MONKEYSPHERE_VALIDATION_AGENT_SOCKET="http://127.0.0.1:$MSVA_PORT"
 
-    # convert TEST_MSVA_WAIT to seconds because that's what "sleep" expects
-    TEST_MSVA_SLEEP="$((${TEST_MSVA_WAIT} / 1000)).$((${TEST_MSVA_WAIT} % 1000))"
-    # wait at most TEST_MSVA_MAX_WAIT milliseconds for MSVA to get ready
-    waited=0
-    until [ ${ret} -eq 0 ] \
-              || [ ${waited} -ge ${TEST_MSVA_MAX_WAIT} ]; do
-        if msva-query-agent https "$(cat client.uid)" x509pem client < client/x509.pem
-        then
-            ret=0
-        else
-            echo "MSVA not ready yet"
-        fi
-        sleep "${TEST_MSVA_SLEEP}"
-        waited=$((${waited} + ${TEST_MSVA_WAIT}))
-    done
-
+    msva_test_cmd="msva-query-agent https \"$(cat client.uid)\" x509pem client < client/x509.pem"
     # check if MSVA is up, fail if not
-    if [ ${ret} -eq 0 ]; then
+    if wait_ready "${msva_test_cmd}"; then
         printf "\nSUCCESS: initial MSVA verification\n"
     else
@@ -207 +190 @@
     fi
     echo "---- Testing OCSP server ----"
-    ocsptool --ask --nonce --load-issuer authority/x509.pem --load-cert server/x509.pem ${store_ocsp}
+    wait_ready "ocsptool --ask --nonce --load-issuer authority/x509.pem --load-cert server/x509.pem ${store_ocsp}"
     echo "---- OCSP test done ----"
 fi