chiark / gitweb /
server/tests.at: Refactor communications test stuff.
authorMark Wooding <mdw@distorted.org.uk>
Wed, 25 Jan 2012 23:59:07 +0000 (23:59 +0000)
committerMark Wooding <mdw@distorted.org.uk>
Wed, 1 Feb 2012 22:57:33 +0000 (22:57 +0000)
More exciting testing will want many of the same hacks.

Also improve the handling of race conditions which may issue warnings:
annotate the server log with custom warnings which instruct a filter to
strip out expected warning messages.

server/tests.at

index 188d650..649ff82 100644 (file)
@@ -48,8 +48,15 @@ m4_define([P32], [21 26 14 12 25 18  2 27 10 31 24 29  0 20 17 11   dnl
 ###--------------------------------------------------------------------------
 ### Scaffolding for running a TrIPE server.
 
 ###--------------------------------------------------------------------------
 ### Scaffolding for running a TrIPE server.
 
+## WITH_TRIPEX(dir, args, body)
 m4_define([WITH_TRIPEX], [
 
 m4_define([WITH_TRIPEX], [
 
+## If this directory doesn't exist then Bad Things will happen.
+if test ! -d $1; then
+  echo >&2 "server directory \`$1' doesn't exist"
+  exit 99
+fi
+
 ## Remove the status file.  This is how we notice that the server's died.
 rm -f $1/server-status
 > $1/expected-server-output
 ## Remove the status file.  This is how we notice that the server's died.
 rm -f $1/server-status
 > $1/expected-server-output
@@ -67,6 +74,10 @@ exec 1>&3 3>&-
 ## not sleep for ages.  (Yes, a second on each test group is a long time.)
 while test ! -r $1/server-status && test ! -S $1/admin; do :; done
 
 ## not sleep for ages.  (Yes, a second on each test group is a long time.)
 while test ! -r $1/server-status && test ! -S $1/admin; do :; done
 
+## Make the port number availale.
+AT_CHECK([TRIPECTL -d$1 PORT],, [stdout])
+mv stdout $1/port
+
 ## Test body...
 $3
 
 ## Test body...
 $3
 
@@ -82,12 +93,68 @@ $3
   (cd strace-hack/
    ulimit -c hard >/dev/null 2>&1
    strace -f -o ../tripe.trace \
   (cd strace-hack/
    ulimit -c hard >/dev/null 2>&1
    strace -f -o ../tripe.trace \
-     TRIPE -d.. $2 >../server-output 2>../server-errors)
+     TRIPE -d.. $2 >../server-output.full 2>../server-errors)
   stat=$?
   echo $stat >server-status
   if test $stat -ne 0; then
     echo "exit status: $stat" >>server-errors
   fi
   stat=$?
   echo $stat >server-status
   if test $stat -ne 0; then
     echo "exit status: $stat" >>server-errors
   fi
+
+  ## We interrupt this relatively sensible macro for an especially awful
+  ## hack.  The tripe server emits warnings which are often caused by lack of
+  ## synchronization between two peers.  These are harmless and shouldn't
+  ## cause test failures.  But we shouldn't just trim out all messages that
+  ## look like the spurious ones: if they appear when we're not expecting
+  ## them, that's bad and they should properly cause a test failure.
+  ##
+  ## So we use the WARN command to insert magic directives into the server's
+  ## message stream.  The directives begin with `WARN USER test'; remaining
+  ## tokens may be as follows.
+  ##
+  ## PUSH              Introduce a new layer of nesting.  Settings between
+  ##                   this PUSH and the matching POP will be forgotten
+  ##                   following the POP.
+  ##
+  ## POP               End a layer of nesting.  See PUSH above.
+  ##
+  ## IGNORE tokens     Ignore lines which begin with the tokens.
+  ##
+  ## Token comparison isn't done very well, but it's good enough for these
+  ## purposes.
+  ##
+  ## We also trim out trace lines here, since it's useful to produce them for
+  ## debugging purposes and changing or introducing more of them shouldn't
+  ## cause failures.
+  awk '
+       BEGIN {
+         sp = 0;
+         npat = 0;
+       }
+       $[]1 == "TRACE" { next; }
+       $[]1 == "WARN" && $[]2 == "USER" && $[]3 == "test" {
+         if ($[]4 == "PUSH")
+           npatstk[[sp++]] = npat;
+         else if ($[]4 == "IGNORE") {
+           s = "";
+           p = "";
+           for (i = 5; i <= NF; i++) {
+             p = p s $[]i;
+             s = " ";
+           }
+           pat[[npat++]] = p;
+         } else if ($[]4 == "POP")
+           npat = npatstk[[--sp]];
+         next;
+       }
+       {
+         for (i = 0; i < npat; i++) {
+           n = length(pat[[i]]);
+           if (substr($[]0, 0, n) == pat[[i]])
+             next;
+         }
+         print $[]0;
+       }
+  ' server-output.full >server-output
 }
 exec 3>&-
 
 }
 exec 3>&-
 
@@ -98,11 +165,80 @@ AT_CHECK([cat $1/server-output; cat >&2 $1/server-errors],,
         [expout], [experr])
 ])
 
         [expout], [experr])
 ])
 
