1 # Hey Emacs, this is a -*- shell-script -*- !!! :-)
3 # Augment PATH with relevant stubs/ directories. We do this by actually
4 # setting PATH, and also by setting $EVENTSCRIPTS_PATH and then
5 # prepending that to $PATH in rc.local to avoid the PATH reset in
10 if [ -d "${TEST_SUBDIR}/stubs" ] ; then
11 EVENTSCRIPTS_PATH="${TEST_SUBDIR}/stubs"
14 export EVENTSCRIPTS_PATH
16 PATH="${EVENTSCRIPTS_PATH}:${PATH}"
18 export EVENTSCRIPTS_TESTS_VAR_DIR="${TEST_VAR_DIR}/unit_eventscripts"
19 if [ -d "$EVENTSCRIPTS_TESTS_VAR_DIR" -a \
20 "$EVENTSCRIPTS_TESTS_VAR_DIR" != "/unit_eventscripts" ] ; then
21 rm -r "$EVENTSCRIPTS_TESTS_VAR_DIR"
23 mkdir -p "$EVENTSCRIPTS_TESTS_VAR_DIR"
24 export CTDB_VARDIR="$EVENTSCRIPTS_TESTS_VAR_DIR/ctdb"
26 if [ -d "${TEST_SUBDIR}/etc" ] ; then
27 cp -a "${TEST_SUBDIR}/etc" "$EVENTSCRIPTS_TESTS_VAR_DIR"
28 export CTDB_ETCDIR="${EVENTSCRIPTS_TESTS_VAR_DIR}/etc"
30 die "Unable to setup \$CTDB_ETCDIR"
33 if [ -d "${TEST_SUBDIR}/etc-ctdb" ] ; then
34 cp -prL "${TEST_SUBDIR}/etc-ctdb" "$EVENTSCRIPTS_TESTS_VAR_DIR"
35 export CTDB_BASE="${EVENTSCRIPTS_TESTS_VAR_DIR}/etc-ctdb"
37 die "Unable to set \$CTDB_BASE"
41 if [ ! -d "${CTDB_BASE}/events.d" ] ; then
43 ERROR: Directory ${CTDB_BASE}/events.d does not exist.
45 That means that no eventscripts can be tested.
47 One possible explanation:
49 You have CTDB installed via RPMs (or similar), so the regular
50 CTDB_BASE directory is in /etc/ctdb/
54 You have done a regular "configure" and "make install" so the tests
55 are installed under /usr/local/.
57 If so, one possible hack to fix this is to create a symlink:
59 ln -s /etc/ctdb /usr/local/etc/ctdb
61 This is nasty but it works... :-)
66 ######################################################################
68 if "$TEST_VERBOSE" ; then
69 debug () { echo "$@" ; }
74 eventscripts_tests_cleanup_hooks=""
77 eventscripts_test_add_cleanup ()
79 eventscripts_tests_cleanup_hooks="${eventscripts_tests_cleanup_hooks}${eventscripts_tests_cleanup_hooks:+ ; }$*"
82 trap 'eval $eventscripts_tests_cleanup_hooks' 0
85 ######################################################################
87 # General setup fakery
91 debug "Setting up shares (3 existing shares)"
92 # Create 3 fake shares/exports.
94 for i in $(seq 1 3) ; do
95 _s="${EVENTSCRIPTS_TESTS_VAR_DIR}/shares/${i}_existing"
97 FAKE_SHARES="${FAKE_SHARES}${FAKE_SHARES:+ }${_s}"
100 export FAKE_PROC_NET_BONDING="$EVENTSCRIPTS_TESTS_VAR_DIR/proc-net-bonding"
101 mkdir -p "$FAKE_PROC_NET_BONDING"
102 rm -f "$FAKE_PROC_NET_BONDING"/*
104 export FAKE_ETHTOOL_LINK_DOWN="$EVENTSCRIPTS_TESTS_VAR_DIR/ethtool-link-down"
105 mkdir -p "$FAKE_ETHTOOL_LINK_DOWN"
106 rm -f "$FAKE_ETHTOOL_LINK_DOWN"/*
108 # This can only have 2 levels. We don't want to resort to usings
109 # something dangerous like "rm -r" setup time.
110 export FAKE_IP_STATE="$EVENTSCRIPTS_TESTS_VAR_DIR/fake-ip-state"
111 mkdir -p "$FAKE_IP_STATE"
112 rm -f "$FAKE_IP_STATE"/*/*
113 rm -f "$FAKE_IP_STATE"/* 2>/dev/null || true
114 rmdir "$FAKE_IP_STATE"/* 2>/dev/null || true
120 debug "Marking TCP port \"${_i}\" as not listening"
121 FAKE_TCP_LISTEN=$(echo "$FAKE_TCP_LISTEN" | sed -r -e "s@[[:space:]]*[\.0-9]+:${_i}@@g")
129 # Replace some shares with non-existent ones.
134 export MISSING_SHARES_TEXT=""
135 for _i in $FAKE_SHARES ; do
136 if [ $_n = "$1" ] ; then
138 _i="${_i%_existing}_missing"
139 debug "Replacing share $_n with missing share \"$_i\""
140 rmdir "$_i" 2>/dev/null || true
141 MISSING_SHARES_TEXT="${MISSING_SHARES_TEXT}${MISSING_SHARES_TEXT:+${_nl}}"$(printf "$_fmt" "${_i}")
143 _t="${_t}${_t:+ }${_i}"
149 # Setup some fake /proc/net/bonding files with just enough info for
152 # arg1 is interface name, arg2 is currently active slave (use "None"
153 # if none), arg3 is MII status ("up" or "down").
157 _slave="${2:-${_iface}_sl_0}"
159 _mii_subs="${4:-${_mii_s:-up}}"
160 echo "Setting $_iface to be a bond with active slave $_slave and MII status $_mii_s"
161 cat >"${FAKE_PROC_NET_BONDING}/$_iface" <<EOF
162 Bonding Mode: IEEE 802.3ad Dynamic link aggregation
163 Currently Active Slave: $_slave
166 # Status of 1st pretend adapter
167 MII Status: $_mii_subs
168 # Status of 2nd pretend adapter
169 MII Status: $_mii_subs
173 ethtool_interfaces_down ()
176 echo "Marking interface $_i DOWN for ethtool"
177 touch "${FAKE_ETHTOOL_LINK_DOWN}/${_i}"
181 ethtool_interfaces_up ()
184 echo "Marking interface $_i UP for ethtool"
185 rm -f "${FAKE_ETHTOOL_LINK_DOWN}/${_i}"
189 setup_nmap_output_filter ()
191 OUT_FILTER="-e 's@^(DEBUG: # Nmap 5.21 scan initiated) .+ (as:)@\1 DATE \2@' -e 's@^(DEBUG: # Nmap done at) .+ (--)@\1 DATE \2@'"
196 echo "# ip rule show"
200 while read _p _x _i _x _t ; do
201 # Remove trailing colon after priority/preference.
203 # Only remove rules that match our priority/preference.
204 [ "$CTDB_PER_IP_ROUTING_RULE_PREF" = "$_p" ] || continue
206 echo "# ip route show table $_t"
207 ip route show table "$_t"
211 # Copied from 13.per_ip_routing for now... so this is lazy testing :-(
212 ipv4_host_addr_to_net ()
217 # Convert the host address to an unsigned long by splitting out
218 # the octets and doing the math.
220 for _o in $(export IFS="." ; echo $_host) ; do
221 _host_ul=$(( ($_host_ul << 8) + $_o)) # work around Emacs color bug
224 # Calculate the mask and apply it.
225 _mask_ul=$(( 0xffffffff << (32 - $_maskbits) ))
226 _net_ul=$(( $_host_ul & $_mask_ul ))
228 # Now convert to a network address one byte at a time.
230 for _o in $(seq 1 4) ; do
231 _net="$(($_net_ul & 255))${_net:+.}${_net}"
232 _net_ul=$(($_net_ul >> 8))
235 echo "${_net}/${_maskbits}"
238 ######################################################################
242 # Evaluate an expression that probably calls functions or uses
243 # variables from the CTDB functions file. This is used for test
248 . "$CTDB_BASE/functions"
253 # Set output for ctdb command. Option 1st argument is return code.
256 _out="$EVENTSCRIPTS_TESTS_VAR_DIR/ctdb.out"
259 _rc="$EVENTSCRIPTS_TESTS_VAR_DIR/ctdb.rc"
260 echo "${1:-0}" >"$_rc"
262 eventscripts_test_add_cleanup "rm -f $_out $_rc"
269 export FAKE_CTDB_NUMNODES="${1:-3}"
270 echo "Setting up CTDB with ${FAKE_CTDB_NUMNODES} fake nodes"
272 export FAKE_CTDB_PNN="${2:-0}"
273 echo "Setting up CTDB with PNN ${FAKE_CTDB_PNN}"
275 if [ -n "$3" ] ; then
276 echo "Setting up CTDB_PUBLIC_ADDRESSES: $3"
277 export CTDB_PUBLIC_ADDRESSES=$(mktemp)
281 echo "${_ip} ${_ifaces}" >>"$CTDB_PUBLIC_ADDRESSES"
283 eventscripts_test_add_cleanup "rm -f $CTDB_PUBLIC_ADDRESSES"
286 export FAKE_CTDB_STATE="$EVENTSCRIPTS_TESTS_VAR_DIR/fake-ctdb"
288 export FAKE_CTDB_IFACES_DOWN="$FAKE_CTDB_STATE/ifaces-down"
289 mkdir -p "$FAKE_CTDB_IFACES_DOWN"
290 rm -f "$FAKE_CTDB_IFACES_DOWN"/*
292 export FAKE_CTDB_SCRIPTSTATUS="$FAKE_CTDB_STATE/scriptstatus"
293 mkdir -p "$FAKE_CTDB_SCRIPTSTATUS"
294 rm -f "$FAKE_CTDB_SCRIPTSTATUS"/*
297 ctdb_get_interfaces ()
299 # The echo/subshell forces all the output onto 1 line.
300 echo $(ctdb ifaces -Y | awk -F: 'FNR > 1 {print $2}')
303 ctdb_get_1_interface ()
305 _t=$(ctdb_get_interfaces)
309 # Print all public addresses as: interface IP maskbits
310 # Each line is suitable for passing to takeip/releaseip
311 ctdb_get_all_public_addresses ()
313 _f="${CTDB_PUBLIC_ADDRESSES:-${CTDB_BASE}/public_addresses}"
314 while IFS="/$IFS" read _ip _maskbits _ifaces ; do
315 echo "$_ifaces $_ip $_maskbits"
319 # Print public addresses on this node as: interface IP maskbits
320 # Each line is suitable for passing to takeip/releaseip
321 ctdb_get_my_public_addresses ()
324 read _x # skip header line
326 while IFS=":" read _x _ip _x _iface _x ; do
327 [ -n "$_iface" ] || continue
328 while IFS="/$IFS" read _i _maskbits _x ; do
329 if [ "$_ip" = "$_i" ] ; then
330 echo $_iface $_ip $_maskbits
333 done <"${CTDB_PUBLIC_ADDRESSES:-${CTDB_BASE}/public_addresses}"
338 # Prints the 1st public address as: interface IP maskbits
339 # This is suitable for passing to takeip/releaseip
340 ctdb_get_1_public_address ()
342 ctdb_get_my_public_addresses | head -n 1
345 ctdb_not_implemented ()
347 export CTDB_NOT_IMPLEMENTED="$1"
348 ctdb_not_implemented="\
349 DEBUG: ctdb: command \"$1\" not implemented in stub"
352 ctdb_fake_scriptstatus ()
361 echo "$_code $_status $_err_out" >"$FAKE_CTDB_SCRIPTSTATUS/$script"
364 setup_ctdb_policy_routing ()
366 export CTDB_PER_IP_ROUTING_CONF="$CTDB_BASE/policy_routing"
367 export CTDB_PER_IP_ROUTING_RULE_PREF=100
368 export CTDB_PER_IP_ROUTING_TABLE_ID_LOW=1000
369 export CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=2000
371 # Tests need to create and populate this file
372 rm -f "$CTDB_PER_IP_ROUTING_CONF"
375 ######################################################################
383 if [ "$1" != "down" ] ; then
385 debug "Marking Samba services as up, listening and managed by CTDB"
386 # Get into known state.
387 for i in "samba" "winbind" ; do
388 eventscript_call ctdb_service_managed "$i"
390 # All possible service names for all known distros.
391 for i in "smb" "nmb" "winbind" "samba" ; do
392 service "$i" force-started
395 export CTDB_SAMBA_SKIP_SHARE_CHECK="no"
396 export CTDB_MANAGED_SERVICES="foo samba winbind bar"
398 export FAKE_TCP_LISTEN="0.0.0.0:445 0.0.0.0:139"
399 export FAKE_WBINFO_FAIL="no"
401 # Some things in 50.samba are backgrounded and waited for. If
402 # we don't sleep at all then timeouts can happen. This avoids
404 export FAKE_SLEEP_FORCE=0.1
406 debug "Marking Samba services as down, not listening and not managed by CTDB"
407 # Get into known state.
408 for i in "samba" "winbind" ; do
409 eventscript_call ctdb_service_unmanaged "$i"
411 # All possible service names for all known distros.
412 for i in "smb" "nmb" "winbind" "samba" ; do
413 service "$i" force-stopped
416 export CTDB_SAMBA_SKIP_SHARE_CHECK="no"
417 export CTDB_MANAGED_SERVICES="foo bar"
418 unset CTDB_MANAGES_SAMBA
419 unset CTDB_MANAGES_WINBIND
421 export FAKE_TCP_LISTEN=""
422 export FAKE_WBINFO_FAIL="yes"
425 # This is ugly but if this file isn't removed before each test
426 # then configuration changes between tests don't stick.
427 rm -f "$CTDB_VARDIR/state/samba/smb.conf.cache"
432 debug "Making wbinfo commands fail"
433 FAKE_WBINFO_FAIL="yes"
436 ######################################################################
444 export FAKE_RPCINFO_SERVICES=""
446 export CTDB_NFS_SKIP_SHARE_CHECK="no"
447 export CTDB_NFS_SKIP_KNFSD_ALIVE_CHECK="no"
449 # Reset the failcounts for nfs services.
450 eventscript_call eval rm -f '$ctdb_fail_dir/nfs_*'
452 rpc_fail_limits_file="${EVENTSCRIPTS_TESTS_VAR_DIR}/rpc_fail_limits"
454 # Force this file to exist so tests can be individually run.
455 if [ ! -f "$rpc_fail_limits_file" ] ; then
456 # This is gross... but is needed to fake through the nfs monitor event.
457 eventscript_call ctdb_service_managed "nfs"
458 service "nfs" force-started # might not be enough
459 CTDB_RC_LOCAL="$CTDB_BASE/rc.local.nfs.monitor.get-limits" \
460 CTDB_MANAGES_NFS="yes" \
461 "${CTDB_BASE}/events.d/60.nfs" "monitor" >"$rpc_fail_limits_file"
464 if [ "$1" != "down" ] ; then
465 debug "Setting up NFS environment: all RPC services up, NFS managed by CTDB"
467 eventscript_call ctdb_service_managed "nfs"
468 service "nfs" force-started # might not be enough
470 export CTDB_MANAGED_SERVICES="foo nfs bar"
472 rpc_services_up "nfs" "mountd" "rquotad" "nlockmgr" "status"
474 debug "Setting up NFS environment: all RPC services down, NFS not managed by CTDB"
476 eventscript_call ctdb_service_unmanaged "nfs"
477 service "nfs" force-stopped # might not be enough
478 eventscript_call startstop_nfs stop
480 export CTDB_MANAGED_SERVICES="foo bar"
481 unset CTDB_MANAGES_NFS
488 debug "Marking RPC service \"${_i}\" as unavailable"
489 FAKE_RPCINFO_SERVICES=$(echo "$FAKE_RPCINFO_SERVICES" | sed -r -e "s@[[:space:]]*${_i}:[0-9]+:[0-9]+@@g")
496 debug "Marking RPC service \"${_i}\" as available"
501 nlockmgr) _t="3:4" ;;
503 *) die "Internal error - unsupported RPC service \"${_i}\"" ;;
506 FAKE_RPCINFO_SERVICES="${FAKE_RPCINFO_SERVICES}${FAKE_RPCINFO_SERVICES:+ }${_i}:${_t}"
510 # Set the required result for a particular RPC program having failed
511 # for a certain number of iterations. This is probably still a work
512 # in progress. Note that we could hook aggressively
513 # nfs_check_rpc_service() to try to implement this but we're better
514 # off testing nfs_check_rpc_service() using independent code... even
515 # if it is incomplete and hacky. So, if the 60.nfs eventscript
516 # changes and the tests start to fail then it may be due to this
517 # function being incomplete.
518 rpc_set_service_failure_response ()
521 # The number of failures defaults to the iteration number. This
522 # will be true when we fail from the 1st iteration... but we need
523 # the flexibility to set the number of failures.
524 _numfails="${2:-${iteration}}"
526 _etc="$CTDB_ETCDIR" # shortcut for readability
527 for _c in "$_etc/sysconfig/nfs" "$_etc/default/nfs" "$_etc/ctdb/sysconfig/nfs" ; do
528 if [ -r "$_c" ] ; then
534 # A handy newline. :-)
541 _ts=$(sed -n -e "s@^${_progname} @@p" "$rpc_fail_limits_file")
543 while [ -n "$_ts" ] ; do
544 # Get the triple: operator, fail limit and actions.
545 _op="${_ts%% *}" ; _ts="${_ts#* }"
546 _li="${_ts%% *}" ; _ts="${_ts#* }"
547 # We've lost some of the quoting but we can simulate
548 # because we know an operator is always the first in a
551 while [ -n "$_ts" ] ; do
552 # If this is an operator then we've got all of the
558 _actions="${_actions}${_actions:+ }${_ts%% *}"
559 # Special case for end of list.
560 if [ "$_ts" != "${_ts#* }" ] ; then
567 if [ "$_numfails" "$_op" "$_li" ] ; then
570 for _action in $_actions ; do
576 knfsd) _ver=3 ; _pn="nfs" ;;
577 lockd) _ver=4 ; _pn="nlockmgr" ;;
578 statd) _pn="status" ;;
581 ERROR: $_pn failed RPC check:
582 rpcinfo: RPC: Program not registered
583 program $_pn version $_ver is not available"
587 _p="rpc.${_progname}"
590 _opts="${STATD_HOSTNAME:+ -n }${STATD_HOSTNAME}"
593 case "${_progname}${_action#restart}" in
596 Trying to restart NFS service
601 _t="Trying to restart NFS service"
605 Trying to restart lock manager service
607 Starting nfslock: OK"
610 _t="Trying to restart lock manager service"
613 _t="Trying to restart $_progname [${_p}${_opts}]"
615 _out="${_out}${_out:+${_nl}}${_t}"
621 required_result $_rc "$_out"
627 ######################################################################
633 if [ "$1" != "down" ] ; then
634 die "setup_vsftpd up not implemented!!!"
636 debug "Setting up VSFTPD environment: service down, not managed by CTDB"
638 eventscript_call ctdb_service_unmanaged vsftpd
639 service vsftpd force-stopped
641 export CTDB_MANAGED_SERVICES="foo"
642 unset CTDB_MANAGES_VSFTPD
646 ######################################################################
652 if [ "$1" != "down" ] ; then
653 die "setup_httpd up not implemented!!!"
655 debug "Setting up HTTPD environment: service down, not managed by CTDB"
657 for i in "apache2" "httpd" ; do
658 eventscript_call ctdb_service_unmanaged "$i"
659 service "$i" force-stopped
662 export CTDB_MANAGED_SERVICES="foo"
663 unset CTDB_MANAGES_HTTPD
667 ######################################################################
669 # Result and test functions
671 # Set some globals and print the summary.
676 _f=$(basename "$0" ".sh")
678 # Remaining format should be NN.service.event.NNN or NN.service.NNN:
691 die "Internal error - unknown testcase filename format"
694 printf "%-17s %-10s %-4s - %s\n\n" "$script" "$event" "$_num" "$desc"
700 CTDB_BASE="$CTDB_BASE"
701 CTDB_ETCDIR="$CTDB_ETCDIR"
702 ctdb client is "$(which ctdb)"
706 # Run an eventscript once. The test passes if the return code and
707 # output match those required.
709 # Any args are passed to the eventscript.
711 # Eventscript tracing can be done by setting:
712 # EVENTSCRIPTS_TESTS_TRACE="sh -x"
714 # or similar. This will almost certainly make a test fail but is
715 # useful for debugging.
718 [ -n "$event" ] || die 'simple_test: $event not set'
720 _extra_header=$(_extra_header)
722 echo "Running eventscript \"$script $event${1:+ }$*\""
724 if $TEST_COMMAND_TRACE ; then
727 _out=$($_trace "${CTDB_BASE}/events.d/$script" "$event" "$@" 2>&1)
729 result_check "$_extra_header"
734 # If something has previously failed then don't continue.
739 echo "##################################################"
743 simple_test_command ()
745 # If something has previously failed then don't continue.
749 echo "##################################################"
750 echo "Running command \"$*\""
756 # Run an eventscript iteratively.
757 # - 1st argument is the number of iterations.
758 # - 2nd argument is something to eval to do setup for every iteration.
759 # The easiest thing to do here is to define a function and pass it
761 # - Subsequent arguments come in pairs: an iteration number and
762 # something to eval for that iteration. Each time an iteration
763 # number is matched the associated argument is given to eval after
764 # the default setup is done. The iteration numbers need to be given
765 # in ascending order.
767 # Some optional args can be given *before* these, surrounded by extra
768 # "--" args. These args are passed to the eventscript. Quoting is
771 # One use of the 2nd and further arguments is to call
772 # required_result() to change what is expected of a particular
776 [ -n "$event" ] || die 'simple_test: $event not set'
779 if [ "$1" = "--" ] ; then
781 while [ "$1" != "--" ] ; do
782 args="${args}${args:+ }$1"
792 echo "Running $_repeats iterations of \"$script $event\" $args"
796 for iteration in $(seq 1 $_repeats) ; do
797 # This is inefficient because the iteration-specific setup
798 # might completely replace the default one. However, running
799 # the default is good because it allows you to revert to a
800 # particular result without needing to specify it explicitly.
802 if [ $iteration = "$1" ] ; then
807 _out=$($EVENTSCRIPTS_TESTS_TRACE "${CTDB_BASE}/events.d/$script" "$event" $args 2>&1)
810 if [ -n "$OUT_FILTER" ] ; then
811 _fout=$(echo "$_out" | eval sed -r $OUT_FILTER)
816 if [ "$_fout" = "$required_output" -a $_rc = $required_rc ] ; then
823 result_print "$_passed" "$_out" "$_rc" "Iteration $iteration"
826 result_footer "$_result" "$(_extra_header)"