Fix mhlogin(1) title.

[nmh] / test / common.sh.in

diff --git a/test/common.sh.in b/test/common.sh.in
index 5a5a223b57148f896dfa8b3175c25b80fcc67c1a..936b89addefa6a836b0e6ffc8dc49d109aea47e7 100644 (file)
--- a/test/common.sh.in
+++ b/test/common.sh.in
@@ -1,28 +1,43 @@
-# 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 "$MH_VERSION"  &&  MH_VERSION="@VERSION@"

 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 "$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 "$OAUTH_SUPPORT"  &&  OAUTH_SUPPORT="@OAUTH_SUPPORT@"
+test -z "$CURL_USER_AGENT"  &&  CURL_USER_AGENT="@CURL_USER_AGENT@"

 
 

-test -z "$MH_INST_DIR"  &&  MH_INST_DIR="${MH_TEST_DIR}/inst"
-export MH_INST_DIR
+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
+export MHTMPDIR

 
 

-unset MHBUILD MHCONTEXT MHMTSUSERCONF MHN MHSHOW MHSTORE MHTMPDIR
-unset MHLDEBUG MHPDEBUG MHWDEBUG MM_CHARSET PAGER
+#### If you're reading this .... you can set MH_TEST_NOCLEANUP to prevent
+#### the test suite from cleaning up the results of a test run, if you need
+#### to do manual debugging on a test.

 
 output_md5()
 {
 
 output_md5()
 {


@@ -30,7 +45,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.


@@ -76,6 +91,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 ()


@@ -90,7 +117,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'


@@ -121,26 +148,88 @@ 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 different, global variable "failed" is incremented.
+#### 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() {
 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=
+    label=test
+    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
+    done
+
+    success=
+    if [ "$ignorespace" ]; then
+        #### POSIX diff should support -b.
+        prepare_space <"$second" | diff -b "$first" - >/dev/null  &&  success=1

     else
     else

-      echo
-      diff -c "$1" "$2"
-      echo
-      echo "$0: test failed, outputs are in $1 and $2."
-      failed=`expr ${failed:-0} + 1`
+        cmp -s "$first" "$second"  &&  success=1
+    fi
+
+    if [ "$success" ]; then
+        [ "$keepfirst" ]  ||  rm -f "$first"
+        rm -f "$second"
+    else
+        echo
+        #### POSIX diff should support -c.
+        diff -c "$first" "$second" || true
+        echo
+        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
 }
 
     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:


@@ -148,7 +237,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


@@ -159,13 +252,55 @@ run_test() {
   fi
 }
 
   fi
 }
 

+#### Function invoked by trap on exit.
+cleanup() {
+    #### Save exit status to use as status for this program.
+    status=$?
+
+    #### Clean up test mail space.
+    #### cd to $MH_TEST_DIR before trying to remove its Mail
+    #### subdirectory.  rm on Solaris won't remove it if it's in the
+    #### path of the current working directory.
+    test -z "$MH_TEST_NOCLEANUP" && (cd $MH_TEST_DIR; rm -rf "$MH_TEST_DIR"/Mail)
+
+    #### Report test name if set, which indicates failure.
+    #### Relies on set -e to invoke the trap which calls
+    #### this function on failure.
+    #### To use:
+    #### 1) Set test name before running the test, use start_test().
+    #### 2) Unset upon successful completion, use finish_test().
+    if test -n "$nmh_tests_testname"; then
+        echo $nmh_tests_testname failed
+    fi
+
+    #### Exit with non-zero status if failure.  Failure is defined as either
+    #### non-empty nmh_tests_testname or non-zero exit status on entry to the
+    #### function.
+    if test -n "$nmh_tests_testname"  -o  $status -ne 0; then
+        test $status -ne 0  &&  exit $status  ||  exit 1
+        test $status -ne 0  &&  exit 0  ||  exit 0
+    fi
+}
+
+#### Function to set the test name, and whatever the future brings.
+start_test() {
+    nmh_tests_testname="$1"
+}
+
+#### Corresponding function to indicate that the test has finished.  It need
+#### not be called after each test, just the last one in a file.
+finish_test() {
+    unset nmh_tests_testname
+}
+

 setup_test ()
 {
 setup_test ()
 {

+  set -e
+

   MH="${MH_TEST_DIR}/Mail/.mh_profile"
   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}"
-  export MH MHMTSCONF MH_LIB_DIR PATH
+  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


@@ -190,30 +325,43 @@ setup_test ()
         "${MHMTSCONF}.old" >"${MHMTSCONF}"
   fi
 
         "${MHMTSCONF}.old" >"${MHMTSCONF}"
   fi
 

-  # clean old test data
-  trap "rm -rf '$MH_TEST_DIR/Mail'" 0
+  #### On Solaris, must set PATH after the install!
+  PATH="${MH_INST_DIR}${bindir}:${PATH}"
+  export PATH
+
+  # clean old test data on exit
+  trap cleanup 0

   # setup test data
   # 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
 fileproc: ${MH_INST_DIR}${bindir}/refile
   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