X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/49e9f226f20711b8504584f32e0bb8323739fab8..1e424a2249aa6b911fd3be973de00cee413342eb:/test/common.sh.in?ds=sidebyside diff --git a/test/common.sh.in b/test/common.sh.in index a117d6fe..b123aca6 100644 --- a/test/common.sh.in +++ b/test/common.sh.in @@ -1,28 +1,61 @@ -# 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@ -#### 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" +#### Use the result of cd and pwd -P so that the result will agree +#### with what getcwd(3) returns. +test -d "$MH_OBJ_DIR/test/testdir" || mkdir -p "$MH_OBJ_DIR/test/testdir" +test -z "$MH_TEST_DIR" && MH_TEST_DIR=`cd "$MH_OBJ_DIR/test/testdir" && pwd -P` +export MH_TEST_DIR +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 "$auxexecdir" && auxexecdir="@libdir@" 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@" -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 +#### If w3m is used, HOME needs to be set, assuming default w3m config. +#### So make sure that HOME is set to avoid run-time warning about not +#### being able to create config directory. +test -z "$HOME" && HOME=$MH_TEST_DIR +HOME=$MH_TEST_DIR +export HOME + +#### If w3m is used, HOME needs to be set, assuming default w3m config. +#### So make sure that HOME is set to avoid run-time warning about not +#### being able to create config directory. +test -z "$HOME" && HOME=$MH_TEST_DIR +HOME=$MH_TEST_DIR +export HOME -unset MHBUILD MHCONTEXT MHMTSUSERCONF MHN MHSHOW MHSTORE MHTMPDIR -unset MHLDEBUG MHPDEBUG MHWDEBUG MM_CHARSET PAGER +unset MAILDROP MHBUILD MHCONTEXT MHMTSUSERCONF MHN MHSHOW MHSTORE +unset MHLDEBUG MHPDEBUG MHWDEBUG PAGER XOAUTH SMTPUTF8 +#### 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 + +#### 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() { @@ -30,7 +63,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). - @MD5SUM@ $* | @MD5FMT@ | cut -d ' ' -f 1 + @MD5SUM@ $* | @MD5FMT@ | awk '{print $1}' } #### Use built-in $((...)) in test suite if shell supports it. @@ -76,6 +109,23 @@ require_prog () fi } +# Skip test if none of the offered locales are supported. +# As side effect, use the first locale that is found. Note that +# some platforms allow, by way of example, en_US.UTF-8 to be used +# even though en_US.UTF8 is listed by locale -a. But by setting +# LC_ALL here, we don't rely on that. +require_locale () +{ + for locale in "$@"; do + if locale -a | grep -i "$locale" >/dev/null; then + LC_ALL="$locale"; export LC_ALL + return + fi + done + + test_skip "no suitable locale available" +} + # Some stuff for doing silly progress indicators if [ -t 1 ] ; then progress_update () @@ -111,36 +161,104 @@ check_for_hard_links () { set +e printf '' > "${MH_TEST_DIR}/$$-1" + xdir_links_supported=0 if link "${MH_TEST_DIR}/$$-1" "${MH_TEST_DIR}/$$-2" 2>/dev/null; then hard_links_supported=1 + mkdir "${MH_TEST_DIR}/xlinkdir" + if link "${MH_TEST_DIR}/$$-1" "${MH_TEST_DIR}/xlinkdir/$$-2" 2>/dev/null; then + xdir_links_supported=1 + fi else hard_links_supported=0 fi rm -f "${MH_TEST_DIR}/$$-1" "${MH_TEST_DIR}/$$-2" + rm -rf "${MH_TEST_DIR}/xlinkdir" 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. -#### 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 +#### significant, emulating GNU diff -w. It is assumed that the +#### first file has already been run through prepare_space. +#### ':' -- will print '' in the failure message, +#### to make it easier to tell which of multiple tests has failed. 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 - echo - diff -c "$1" "$2" || true - 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 +} + + +#### 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: @@ -148,7 +266,11 @@ check() { #### 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 @@ -159,12 +281,60 @@ run_test() { 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() { + #### run_test disables exit on non-zero status, but does increment + #### failed. Don't overwrite nmh_tests_testname if there was a + #### failure; remember the first test that failed. + [ ${failed:-0} -eq 0 ] && 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() { + #### run_test disables exit on non-zero status, but does increment + #### failed. Don't unset nmh_tests_testname if there was a failure. + [ ${failed:-0} -eq 0 ] && unset nmh_tests_testname +} + setup_test () { + set -e + 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 @@ -189,35 +359,50 @@ setup_test () "${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 + # clean old test data on exit + trap cleanup 0 + # setup test data mkdir -p "$MH_TEST_DIR/Mail" || exit 1 cat > "$MH" < /dev/null + #### Suppress warnings about a new version. + #### mhparam version includes the nmh- prefix, so be consistent with that. + printf 'Version: nmh-%s\n' "${MH_VERSION}" >> "${MH_TEST_DIR}"/Mail/context + # create 10 basic messages for i in 1 2 3 4 5 6 7 8 9 10; do