Test suite: new tests and code factoring.
[metze/ctdb/wip.git] / tests / scripts / ctdb_test_functions.bash
index bc660dbc23893315fcebd69619c43702b3a6455e..b84fe7224ef604390ecc9957f77828d4a0c98574 100644 (file)
@@ -8,8 +8,6 @@ fail ()
 
 ######################################################################
 
-#. /root/SOFS/autosofs/scripts/tester.bash
-
 ctdb_test_begin ()
 {
     local name="$1"
@@ -57,12 +55,40 @@ test_exit ()
 
 ctdb_test_exit ()
 {
-    if ! onnode 0 $TEST_WRAP cluster_is_healthy ; then
-       echo "Restarting ctdb on all nodes to get back into known state..."
+    local status=$?
+
+    trap - 0
+
+    [ $(($testfailures+0)) -eq 0 -a $status -ne 0 ] && testfailures=$status
+    status=$(($testfailures+0))
+
+    # Avoid making a test fail from this point onwards.  The test is
+    # now complete.
+    set +e
+
+    echo "*** TEST COMPLETE (RC=$status), CLEANING UP..."
+
+    eval "$ctdb_test_exit_hook" || true
+    unset ctdb_test_exit_hook
+
+    if $ctdb_test_restart_scheduled || ! cluster_is_healthy ; then
+
        restart_ctdb
+    else
+       # This could be made unconditional but then we might get
+       # duplication from the recovery in restart_ctdb.  We want to
+       # leave the recovery in restart_ctdb so that future tests that
+       # might do a manual restart mid-test will benefit.
+       echo "Forcing a recovery..."
+       onnode 0 ctdb recover
     fi
 
-    test_exit
+    exit $status
+}
+
+ctdb_test_exit_hook_add ()
+{
+    ctdb_test_exit_hook="${ctdb_test_exit_hook}${ctdb_test_exit_hook:+ ; }$*"
 }
 
 ctdb_test_run ()
@@ -130,8 +156,19 @@ ctdb_test_init ()
 {
     scriptname=$(basename "$0")
     testfailures=0
+    ctdb_test_restart_scheduled=false
 
     ctdb_test_cmd_options $@
+
+    trap "ctdb_test_exit" 0
+}
+
+ctdb_test_check_real_cluster ()
+{
+    [ -n "$CTDB_TEST_REAL_CLUSTER" ] && return 0
+
+    echo "ERROR: This test must be run on a real/virtual cluster, not local daemons."
+    return 1
 }
 
 ########################################
@@ -142,17 +179,24 @@ try_command_on_node ()
     local nodespec="$1" ; shift
 
     local verbose=false
-    if [ "$nodespec" = "-v" ] ; then
-       verbose=true
+    local onnode_opts=""
+
+    while [ "${nodespec#-}" != "$nodespec" ] ; do
+       if [ "$nodespec" = "-v" ] ; then
+           verbose=true
+       else
+           onnode_opts="$nodespec"
+       fi
        nodespec="$1" ; shift
-    fi
+    done
+
     local cmd="$*"
 
-    out=$(onnode -q "$nodespec" "$cmd" 2>&1) || {
+    out=$(onnode -q $onnode_opts "$nodespec" "$cmd" 2>&1) || {
 
        echo "Failed to execute \"$cmd\" on node(s) \"$nodespec\""
        echo "$out"
-       exit 1
+       return 1
     }
 
     if $verbose ; then
@@ -192,6 +236,49 @@ sanity_check_output ()
     return $ret
 }
 
+sanity_check_ips ()
+{
+    local ips="$1" # Output of "ctdb ip -n all"
+
+    echo "Sanity checking IPs..."
+
+    local x ipp prev
+    prev=""
+    while read x ipp ; do
+       [ "$ipp" = "-1" ] && break
+       if [ -n "$prev" -a "$ipp" != "$prev" ] ; then
+           echo "OK"
+           return 0
+       fi
+       prev="$ipp"
+    done <<<"$ips"
+
+    echo "BAD: a node was -1 or IPs are only assigned to one node"
+    echo "Are you running an old version of CTDB?"
+    return 1
+}
+
+select_test_node_and_ips ()
+{
+    try_command_on_node 0 "$CTDB ip -n all | sed -e '1d'"
+
+    # When selecting test_node we just want a node that has public
+    # IPs.  This will work and is economically semi-random.  :-)
+    local x
+    read x test_node <<<"$out"
+
+    test_node_ips=""
+    local ip pnn
+    while read ip pnn ; do
+       if [ "$pnn" = "$test_node" ] ; then
+            test_node_ips="${test_node_ips}${test_node_ips:+ }${ip}"
+       fi
+    done <<<"$out" # bashism to avoid problem setting variable in pipeline.
+
+    echo "Selected node ${test_node} with IPs: ${test_node_ips}."
+    test_ip="${test_node_ips%% *}"
+}
+
 #######################################
 
 # Wait until either timeout expires or command succeeds.  The command
@@ -201,14 +288,15 @@ wait_until ()
     local timeout="$1" ; shift # "$@" is the command...
 
     echo -n "<${timeout}|"
-    while [ $timeout -gt 0 ] ; do
+    local t=$timeout
+    while [ $t -gt 0 ] ; do
        if "$@" ; then
-           echo '|'
+           echo "|$(($timeout - $t))|"
            echo "OK"
            return 0
        fi
        echo -n .
-       timeout=$(($timeout - 1))
+       t=$(($t - 1))
        sleep 1
     done
     
@@ -246,12 +334,20 @@ _cluster_is_healthy ()
 
 cluster_is_healthy ()
 {
-    if _cluster_is_healthy ; then
+    if onnode 0 $CTDB_TEST_WRAPPER _cluster_is_healthy ; then
        echo "Cluster is HEALTHY"
-       exit 0
+       return 0
     else
        echo "Cluster is UNHEALTHY"
-       exit 1
+       if ! ${ctdb_test_restart_scheduled:-false} ; then
+           echo "DEBUG:"
+           local i
+           for i in "ctdb status" "onnode -q 0 onnode all ctdb scriptstatus" ; do
+               echo "$i"
+               $i || true
+           done
+       fi
+       return 1
     fi
 }
 
@@ -264,36 +360,51 @@ wait_until_healthy ()
     wait_until 120 _cluster_is_healthy
 }
 
