1 #!/bin/sh
2 
3 set -e
4 
5 if [ "${SKIP_RUNTIME_TESTS:-0}" -eq 1 ]; then
6 	echo
7 	echo "======================"
8 	echo "runtime tests skipped!"
9 	echo "======================"
10 	echo
11 	exit 0
12 fi
13 
14 ggflags=
15 
16 port=10965
17 
18 config_common="
19 ipv6 off
20 port $port
21 "
22 
23 # usage: config <global config> <stuff for localhost>
24 # generates a configuration file reg.conf
25 config() {
26 	cat <<EOF > reg.conf
27 $config_common
28 $1
29 server "localhost" {
30 	cert "$PWD/cert.pem"
31 	key  "$PWD/key.pem"
32 	root "$PWD/testdata"
33 	$2
34 }
35 EOF
36 }
37 
38 checkconf() {
39 	./../gmid -n -c reg.conf
40 }
41 
42 # usage: get <path>
43 # return the body of the request on stdout
44 get() {
45 	./gg -T30 -b $ggflags "gemini://localhost:10965/$1"
46 }
47 
48 # usage: head <path>
49 # return the meta response line on stdout
50 head() {
51 	./gg -T30 -h $ggflags "gemini://localhost:10965/$1"
52 }
53 
54 # usage: raw <path>
55 # return both header and body
56 raw() {
57 	./gg -T30 $ggflags "gemini://localhost:10965/$1"
58 }
59 
60 run() {
61 	./../gmid -f -c reg.conf &
62 	pid=$!
63 	# give gmid time to bind the port, otherwise we end up
64 	# executing gg when gmid isn't ready yet.
65 	sleep 1
66 }
67 
68 # usage: check [exit-message]
69 # check if gmid is still running
70 check() {
71 	if ! ps $pid >/dev/null; then
72 		echo ${1:-"gmid crashed?"}
73 		exit 1
74 	fi
75 }
76 
77 restart() {
78 	kill -HUP $pid
79 	sleep 1
80 }
81 
82 # quit gmid
83 quit() {
84 	kill $pid || true
85 	wait || true
86 }
87 
88 count() {
89 	wc -l | xargs
90 }
91 
92 # usage: eq a b errmsg
93 # if a and b aren't equal strings, exit with errmsg
94 eq() {
95 	if ! [ "$1" = "$2" ]; then
96 		echo "$3: \"$1\" not equal \"$2\""
97 		exit 1
98 	fi
99 }
100 
101 onexit() {
102 	rm -f bigfile bigfile.sha
103 	quit
104 }
105 
106 # configless tests
107 
108 ./../gmid -p $port -H localhost -d . testdata &
109 pid=$!
110 sleep 1
111 
112 eq "$(head /)"		"20 text/gemini"	"Unexpected head for /"
113 eq "$(get /)"		"# hello world$ln"	"Unexpected body for /"
114 echo OK GET / in configless mode
115 quit
116 
117 # daemon tests
118 
119 trap 'onexit' INT TERM EXIT
120 
121 endl=`printf "\r\n"`
122 lf=`echo`
123 
124 config "" ""
125 checkconf
126 run
127 
128 eq "$(head /)"		"20 text/gemini"	"Unexpected head for /"
129 eq "$(get /)"		"# hello world$ln"	"Unexpected body for /"
130 echo OK GET /
131 
132 eq "$(head /foo)"	"51 not found"		"Unexpected head /foo"
133 eq "$(get /foo)"	""			"Unexpected body /foo"
134 echo OK GET /foo
135 
136 # should redirect if asked for a directory but without the trailing /
137 eq "$(head /dir)"	"30 /dir/"		"Unexpected redirect for /dir"
138 eq "$(get  /dir)"	""			"Unexpected body for redirect"
139 echo OK GET /dir
140 
141 # 51 for a directory without index.gmi
142 eq "$(head /dir/)"	"51 not found"		"Unexpected head for /"
143 eq "$(get  /dir/)"	""			"Unexpected body for error"
144 echo OK GET /dir/
145 
146 eq "$(head /dir/foo.gmi)" "20 text/gemini"	"Unexpected head for /dir/foo.gmi"
147 eq "$(get  /dir/foo.gmi)" "# hello world$ln"	"Unexpected body for /dir/foo.gmi"
148 echo OK GET /dir/foo.gmi
149 
150 # try a big file
151 eq "$(head /bigfile)"	"20 application/octet-stream" "Unexpected head for /bigfile"
152 get /bigfile > bigfile
153 ./sha bigfile bigfile.sha
154 eq "$(cat bigfile.sha)"	"$(cat testdata/bigfile.sha)" "Unexpected sha for /bigfile"
155 echo OK GET /bigfile
156 
157 # shouldn't be executing cgi scripts
158 eq "$(head /hello)"	"20 application/octet-stream" "Unexpected head for /hello"
159 echo OK GET /hello
160 
161 check "should be running"
162 
163 # try with custom mime
164 config 'map "text/x-funny-text" to-ext "gmi"' 'default type "application/x-trash"'
165 checkconf
166 restart
167 
168 eq "$(head /)"		"20 text/x-funny-text"		"Unexpected head for /"
169 echo OK GET / with custom mime
170 
171 eq "$(head /hello)"	"20 application/x-trash"	"Unexpected head for /hello"
172 echo OK GET /hello with custom mime
173 
174 check "should be running"
175 
176 # try with custom lang
177 config '' 'lang "it"'
178 checkconf
179 restart
180 
181 eq "$(head /)"		"20 text/gemini; lang=it"	"Unexpected head for /"
182 echo OK GET / with custom lang
183 
184 check "should be running"
185 
186 # make sure we can use different lang in different location rules
187 config '' 'lang "it" location "/en/*" { lang "en" } location "/de/*" { lang "de" }'
188 checkconf
189 echo OK parse multiple locations correctly
190 restart
191 
192 # try with CGI scripts
193 config '' 'cgi "*"'
194 checkconf
195 restart
196 
197 eq "$(head /hello)"	"20 text/gemini"		"Unexpected head for /hello"
198 eq "$(get  /hello)"	"# hello world$ln"		"Unexpected body for /hello"
199 echo OK GET /hello with cgi
200 
201 eq "$(head /slow)"	"20 text/gemini"		"Unexpected head for /slow"
202 eq "$(get  /slow)"	"# hello world$ln"		"Unexpected body for /slow"
203 echo OK GET /slow with cgi
204 
205 eq "$(head /err)"	"42 CGI error"	"Unexpected head for /err"
206 eq "$(get  /err)"	""		"Unexpected body for /err"
207 echo OK GET /err with cgi
208 
209 eq "$(raw /invalid | wc -c | xargs)" 2048		"Unexpected body for /invalid"
210 echo OK GET /invalid with cgi
211 
212 eq "$(raw /max-length-reply | wc -c | xargs)" 1029	"Unexpected header for /max-length-reply"
213 echo OK GET /max-length-reply with cgi
214 
215 # try a big file
216 eq "$(head /serve-bigfile)"	"20 application/octet-stream" "Unexpected head for /serve-bigfile"
217 get /bigfile > bigfile
218 ./sha bigfile bigfile.sha
219 eq "$(cat bigfile.sha)"	"$(cat testdata/bigfile.sha)" "Unexpected sha for /serve-bigfile"
220 echo OK GET /serve-bigfile with cgi
221 
222 # ensure we split the query correctly
223 eq "$(get /env | awk /^-/ | count)"		1	"Unexpected number of arguments"
224 eq "$(get /env?foo | awk /^-/ | count)"		2	"Unexpected number of arguments"
225 eq "$(get /env?foo+bar | awk /^-/ | count)"	3	"Unexpected number of arguments"
226 eq "$(get /env?foo+bar=5 | awk /^-/ | count)"	1	"Unexpected number of arguments"
227 eq "$(get /env?foo+bar%3d5 | awk /^-/ | count)"	3	"Unexpected number of arguments"
228 
229 check "should be running"
230 
231 config '' 'index "foo.gmi"'
232 checkconf
233 restart
234 
235 eq "$(head /dir/)"	"20 text/gemini"	"Unexpected head for /"
236 eq "$(get  /dir/)"	"# hello world$ln"	"Unexpected body for error"
237 echo OK GET /dir/ with custom index
238 
239 check "should be running"
240 
241 config '' 'location "/dir/*" { default type "text/plain" index "hello" }'
242 checkconf
243 restart
244 
245 eq "$(head /dir/hello)"	"20 text/plain"			"Unexpected head for /"
246 echo OK GET /dir/hello with location and default type
247 
248 eq "$(head /dir/)"	"20 text/plain"			"Unexpected head for /dir/"
249 eq "$(get  /dir/|tail -1)" 'echo "# hello world"'	"Unexpected body for /dir/"
250 echo OK GET /dir/ with location and custom index
251 
252 check "should be running"
253 
254 config '' 'location "/dir/*" { auto index on }'
255 checkconf
256 restart
257 
258 eq "$(head /)"		"20 text/gemini"		"Unexpected head for /"
259 eq "$(get  /)"		"# hello world$ln"		"Unexpected body for /"
260 echo OK GET / with auto index
261 
262 eq "$(head /dir)"		"30 /dir/"		"Unexpected head for /dir"
263 eq "$(head /dir/)"		"20 text/gemini"	"Unexpected head for /dir/"
264 eq "$(get /dir/|wc -l|xargs)"	"5"			"Unexpected body for /dir/"
265 echo OK GET /dir/ with auto index on
266 
267 check "should be running"
268 
269 # test block return and strip
270 
271 config '' 'location "*" { block }'
272 checkconf
273 restart
274 
275 eq "$(head /)"		"40 temporary failure"		"Unexpected head for /"
276 eq "$(get /)"		""				"Unexpected body for /"
277 echo OK GET / with block
278 
279 eq "$(head /nonexists)"	"40 temporary failure"		"Unexpected head for /nonexists"
280 eq "$(get /nonexists)"	""				"Unexpected body for /nonexists"
281 echo OK GET /nonexists with block
282 
283 check "should be running"
284 
285 config '' '
286 location "/dir" {
287 	strip 1
288 	block return 40 "%% %p %q %P %N test"
289 }
290 location "*" {
291 	strip 99
292 	block return 40 "%% %p %q %P %N test"
293 }'
294 checkconf
295 restart
296 
297 eq "$(head /dir/foo.gmi)"	"40 % /foo.gmi  10965 localhost test"
298 echo OK GET /dir/foo.gmi with strip and block
299 
300 eq "$(head /bigfile)"		"40 % /  10965 localhost test"
301 echo OK GET /bigfile with strip and block
302 
303 check "should be running"
304 
305 # test the entrypoint
306 
307 config '' 'entrypoint "/env"'
308 checkconf
309 restart
310 
311 eq "$(head /foo/bar)"	"20 text/plain; lang=en"	"Unknown head for /foo/bar"
312 eq "$(get /foo/bar|grep PATH_INFO)" "PATH_INFO=/foo/bar" "Unexpected PATH_INFO"
313 echo OK GET /foo/bar with entrypoint
314 
315 # test with require ca
316 
317 config '' 'require client ca "'$PWD'/testca.pem"'
318 checkconf
319 restart
320 
321 eq "$(head /)"		"60 client certificate required" "Unexpected head for /"
322 echo OK GET / without client certificate
323 
324 ggflags="-C valid.crt -K valid.key"
325 eq "$(head /)"		"20 text/gemini"		"Unexpected head for /"
326 echo OK GET / with valid client certificate
327 
328 ggflags="-C invalid.cert.pem -K invalid.key.pem"
329 eq "$(head /)"		"61 certificate not authorised"	"Unexpected head for /"
330 echo OK GET / with invalid client certificate
331 
332 ggflags=''
333 
334 
335 # test with root inside a location
336 
337 config '' 'location "/foo/*" { root "'$PWD'/testdata" strip 1 }'
338 checkconf
339 restart
340 
341 eq "$(head /foo)"	"51 not found"		"Unexpected head for /foo"
342 eq "$(head /foo/)"	"20 text/gemini"	"Unexpected head for /foo/"
343 echo OK /foo and /foo/ with root inside location
344 
345 # how to match both /foo and /foo/*
346 config '' '
347 	location "/foo"   { block return 31 "%p/" }
348 	location "/foo/*" { root "'$PWD'/testdata" strip 1 }
349 '
350 checkconf
351 restart
352 
353 eq "$(head /foo)"	"31 /foo/"		"Unexpected head for /foo"
354 eq "$(head /foo/)"	"20 text/gemini"	"Unexpected head for /foo/"
355 echo OK /foo and /foo/ with root inside location
356 
357 # test with fastcgi
358 
359 # NB: the fcgi spawn is NOT supported outside of this test suite
360 
361 config 'prefork 1' 'fastcgi spawn "'$PWD'/fcgi-test"'
362 checkconf
363 restart
364 
365 eq "$(head /)"		"20 text/gemini"	"Unexpected head for /"
366 eq "$(get /)"		"# Hello, world!"	"Unexpected body for /"
367 echo OK GET / with fastcgi
368 
369 # test macro expansion
370 
371 cat <<EOF > reg.conf
372 pwd = "$PWD"
373 $config_common
374 
375 server "localhost" {
376 	# the quoting of \$ is for sh
377 	cert \$pwd "/cert.pem"
378 	key  \$pwd "/key.pem"
379 	root \$pwd "/testdata"
380 }
381 EOF
382 checkconf
383 restart
384 
385 eq "$(head /)"		"20 text/gemini"	"Unexpected head for /"
386 eq "$(get /)"		"# hello world$ln"	"Unexpected body for /"
387 echo OK GET / with macro expansion