ctdb/tests/scripts/unit.sh

   1 # Hey Emacs, this is a -*- shell-script -*- !!!  :-)
   2
   3 . "${TEST_SCRIPTS_DIR}/common.sh"
   4
   5 # Common variables and functions for CTDB unit tests.
   6
   7 trap -- '' PIPE
   8
   9 # Set the required result for a test.
  10 # - Argument 1 is exit code.
  11 # - Argument 2, if present is the required test output but "--"
  12 #   indicates empty output.
  13 # If argument 2 is not present or null then read required test output
  14 # from stdin.
  15 required_result()
  16 {
  17         required_rc="${1:-0}"
  18         if [ -n "$2" ]; then
  19                 if [ "$2" = "--" ]; then
  20                         required_output=""
  21                 else
  22                         # Use a sub-shell to strip trailing newlines.
  23                         # They can't be matched anyway because the
  24                         # test is run in a sub-shell, which strips
  25                         # trailing newlines.
  26                         # shellcheck disable=SC2116
  27                         required_output=$(echo "$2")
  28                 fi
  29         else
  30                 if ! tty -s; then
  31                         required_output=$(cat)
  32                 else
  33                         required_output=""
  34                 fi
  35         fi
  36 }
  37
  38 required_error()
  39 {
  40         rc=$(errcode "$1")
  41         shift
  42         required_result "$rc" "$@"
  43 }
  44
  45 ok()
  46 {
  47         required_result 0 "$@"
  48 }
  49
  50 ok_null()
  51 {
  52         ok --
  53 }
  54
  55 reset_extra_header()
  56 {
  57         # Re-define this function to output extra header information
  58         extra_header()
  59         {
  60                 :
  61         }
  62 }
  63
  64 reset_extra_footer()
  65 {
  66         # Re-define this function to output extra footer information
  67         extra_footer()
  68         {
  69                 :
  70         }
  71 }
  72
  73 reset_extra_header
  74 reset_extra_footer
  75
  76 result_print()
  77 {
  78         _passed="$1"
  79         _out="$2"
  80         _rc="$3"
  81
  82         if "$CTDB_TEST_VERBOSE" || ! $_passed; then
  83                 extra_header
  84
  85                 cat <<EOF
  86 --------------------------------------------------
  87 Output (Exit status: ${_rc}):
  88 --------------------------------------------------
  89 EOF
  90                 # Avoid echo, which might expand unintentional escapes
  91                 printf '%s\n' "$_out" |
  92                         result_filter |
  93                         cat "${CTDB_TEST_CAT_RESULTS_OPTS:--}"
  94         fi
  95
  96         if ! $_passed; then
  97                 cat <<EOF
  98 --------------------------------------------------
  99 Required output (Exit status: ${required_rc}):
 100 --------------------------------------------------
 101 EOF
 102                 # Avoid echo, which might expand unintentional escapes
 103                 printf '%s\n' "$required_output" |
 104                         cat "${CTDB_TEST_CAT_RESULTS_OPTS:--}"
 105
 106                 if $CTDB_TEST_DIFF_RESULTS; then
 107                         _outr=$(mktemp)
 108                         # Avoid echo, which might expand unintentional escapes
 109                         printf '%s\n' "$required_output" >"$_outr"
 110
 111                         _outf=$(mktemp)
 112                         # Avoid echo, which might expand unintentional escapes
 113                         printf '%s\n' "$_fout" >"$_outf"
 114
 115                         cat <<EOF
 116 --------------------------------------------------
 117 Diff:
 118 --------------------------------------------------
 119 EOF
 120                         diff -u "$_outr" "$_outf" | cat -A
 121                         rm "$_outr" "$_outf"
 122                 fi
 123         fi
 124 }
 125
 126 result_footer()
 127 {
 128         _passed="$1"
 129
 130         if "$CTDB_TEST_VERBOSE" || ! $_passed; then
 131                 extra_footer
 132         fi
 133
 134         if $_passed; then
 135                 echo "PASSED"
 136                 return 0
 137         else
 138                 echo
 139                 echo "FAILED"
 140                 return 1
 141         fi
 142 }
 143
 144 # Result filtering is (usually) used to replace the date/time/PID
 145 # prefix on some CTDB tool/client log messages with the literal string
 146 # "DATE TIME [PID]".  This allows tests to loosely match this output,
 147 # since it can't otherwise be matched.
 148 result_filter_default()
 149 {
 150         _date_time_pid='[0-9/][0-9/]*\ [0-9:\.][0-9:\.]*\ \[[\ 0-9][\ 0-9]*\]'
 151         sed -e "s@^${_date_time_pid}:@DATE\ TIME\ \[PID\]:@"
 152 }
 153 # Used in testcases
 154 # shellcheck disable=SC2034
 155 TEST_DATE_STAMP=""
 156
 157 # Override this function to customise output filtering.
 158 result_filter()
 159 {
 160         result_filter_default
 161 }
 162
 163 result_check()
 164 {
 165         _rc=$?
 166
 167         # Avoid echo, which might expand unintentional escapes
 168         _fout=$(printf '%s\n' "$_out" | result_filter)
 169
 170         if [ "$_fout" = "$required_output" ] &&
 171                 [ "$_rc" = "$required_rc" ]; then
 172                 _passed=true
 173         else
 174                 _passed=false
 175         fi
 176
 177         result_print "$_passed" "$_out" "$_rc"
 178         result_footer "$_passed"
 179 }
 180
 181 test_fail()
 182 {
 183         _passed=false
 184         return 1
 185 }
 186
 187 test_case_string=""
 188 test_case()
 189 {
 190         test_case_string="$*"
 191 }
 192
 193 test_header_default()
 194 {
 195         echo "=================================================="
 196         if [ -n "$test_case_string" ]; then
 197                 echo "Summary: ${test_case_string}"
 198                 test_case_string=""
 199         fi
 200         echo "Running: $*"
 201 }
 202
 203 reset_test_header()
 204 {
 205         # Re-define this function to get different header
 206         test_header()
 207         {
 208                 test_header_default "$@"
 209         }
 210 }
 211
 212 reset_test_header
 213
 214 # Simple test harness for running binary unit tests
 215 unit_test()
 216 {
 217         test_header "$@"
 218
 219         _wrapper="$VALGRIND"
 220         if $CTDB_TEST_COMMAND_TRACE; then
 221                 _wrapper="strace"
 222         fi
 223         _out=$($_wrapper "$@" 2>&1)
 224
 225         result_check || exit $?
 226 }
 227
 228 # Simple test harness for running shell script unit tests
 229 script_test()
 230 {
 231         test_header "$@"
 232
 233         _shell=""
 234         if ${CTDB_TEST_COMMAND_TRACE}; then
 235                 _shell="sh -x"
 236         else
 237                 _shell="sh"
 238         fi
 239
 240         _out=$($_shell "$@" 2>&1)
 241
 242         result_check || exit $?
 243 }
 244
 245 # Simple test harness for running tests without tracing
 246 unit_test_notrace()
 247 {
 248         test_header "$@"
 249
 250         _out=$("$@" 2>&1)
 251
 252         result_check || exit $?
 253 }
 254
 255 test_cleanup_hooks=""
 256
 257 test_cleanup()
 258 {
 259         test_cleanup_hooks="${test_cleanup_hooks}${test_cleanup_hooks:+ ; }$*"
 260 }
 261
 262 trap 'eval $test_cleanup_hooks' 0
 263
 264 local="${CTDB_TEST_SUITE_DIR}/scripts/local.sh"
 265 if [ -r "$local" ]; then
 266         . "$local"
 267 fi