-# Incomplete! Do not use!
+# This function is becoming nicely overloaded.  Soon it will collapse!  :-)
 node_has_status ()
 {
     local pnn="$1"
     local status="$2"
 
-    local bits
+    local bits fpat mpat
     case "$status" in
+       (unhealthy)    bits="?:?:?:1" ;;
+       (healthy)      bits="?:?:?:0" ;;
        (disconnected) bits="1:?:?:?" ;;
        (connected)    bits="0:?:?:?" ;;
        (banned)       bits="?:1:?:?" ;;
        (unbanned)     bits="?:0:?:?" ;;
        (disabled)     bits="?:?:1:?" ;;
        (enabled)      bits="?:?:0:?" ;;
+       (frozen)       fpat='^[[:space:]]+frozen[[:space:]]+1$' ;;
+       (unfrozen)     fpat='^[[:space:]]+frozen[[:space:]]+0$' ;;
+       (monon)        mpat='^Monitoring mode:ACTIVE \(0\)$' ;;
+       (monoff)       mpat='^Monitoring mode:DISABLED \(1\)$' ;;
        *)
            echo "node_has_status: unknown status \"$status\""
            return 1
     esac
 
-    local out x line
+    if [ -n "$bits" ] ; then
+       local out x line
 
-    out=$(ctdb -Y status 2>&1) || return 1
+       out=$(ctdb -Y status 2>&1) || return 1
 
-    {
-        read x
-        while read line ; do
-           [ "${line#:${pnn}:*:${bits}:}" = "" ] && return 0
-        done
+       {
+            read x
+            while read line ; do
+               [ "${line#:${pnn}:*:${bits}:}" = "" ] && return 0
+            done
+           return 1
+       } <<<"$out" # Yay bash!
+    elif [ -n "$fpat" ] ; then
+       ctdb statistics -n "$pnn" | egrep -q "$fpat"
+    elif [ -n "$mpat" ] ; then
+       ctdb getmonmode -n "$pnn" | egrep -q "$mpat"
+    else
+       echo 'node_has_status: unknown mode, neither $bits nor $fpat is set'
        return 1
-    } <<<"$out" # Yay bash!
+    fi
 }
 
 wait_until_node_has_status ()
@@ -341,7 +452,136 @@ wait_until_ips_are_on_nodeglob ()
     wait_until 60 ips_are_on_nodeglob "$@"
 }
 
