Rearrange all callers of post(8) so that the filename is always last.

[nmh] / test / common.sh.in

diff --git a/test/common.sh.in b/test/common.sh.in
index b373b2f1f6b55b231d88d2fa3cd78b5b6890ee45..aa1e8455b433230b4fbde42e14ead072d0b69e95 100644 (file)
--- a/test/common.sh.in
+++ b/test/common.sh.in
@@ -1,29 +1,32 @@
-# Common helper routines for test shell scripts -- intended to be sourced by them
+# Common helper routines for test shell scripts -- to be sourced by them

 # @configure_input@
 
 
 # @configure_input@
 
 

-#### The following exported variables are set by "make check".  Ensure
+#### The following variables are set by "make check".  Ensure

 #### that they are set here so that individual tests can be run
 #### outside of make.  Requires that MH_OBJ_DIR be set on entry.
 test -z "$MH_TEST_DIR"  &&  MH_TEST_DIR="$MH_OBJ_DIR/test/testdir"
 #### that they are set here so that individual tests can be run
 #### outside of make.  Requires that MH_OBJ_DIR be set on entry.
 test -z "$MH_TEST_DIR"  &&  MH_TEST_DIR="$MH_OBJ_DIR/test/testdir"

+test -z "$MH_INST_DIR"  &&  MH_INST_DIR="${MH_TEST_DIR}/inst"

 test -z "$prefix"  &&  prefix=@prefix@
 test -z "$datarootdir"  &&  datarootdir=@datarootdir@
 test -z "$exec_prefix"  &&  exec_prefix=@exec_prefix@
 test -z "$prefix"  &&  prefix=@prefix@
 test -z "$datarootdir"  &&  datarootdir=@datarootdir@
 test -z "$exec_prefix"  &&  exec_prefix=@exec_prefix@

-test -z "$auxexecdir"  &&  auxexecdir="@libdir@"

 test -z "$bindir"  &&  bindir="@bindir@"
 test -z "$mandir"  &&  mandir="@mandir@"
 test -z "$bindir"  &&  bindir="@bindir@"
 test -z "$mandir"  &&  mandir="@mandir@"

-test -z "$sysconfdir"  &&  sysconfdir="@sysconfdir@"
+test -z "$nmhetcdir"  &&  nmhetcdir="@sysconfdir@/nmh"
+#### The following doesn't support running the distcheck version of
+#### test-mhparam standalone, but only via make distcheck.
+test -z "$nmhetcdirinst"  &&  nmhetcdirinst="@nmhetcdirinst@$nmhetcdir"
+test -z "$nmhlibexecdir"  &&  nmhlibexecdir="@libexecdir@/nmh"

 test -z "$supported_locks"  &&  supported_locks="@supported_locks@"
 test -z "$supported_locks"  &&  supported_locks="@supported_locks@"

+test -z "$default_locking"  &&  default_locking="@default_locking@"

 test -z "$MULTIBYTE_ENABLED"  &&  MULTIBYTE_ENABLED="@MULTIBYTE_ENABLED@"
 test -z "$ICONV_ENABLED"  &&  ICONV_ENABLED="@ICONV_ENABLED@"
 test -z "$MULTIBYTE_ENABLED"  &&  MULTIBYTE_ENABLED="@MULTIBYTE_ENABLED@"
 test -z "$ICONV_ENABLED"  &&  ICONV_ENABLED="@ICONV_ENABLED@"

-export MH_TEST_DIR auxexecdir bindir mandir sysconfdir
-export MULTIBYTE_ENABLED ICONV_ENABLED
-
-test -z "$MH_INST_DIR"  &&  MH_INST_DIR="${MH_TEST_DIR}/inst"
-export MH_INST_DIR

 
 

-unset MHBUILD MHCONTEXT MHMTSUSERCONF MHN MHSHOW MHSTORE
-unset MHLDEBUG MHPDEBUG MHWDEBUG MM_CHARSET PAGER
+unset MAILDROP MHBUILD MHCONTEXT MHMTSUSERCONF MHN MHSHOW MHSTORE
+unset MHLDEBUG MHPDEBUG MHWDEBUG PAGER
+#### Set LC_ALL in individual tests as needed.  Unset these so
+#### that we don't depend on user's settings in other tests.
+unset LANG LC_ALL LC_CTYPE

 
 #### Use a test dir for tmp files when MHTMPDIR applies.
 MHTMPDIR=$MH_TEST_DIR/Mail
 
 #### Use a test dir for tmp files when MHTMPDIR applies.
 MHTMPDIR=$MH_TEST_DIR/Mail


@@ -81,6 +84,18 @@ require_prog ()
   fi
 }
 
   fi
 }
 

+# Skip test if none of the offered locales are supported.
+require_locale ()
+{
+  for locale in "$@"; do
+    if locale -a | grep -i "$locale" >/dev/null; then
+        return
+    fi
+  done
+
+  test_skip "no suitable locale available"
+}
+

 # Some stuff for doing silly progress indicators
 if [ -t 1 ] ; then
   progress_update ()
 # Some stuff for doing silly progress indicators
 if [ -t 1 ] ; then
   progress_update ()


