Changeset 4fb510d in mod_gnutls for test/common.bash

Timestamp:

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

Author:

Thomas Klute <thomas2.klute@…>

Branches:

debian/master, debian/stretch-backports, master, 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.

File:

• test/common.bash (modified) (1 diff)

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)"
 }