-stop_daemons ()
+get_src_socket ()
+{
+    local proto="$1"
+    local dst_socket="$2"
+    local pid="$3"
+    local prog="$4"
+
+    local pat="^${proto}[[:space:]]+[[:digit:]]+[[:space:]]+[[:digit:]]+[[:space:]]+[^[:space:]]+[[:space:]]+${dst_socket//./\\.}[[:space:]]+ESTABLISHED[[:space:]]+${pid}/${prog}[[:space:]]*\$"
+    out=$(netstat -tanp |
+       egrep "$pat" |
+       awk '{ print $4 }')
+
+    [ -n "$out" ]
+}
+
+wait_until_get_src_socket ()
+{
+    local proto="$1"
+    local dst_socket="$2"
+    local pid="$3"
+    local prog="$4"
+
+    echo "Waiting for ${prog} to establish connection to ${dst_socket}..."
+
+    wait_until 5 get_src_socket "$@"
+}
+
+#######################################
+
+# filename will be in $tcpdump_filename, pid in $tcpdump_pid
+tcpdump_start ()
+{
+    tcpdump_filter="$1" # global
+
+    echo "Running tcpdump..."
+    tcpdump_filename=$(mktemp)
+    ctdb_test_exit_hook_add "rm -f $tcpdump_filename"
+
+    # The only way of being sure that tcpdump is listening is to send
+    # some packets that it will see.  So we use dummy pings - the -U
+    # option to tcpdump ensures that packets are flushed to the file
+    # as they are captured.
+    local dummy_addr="127.3.2.1"
+    local dummy="icmp and dst host ${dummy_addr} and icmp[icmptype] == icmp-echo"
+    tcpdump -n -p -s 0 -e -U -w $tcpdump_filename -i any "($tcpdump_filter) or ($dummy)" &
+    ctdb_test_exit_hook_add "kill $! >/dev/null 2>&1"
+
+    echo "Waiting for tcpdump output file to be ready..."
+    ping -q "$dummy_addr" >/dev/null 2>&1 &
+    ctdb_test_exit_hook_add "kill $! >/dev/null 2>&1"
+
+    tcpdump_listen_for_dummy ()
+    {
+       tcpdump -n -r $tcpdump_filename -c 1 "$dummy" >/dev/null 2>&1
+    }
+
+    wait_until 10 tcpdump_listen_for_dummy
+}
+
+# By default, wait for 1 matching packet.
+tcpdump_wait ()
+{
+    local count="${1:-1}"
+    local filter="${2:-${tcpdump_filter}}"
+
+    tcpdump_check ()
+    {
+       local found=$(tcpdump -n -r $tcpdump_filename "$filter" 2>/dev/null | wc -l)
+       [ $found -ge $count ]
+    }
+
+    echo "Waiting for tcpdump to capture some packets..."
+    if ! wait_until 30 tcpdump_check ; then
+       echo "DEBUG:"
+       local i
+       for i in "ctdb status" "netstat -tanp" "tcpdump -n -e -r $tcpdump_filename" ; do
+           echo "$i"
+           $i || true
+       done
+       return 1
+    fi
+}
+
+tcpdump_show ()
+{
+    local filter="${1:-${tcpdump_filter}}"
+
+    tcpdump -n -r $tcpdump_filename  "$filter" 2>/dev/null
+}
+
+tcptickle_sniff_start ()
+{
+    local src="$1"
+    local dst="$2"
+
+    local in="src host ${dst%:*} and tcp src port ${dst##*:} and dst host ${src%:*} and tcp dst port ${src##*:}"
+    local out="src host ${src%:*} and tcp src port ${src##*:} and dst host ${dst%:*} and tcp dst port ${dst##*:}"
+    local tickle_ack="${in} and (tcp[tcpflags] & tcp-ack != 0) and (tcp[14] == 4) and (tcp[15] == 210)" # win == 1234
+    local ack_ack="${out} and (tcp[tcpflags] & tcp-ack != 0)"
+    tcptickle_reset="${in} and tcp[tcpflags] & tcp-rst != 0"
+    local filter="(${tickle_ack}) or (${ack_ack}) or (${tcptickle_reset})"
+
+    tcpdump_start "$filter"
+}
+
+tcptickle_sniff_wait_show ()
+{
+    tcpdump_wait 1 "$tcptickle_reset"
+
+    echo "GOOD: here are some TCP tickle packets:"
+    tcpdump_show
+}
+
+gratarp_sniff_start ()
+{
+    tcpdump_start "arp host ${test_ip}"
+}
+
+gratarp_sniff_wait_show ()
+{
+    tcpdump_wait 2
+
+    echo "GOOD: this should be the some gratuitous ARPs:"
+    tcpdump_show
+}
+
+
+#######################################
+
+daemons_stop ()
 {
     echo "Attempting to politely shutdown daemons..."
     onnode 1 ctdb shutdown -n all || true
@@ -349,24 +589,23 @@ stop_daemons ()
     echo "Sleeping for a while..."
     sleep_for 1
 
-    if pidof $CTDB_DIR/bin/ctdbd >/dev/null ; then
+    if pgrep -f $CTDB_DIR/bin/ctdbd >/dev/null ; then
        echo "Killing remaining daemons..."
-       killall $CTDB_DIR/bin/ctdbd
+       pkill -f $CTDB_DIR/bin/ctdbd
 
-       if pidof $CTDB_DIR/bin/ctdbd >/dev/null ; then
+       if pgrep -f $CTDB_DIR/bin/ctdbd >/dev/null ; then
            echo "Once more with feeling.."
-           killall -9 $CTDB_DIR/bin/ctdbd
+           pkill -9 $CTDB_DIR/bin/ctdbd
        fi
     fi
 
-    var_dir=$CTDB_DIR/tests/var
+    local var_dir=$CTDB_DIR/tests/var
     rm -rf $var_dir/test.db
 }
 