@@ -126,36 +141,40 @@ check_for_hard_links () {
   set -e
 }
 
   set -e
 }
 

-#### Filter that squeezes blank lines, emulating GNU cat -s.
+#### Filter that squeezes blank lines, partially emulating GNU cat -s,
+#### but sufficient for our purpose.
+#### From http://www-rohan.sdsu.edu/doc/sed.html, compiled by Eric Pement.

 squeeze_lines() {
 squeeze_lines() {

-  awk '!length && e {next} {e = !length} 1'
+  sed '/^$/N;/\n$/D'

 }
 
 }
 

-#### Filter that inserts initial whitespace and converts non-breakable
-#### space U+00A0 to an ASCII space.
+#### Filter that converts non-breakable space U+00A0 to an ASCII space.

 prepare_space() {
 prepare_space() {

-  sed 's/^/ /; s/'"`printf '\\302\\240'`"'/ /g'
+  sed 's/'"`printf '\\302\\240'`"'/ /g'

 }
 
 #### check() requires two arguments, each the name of a file to be
 #### diff'ed.
 }
 
 #### check() requires two arguments, each the name of a file to be
 #### diff'ed.

-#### If the same, the second file is removed.  And the first file is
-####   removed unless there's an optional argument with a value of
-####   'keep first'.
-#### If different, global variable "failed" is incremented.
-#### If there's an optional 'ignore space' argument, spacing differences
-####   will not be considered signficant, emulating GNU diff -w.  It
-####   is assumed that the first file has already been run through
-####   prepare_space.
+#### If the contents are same, the second file is removed.  If different,
+#### global variable "failed" is incremented.
+#### Optional arguments:
+####   'keep first' -- first file is removed unless this is present.
+####   'ignore space' -- spacing differences will not be considered
+####        signficant, emulating GNU diff -w.  It is assumed that the
+####        first file has already been run through prepare_space.
+####   ':' <test name> -- will print '<test name>' in the failure message,
+####        to make it easier to tell which of multiple tests has failed.

 check() {
     first=$1; shift
     second=$1; shift
     keepfirst=
     ignorespace=
 check() {
     first=$1; shift
     second=$1; shift
     keepfirst=
     ignorespace=

+    label=test

     while [ $# -gt 0 ]; do
         case $1 in
             'keep first')   keepfirst=1 ;;
             'ignore space') ignorespace=1 ;;
     while [ $# -gt 0 ]; do
         case $1 in
             'keep first')   keepfirst=1 ;;
             'ignore space') ignorespace=1 ;;

+           ':') shift; label=\'"$*"\'; break ;;

             *) echo "$0: invalid check() argument \"$1\" in test suite" >&2 ;;
         esac
         shift
             *) echo "$0: invalid check() argument \"$1\" in test suite" >&2 ;;
         esac
         shift


@@ -177,13 +196,33 @@ check() {
         #### POSIX diff should support -c.
         diff -c "$first" "$second" || true
         echo
         #### POSIX diff should support -c.
         diff -c "$first" "$second" || true
         echo

-        echo "$0: test failed, outputs are in $first and $second."
+        echo "$0: $label failed, outputs are in $first and $second."

         failed=`expr ${failed:-0} + 1`
         #### Set return status of the function.
         [ $failed -eq 0 ]
     fi
 }
 
         failed=`expr ${failed:-0} + 1`
         #### Set return status of the function.
         [ $failed -eq 0 ]
     fi
 }
 

+
+#### Shortcut to enable use of valgrind:  set NMH_VALGRIND environment
+#### variable (to anything) so run_* will use valgrind.
+if [ "${NMH_VALGRIND}"  -a  -z "${NMH_TEST_PREFIX}" ]; then
+  #### Need absolute path to valgrind.supp in case the test does a cd.
+  NMH_TEST_PREFIX="valgrind --quiet --error-exitcode=1 \
+                     --suppressions=`cd ${srcdir} && pwd`/test/valgrind.supp"
+fi
+
+#### Run test under another program by setting NMH_TEST_PREFIX
+#### environment variable to, e.g., 'valgrind --quiet'.
+run_prog() {
+  case $1 in
+    #### Don't run valgrind on shell built-in.
+    eval\ *) "$@" ;;
+    *) ${NMH_TEST_PREFIX} "$@" ;;
+  esac
+}
+
+

 #### run_test() requires two arguments, the first is a program and
 #### arguments, the second is its expected one-line output string.
 #### If the actual output does not match that string:
 #### run_test() requires two arguments, the first is a program and
 #### arguments, the second is its expected one-line output string.
 #### If the actual output does not match that string:


