xref: /unit/test/test_static.py (revision 1848:4bd548074e2c) 
1import os
2import socket
3
4import pytest
5
6from unit.applications.proto import TestApplicationProto
7from unit.option import option
8from unit.utils import waitforfiles
9
10
11class TestStatic(TestApplicationProto):
12    prerequisites = {}
13
14    def setup_method(self):
15        os.makedirs(option.temp_dir + '/assets/dir')
16        with open(option.temp_dir + '/assets/index.html', 'w') as index, open(
17            option.temp_dir + '/assets/README', 'w'
18        ) as readme, open(
19            option.temp_dir + '/assets/log.log', 'w'
20        ) as log, open(
21            option.temp_dir + '/assets/dir/file', 'w'
22        ) as file:
23            index.write('0123456789')
24            readme.write('readme')
25            log.write('[debug]')
26            file.write('blah')
27
28        self._load_conf(
29            {
30                "listeners": {"*:7080": {"pass": "routes"}},
31                "routes": [{"action": {"share": option.temp_dir + "/assets"}}],
32                "settings": {
33                    "http": {
34                        "static": {
35                            "mime_types": {"text/plain": [".log", "README"]}
36                        }
37                    }
38                },
39            }
40        )
41
42    def test_static_index(self):
43        assert self.get(url='/index.html')['body'] == '0123456789', 'index'
44        assert self.get(url='/')['body'] == '0123456789', 'index 2'
45        assert self.get(url='//')['body'] == '0123456789', 'index 3'
46        assert self.get(url='/.')['body'] == '0123456789', 'index 4'
47        assert self.get(url='/./')['body'] == '0123456789', 'index 5'
48        assert self.get(url='/?blah')['body'] == '0123456789', 'index vars'
49        assert self.get(url='/#blah')['body'] == '0123456789', 'index anchor'
50        assert self.get(url='/dir/')['status'] == 404, 'index not found'
51
52        resp = self.get(url='/index.html/')
53        assert resp['status'] == 404, 'index not found 2 status'
54        assert (
55            resp['headers']['Content-Type'] == 'text/html'
56        ), 'index not found 2 Content-Type'
57
58    def test_static_large_file(self, temp_dir):
59        file_size = 32 * 1024 * 1024
60        with open(temp_dir + '/assets/large', 'wb') as f:
61            f.seek(file_size - 1)
62            f.write(b'\0')
63
64        assert (
65            len(self.get(url='/large', read_buffer_size=1024 * 1024)['body'])
66            == file_size
67        ), 'large file'
68
69    def test_static_etag(self, temp_dir):
70        etag = self.get(url='/')['headers']['ETag']
71        etag_2 = self.get(url='/README')['headers']['ETag']
72
73        assert etag != etag_2, 'different ETag'
74        assert etag == self.get(url='/')['headers']['ETag'], 'same ETag'
75
76        with open(temp_dir + '/assets/index.html', 'w') as f:
77            f.write('blah')
78
79        assert etag != self.get(url='/')['headers']['ETag'], 'new ETag'
80
81    def test_static_redirect(self):
82        resp = self.get(url='/dir')
83        assert resp['status'] == 301, 'redirect status'
84        assert resp['headers']['Location'] == '/dir/', 'redirect Location'
85        assert 'Content-Type' not in resp['headers'], 'redirect Content-Type'
86
87    def test_static_space_in_name(self, temp_dir):
88        os.rename(
89            temp_dir + '/assets/dir/file', temp_dir + '/assets/dir/fi le',
90        )
91        assert waitforfiles(temp_dir + '/assets/dir/fi le')
92        assert self.get(url='/dir/fi le')['body'] == 'blah', 'file name'
93
94        os.rename(temp_dir + '/assets/dir', temp_dir + '/assets/di r')
95        assert waitforfiles(temp_dir + '/assets/di r/fi le')
96        assert self.get(url='/di r/fi le')['body'] == 'blah', 'dir name'
97
98        os.rename(temp_dir + '/assets/di r', temp_dir + '/assets/ di r ')
99        assert waitforfiles(temp_dir + '/assets/ di r /fi le')
100        assert (
101            self.get(url='/ di r /fi le')['body'] == 'blah'
102        ), 'dir name enclosing'
103
104        assert (
105            self.get(url='/%20di%20r%20/fi le')['body'] == 'blah'
106        ), 'dir encoded'
107        assert (
108            self.get(url='/ di r %2Ffi le')['body'] == 'blah'
109        ), 'slash encoded'
110        assert (
111            self.get(url='/ di r /fi%20le')['body'] == 'blah'
112        ), 'file encoded'
113        assert (
114            self.get(url='/%20di%20r%20%2Ffi%20le')['body'] == 'blah'
115        ), 'encoded'
116        assert (
117            self.get(url='/%20%64%69%20%72%20%2F%66%69%20%6C%65')['body']
118            == 'blah'
119        ), 'encoded 2'
120
121        os.rename(
122            temp_dir + '/assets/ di r /fi le',
123            temp_dir + '/assets/ di r / fi le ',
124        )
125        assert waitforfiles(temp_dir + '/assets/ di r / fi le ')
126        assert (
127            self.get(url='/%20di%20r%20/%20fi%20le%20')['body'] == 'blah'
128        ), 'file name enclosing'
129
130        try:
131            open(temp_dir + '/ф а', 'a').close()
132            utf8 = True
133
134        except KeyboardInterrupt:
135            raise
136
137        except:
138            utf8 = False
139
140        if utf8:
141            os.rename(
142                temp_dir + '/assets/ di r / fi le ',
143                temp_dir + '/assets/ di r /фа йл',
144            )
145            assert waitforfiles(temp_dir + '/assets/ di r /фа йл')
146            assert (
147                self.get(url='/ di r /фа йл')['body'] == 'blah'
148            ), 'file name 2'
149
150            os.rename(
151                temp_dir + '/assets/ di r ', temp_dir + '/assets/ди ректория',
152            )
153            assert waitforfiles(temp_dir + '/assets/ди ректория/фа йл')
154            assert (
155                self.get(url='/ди ректория/фа йл')['body'] == 'blah'
156            ), 'dir name 2'
157
158    def test_static_unix_socket(self, temp_dir):
159        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
160        sock.bind(temp_dir + '/assets/unix_socket')
161
162        assert self.get(url='/unix_socket')['status'] == 404, 'socket'
163
164        sock.close()
165
166    def test_static_unix_fifo(self, temp_dir):
167        os.mkfifo(temp_dir + '/assets/fifo')
168
169        assert self.get(url='/fifo')['status'] == 404, 'fifo'
170
171    def test_static_symlink(self, temp_dir):
172        os.symlink(temp_dir + '/assets/dir', temp_dir + '/assets/link')
173
174        assert self.get(url='/dir')['status'] == 301, 'dir'
175        assert self.get(url='/dir/file')['status'] == 200, 'file'
176        assert self.get(url='/link')['status'] == 301, 'symlink dir'
177        assert self.get(url='/link/file')['status'] == 200, 'symlink file'
178
179    def test_static_method(self):
180        resp = self.head()
181        assert resp['status'] == 200, 'HEAD status'
182        assert resp['body'] == '', 'HEAD empty body'
183
184        assert self.delete()['status'] == 405, 'DELETE'
185        assert self.post()['status'] == 405, 'POST'
186        assert self.put()['status'] == 405, 'PUT'
187
188    def test_static_path(self):
189        assert self.get(url='/dir/../dir/file')['status'] == 200, 'relative'
190
191        assert self.get(url='./')['status'] == 400, 'path invalid'
192        assert self.get(url='../')['status'] == 400, 'path invalid 2'
193        assert self.get(url='/..')['status'] == 400, 'path invalid 3'
194        assert self.get(url='../assets/')['status'] == 400, 'path invalid 4'
195        assert self.get(url='/../assets/')['status'] == 400, 'path invalid 5'
196
197    def test_static_two_clients(self):
198        _, sock = self.get(url='/', start=True, no_recv=True)
199        _, sock2 = self.get(url='/', start=True, no_recv=True)
200
201        assert sock.recv(1) == b'H', 'client 1'
202        assert sock2.recv(1) == b'H', 'client 2'
203        assert sock.recv(1) == b'T', 'client 1 again'
204        assert sock2.recv(1) == b'T', 'client 2 again'
205
206        sock.close()
207        sock2.close()
208
209    def test_static_mime_types(self):
210        assert 'success' in self.conf(
211            {
212                "text/x-code/x-blah/x-blah": "readme",
213                "text/plain": [".html", ".log", "file"],
214            },
215            'settings/http/static/mime_types',
216        ), 'configure mime_types'
217
218        assert (
219            self.get(url='/README')['headers']['Content-Type']
220            == 'text/x-code/x-blah/x-blah'
221        ), 'mime_types string case insensitive'
222        assert (
223            self.get(url='/index.html')['headers']['Content-Type']
224            == 'text/plain'
225        ), 'mime_types html'
226        assert (
227            self.get(url='/')['headers']['Content-Type'] == 'text/plain'
228        ), 'mime_types index default'
229        assert (
230            self.get(url='/dir/file')['headers']['Content-Type']
231            == 'text/plain'
232        ), 'mime_types file in dir'
233
234    def test_static_mime_types_partial_match(self):
235        assert 'success' in self.conf(
236            {"text/x-blah": ["ile", "fil", "f", "e", ".file"],},
237            'settings/http/static/mime_types',
238        ), 'configure mime_types'
239        assert 'Content-Type' not in self.get(url='/dir/file'), 'partial match'
240
241    def test_static_mime_types_reconfigure(self):
242        assert 'success' in self.conf(
243            {
244                "text/x-code": "readme",
245                "text/plain": [".html", ".log", "file"],
246            },
247            'settings/http/static/mime_types',
248        ), 'configure mime_types'
249
250        assert self.conf_get('settings/http/static/mime_types') == {
251            'text/x-code': 'readme',
252            'text/plain': ['.html', '.log', 'file'],
253        }, 'mime_types get'
254        assert (
255            self.conf_get('settings/http/static/mime_types/text%2Fx-code')
256            == 'readme'
257        ), 'mime_types get string'
258        assert self.conf_get(
259            'settings/http/static/mime_types/text%2Fplain'
260        ) == ['.html', '.log', 'file'], 'mime_types get array'
261        assert (
262            self.conf_get('settings/http/static/mime_types/text%2Fplain/1')
263            == '.log'
264        ), 'mime_types get array element'
265
266        assert 'success' in self.conf_delete(
267            'settings/http/static/mime_types/text%2Fplain/2'
268        ), 'mime_types remove array element'
269        assert (
270            'Content-Type' not in self.get(url='/dir/file')['headers']
271        ), 'mime_types removed'
272
273        assert 'success' in self.conf_post(
274            '"file"', 'settings/http/static/mime_types/text%2Fplain'
275        ), 'mime_types add array element'
276        assert (
277            self.get(url='/dir/file')['headers']['Content-Type']
278            == 'text/plain'
279        ), 'mime_types reverted'
280
281        assert 'success' in self.conf(
282            '"file"', 'settings/http/static/mime_types/text%2Fplain'
283        ), 'configure mime_types update'
284        assert (
285            self.get(url='/dir/file')['headers']['Content-Type']
286            == 'text/plain'
287        ), 'mime_types updated'
288        assert (
289            'Content-Type' not in self.get(url='/log.log')['headers']
290        ), 'mime_types updated 2'
291
292        assert 'success' in self.conf(
293            '".log"', 'settings/http/static/mime_types/text%2Fblahblahblah'
294        ), 'configure mime_types create'
295        assert (
296            self.get(url='/log.log')['headers']['Content-Type']
297            == 'text/blahblahblah'
298        ), 'mime_types create'
299
300    def test_static_mime_types_correct(self):
301        assert 'error' in self.conf(
302            {"text/x-code": "readme", "text/plain": "readme"},
303            'settings/http/static/mime_types',
304        ), 'mime_types same extensions'
305        assert 'error' in self.conf(
306            {"text/x-code": [".h", ".c"], "text/plain": ".c"},
307            'settings/http/static/mime_types',
308        ), 'mime_types same extensions array'
309        assert 'error' in self.conf(
310            {"text/x-code": [".h", ".c", "readme"], "text/plain": "README",},
311            'settings/http/static/mime_types',
312        ), 'mime_types same extensions case insensitive'
313
314    @pytest.mark.skip('not yet')
315    def test_static_mime_types_invalid(self, temp_dir):
316        assert 'error' in self.http(
317            b"""PUT /config/settings/http/static/mime_types/%0%00% HTTP/1.1\r
318Host: localhost\r
319Connection: close\r
320Content-Length: 6\r
321\r
322\"blah\"""",
323            raw_resp=True,
324            raw=True,
325            sock_type='unix',
326            addr=temp_dir + '/control.unit.sock',
327        ), 'mime_types invalid'
328