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