summaryrefslogtreecommitdiffstats
path: root/testprogs/blackbox/subunit.sh
blob: 0c27775d07c298d428895b07db1ef500543d0638 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
#
#  subunit.sh: shell functions to report test status via the subunit protocol.
#  Copyright (C) 2006  Robert Collins <robertc@robertcollins.net>
#  Copyright (C) 2008  Jelmer Vernooij <jelmer@samba.org>
#
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, write to the Free Software
#  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#

timestamp()
{
	# mark the start time. With Gnu date, you get nanoseconds from %N
	# (here truncated to microseconds with %6N), but not on BSDs,
	# Solaris, etc, which will apparently leave either %N or N at the end.
	date -u +'time: %Y-%m-%d %H:%M:%S.%6NZ' | sed 's/\..*NZ$/.000000Z/'
}

subunit_start_test()
{
	# emit the current protocol start-marker for test $1
	timestamp
	printf 'test: %s\n' "$1"
}

subunit_pass_test()
{
	# emit the current protocol test passed marker for test $1
	timestamp
	printf 'success: %s\n' "$1"
}

# This is just a hack as we have some broken scripts
# which use "exit $failed", without initializing failed.
failed=0

subunit_fail_test()
{
	# emit the current protocol fail-marker for test $1, and emit stdin as
	# the error text.
	# we use stdin because the failure message can be arbitrarily long, and this
	# makes it convenient to write in scripts (using <<END syntax.
	timestamp
	printf 'failure: %s [\n' "$1"
	cat -
	printf '\n]\n'
}

subunit_error_test()
{
	# emit the current protocol error-marker for test $1, and emit stdin as
	# the error text.
	# we use stdin because the failure message can be arbitrarily long, and this
	# makes it convenient to write in scripts (using <<END syntax.
	timestamp
	printf 'error: %s [\n' "$1"
	cat -
	printf '\n]\n'
}

subunit_skip_test()
{
	# emit the current protocol skip-marker for test $1, and emit stdin as
	# the error text.
	# we use stdin because the failure message can be arbitrarily long, and this
	# makes it convenient to write in scripts (using <<END syntax.
	printf 'skip: %s [\n' "$1"
	cat -
	printf '\n]\n'
}

testit()
{
	name="$1"
	shift
	cmdline="$*"
	subunit_start_test "$name"
	output=$($cmdline 2>&1)
	status=$?
	if [ ${status} -eq 0 ]; then
		subunit_pass_test "$name"
	else
		echo "$output" | subunit_fail_test "$name"
	fi
	return $status
}

# This returns 0 if the command gave success and the grep value was found
# all other cases return != 0
testit_grep()
{
	name="$1"
	shift
	grep="$1"
	shift
	cmdline="$*"
	subunit_start_test "$name"
	output=$($cmdline 2>&1)
	status=$?
	if [ ${status} -ne 0 ]; then
		printf '%s' "$output" | subunit_fail_test "$name"
		return $status
	fi
	printf '%s' "$output" | grep -q "$grep"
	gstatus=$?
	if [ ${gstatus} -eq 0 ]; then
		subunit_pass_test "$name"
	else
		printf 'GREP: "%s" not found in output:\n%s' "$grep" "$output" | subunit_fail_test "$name"
	fi
	return $gstatus
}

# This returns 0 if the command gave success and the grep value was found
# num times all other cases return != 0
testit_grep_count()
{
	name="$1"
	shift
	grep="$1"
	shift
	num="$1"
	shift
	cmdline="$*"
	subunit_start_test "$name"
	output=$($cmdline 2>&1)
	status=$?
	if [ ${status} -ne 0 ]; then
		printf '%s' "$output" | subunit_fail_test "$name"
		return $status
	fi
	found=$(printf '%s' "$output" | grep -c "$grep")
	if [ "${found}" -eq "$num" ]; then
	    subunit_pass_test "$name"
	else
	    printf 'GREP: "%s" found "%d" times, expected "%d" in output:\n%s'\
		   "$grep" "$found" "$num" "$output" |
		subunit_fail_test "$name"
	    return 1
	fi
	return 0
}

testit_expect_failure()
{
	name="$1"
	shift
	cmdline="$*"
	subunit_start_test "$name"
	output=$($cmdline 2>&1)
	status=$?
	if [ ${status} = 0 ]; then
		echo "$output" | subunit_fail_test "$name"
		return 1
	else
		subunit_pass_test "$name"
		return 0
	fi
}

# This returns 0 if the command gave a failure and the grep value was found
# all other cases return != 0
testit_expect_failure_grep()
{
	name="$1"
	shift
	grep="$1"
	shift
	cmdline="$*"
	subunit_start_test "$name"
	output=$($cmdline 2>&1)
	status=$?
	if [ ${status} -eq 0 ]; then
		printf '%s' "$output" | subunit_fail_test "$name"
		return 1
	fi
	printf '%s' "$output" | grep -q "$grep"
	gstatus=$?
	if [ ${gstatus} -eq 0 ]; then
		subunit_pass_test "$name"
	else
		printf 'GREP: "%s" not found in output:\n%s' "$grep" "$output" | subunit_fail_test "$name"
		return 1
	fi
	return 0
}

testok()
{
	name=$(basename $1)
	failed=$2

	exit $failed
}

# work out the top level source directory
if [ -d source4 ]; then
	SRCDIR="."
else
	SRCDIR=".."
fi
export SRCDIR