-start_daemons ()
+daemons_setup ()
 {
     local num_nodes="${1:-2}" # default is 2 nodes
-    shift # "$@" gets passed to ctdbd
 
     local var_dir=$CTDB_DIR/tests/var
 
@@ -374,7 +613,14 @@ start_daemons ()
 
     local nodes=$var_dir/nodes.txt
     local public_addresses=$var_dir/public_addresses.txt
-    rm -f $nodes $public_addresses
+    local no_public_addresses=$var_dir/no_public_addresses.txt
+    rm -f $nodes $public_addresses $no_public_addresses
+
+    # If there are (strictly) greater than 2 nodes then we'll randomly
+    # choose a node to have no public addresses.
+    local no_public_ips=-1
+    [ $num_nodes -gt 2 ] && no_public_ips=$(($RANDOM % $num_nodes))
+    echo "$no_public_ips" >$no_public_addresses
 
     local i
     for i in $(seq 1 $num_nodes) ; do
@@ -383,28 +629,58 @@ start_daemons ()
            ip addr add ::$i/128 dev lo
        else
            echo 127.0.0.$i >> $nodes
-           # 2 public addresses per node, just to make things interesting.
-           echo "192.0.2.$i/24 lo" >> $public_addresses
-           echo "192.0.2.$(($i + $num_nodes))/24 lo" >> $public_addresses
+           # 2 public addresses on most nodes, just to make things interesting.
+           if [ $(($i - 1)) -ne $no_public_ips ] ; then
+               echo "192.0.2.$i/24 lo" >> $public_addresses
+               echo "192.0.2.$(($i + $num_nodes))/24 lo" >> $public_addresses
+           fi
        fi
     done
+}
+
+daemons_start ()
+{
+    local num_nodes="${1:-2}" # default is 2 nodes
+    shift # "$@" gets passed to ctdbd
+
+    local var_dir=$CTDB_DIR/tests/var
 
-    local ctdb_options="--reclock=$var_dir/rec.lock --nlist $nodes --public-addresses $public_addresses --nopublicipcheck --event-script-dir=tests/events.d --logfile=$var_dir/daemons.log -d 0 --dbdir=$var_dir/test.db --dbdir-persistent=$var_dir/test.db/persistent"
+    local nodes=$var_dir/nodes.txt
+    local public_addresses=$var_dir/public_addresses.txt
+    local no_public_addresses=$var_dir/no_public_addresses.txt
+
+    local no_public_ips=-1
+    [ -r $no_public_addresses ] && read no_public_ips <$no_public_addresses
+
+    local ctdb_options="--reclock=$var_dir/rec.lock --nlist $nodes --nopublicipcheck --event-script-dir=$CTDB_DIR/tests/events.d --logfile=$var_dir/daemons.log -d 0 --dbdir=$var_dir/test.db --dbdir-persistent=$var_dir/test.db/persistent"
 
     echo "Starting $num_nodes ctdb daemons..."
-    for i in $(seq 1 $num_nodes) ; do
+    if  [ "$no_public_ips" != -1 ] ; then
+       echo "Node $no_public_ips will have no public IPs."
+    fi
+
+    for i in $(seq 0 $(($num_nodes - 1))) ; do
        if [ $(id -u) -eq 0 ]; then
             ctdb_options="$ctdb_options --public-interface=lo"
        fi
 
-       $VALGRIND bin/ctdbd --socket=$var_dir/sock.$i $ctdb_options "$@" || return 1
+       if [ $i -eq $no_public_ips ] ; then
+           ctdb_options="$ctdb_options --public-addresses=/dev/null"
+       else
+           ctdb_options="$ctdb_options --public-addresses=$public_addresses"
+       fi
+
+       # Need full path so we can use "pkill -f" to kill the daemons.
+       $VALGRIND $CTDB_DIR/bin/ctdbd --socket=$var_dir/sock.$i $ctdb_options "$@" ||return 1
     done
 
     if [ -L /tmp/ctdb.socket -o ! -S /tmp/ctdb.socket ] ; then 
-       ln -sf $var_dir/sock.1 /tmp/ctdb.socket || return 1
+       ln -sf $var_dir/sock.0 /tmp/ctdb.socket || return 1
     fi
 }
 
