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