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 CTDB_BASE="${TEST_SUBDIR}/etc-ctdb"
36 die "Unable to set \$CTDB_BASE"
40 if [ ! -d "${CTDB_BASE}/events.d" ] ; then
42 ERROR: Directory ${CTDB_BASE}/events.d does not exist.
44 That means that no eventscripts can be tested.
46 One possible explanation:
48 You have CTDB installed via RPMs (or similar), so the regular
49 CTDB_BASE directory is in /etc/ctdb/
53 You have done a regular "configure" and "make install" so the tests
54 are installed under /usr/local/.
56 If so, one possible hack to fix this is to create a symlink:
58 ln -s /etc/ctdb /usr/local/etc/ctdb
60 This is nasty but it works... :-)
65 ######################################################################
67 if "$TEST_VERBOSE" ; then
68 debug () { echo "$@" ; }
73 eventscripts_tests_cleanup_hooks=""
76 eventscripts_test_add_cleanup ()
78 eventscripts_tests_cleanup_hooks="${eventscripts_tests_cleanup_hooks}${eventscripts_tests_cleanup_hooks:+ ; }$*"
81 trap 'eval $eventscripts_tests_cleanup_hooks' 0
84 ######################################################################
86 # General setup fakery
90 debug "Setting up shares (3 existing shares)"
91 # Create 3 fake shares/exports.
93 for i in $(seq 1 3) ; do
94 _s="${EVENTSCRIPTS_TESTS_VAR_DIR}/shares/${i}_existing"
96 FAKE_SHARES="${FAKE_SHARES}${FAKE_SHARES:+ }${_s}"
99 export FAKE_PROC_NET_BONDING="$EVENTSCRIPTS_TESTS_VAR_DIR/proc-net-bonding"
100 mkdir -p "$FAKE_PROC_NET_BONDING"
101 rm -f "$FAKE_PROC_NET_BONDING"/*
103 export FAKE_ETHTOOL_LINK_DOWN="$EVENTSCRIPTS_TESTS_VAR_DIR/ethtool-link-down"
104 mkdir -p "$FAKE_ETHTOOL_LINK_DOWN"
105 rm -f "$FAKE_ETHTOOL_LINK_DOWN"/*
107 # This can only have 2 levels. We don't want to resort to usings
108 # something dangerous like "rm -r" setup time.
109 export FAKE_IP_STATE="$EVENTSCRIPTS_TESTS_VAR_DIR/fake-ip-state"
110 mkdir -p "$FAKE_IP_STATE"
111 rm -f "$FAKE_IP_STATE"/*/*
112 rm -f "$FAKE_IP_STATE"/* 2>/dev/null || true
113 rmdir "$FAKE_IP_STATE"/* 2>/dev/null || true
119 debug "Marking TCP port \"${_i}\" as not listening"
120 FAKE_TCP_LISTEN=$(echo "$FAKE_TCP_LISTEN" | sed -r -e "s@[[:space:]]*[\.0-9]+:${_i}@@g")
128 # Replace some shares with non-existent ones.
133 export MISSING_SHARES_TEXT=""
134 for _i in $FAKE_SHARES ; do
135 if [ $_n = "$1" ] ; then
137 _i="${_i%_existing}_missing"
138 debug "Replacing share $_n with missing share \"$_i\""
139 rmdir "$_i" 2>/dev/null || true
140 MISSING_SHARES_TEXT="${MISSING_SHARES_TEXT}${MISSING_SHARES_TEXT:+${_nl}}"$(printf "$_fmt" "${_i}")
142 _t="${_t}${_t:+ }${_i}"
148 # Setup some fake /proc/net/bonding files with just enough info for
151 # arg1 is interface name, arg2 is currently active slave (use "None"
152 # if none), arg3 is MII status ("up" or "down").
156 _slave="${2:-${_iface}_sl_0}"
158 _mii_subs="${4:-${_mii_s:-up}}"
159 echo "Setting $_iface to be a bond with active slave $_slave and MII status $_mii_s"
160 cat >"${FAKE_PROC_NET_BONDING}/$_iface" <<EOF
161 Bonding Mode: IEEE 802.3ad Dynamic link aggregation
162 Currently Active Slave: $_slave
165 # Status of 1st pretend adapter
166 MII Status: $_mii_subs
167 # Status of 2nd pretend adapter
168 MII Status: $_mii_subs
172 ethtool_interfaces_down ()
175 echo "Marking interface $_i DOWN for ethtool"
176 touch "${FAKE_ETHTOOL_LINK_DOWN}/${_i}"
180 ethtool_interfaces_up ()
183 echo "Marking interface $_i UP for ethtool"
184 rm -f "${FAKE_ETHTOOL_LINK_DOWN}/${_i}"
188 setup_nmap_output_filter ()
190 OUT_FILTER="-e 's@^(DEBUG: # Nmap 5.21 scan initiated) .+ (as:)@\1 DATE \2@' -e 's@^(DEBUG: # Nmap done at) .+ (--)@\1 DATE \2@'"
195 echo "# ip rule show"
199 while read _p _x _i _x _t ; do
200 # Remove trailing colon after priority/preference.
202 # Only remove rules that match our priority/preference.
203 [ "$CTDB_PER_IP_ROUTING_RULE_PREF" = "$_p" ] || continue
205 echo "# ip route show table $_t"
206 ip route show table "$_t"
210 # Copied from 13.per_ip_routing for now... so this is lazy testing :-(
211 ipv4_host_addr_to_net ()
216 # Convert the host address to an unsigned long by splitting out
217 # the octets and doing the math.
219 for _o in $(export IFS="." ; echo $_host) ; do
220 _host_ul=$(( ($_host_ul << 8) + $_o)) # work around Emacs color bug
223 # Calculate the mask and apply it.
224 _mask_ul=$(( 0xffffffff << (32 - $_maskbits) ))
225 _net_ul=$(( $_host_ul & $_mask_ul ))
227 # Now convert to a network address one byte at a time.
229 for _o in $(seq 1 4) ; do
230 _net="$(($_net_ul & 255))${_net:+.}${_net}"
231 _net_ul=$(($_net_ul >> 8))
234 echo "${_net}/${_maskbits}"
237 ######################################################################
241 # Evaluate an expression that probably calls functions or uses
242 # variables from the CTDB functions file. This is used for test
247 . "$CTDB_BASE/functions"
252 # Set output for ctdb command. Option 1st argument is return code.
255 _out="$EVENTSCRIPTS_TESTS_VAR_DIR/ctdb.out"
258 _rc="$EVENTSCRIPTS_TESTS_VAR_DIR/ctdb.rc"
259 echo "${1:-0}" >"$_rc"
261 eventscripts_test_add_cleanup "rm -f $_out $_rc"
268 export FAKE_CTDB_NUMNODES="${1:-3}"
269 echo "Setting up CTDB with ${FAKE_CTDB_NUMNODES} fake nodes"
271 export FAKE_CTDB_PNN="${2:-0}"
272 echo "Setting up CTDB with PNN ${FAKE_CTDB_PNN}"
274 if [ -n "$3" ] ; then
275 echo "Setting up CTDB_PUBLIC_ADDRESSES: $3"
276 export CTDB_PUBLIC_ADDRESSES=$(mktemp)
280 echo "${_ip} ${_ifaces}" >>"$CTDB_PUBLIC_ADDRESSES"
282 eventscripts_test_add_cleanup "rm -f $CTDB_PUBLIC_ADDRESSES"
285 export FAKE_CTDB_STATE="$EVENTSCRIPTS_TESTS_VAR_DIR/fake-ctdb"
287 export FAKE_CTDB_IFACES_DOWN="$FAKE_CTDB_STATE/ifaces-down"
288 mkdir -p "$FAKE_CTDB_IFACES_DOWN"
289 rm -f "$FAKE_CTDB_IFACES_DOWN"/*
291 export FAKE_CTDB_SCRIPTSTATUS="$FAKE_CTDB_STATE/scriptstatus"
292 mkdir -p "$FAKE_CTDB_SCRIPTSTATUS"
293 rm -f "$FAKE_CTDB_SCRIPTSTATUS"/*
296 ctdb_get_interfaces ()
298 # The echo/subshell forces all the output onto 1 line.
299 echo $(ctdb ifaces -Y | awk -F: 'FNR > 1 {print $2}')
302 ctdb_get_1_interface ()
304 _t=$(ctdb_get_interfaces)
308 # Print all public addresses as: interface IP maskbits
309 # Each line is suitable for passing to takeip/releaseip
310 ctdb_get_all_public_addresses ()
312 _f="${CTDB_PUBLIC_ADDRESSES:-${CTDB_BASE}/public_addresses}"
313 while IFS="/$IFS" read _ip _maskbits _ifaces ; do
314 echo "$_ifaces $_ip $_maskbits"
318 # Print public addresses on this node as: interface IP maskbits
319 # Each line is suitable for passing to takeip/releaseip
320 ctdb_get_my_public_addresses ()
323 read _x # skip header line
325 while IFS=":" read _x _ip _x _iface _x ; do
326 [ -n "$_iface" ] || continue
327 while IFS="/$IFS" read _i _maskbits _x ; do
328 if [ "$_ip" = "$_i" ] ; then
329 echo $_iface $_ip $_maskbits
332 done <"${CTDB_PUBLIC_ADDRESSES:-${CTDB_BASE}/public_addresses}"
337 # Prints the 1st public address as: interface IP maskbits
338 # This is suitable for passing to takeip/releaseip
339 ctdb_get_1_public_address ()
341 ctdb_get_my_public_addresses | head -n 1
344 ctdb_not_implemented ()
346 export CTDB_NOT_IMPLEMENTED="$1"
347 ctdb_not_implemented="\
348 DEBUG: ctdb: command \"$1\" not implemented in stub"
351 ctdb_fake_scriptstatus ()
360 echo "$_code $_status $_err_out" >"$FAKE_CTDB_SCRIPTSTATUS/$script"
363 setup_ctdb_policy_routing ()
365 export CTDB_PER_IP_ROUTING_CONF="$CTDB_BASE/policy_routing"
366 export CTDB_PER_IP_ROUTING_RULE_PREF=100
367 export CTDB_PER_IP_ROUTING_TABLE_ID_LOW=1000
368 export CTDB_PER_IP_ROUTING_TABLE_ID_HIGH=2000
370 # Tests need to create and populate this file
371 rm -f "$CTDB_PER_IP_ROUTING_CONF"
374 ######################################################################
382 if [ "$1" != "down" ] ; then
384 debug "Marking Samba services as up, listening and managed by CTDB"
385 # Get into known state.
386 for i in "samba" "winbind" ; do
387 eventscript_call ctdb_service_managed "$i"
389 # All possible service names for all known distros.
390 for i in "smb" "nmb" "winbind" "samba" ; do
391 service "$i" force-started
394 export CTDB_SAMBA_SKIP_SHARE_CHECK="no"
395 export CTDB_MANAGED_SERVICES="foo samba winbind bar"
397 export FAKE_TCP_LISTEN="0.0.0.0:445 0.0.0.0:139"
398 export FAKE_WBINFO_FAIL="no"
400 # Some things in 50.samba are backgrounded and waited for. If
401 # we don't sleep at all then timeouts can happen. This avoids
403 export FAKE_SLEEP_FORCE=0.1
405 debug "Marking Samba services as down, not listening and not managed by CTDB"
406 # Get into known state.
407 for i in "samba" "winbind" ; do
408 eventscript_call ctdb_service_unmanaged "$i"
410 # All possible service names for all known distros.
411 for i in "smb" "nmb" "winbind" "samba" ; do
412 service "$i" force-stopped
415 export CTDB_SAMBA_SKIP_SHARE_CHECK="no"
416 export CTDB_MANAGED_SERVICES="foo bar"
417 unset CTDB_MANAGES_SAMBA
418 unset CTDB_MANAGES_WINBIND
420 export FAKE_TCP_LISTEN=""
421 export FAKE_WBINFO_FAIL="yes"
424 # This is ugly but if this file isn't removed before each test
425 # then configuration changes between tests don't stick.
426 rm -f "$CTDB_VARDIR/state/samba/smb.conf.cache"
431 debug "Making wbinfo commands fail"
432 FAKE_WBINFO_FAIL="yes"
435 ######################################################################
443 export FAKE_RPCINFO_SERVICES=""
445 export CTDB_NFS_SKIP_SHARE_CHECK="no"
446 export CTDB_NFS_SKIP_KNFSD_ALIVE_CHECK="no"
448 # Reset the failcounts for nfs services.
449 eventscript_call eval rm -f '$ctdb_fail_dir/nfs_*'
451 rpc_fail_limits_file="${EVENTSCRIPTS_TESTS_VAR_DIR}/rpc_fail_limits"
453 # Force this file to exist so tests can be individually run.
454 if [ ! -f "$rpc_fail_limits_file" ] ; then
455 # This is gross... but is needed to fake through the nfs monitor event.
456 eventscript_call ctdb_service_managed "nfs"
457 service "nfs" force-started # might not be enough
458 CTDB_RC_LOCAL="$CTDB_BASE/rc.local.nfs.monitor.get-limits" \
459 CTDB_MANAGES_NFS="yes" \
460 "${CTDB_BASE}/events.d/60.nfs" "monitor" >"$rpc_fail_limits_file"
463 if [ "$1" != "down" ] ; then
464 debug "Setting up NFS environment: all RPC services up, NFS managed by CTDB"
466 eventscript_call ctdb_service_managed "nfs"
467 service "nfs" force-started # might not be enough
469 export CTDB_MANAGED_SERVICES="foo nfs bar"
471 rpc_services_up "nfs" "mountd" "rquotad" "nlockmgr" "status"
473 debug "Setting up NFS environment: all RPC services down, NFS not managed by CTDB"
475 eventscript_call ctdb_service_unmanaged "nfs"
476 service "nfs" force-stopped # might not be enough
477 eventscript_call startstop_nfs stop
479 export CTDB_MANAGED_SERVICES="foo bar"
480 unset CTDB_MANAGES_NFS
487 debug "Marking RPC service \"${_i}\" as unavailable"
488 FAKE_RPCINFO_SERVICES=$(echo "$FAKE_RPCINFO_SERVICES" | sed -r -e "s@[[:space:]]*${_i}:[0-9]+:[0-9]+@@g")
495 debug "Marking RPC service \"${_i}\" as available"
500 nlockmgr) _t="3:4" ;;
502 *) die "Internal error - unsupported RPC service \"${_i}\"" ;;
505 FAKE_RPCINFO_SERVICES="${FAKE_RPCINFO_SERVICES}${FAKE_RPCINFO_SERVICES:+ }${_i}:${_t}"
509 # Set the required result for a particular RPC program having failed
510 # for a certain number of iterations. This is probably still a work
511 # in progress. Note that we could hook aggressively
512 # nfs_check_rpc_service() to try to implement this but we're better
513 # off testing nfs_check_rpc_service() using independent code... even
514 # if it is incomplete and hacky. So, if the 60.nfs eventscript
515 # changes and the tests start to fail then it may be due to this
516 # function being incomplete.
517 rpc_set_service_failure_response ()
520 # The number of failures defaults to the iteration number. This
521 # will be true when we fail from the 1st iteration... but we need
522 # the flexibility to set the number of failures.
523 _numfails="${2:-${iteration}}"
525 _etc="$CTDB_ETCDIR" # shortcut for readability
526 for _c in "$_etc/sysconfig/nfs" "$_etc/default/nfs" "$_etc/ctdb/sysconfig/nfs" ; do
527 if [ -r "$_c" ] ; then
533 # A handy newline. :-)
540 _ts=$(sed -n -e "s@^${_progname} @@p" "$rpc_fail_limits_file")
542 while [ -n "$_ts" ] ; do
543 # Get the triple: operator, fail limit and actions.
544 _op="${_ts%% *}" ; _ts="${_ts#* }"
545 _li="${_ts%% *}" ; _ts="${_ts#* }"
546 # We've lost some of the quoting but we can simulate
547 # because we know an operator is always the first in a
550 while [ -n "$_ts" ] ; do
551 # If this is an operator then we've got all of the
557 _actions="${_actions}${_actions:+ }${_ts%% *}"
558 # Special case for end of list.
559 if [ "$_ts" != "${_ts#* }" ] ; then
566 if [ "$_numfails" "$_op" "$_li" ] ; then
569 for _action in $_actions ; do
575 knfsd) _ver=3 ; _pn="nfs" ;;
576 lockd) _ver=4 ; _pn="nlockmgr" ;;
577 statd) _pn="status" ;;
580 ERROR: $_pn failed RPC check:
581 rpcinfo: RPC: Program not registered
582 program $_pn version $_ver is not available"
586 _p="rpc.${_progname}"
589 _opts="${STATD_HOSTNAME:+ -n }${STATD_HOSTNAME}"
592 case "${_progname}${_action#restart}" in
595 Trying to restart NFS service
600 _t="Trying to restart NFS service"
604 Trying to restart lock manager service
606 Starting nfslock: OK"
609 _t="Trying to restart lock manager service"
612 _t="Trying to restart $_progname [${_p}${_opts}]"
614 _out="${_out}${_out:+${_nl}}${_t}"
620 required_result $_rc "$_out"
626 ######################################################################
632 if [ "$1" != "down" ] ; then
633 die "setup_vsftpd up not implemented!!!"
635 debug "Setting up VSFTPD environment: service down, not managed by CTDB"
637 eventscript_call ctdb_service_unmanaged vsftpd
638 service vsftpd force-stopped
640 export CTDB_MANAGED_SERVICES="foo"
641 unset CTDB_MANAGES_VSFTPD
645 ######################################################################
651 if [ "$1" != "down" ] ; then
652 die "setup_httpd up not implemented!!!"
654 debug "Setting up HTTPD environment: service down, not managed by CTDB"
656 for i in "apache2" "httpd" ; do
657 eventscript_call ctdb_service_unmanaged "$i"
658 service "$i" force-stopped
661 export CTDB_MANAGED_SERVICES="foo"
662 unset CTDB_MANAGES_HTTPD
666 ######################################################################
668 # Result and test functions
670 # Set some globals and print the summary.
675 _f=$(basename "$0" ".sh")
677 # Remaining format should be NN.service.event.NNN or NN.service.NNN:
690 die "Internal error - unknown testcase filename format"
693 printf "%-17s %-10s %-4s - %s\n\n" "$script" "$event" "$_num" "$desc"
699 CTDB_BASE="$CTDB_BASE"
700 CTDB_ETCDIR="$CTDB_ETCDIR"
701 ctdb client is "$(which ctdb)"
705 # Run an eventscript once. The test passes if the return code and
706 # output match those required.
708 # Any args are passed to the eventscript.
710 # Eventscript tracing can be done by setting:
711 # EVENTSCRIPTS_TESTS_TRACE="sh -x"
713 # or similar. This will almost certainly make a test fail but is
714 # useful for debugging.
717 [ -n "$event" ] || die 'simple_test: $event not set'
719 _extra_header=$(_extra_header)
721 echo "Running eventscript \"$script $event${1:+ }$*\""
723 if $TEST_COMMAND_TRACE ; then
726 _out=$($_trace "${CTDB_BASE}/events.d/$script" "$event" "$@" 2>&1)
728 result_check "$_extra_header"
733 # If something has previously failed then don't continue.
738 echo "##################################################"
742 simple_test_command ()
744 # If something has previously failed then don't continue.
748 echo "##################################################"
749 echo "Running command \"$*\""
755 # Run an eventscript iteratively.
756 # - 1st argument is the number of iterations.
757 # - 2nd argument is something to eval to do setup for every iteration.
758 # The easiest thing to do here is to define a function and pass it
760 # - Subsequent arguments come in pairs: an iteration number and
761 # something to eval for that iteration. Each time an iteration
762 # number is matched the associated argument is given to eval after
763 # the default setup is done. The iteration numbers need to be given
764 # in ascending order.
766 # Some optional args can be given *before* these, surrounded by extra
767 # "--" args. These args are passed to the eventscript. Quoting is
770 # One use of the 2nd and further arguments is to call
771 # required_result() to change what is expected of a particular
775 [ -n "$event" ] || die 'simple_test: $event not set'
778 if [ "$1" = "--" ] ; then
780 while [ "$1" != "--" ] ; do
781 args="${args}${args:+ }$1"
791 echo "Running $_repeats iterations of \"$script $event\" $args"
795 for iteration in $(seq 1 $_repeats) ; do
796 # This is inefficient because the iteration-specific setup
797 # might completely replace the default one. However, running
798 # the default is good because it allows you to revert to a
799 # particular result without needing to specify it explicitly.
801 if [ $iteration = "$1" ] ; then
806 _out=$($EVENTSCRIPTS_TESTS_TRACE "${CTDB_BASE}/events.d/$script" "$event" $args 2>&1)
809 if [ -n "$OUT_FILTER" ] ; then
810 _fout=$(echo "$_out" | eval sed -r $OUT_FILTER)
815 if [ "$_fout" = "$required_output" -a $_rc = $required_rc ] ; then
822 result_print "$_passed" "$_out" "$_rc" "Iteration $iteration"
825 result_footer "$_result" "$(_extra_header)"