+#######################################
+
 _restart_ctdb ()
 {
     if [ -e /etc/redhat-release ] ; then
@@ -414,23 +690,83 @@ _restart_ctdb ()
     fi
 }
 
-restart_ctdb ()
+setup_ctdb ()
 {
     if [ -n "$CTDB_NODES_SOCKETS" ] ; then
-       stop_daemons
-       start_daemons $CTDB_NUM_NODES
-    else
-       onnode -pq all $TEST_WRAP _restart_ctdb 
-    fi || return 1
+       daemons_setup $CTDB_TEST_NUM_DAEMONS
+    fi
+}
+
+restart_ctdb ()
+{
+    echo -n "Restarting CTDB"
+    if $ctdb_test_restart_scheduled ; then
+       echo -n " (scheduled)"
+    fi
+    echo "..."
+    
+    local i
+    for i in $(seq 1 5) ; do
+       if [ -n "$CTDB_NODES_SOCKETS" ] ; then
+           daemons_stop
+           daemons_start $CTDB_TEST_NUM_DAEMONS
+       else
+           onnode -p all $CTDB_TEST_WRAPPER _restart_ctdb 
+       fi && break
+
+       echo "That didn't seem to work - sleeping a while and trying again..."
+       sleep_for 5
+    done
        
-    onnode -q 1  $TEST_WRAP wait_until_healthy || return 1
+    onnode -q 1  $CTDB_TEST_WRAPPER wait_until_healthy || return 1
 
     echo "Setting RerecoveryTimeout to 1"
     onnode -pq all "ctdb setvar RerecoveryTimeout 1"
 
-    #echo "Sleeping to allow ctdb to settle..."
-    #sleep_for 10
+    # In recent versions of CTDB, forcing a recovery like this blocks
+    # until the recovery is complete.  Hopefully this will help the
+    # cluster to stabilise before a subsequent test.
+    echo "Forcing a recovery..."
+    onnode -q 0 ctdb recover
+    sleep_for 1
+    echo "Forcing a recovery..."
+    onnode -q 0 ctdb recover
 
     echo "ctdb is ready"
 }
 
+ctdb_restart_when_done ()
+{
+    ctdb_test_restart_scheduled=true
+}
+
+#######################################
+
+install_eventscript ()
+{
+    local script_name="$1"
+    local script_contents="$2"
+
+    if [ -n "$CTDB_TEST_REAL_CLUSTER" ] ; then
+       # The quoting here is *very* fragile.  However, we do
+       # experience the joy of installing a short script using
+       # onnode, and without needing to know the IP addresses of the
+       # nodes.
+       onnode all "f=\"\${CTDB_BASE:-/etc/ctdb}/events.d/${script_name}\" ; echo \"Installing \$f\" ; echo '${script_contents}' > \"\$f\" ; chmod 755 \"\$f\""
+    else
+       f="${CTDB_DIR}/tests/events.d/${script_name}"
+       echo "$script_contents" >"$f"
+       chmod 755 "$f"
+    fi
+}
+
+uninstall_eventscript ()
+{
+    local script_name="$1"
+
+    if [ -n "$CTDB_TEST_REAL_CLUSTER" ] ; then
+       onnode all "rm -vf \"\${CTDB_BASE:-/etc/ctdb}/events.d/${script_name}\""
+    else
+       rm -vf "${CTDB_DIR}/tests/events.d/${script_name}"
+    fi
+}