Moved check() function from individual tests to common.sh.
[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 different, global variable "failed" is incremented.
82 check() {
83     #### POSIX diff should support -c.
84     diff -c "$1" "$2"  ||  failed=`expr ${failed:-0} + 1`
85 }
86
87 setup_test ()
88 {
89   export MH=${MH_TEST_DIR}/Mail/.mh_profile
90   export MHMTSCONF=${MH_INST_DIR}${sysconfdir}/mts.conf
91   export PATH=${MH_INST_DIR}${bindir}:${PATH}
92   export MH_LIB_DIR=${MH_INST_DIR}${auxexecdir}
93
94   #
95   # Only install once
96   #
97   if [ ! -d ${MH_INST_DIR}${bindir} ]; then
98     (cd ${MH_OBJ_DIR} && make DESTDIR=${MH_INST_DIR} install) || exit 1
99   fi
100
101   # clean old test data
102   trap "rm -rf $MH_TEST_DIR/Mail; exit \$status" 0
103   # setup test data
104   mkdir $MH_TEST_DIR/Mail || exit 1
105   cat > $MH <<EOF || exit 1
106 Path: ${MH_TEST_DIR}/Mail
107 mhlproc: ${MH_LIB_DIR}/mhl
108 EOF
109
110   for f in MailAliases components digestcomps distcomps forwcomps mhl.body \
111            mhl.digest mhl.format mhl.forward mhl.headers mhl.reply \
112            mhn.defaults rcvdistcomps replcomps replgroupcomps scan.MMDDYY \
113            scan.YYYYMMDD scan.default scan.mailx scan.nomime scan.size \
114            scan.time scan.timely scan.unseen
115   do
116     cp ${MH_INST_DIR}${sysconfdir}/${f} ${MH_TEST_DIR}/Mail || exit 1
117   done
118
119   folder -create +inbox > /dev/null
120   # create 10 basic messages
121   for i in 1 2 3 4 5 6 7 8 9 10;
122   do
123     cat > $MH_TEST_DIR/Mail/inbox/$i <<EOF || exit 1
124 From: Test$i <test$i@example.com>
125 To: Some User <user@example.com>
126 Date: Fri, 29 Sep 2006 00:00:00
127 Subject: Testing message $i
128
129 This is message number $i
130 EOF
131   done
132 }