@@ -191,7 +230,11 @@ check() {
 #### if there is an optional third argument, it is used in the error message.
 run_test() {
   set +e
 #### if there is an optional third argument, it is used in the error message.
 run_test() {
   set +e

-  actual_output=`$1 2>&1`
+  case $1 in
+    #### Don't run valgrind on shell built-in.
+    eval\ *) actual_output=`$1 2>&1` ;;
+    *) actual_output=`${NMH_TEST_PREFIX} $1 2>&1` ;;
+  esac

   set -e
   if test x"$actual_output" != x"$2"; then
     echo "$0: ${3:-\"$1\"} expected:" 1>&2
   set -e
   if test x"$actual_output" != x"$2"; then
     echo "$0: ${3:-\"$1\"} expected:" 1>&2


@@ -205,9 +248,9 @@ run_test() {
 setup_test ()
 {
   MH="${MH_TEST_DIR}/Mail/.mh_profile"
 setup_test ()
 {
   MH="${MH_TEST_DIR}/Mail/.mh_profile"

-  MHMTSCONF="${MH_INST_DIR}${sysconfdir}/mts.conf"
-  MH_LIB_DIR="${MH_INST_DIR}${auxexecdir}"
-  export MH MHMTSCONF MH_LIB_DIR
+  MHMTSCONF="${MH_INST_DIR}${nmhetcdir}/mts.conf"
+  MH_LIBEXEC_DIR="${MH_INST_DIR}${nmhlibexecdir}"
+  export MH MHMTSCONF MH_LIBEXEC_DIR

 
   #
   # Only install once
 
   #
   # Only install once


@@ -237,29 +280,38 @@ setup_test ()
   export PATH
 
   # clean old test data
   export PATH
 
   # clean old test data

-  trap "rm -rf '$MH_TEST_DIR/Mail'" 0
+  trap "cd $MH_TEST_DIR; rm -rf '$MH_TEST_DIR/Mail'" 0

   # setup test data
   mkdir -p "$MH_TEST_DIR/Mail" || exit 1
   cat > "$MH" <<EOF || exit 1
 Path: ${MH_TEST_DIR}/Mail
 buildmimeproc: ${MH_INST_DIR}${bindir}/mhbuild
 fileproc: ${MH_INST_DIR}${bindir}/refile
   # setup test data
   mkdir -p "$MH_TEST_DIR/Mail" || exit 1
   cat > "$MH" <<EOF || exit 1
 Path: ${MH_TEST_DIR}/Mail
 buildmimeproc: ${MH_INST_DIR}${bindir}/mhbuild
 fileproc: ${MH_INST_DIR}${bindir}/refile

-libdir: ${MH_LIB_DIR}
+libexecdir: ${MH_LIBEXEC_DIR}

 mhbuild: -nocontentid
 mhbuild: -nocontentid

-mhlproc: ${MH_LIB_DIR}/mhl
+mhlproc: ${MH_LIBEXEC_DIR}/mhl

 moreproc: cat
 moreproc: cat

-postproc: ${MH_LIB_DIR}/post
-showproc: ${MH_LIB_DIR}/mhl
+postproc: ${MH_LIBEXEC_DIR}/post
+showmimeproc: ${MH_INST_DIR}${bindir}/mhshow
+showproc: ${MH_LIBEXEC_DIR}/mhl
+#: The following aren't currently used by the test suite, but are
+#: defined here in case they are in the future:
+mailproc: ${MH_INST_DIR}${bindir}/mhmail
+rcvstoreproc: ${MH_LIBEXEC_DIR}/rcvstore
+sendproc: ${MH_INST_DIR}${bindir}/send
+whatnowproc: ${MH_INST_DIR}${bindir}/whatnow
+whomproc: ${MH_INST_DIR}${bindir}/whom
+#: incproc and packproc are defined in config.c but not used by any code.

 EOF
 
 EOF
 

-  for f in MailAliases components digestcomps distcomps forwcomps mhl.body \
-           mhl.digest mhl.format mhl.forward mhl.headers mhl.reply \
-           mhn.defaults rcvdistcomps replcomps replgroupcomps scan.MMDDYY \
-           scan.YYYYMMDD scan.default scan.highlighted scan.mailx scan.nomime \
-           scan.size scan.time scan.timely scan.unseen
-  do
-    cp "${MH_INST_DIR}${sysconfdir}/${f}" "${MH_TEST_DIR}/Mail" || exit 1
-  done
+  if test -z '@nmhetcdirinst@'; then
+    #### This isn't used with make distcheck, so that we can use it to
+    #### be sure that etc files are not used from an existing nmh
+    #### installation.
+    #### posh doesn't like "${MH_INST_DIR}${nmhetcdir}"/*, so cd to
+    #### the directory and provide an argument without quotes to cp.
+    (cd "${MH_INST_DIR}${nmhetcdir}/"  &&  cp * "${MH_TEST_DIR}/Mail")
+  fi

 
   folder -create +inbox > /dev/null
   # create 10 basic messages
 
   folder -create +inbox > /dev/null
   # create 10 basic messages