[tor-commits] [chutney/master] Implement an "allow failures" feature in test-network.sh

[teor at torproject.org]

commit ea4af7b764ac36cc41de95f21894ed4120abd187
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Mar 12 08:57:34 2019 -0400

    Implement an "allow failures" feature in test-network.sh
    
    You can either set CHUTNEY_ALLOW_FAILURES or use an --allow-failures
    command-line option to control this.  Chutney will then reattempt the
    test, from bootstrap through shutdown, until either it succeeds, or
    until it has failed $CHUTNEY_ALLOW_FAILURES+1 times.
    
    The default value is zero, so that default behavior will not change.
---
 tools/test-network.sh | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/tools/test-network.sh b/tools/test-network.sh
index b430694..f28acea 100755
--- a/tools/test-network.sh
+++ b/tools/test-network.sh
@@ -15,6 +15,9 @@ export CHUTNEY_WARNINGS_SUMMARY=${CHUTNEY_WARNINGS_SUMMARY:-true}
 # default to exiting when this script exits
 export CHUTNEY_CONTROLLING_PID=${CHUTNEY_CONTROLLING_PID:-$$}
 
+# default to allowing zero failures
+export CHUTNEY_ALLOW_FAILURES=${CHUTNEY_ALLOW_FAILURES:-0}
+
 # default to no DNS: this is a safe, working default for most users
 # If a custom test expects DNS, it needs to set CHUTNEY_DNS_CONF
 export CHUTNEY_DNS_CONF=${CHUTNEY_DNS_CONF:-/dev/null}
@@ -158,6 +161,11 @@ do
             export CHUTNEY_DATA_DIR="$2"
             shift
             ;;
+        # How many failures should we allow? Defaults to 0.
+        --allow-failures)
+            export CHUTNEY_ALLOW_FAILURES="$2"
+            shift
+            ;;
         # Try not to say anything (applies only to this script)
         --quiet)
             export ECHO=true
@@ -333,4 +341,17 @@ if [ "$NETWORK_DRY_RUN" = true ] || [ "$CHUTNEY_WARNINGS_ONLY" = true ]; then
     exit 0
 fi
 
-exec "$CHUTNEY_PATH/tools/test-network-impl.sh"
+n_attempts=0
+max_attempts=$((CHUTNEY_ALLOW_FAILURES+1))
+
+while [ "$n_attempts" -lt "$max_attempts" ]; do
+    n_attempts=$((n_attempts+1))
+    $ECHO "==== Running tests: attempt $n_attempts/$max_attempts"
+    if "$CHUTNEY_PATH/tools/test-network-impl.sh"; then
+	$ECHO "==== Chutney succeeded after $n_attempts attempt(s)."
+	exit 0
+    fi
+done
+
+$ECHO "Chutney failed $n_attempts times; we may have a problem here."
+exit 1