+## WITH_TRIPE(args, body)
 m4_define([WITH_TRIPE], [WITH_TRIPEX([.], [$1], [$2])])
 
 m4_define([WITH_TRIPE], [WITH_TRIPEX([.], [$1], [$2])])
 
+## WITH_2TRIPES(adir, bdir, bothargs, aargs, bargs, body)
 m4_define([WITH_2TRIPES],
          [WITH_TRIPEX([$1], [$3 $4], [WITH_TRIPEX([$2], [$3 $5], [$6])])])
 
 m4_define([WITH_2TRIPES],
          [WITH_TRIPEX([$1], [$3 $4], [WITH_TRIPEX([$2], [$3 $5], [$6])])])
 
+## COMMS_EPING(adir, aname, bdir, bname)
+m4_define([COMMS_EPING], [
+  AT_CHECK([TRIPECTL -d$1 EPING $4],, [ignore])
+  AT_CHECK([TRIPECTL -d$3 EPING $2],, [ignore])
+])
+
+## COMMS_SLIP(adir, aname, bdir, bname)
+m4_define([COMMS_SLIP], [
+  AT_CHECK([echo "from $1" | USLIP -p $1/$4])
+  AT_CHECK([USLIP -g $3/$2],, [from $1[]nl])
+  AT_CHECK([echo "from $3" | USLIP -p $3/$2])
+  AT_CHECK([USLIP -g $1/$4],, [from $3[]nl])
+])
+
+## AWAIT_KXDONE(adir, aname, bdir, bname, body)
+m4_define([AWAIT_KXDONE], [
+
+  ## Ignore some reports caused by races.
+  TRIPECTL -d$3 WARN test PUSH
+  TRIPECTL -d$3 WARN test IGNORE WARN KX $2 incorrect cookie
+  TRIPECTL -d$3 WARN test IGNORE WARN KX $2 unexpected pre-challenge
+
+  ## Watch for the key-exchange completion announcement in the background.
+  COPROCESSES([wait-$1], [
+    echo WATCH +n
+    while read line; do
+      set x $line; shift
+      echo >&2 ">>> $line"
+      case "$[]1:$[]2:$[]3" in
+       OK::) ;;
+       NOTE:KXDONE:$4) break ;;
+       NOTE:*) ;;
+       *) exit 63 ;;
+      esac
+    done
+  ], [
+    TRIPECTL -d$1
+  ]) & waiter_$1=$!
+
+  $5
+
+  ## Collect the completion announcement.
+  wait $waiter_$1; waitrc=$?
+  AT_CHECK([echo $waitrc],, [0[]nl])
+
+  ## Be interested in key-exchange warnings again.
+  TRIPECTL -d$4 WARN test POP
+])
+
+## ESTABLISH(adir, aname, aopts, bdir, bname, bopts)
+m4_define([ESTABLISH], [
+
+  ## Set up the establishment.
+  AWAIT_KXDONE([$1], [$2], [$4], [$5], [
+    AT_CHECK([TRIPECTL -d$1 ADD -cork $6 $5 INET 127.0.0.1 $(cat $4/port)])
+    AT_CHECK([TRIPECTL -d$4 ADD $3 $2 INET 127.0.0.1 $(cat $1/port)])
+  ])
+
+  ## Check transport pinging.
+  AT_CHECK([TRIPECTL -d$1 PING $5],, [ignore])
+  AT_CHECK([TRIPECTL -d$4 PING $2],, [ignore])
+
+  ## Check communication works.
+  COMMS_EPING([$1], [$2], [$4], [$5])
+  COMMS_SLIP([$1], [$2], [$4], [$5])
+])
+
 ###--------------------------------------------------------------------------
 ### Very unpleasant coprocess handling.
 
 ###--------------------------------------------------------------------------
 ### Very unpleasant coprocess handling.
 
