Make sure we don't modify the original text when processing the disposition

[nmh] / test / common.sh.in

diff --git a/test/common.sh.in b/test/common.sh.in
index 4c804155b3145470fba944f052a940fac9f8defe..85ec2089c709d25324c06c6d3054bfd04217f65d 100644 (file)
--- a/test/common.sh.in
+++ b/test/common.sh.in
@@ -13,15 +13,24 @@ test -z "$auxexecdir"  &&  auxexecdir="@libdir@"
 test -z "$bindir"  &&  bindir="@bindir@"
 test -z "$mandir"  &&  mandir="@mandir@"
 test -z "$sysconfdir"  &&  sysconfdir="@sysconfdir@"
 test -z "$bindir"  &&  bindir="@bindir@"
 test -z "$mandir"  &&  mandir="@mandir@"
 test -z "$sysconfdir"  &&  sysconfdir="@sysconfdir@"

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

 test -z "$MULTIBYTE_ENABLED"  &&  MULTIBYTE_ENABLED="@MULTIBYTE_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 MH_TEST_DIR auxexecdir bindir mandir sysconfdir

-export MULTIBYTE_ENABLED
+export MULTIBYTE_ENABLED ICONV_ENABLED

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

-unset MHBUILD MHCONTEXT MHMTSUSERCONF MHN MHSHOW MHSTORE MHTMPDIR
-unset MHLDEBUG MHPDEBUG MHWDEBUG MM_CHARSET PAGER
+unset 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_TYPE
+
+#### Use a test dir for tmp files when MHTMPDIR applies.
+MHTMPDIR=$MH_TEST_DIR/Mail
+export MHTMPDIR

 
 output_md5()
 {
 
 output_md5()
 {


@@ -29,7 +38,7 @@ output_md5()
   #### the same line, the caller needs to add it.  This avoids
   #### differences due to a leading '*' binary file indicator, for
   #### text files, on some platforms (Cygwin).
   #### the same line, the caller needs to add it.  This avoids
   #### differences due to a leading '*' binary file indicator, for
   #### text files, on some platforms (Cygwin).

-  @MD5SUM@ $* | @MD5FMT@ | cut -d ' ' -f 1
+  @MD5SUM@ $* | @MD5FMT@ | awk '{print $1}'

 }
 
 #### Use built-in $((...)) in test suite if shell supports it.
 }
 
 #### Use built-in $((...)) in test suite if shell supports it.


@@ -89,7 +98,7 @@ if [ -t 1 ] ; then
     # note \r so next update will overwrite
     printf '%3d%%\r' $PERC
   }
     # note \r so next update will overwrite
     printf '%3d%%\r' $PERC
   }

-  
+

   progress_done ()
   {
     printf '100%%\n'
   progress_done ()
   {
     printf '100%%\n'


@@ -120,26 +129,85 @@ check_for_hard_links () {
   set -e
 }
 
   set -e
 }
 

+#### 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() {
+  sed '/^$/N;/\n$/D'
+}
+
+#### Filter that converts non-breakable space U+00A0 to an ASCII space.
+prepare_space() {
+  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 the optional third argument has a value of
-####   'keep first'.
+#### If the contents are 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 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.

 check() {
 check() {

-    #### POSIX diff should support -c.
-    if cmp -s "$1" "$2"; then
-      test $# -lt 3 -o "$3" != 'keep first'  &&  rm -f "$1"
-      rm -f "$2"
+    first=$1; shift
+    second=$1; shift
+    keepfirst=
+    ignorespace=
+    while [ $# -gt 0 ]; do
+        case $1 in
+            'keep first')   keepfirst=1 ;;
+            'ignore space') ignorespace=1 ;;
+            *) echo "$0: invalid check() argument \"$1\" in test suite" >&2 ;;
+        esac
+        shift
+    done
+
+    success=
+    if [ "$ignorespace" ]; then
+        #### POSIX diff should support -b.
+        prepare_space <"$second" | diff -b "$first" - >/dev/null  &&  success=1
+    else
+        cmp -s "$first" "$second"  &&  success=1
+    fi
+
+    if [ "$success" ]; then
+        [ "$keepfirst" ]  ||  rm -f "$first"
+        rm -f "$second"

     else
     else

-      echo
-      diff -c "$1" "$2"
-      echo
-      echo "$0: test failed, outputs are in $1 and $2."
-      failed=`expr ${failed:-0} + 1`
+        echo
+        #### POSIX diff should support -c.
+        diff -c "$first" "$second" || true
+        echo
+        echo "$0: test failed, outputs are in $first and $second."
+        failed=`expr ${failed:-0} + 1`
+        #### Set return status of the function.
+        [ $failed -eq 0 ]

     fi
 }
 
     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:


@@ -147,7 +215,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


@@ -162,9 +234,8 @@ setup_test ()
 {
   MH="${MH_TEST_DIR}/Mail/.mh_profile"
   MHMTSCONF="${MH_INST_DIR}${sysconfdir}/mts.conf"
 {
   MH="${MH_TEST_DIR}/Mail/.mh_profile"
   MHMTSCONF="${MH_INST_DIR}${sysconfdir}/mts.conf"

-  PATH="${MH_INST_DIR}${bindir}:${PATH}"

   MH_LIB_DIR="${MH_INST_DIR}${auxexecdir}"
   MH_LIB_DIR="${MH_INST_DIR}${auxexecdir}"

-  export MH MHMTSCONF MH_LIB_DIR PATH
+  export MH MHMTSCONF MH_LIB_DIR

 
   #
   # Only install once
 
   #
   # Only install once


@@ -189,10 +260,14 @@ setup_test ()
         "${MHMTSCONF}.old" >"${MHMTSCONF}"
   fi
 
         "${MHMTSCONF}.old" >"${MHMTSCONF}"
   fi
 

+  #### On Solaris, must set PATH after the install!
+  PATH="${MH_INST_DIR}${bindir}:${PATH}"
+  export PATH
+

   # clean old test data
   trap "rm -rf '$MH_TEST_DIR/Mail'" 0
   # setup test data
   # clean old test data
   trap "rm -rf '$MH_TEST_DIR/Mail'" 0
   # setup test data

-  mkdir "$MH_TEST_DIR/Mail" || exit 1
+  mkdir -p "$MH_TEST_DIR/Mail" || exit 1

   cat > "$MH" <<EOF || exit 1
 Path: ${MH_TEST_DIR}/Mail
 buildmimeproc: ${MH_INST_DIR}${bindir}/mhbuild
   cat > "$MH" <<EOF || exit 1
 Path: ${MH_TEST_DIR}/Mail
 buildmimeproc: ${MH_INST_DIR}${bindir}/mhbuild


@@ -208,8 +283,8 @@ 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 \
   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
+           scan.YYYYMMDD scan.curses 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
   do
     cp "${MH_INST_DIR}${sysconfdir}/${f}" "${MH_TEST_DIR}/Mail" || exit 1
   done