The test check() function now removes the expected and actual output files if they...
[mmh] / test / common.sh.in
1 # Common helper routines for test shell scripts -- intended to be sourced by them
2 # @configure_input@
3
4
5 #### The following exported 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 "$prefix"  &&  prefix=@prefix@
10 test -z "$datarootdir"  &&  datarootdir=@datarootdir@
11 test -z "$exec_prefix"  &&  exec_prefix=@exec_prefix@
12 test -z "$auxexecdir"  &&  auxexecdir="@libdir@"
13 test -z "$bindir"  &&  bindir="@bindir@"
14 test -z "$mandir"  &&  mandir="@mandir@"
15 test -z "$sysconfdir"  &&  sysconfdir="@sysconfdir@"
16 export MH_TEST_DIR auxexecdir bindir mandir sysconfdir
17
18 test -z "$MH_INST_DIR"  &&  MH_INST_DIR=${MH_TEST_DIR}/inst
19 export MH_INST_DIR
20
21
22 output_md5()
23 {
24   @MD5SUM@ $* | @MD5FMT@
25 }
26
27 test_skip ()
28 {
29   WHY="$1"
30   echo "$Test $0 SKIP ($WHY)"
31   exit 77
32 }
33
34 # portable implementation of 'which' utility
35 findprog()
36 {
37   FOUND=
38   PROG="$1"
39   IFS_SAVE="$IFS"
40   IFS=:
41   for D in $PATH; do
42     if [ -z "$D" ]; then
43       D=.
44     fi
45     if [ -f "$D/$PROG" ] && [ -x "$D/$PROG" ]; then
46       printf '%s\n' "$D/$PROG"
47       break
48     fi
49   done
50   IFS="$IFS_SAVE"
51 }
52
53 require_prog ()
54 {
55   if [ -z "$(findprog $1)" ]; then
56     test_skip "missing $1"
57   fi
58 }
59
60 # Some stuff for doing silly progress indicators
61 progress_update ()
62 {
63   THIS="$1"
64   FIRST="$2"
65   LAST="$3"
66   RANGE="$(($LAST - $FIRST))"
67   PROG="$(($THIS - $FIRST))"
68   # this automatically rounds to nearest integer
69   PERC="$(((100 * $PROG) / $RANGE))"
70   # note \r so next update will overwrite
71   printf "%3d%%\r" $PERC
72 }
73
74 progress_done ()
75 {
76   printf "100%%\n"
77 }
78
79 #### check() requires two arguments, each the name of a file to be
80 #### diff'ed.
81 #### If the same, the second file is removed.  And the first file is
82 ####   removed unless the optional third argument has a value of
83 ####   'keep first'.
84 #### If different, global variable "failed" is incremented.
85 check() {
86     #### POSIX diff should support -c.
87     if diff -c "$1" "$2"; then
88       test $# -lt 3 -o "$3" != 'keep first'  &&  rm -f "$1"
89       rm -f "$2"
90     else
91       echo "$0: test failed, outputs are in $1 and $2."
92       failed=`expr ${failed:-0} + 1`
93     fi
94 }
95
96 #### check_string() requires two arguments, the first is a program and
97 #### arguments, the second is its expected one-line output string.  If
98 #### the actual output does not match that string, an error message is
99 #### printed and global variable "failed" is incremented.
100 check_string() {
101   #### Invert exit status to prevent triggering immediate exit due to set -e.
102   ! actual_output=`$1 2>&1`
103   if test "$actual_output" != "$2"; then
104     echo "$0: \"$1\" should have produced:" 1>&2
105     echo "    $2" 1>&2
106     echo "but instead produced:" 1>&2
107     echo "    $actual_output" 1>&2
108     failed=`expr ${failed:-0} + 1`
109   fi
110 }
111
112 setup_test ()
113 {
114   export MH=${MH_TEST_DIR}/Mail/.mh_profile
115   export MHMTSCONF=${MH_INST_DIR}${sysconfdir}/mts.conf
116   export PATH=${MH_INST_DIR}${bindir}:${PATH}
117   export MH_LIB_DIR=${MH_INST_DIR}${auxexecdir}
118
119   #
120   # Only install once
121   #
122   if [ ! -d ${MH_INST_DIR}${bindir} ]; then
123     (cd ${MH_OBJ_DIR} && make DESTDIR=${MH_INST_DIR} install) || exit 1
124   fi
125
126   # clean old test data
127   trap "rm -rf $MH_TEST_DIR/Mail; exit \$status" 0
128   # setup test data
129   mkdir $MH_TEST_DIR/Mail || exit 1
130   cat > $MH <<EOF || exit 1
131 Path: ${MH_TEST_DIR}/Mail
132 mhlproc: ${MH_LIB_DIR}/mhl
133 EOF
134
135   for f in MailAliases components digestcomps distcomps forwcomps mhl.body \
136            mhl.digest mhl.format mhl.forward mhl.headers mhl.reply \
137            mhn.defaults rcvdistcomps replcomps replgroupcomps scan.MMDDYY \
138            scan.YYYYMMDD scan.default scan.mailx scan.nomime scan.size \
139            scan.time scan.timely scan.unseen
140   do
141     cp ${MH_INST_DIR}${sysconfdir}/${f} ${MH_TEST_DIR}/Mail || exit 1
142   done
143
144   folder -create +inbox > /dev/null
145   # create 10 basic messages
146   for i in 1 2 3 4 5 6 7 8 9 10;
147   do
148     cat > $MH_TEST_DIR/Mail/inbox/$i <<EOF || exit 1
149 From: Test$i <test$i@example.com>
150 To: Some User <user@example.com>
151 Date: Fri, 29 Sep 2006 00:00:00
152 Subject: Testing message $i
153
154 This is message number $i
155 EOF
156   done
157 }