@@ -205,53 +341,8 @@ export TRIPE_SLIPIF=USLIP
 for i in alice bob; do (mkdir $i; cd $i; SETUPDIR([ec])); done
 
 WITH_2TRIPES([alice], [bob], [-nslip], [-talice], [-tbob], [
 for i in alice bob; do (mkdir $i; cd $i; SETUPDIR([ec])); done
 
 WITH_2TRIPES([alice], [bob], [-nslip], [-talice], [-tbob], [
-
-  AT_CHECK([TRIPECTL -dalice PORT],, [stdout])
-  mv stdout alice/port
-
-  AT_CHECK([TRIPECTL -dbob PORT],, [stdout])
-  mv stdout bob/port
-
-  ## Watch for the key-exchange completion announcement, and then exit.
-  COPROCESSES([wait], [
-    echo WATCH +n
-    while read line; do
-      case "$line" in
-       OK) ;;
-       "NOTE KXDONE "*) break ;;
-       NOTE*) ;;
-       *) exit 63 ;;
-      esac
-    done
-  ], [
-    TRIPECTL -dalice
-  ]) &
-
-  ## Don't panic if you don't see the unexpected-source warning.  It happens
-  ## for me, but it's not important either way.
-  AT_CHECK([TRIPECTL -dalice ADD bob INET 127.0.0.1 $(cat bob/port)])
-  echo >>bob/expected-server-output \
-    "WARN PEER - unexpected-source INET 127.0.0.1 $(cat alice/port)"
-  AT_CHECK([TRIPECTL -dbob ADD -key alice not-alice \
-                              INET 127.0.0.1 $(cat alice/port)])
-
-  ## Check transport pinging.
-  AT_CHECK([TRIPECTL -dalice PING bob],, [ignore])
-  AT_CHECK([TRIPECTL -dbob PING not-alice],, [ignore])
-
-  ## Wait for the completion announcement.
-  wait
-
-  ## Check encrypted pinging.
-  AT_CHECK([TRIPECTL -dalice EPING bob],, [ignore])
-  AT_CHECK([TRIPECTL -dbob EPING not-alice],, [ignore])
-
-  ## Check that packets can flow from one to the other.
-  AT_CHECK([echo "from alice" | USLIP -p alice/bob])
-  AT_CHECK([USLIP -g bob/not-alice],, [from alice[]nl])
-
-  AT_CHECK([echo "from bob" | USLIP -p bob/not-alice])
-  AT_CHECK([USLIP -g alice/bob],, [from bob[]nl])
+  ESTABLISH([alice], [not-alice], [-key alice],
+           [bob], [bob], [])
 ])
 
 AT_CLEANUP
 ])
 
 AT_CLEANUP