summaryrefslogtreecommitdiff
path: root/crocoite/test_browser.py
blob: cf7be3946c50e024f9b7472326fb100a3afb4df5 (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
# Copyright (c) 2017 crocoite contributors
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

import pytest
from operator import itemgetter
from http.server import BaseHTTPRequestHandler

from .browser import Item, SiteLoader, ChromeService

class TItem (Item):
    """ This should be as close to Item as possible """

    __slots__ = ('bodySend', '_body')
    base = 'http://localhost:8000/'

    def __init__ (self, path, status, headers, bodyReceive, bodySend=None):
        super ().__init__ (tab=None)
        self.chromeResponse = {'response': {'headers': headers, 'status': status, 'url': self.base + path}}
        self._body = bodyReceive, False
        self.bodySend = bodyReceive if not bodySend else bodySend

    @property
    def body (self):
        return self._body

testItems = [
    TItem ('binary', 200, {'Content-Type': 'application/octet-stream'}, b'\x00\x01\x02'),
    TItem ('attachment', 200, 
            {'Content-Type': 'text/plain; charset=utf-8',
            'Content-Disposition': 'attachment; filename="attachment.txt"',
            },
            'This is a simple text file with umlauts. ÄÖU.'.encode ('utf8')),
    TItem ('encoding/utf8', 200, {'Content-Type': 'text/plain; charset=utf-8'},
            'This is a test, äöü μνψκ ¥¥¥¿ýý¡'.encode ('utf8')),
    TItem ('encoding/iso88591', 200, {'Content-Type': 'text/plain; charset=ISO-8859-1'},
            'This is a test, äöü.'.encode ('utf8'),
            'This is a test, äöü.'.encode ('ISO-8859-1')),
    TItem ('encoding/latin1', 200, {'Content-Type': 'text/plain; charset=latin1'},
            'This is a test, äöü.'.encode ('utf8'),
            'This is a test, äöü.'.encode ('latin1')),
    TItem ('image', 200, {'Content-Type': 'image/png'},
            # 1×1 png image
            b'\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x08\x00\x00\x00\x00:~\x9bU\x00\x00\x00\nIDAT\x08\x1dc\xf8\x0f\x00\x01\x01\x01\x006_g\x80\x00\x00\x00\x00IEND\xaeB`\x82'),
    TItem ('empty', 200, {}, b''),
    TItem ('redirect/301/empty', 301, {'Location': '/empty'}, b''),
    TItem ('redirect/301/redirect/301/empty', 301, {'Location': '/redirect/301/empty'}, b''),
    TItem ('nonexistent', 404, {}, b''),
    TItem ('html', 200, {'Content-Type': 'html'},
            '<html><body><img src="/image"><img src="/nonexistent"></body></html>'.encode ('utf8')),
    TItem ('html/alert', 200, {'Content-Type': 'html'},
            '<html><body><script>window.addEventListener("beforeunload", function (e) { e.returnValue = "bye?"; return e.returnValue; }); alert("stopping here"); if (confirm("are you sure?") || prompt ("42?")) { window.location = "/nonexistent"; }</script><img src="/image"></body></html>'.encode ('utf8')),
    ]
testItemMap = dict ([(item.parsedUrl.path, item) for item in testItems])

class RequestHandler (BaseHTTPRequestHandler):
    def do_GET(self):
        item = testItemMap.get (self.path)
        if item:
            self.send_response (item.response['status'])
            for k, v in item.response['headers'].items ():
                self.send_header (k, v)
            body = item.bodySend
            self.send_header ('Content-Length', len (body))
            self.end_headers()
            self.wfile.write (body)
        return
            
    def log_message (self, format, *args):
        pass

@pytest.fixture
def http ():
    def run ():
        import http.server
        PORT = 8000
        httpd = http.server.HTTPServer (("localhost", PORT), RequestHandler)
        print ('starting http server')
        httpd.serve_forever()

    from multiprocessing import Process
    p = Process (target=run)
    p.start ()
    yield p
    p.terminate ()
    p.join ()

@pytest.fixture
def loader (http):
    def f (path):
        assert path.startswith ('/')
        return SiteLoader (browser, 'http://localhost:8000{}'.format (path))
    print ('loader setup')
    with ChromeService () as browser:
        yield f
    print ('loader teardown')

def itemsLoaded (l, items):
    items = dict ([(i.parsedUrl.path, i) for i in items])
    timeout = 5
    while True:
        if not l.notify.wait (timeout) and len (items) > 0:
            assert False, 'timeout'
        if len (l.queue) > 0:
            item = l.queue.popleft ()
            if isinstance (item, Exception):
                raise item
            assert item.chromeResponse is not None
            golden = items.pop (item.parsedUrl.path)
            if not golden:
                assert False, 'url {} not supposed to be fetched'.format (item.url)
            assert item.body[0] == golden.body[0]
            assert item.response['status'] == golden.response['status']
            for k, v in golden.responseHeaders:
                actual = list (map (itemgetter (1), filter (lambda x: x[0] == k, item.responseHeaders)))
                assert v in actual

        # check queue at least once
        if not items:
            break

def literalItem (lf, item, deps=[]):
    with lf (item.parsedUrl.path) as l:
        l.start ()
        itemsLoaded (l, [item] + deps)

def test_empty (loader):
    literalItem (loader, testItemMap['/empty'])

def test_redirect (loader):
    literalItem (loader, testItemMap['/redirect/301/empty'], [testItemMap['/empty']])
    # chained redirects
    literalItem (loader, testItemMap['/redirect/301/redirect/301/empty'], [testItemMap['/redirect/301/empty'], testItemMap['/empty']])

def test_encoding (loader):
    """ Text responses are transformed to UTF-8. Make sure this works
    correctly. """
    for item in {testItemMap['/encoding/utf8'], testItemMap['/encoding/latin1'], testItemMap['/encoding/iso88591']}:
        literalItem (loader, item)

def test_binary (loader):
    """ Browser should ignore content it cannot display (i.e. octet-stream) """
    with loader ('/binary') as l:
        l.start ()
        itemsLoaded (l, [])

def test_image (loader):
    """ Images should be displayed inline """
    literalItem (loader, testItemMap['/image'])

def test_attachment (loader):
    """ And downloads won’t work in headless mode, even if it’s just a text file """
    with loader ('/attachment') as l:
        l.start ()
        itemsLoaded (l, [])

def test_html (loader):
    literalItem (loader, testItemMap['/html'], [testItemMap['/image'], testItemMap['/nonexistent']])
    # make sure alerts are dismissed correctly (image won’t load otherwise)
    literalItem (loader, testItemMap['/html/alert'], [testItemMap['/image']])