diplodocus.org Git - nmh/blob - test/common.sh.in

   1 # Common helper routines for test shell scripts -- to be sourced by them
   2 # @configure_input@
   3
   4
   5 #### The following variables are set by "make check".  Ensure
   6 #### that they are set here so that individual tests can be run
   7 #### outside of make.  Requires that MH_OBJ_DIR be set on entry.
   8 test -z "$MH_TEST_DIR"  &&  MH_TEST_DIR="$MH_OBJ_DIR/test/testdir"
   9 test -z "$MH_INST_DIR"  &&  MH_INST_DIR="${MH_TEST_DIR}/inst"
  10 test -z "$MH_VERSION"  &&  MH_VERSION="@VERSION@"
  11 test -z "$prefix"  &&  prefix=@prefix@
  12 test -z "$datarootdir"  &&  datarootdir=@datarootdir@
  13 test -z "$exec_prefix"  &&  exec_prefix=@exec_prefix@
  14 test -z "$bindir"  &&  bindir="@bindir@"
  15 test -z "$mandir"  &&  mandir="@mandir@"
  16 test -z "$nmhetcdir"  &&  nmhetcdir="@sysconfdir@/nmh"
  17 #### The following doesn't support running the distcheck version of
  18 #### test-mhparam standalone, but only via make distcheck.
  19 test -z "$nmhetcdirinst"  &&  nmhetcdirinst="@nmhetcdirinst@$nmhetcdir"
  20 test -z "$nmhlibexecdir"  &&  nmhlibexecdir="@libexecdir@/nmh"
  21 test -z "$supported_locks"  &&  supported_locks="@supported_locks@"
  22 test -z "$default_locking"  &&  default_locking="@default_locking@"
  23 test -z "$MULTIBYTE_ENABLED"  &&  MULTIBYTE_ENABLED="@MULTIBYTE_ENABLED@"
  24 test -z "$ICONV_ENABLED"  &&  ICONV_ENABLED="@ICONV_ENABLED@"
  25 test -z "$OAUTH_SUPPORT"  &&  OAUTH_SUPPORT="@OAUTH_SUPPORT@"
  26 test -z "$CURL_USER_AGENT"  &&  CURL_USER_AGENT="@CURL_USER_AGENT@"
  27
  28 unset MAILDROP MHBUILD MHCONTEXT MHMTSUSERCONF MHN MHSHOW MHSTORE
  29 unset MHLDEBUG MHPDEBUG MHWDEBUG PAGER
  30 #### Set LC_ALL in individual tests as needed.  Unset these so
  31 #### that we don't depend on user's settings in other tests.
  32 unset LANG LC_ALL LC_CTYPE
  33
  34 #### Use a test dir for tmp files when MHTMPDIR applies.
  35 MHTMPDIR=$MH_TEST_DIR/Mail
  36 export MHTMPDIR
  37
  38 #### If you're reading this .... you can set MH_TEST_NOCLEANUP to prevent
  39 #### the test suite from cleaning up the results of a test run, if you need
  40 #### to do manual debugging on a test.
  41
  42 output_md5()
  43 {
  44   #### Output just the checksum.  If the filename needs to appear on
  45   #### the same line, the caller needs to add it.  This avoids
  46   #### differences due to a leading '*' binary file indicator, for
  47   #### text files, on some platforms (Cygwin).
  48   @MD5SUM@ $* | @MD5FMT@ | awk '{print $1}'
  49 }
  50
  51 #### Use built-in $((...)) in test suite if shell supports it.
  52 #### Borrowed from configure's as_fn_arith.  The result is placed
  53 #### in global arith_val.
  54 #### Detected at run-time instead of by configure to allow testing
  55 #### with different shells.
  56 if (eval "test \$(( 1 + 1 )) = 2" 2>/dev/null); then
  57   eval 'arith_eval () { arith_val=$(( $* )); }'
  58 else
  59   arith_eval () { arith_val=`expr "$@" || test $? -eq 1`; }
  60 fi
  61
  62 test_skip ()
  63 {
  64   WHY="$1"
  65   echo "$Test $0 SKIP ($WHY)"
  66   exit 77
  67 }
  68
  69 # portable implementation of 'which' utility
  70 findprog()
  71 {
  72   PROG="$1"
  73   #### Don't need to save current IFS because this function is run in
  74   #### a subshell.
  75   IFS=:
  76   for D in $PATH; do
  77     if [ -z "$D" ]; then
  78       D=.
  79     fi
  80     if [ -f "$D/$PROG"  -a  -x "$D/$PROG" ]; then
  81       printf '%s\n' "$D/$PROG"
  82       break
  83     fi
  84   done
  85 }
  86
  87 require_prog ()
  88 {
  89   if [ -z "`findprog $1`" ]; then
  90     test_skip "missing $1"
  91   fi
  92 }
  93
  94 # Skip test if none of the offered locales are supported.
  95 require_locale ()
  96 {
  97   for locale in "$@"; do
  98     if locale -a | grep -i "$locale" >/dev/null; then
  99         return
 100     fi
 101   done
 102
 103   test_skip "no suitable locale available"
 104 }
 105
 106 # Some stuff for doing silly progress indicators
 107 if [ -t 1 ] ; then
 108   progress_update ()
 109   {
 110     THIS="$1"
 111     FIRST="$2"
 112     LAST="$3"
 113     arith_eval $LAST - $FIRST; RANGE=$arith_val
 114     arith_eval $THIS - $FIRST; PROG=$arith_val
 115     # this automatically rounds to nearest integer
 116     arith_eval 100 \* $PROG / $RANGE; PERC=$arith_val
 117     # note \r so next update will overwrite
 118     printf '%3d%%\r' $PERC
 119   }
 120
 121   progress_done ()
 122   {
 123     printf '100%%\n'
 124   }
 125 else
 126   # don't emit anything if stdout is not connected to a tty.
 127   progress_update ()
 128   {
 129         :
 130   }
 131   progress_done ()
 132   {
 133         :
 134   }
 135 fi
 136
 137 check_for_hard_links () {
 138   set +e
 139
 140   printf '' > "${MH_TEST_DIR}/$$-1"
 141   if link "${MH_TEST_DIR}/$$-1" "${MH_TEST_DIR}/$$-2" 2>/dev/null; then
 142     hard_links_supported=1
 143   else
 144     hard_links_supported=0
 145   fi
 146   rm -f "${MH_TEST_DIR}/$$-1" "${MH_TEST_DIR}/$$-2"
 147
 148   set -e
 149 }
 150
 151 #### Filter that squeezes blank lines, partially emulating GNU cat -s,
 152 #### but sufficient for our purpose.
 153 #### From http://www-rohan.sdsu.edu/doc/sed.html, compiled by Eric Pement.
 154 squeeze_lines() {
 155   sed '/^$/N;/\n$/D'
 156 }
 157
 158 #### Filter that converts non-breakable space U+00A0 to an ASCII space.
 159 prepare_space() {
 160   sed 's/'"`printf '\\302\\240'`"'/ /g'
 161 }
 162
 163 #### check() requires two arguments, each the name of a file to be
 164 #### diff'ed.
 165 #### If the contents are same, the second file is removed.  If different,
 166 #### global variable "failed" is incremented.
 167 #### Optional arguments:
 168 ####   'keep first' -- first file is removed unless this is present.
 169 ####   'ignore space' -- spacing differences will not be considered
 170 ####        signficant, emulating GNU diff -w.  It is assumed that the
 171 ####        first file has already been run through prepare_space.
 172 ####   ':' <test name> -- will print '<test name>' in the failure message,
 173 ####        to make it easier to tell which of multiple tests has failed.
 174 check() {
 175     first=$1; shift
 176     second=$1; shift
 177     keepfirst=
 178     ignorespace=
 179     label=test
 180     while [ $# -gt 0 ]; do
 181         case $1 in
 182             'keep first')   keepfirst=1 ;;
 183             'ignore space') ignorespace=1 ;;
 184             ':') shift; label=\'"$*"\'; break ;;
 185             *) echo "$0: invalid check() argument \"$1\" in test suite" >&2 ;;
 186         esac
 187         shift
 188     done
 189
 190     success=
 191     if [ "$ignorespace" ]; then
 192         #### POSIX diff should support -b.
 193         prepare_space <"$second" | diff -b "$first" - >/dev/null  &&  success=1
 194     else
 195         cmp -s "$first" "$second"  &&  success=1
 196     fi
 197
 198     if [ "$success" ]; then
 199         [ "$keepfirst" ]  ||  rm -f "$first"
 200         rm -f "$second"
 201     else
 202         echo
 203         #### POSIX diff should support -c.
 204         diff -c "$first" "$second" || true
 205         echo
 206         echo "$0: $label failed, outputs are in $first and $second."
 207         failed=`expr ${failed:-0} + 1`
 208         #### Set return status of the function.
 209         [ $failed -eq 0 ]
 210     fi
 211 }
 212
 213
 214 #### Shortcut to enable use of valgrind:  set NMH_VALGRIND environment
 215 #### variable (to anything) so run_* will use valgrind.
 216 if [ "${NMH_VALGRIND}"  -a  -z "${NMH_TEST_PREFIX}" ]; then
 217   #### Need absolute path to valgrind.supp in case the test does a cd.
 218   NMH_TEST_PREFIX="valgrind --quiet --error-exitcode=1 \
 219                      --suppressions=`cd ${srcdir} && pwd`/test/valgrind.supp"
 220 fi
 221
 222 #### Run test under another program by setting NMH_TEST_PREFIX
 223 #### environment variable to, e.g., 'valgrind --quiet'.
 224 run_prog() {
 225   case $1 in
 226     #### Don't run valgrind on shell built-in.
 227     eval\ *) "$@" ;;
 228     *) ${NMH_TEST_PREFIX} "$@" ;;
 229   esac
 230 }
 231
 232
 233 #### run_test() requires two arguments, the first is a program and
 234 #### arguments, the second is its expected one-line output string.
 235 #### If the actual output does not match that string:
 236 #### an error message is printed and global variable "failed" is incremented;
 237 #### if there is an optional third argument, it is used in the error message.
 238 run_test() {
 239   set +e
 240   case $1 in
 241     #### Don't run valgrind on shell built-in.
 242     eval\ *) actual_output=`$1 2>&1` ;;
 243     *) actual_output=`${NMH_TEST_PREFIX} $1 2>&1` ;;
 244   esac
 245   set -e
 246   if test x"$actual_output" != x"$2"; then
 247     echo "$0: ${3:-\"$1\"} expected:" 1>&2
 248     echo "    '$2'" 1>&2
 249     echo "but instead got:" 1>&2
 250     echo "    '$actual_output'" 1>&2
 251     failed=`expr ${failed:-0} + 1`
 252   fi
 253 }
 254
 255 #### Function invoked by trap on exit.
 256 cleanup() {
 257     #### Save exit status to use as status for this program.
 258     status=$?
 259
 260     #### Clean up test mail space.
 261     #### cd to $MH_TEST_DIR before trying to remove its Mail
 262     #### subdirectory.  rm on Solaris won't remove it if it's in the
 263     #### path of the current working directory.
 264     test -z "$MH_TEST_NOCLEANUP" && (cd $MH_TEST_DIR; rm -rf "$MH_TEST_DIR"/Mail)
 265
 266     #### Report test name if set, which indicates failure.
 267     #### Relies on set -e to invoke the trap which calls
 268     #### this function on failure.
 269     #### To use:
 270     #### 1) Set test name before running the test, use start_test().
 271     #### 2) Unset upon successful completion, use finish_test().
 272     if test -n "$nmh_tests_testname"; then
 273         echo $nmh_tests_testname failed
 274     fi
 275
 276     #### Exit with non-zero status if failure.  Failure is defined as either
 277     #### non-empty nmh_tests_testname or non-zero exit status on entry to the
 278     #### function.
 279     if test -n "$nmh_tests_testname"  -o  $status -ne 0; then
 280         test $status -ne 0  &&  exit $status  ||  exit 1
 281         test $status -ne 0  &&  exit 0  ||  exit 0
 282     fi
 283 }
 284
 285 #### Function to set the test name, and whatever the future brings.
 286 start_test() {
 287     nmh_tests_testname="$1"
 288 }
 289
 290 #### Corresponding function to indicate that the test has finished.  It need
 291 #### not be called after each test, just the last one in a file.
 292 finish_test() {
 293     unset nmh_tests_testname
 294 }
 295
 296 setup_test ()
 297 {
 298   set -e
 299
 300   MH="${MH_TEST_DIR}/Mail/.mh_profile"
 301   MHMTSCONF="${MH_INST_DIR}${nmhetcdir}/mts.conf"
 302   MH_LIBEXEC_DIR="${MH_INST_DIR}${nmhlibexecdir}"
 303   export MH MHMTSCONF MH_LIBEXEC_DIR
 304
 305   #
 306   # Only install once
 307   #
 308   if [ -d "${MH_INST_DIR}${bindir}" ]; then
 309     :
 310   else
 311     (cd "${MH_OBJ_DIR}" &&
 312       make DESTDIR="${MH_INST_DIR}" SETGID_MAIL= install) ||
 313       exit 1
 314
 315     #### Don't test with sendmail because it would really send the
 316     #### mail.  If configured to use sendmail, change to smtp instead
 317     #### so that we use fakesmtp.
 318     #### And set up the maildrop in the test directory so tests don't
 319     #### use the user's real maildrop.
 320     #### test-slocal needs to look at the original mts.conf, so save it.
 321     mv -f "${MHMTSCONF}" "${MHMTSCONF}.old"
 322     sed -e 's/mts: *.*/mts: smtp/' \
 323         -e "s%mmdfldir: *.*%mmdfldir: ${MH_TEST_DIR}/Mail%" \
 324         -e 's%mmdflfil: *.*%mmdflfil: maildrop%' \
 325         "${MHMTSCONF}.old" >"${MHMTSCONF}"
 326   fi
 327
 328   #### On Solaris, must set PATH after the install!
 329   PATH="${MH_INST_DIR}${bindir}:${PATH}"
 330   export PATH
 331
 332   # clean old test data on exit
 333   trap cleanup 0
 334   # setup test data
 335   mkdir -p "$MH_TEST_DIR/Mail" || exit 1
 336   cat > "$MH" <<EOF || exit 1
 337 Path: ${MH_TEST_DIR}/Mail
 338 buildmimeproc: ${MH_INST_DIR}${bindir}/mhbuild
 339 fileproc: ${MH_INST_DIR}${bindir}/refile
 340 libexecdir: ${MH_LIBEXEC_DIR}
 341 mhbuild: -nocontentid
 342 mhlproc: ${MH_LIBEXEC_DIR}/mhl
 343 moreproc: cat
 344 postproc: ${MH_LIBEXEC_DIR}/post
 345 showmimeproc: ${MH_INST_DIR}${bindir}/mhshow
 346 showproc: ${MH_LIBEXEC_DIR}/mhl
 347 #: The following aren't currently used by the test suite, but are
 348 #: defined here in case they are in the future:
 349 mailproc: ${MH_INST_DIR}${bindir}/mhmail
 350 rcvstoreproc: ${MH_LIBEXEC_DIR}/rcvstore
 351 sendproc: ${MH_INST_DIR}${bindir}/send
 352 whatnowproc: ${MH_INST_DIR}${bindir}/whatnow
 353 whomproc: ${MH_INST_DIR}${bindir}/whom
 354 #: incproc and packproc are defined in config.c but not used by any code.
 355 EOF
 356
 357   if test -z '@nmhetcdirinst@'; then
 358     #### This isn't used with make distcheck, so that we can use it to
 359     #### be sure that etc files are not used from an existing nmh
 360     #### installation.
 361     #### posh doesn't like "${MH_INST_DIR}${nmhetcdir}"/*, so cd to
 362     #### the directory and provide an argument without quotes to cp.
 363     (cd "${MH_INST_DIR}${nmhetcdir}/"  &&  cp * "${MH_TEST_DIR}/Mail")
 364   fi
 365
 366   folder -create +inbox > /dev/null
 367   # create 10 basic messages
 368   for i in 1 2 3 4 5 6 7 8 9 10;
 369   do
 370     cat > $MH_TEST_DIR/Mail/inbox/$i <<EOF || exit 1
 371 From: Test$i <test$i@example.com>
 372 To: Some User <user@example.com>
 373 Date: Fri, 29 Sep 2006 00:00:00
 374 Message-Id: $i@test.nmh
 375 Subject: Testing message $i
 376
 377 This is message number $i
 378 EOF
 379   done
 380 }