-
Notifications
You must be signed in to change notification settings - Fork 376
/
test_stateful_browser.py
655 lines (539 loc) · 22.5 KB
/
test_stateful_browser.py
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
import os
import tempfile
import json
import setpath # noqa:F401, must come before 'import mechanicalsoup'
import mechanicalsoup
import sys
import re
from bs4 import BeautifulSoup
from utils import (
setup_mock_browser,
prepare_mock_browser,
mock_get,
open_legacy_httpbin
)
import pytest
import webbrowser
def test_request_forward():
data = [('var1', 'val1'), ('var2', 'val2')]
browser, url = setup_mock_browser(expected_post=data)
r = browser.request('POST', url + '/post', data=data)
assert r.text == 'Success!'
def test_properties():
"""Check that properties return the same value as the getter."""
browser = mechanicalsoup.StatefulBrowser()
browser.open_fake_page('<form></form>', url="http://example.com")
assert browser.page == browser.get_current_page()
assert browser.page is not None
assert browser.url == browser.get_url()
assert browser.url is not None
browser.select_form()
assert browser.form == browser.get_current_form()
assert browser.form is not None
def test_submit_online(httpbin):
"""Complete and submit the pizza form at http://httpbin.org/forms/post """
browser = mechanicalsoup.StatefulBrowser()
browser.set_user_agent('testing MechanicalSoup')
browser.open(httpbin.url)
for link in browser.links():
if link["href"] == "/":
browser.follow_link(link)
break
browser.follow_link("forms/post")
assert browser.get_url() == httpbin + "/forms/post"
browser.select_form("form")
browser["custname"] = "Customer Name Here"
browser["size"] = "medium"
browser["topping"] = ("cheese", "bacon")
# Change our mind to make sure old boxes are unticked
browser["topping"] = ("cheese", "onion")
browser["comments"] = "Some comment here"
browser.get_current_form().set("nosuchfield", "new value", True)
response = browser.submit_selected()
json = response.json()
data = json["form"]
assert data["custname"] == "Customer Name Here"
assert data["custtel"] == "" # web browser submits "" for input left blank
assert data["size"] == "medium"
assert set(data["topping"]) == set(("cheese", "onion"))
assert data["comments"] == "Some comment here"
assert data["nosuchfield"] == "new value"
assert json["headers"]["User-Agent"] == 'testing MechanicalSoup'
# Ensure we haven't blown away any regular headers
expected_headers = ('Content-Length', 'Host', 'Content-Type', 'Connection',
'Accept', 'User-Agent', 'Accept-Encoding')
assert set(expected_headers).issubset(json["headers"].keys())
def test_no_404(httpbin):
browser = mechanicalsoup.StatefulBrowser()
resp = browser.open(httpbin + "/nosuchpage")
assert resp.status_code == 404
def test_404(httpbin):
browser = mechanicalsoup.StatefulBrowser(raise_on_404=True)
with pytest.raises(mechanicalsoup.LinkNotFoundError):
resp = browser.open(httpbin + "/nosuchpage")
resp = browser.open(httpbin.url)
assert resp.status_code == 200
def test_user_agent(httpbin):
browser = mechanicalsoup.StatefulBrowser(user_agent='007')
resp = browser.open(httpbin + "/user-agent")
assert resp.json() == {'user-agent': '007'}
def test_open_relative(httpbin):
# Open an arbitrary httpbin page to set the current URL
browser = mechanicalsoup.StatefulBrowser()
browser.open(httpbin + "/html")
# Open a relative page and make sure remote host and browser agree on URL
resp = browser.open_relative("/get")
assert resp.json()['url'] == httpbin + "/get"
assert browser.get_url() == httpbin + "/get"
# Test passing additional kwargs to the session
resp = browser.open_relative("/basic-auth/me/123", auth=('me', '123'))
assert browser.get_url() == httpbin + "/basic-auth/me/123"
assert resp.json() == {"authenticated": True, "user": "me"}
def test_links():
browser = mechanicalsoup.StatefulBrowser()
html = '''<a class="bluelink" href="/blue" id="blue_link">A Blue Link</a>
<a class="redlink" href="/red" id="red_link">A Red Link</a>'''
expected = [BeautifulSoup(html, "lxml").a]
browser.open_fake_page(html)
# Test StatefulBrowser.links url_regex argument
assert browser.links(url_regex="bl") == expected
assert browser.links(url_regex="bluish") == []
# Test StatefulBrowser.links link_text argument
assert browser.links(link_text="A Blue Link") == expected
assert browser.links(link_text="Blue") == []
# Test StatefulBrowser.links kwargs passed to BeautifulSoup.find_all
assert browser.links(string=re.compile('Blue')) == expected
assert browser.links(class_="bluelink") == expected
assert browser.links(id="blue_link") == expected
assert browser.links(id="blue") == []
# Test returning a non-singleton
two_links = browser.links(id=re.compile('_link'))
assert len(two_links) == 2
assert two_links == BeautifulSoup(html, "lxml").find_all('a')
@pytest.mark.parametrize("expected_post", [
pytest.param(
[
('text', 'Setting some text!'),
('comment', 'Selecting an input submit'),
('diff', 'Review Changes'),
], id='input'),
pytest.param(
[
('text', '= Heading =\n\nNew page here!\n'),
('comment', 'Selecting a button submit'),
('cancel', 'Cancel'),
], id='button'),
])
def test_submit_btnName(expected_post):
'''Tests that the btnName argument chooses the submit button.'''
browser, url = setup_mock_browser(expected_post=expected_post)
browser.open(url)
browser.select_form('#choose-submit-form')
browser['text'] = dict(expected_post)['text']
browser['comment'] = dict(expected_post)['comment']
initial_state = browser._StatefulBrowser__state
res = browser.submit_selected(btnName=expected_post[2][0])
assert res.status_code == 200 and res.text == 'Success!'
assert initial_state != browser._StatefulBrowser__state
def test_submit_dont_update_state():
expected_post = [
('text', 'Bananas are good.'),
('preview', 'Preview Page')]
browser, url = setup_mock_browser(expected_post=expected_post)
browser.open(url)
browser.select_form('#choose-submit-form')
browser['text'] = dict(expected_post)['text']
initial_state = browser._StatefulBrowser__state
res = browser.submit_selected(update_state=False)
assert res.status_code == 200 and res.text == 'Success!'
assert initial_state == browser._StatefulBrowser__state
def test_get_set_debug():
browser = mechanicalsoup.StatefulBrowser()
# Debug mode is off by default
assert not browser.get_debug()
browser.set_debug(True)
assert browser.get_debug()
def test_list_links(capsys):
# capsys is a pytest fixture that allows us to inspect the std{err,out}
browser = mechanicalsoup.StatefulBrowser()
links = '''
<a href="/link1">Link #1</a>
<a href="/link2" id="link2"> Link #2</a>
'''
browser.open_fake_page('<html>{0}</html>'.format(links))
browser.list_links()
out, err = capsys.readouterr()
expected = 'Links in the current page:{0}'.format(links)
assert out == expected
def test_launch_browser(mocker):
browser = mechanicalsoup.StatefulBrowser()
browser.set_debug(True)
browser.open_fake_page('<html></html>')
mocker.patch('webbrowser.open')
with pytest.raises(mechanicalsoup.LinkNotFoundError):
browser.follow_link('nosuchlink')
# mock.assert_called_once() not available on some versions :-(
assert webbrowser.open.call_count == 1
mocker.resetall()
with pytest.raises(mechanicalsoup.LinkNotFoundError):
browser.select_form('nosuchlink')
# mock.assert_called_once() not available on some versions :-(
assert webbrowser.open.call_count == 1
def test_find_link():
browser = mechanicalsoup.StatefulBrowser()
browser.open_fake_page('<html></html>')
with pytest.raises(mechanicalsoup.LinkNotFoundError):
browser.find_link('nosuchlink')
def test_verbose(capsys):
'''Tests that the btnName argument chooses the submit button.'''
browser, url = setup_mock_browser()
browser.open(url)
out, err = capsys.readouterr()
assert out == ""
assert err == ""
assert browser.get_verbose() == 0
browser.set_verbose(1)
browser.open(url)
out, err = capsys.readouterr()
assert out == "."
assert err == ""
assert browser.get_verbose() == 1
browser.set_verbose(2)
browser.open(url)
out, err = capsys.readouterr()
assert out == "mock://form.com\n"
assert err == ""
assert browser.get_verbose() == 2
def test_new_control(httpbin):
browser = mechanicalsoup.StatefulBrowser()
browser.open(httpbin + "/forms/post")
browser.select_form("form")
with pytest.raises(mechanicalsoup.LinkNotFoundError):
# The control doesn't exist, yet.
browser["temperature"] = "cold"
browser["size"] = "large" # Existing radio
browser["comments"] = "This is a comment" # Existing textarea
browser.new_control("text", "temperature", "warm")
browser.new_control("textarea", "size", "Sooo big !")
browser.new_control("text", "comments", "This is an override comment")
browser.new_control("checkbox", "foo", "valval", checked="checked")
tag = browser.get_current_form().form.find("input", {"name": "foo"})
assert tag.attrs["checked"] == "checked"
browser["temperature"] = "hot"
response = browser.submit_selected()
json = response.json()
data = json["form"]
print(data)
assert data["temperature"] == "hot"
assert data["size"] == "Sooo big !"
assert data["comments"] == "This is an override comment"
assert data["foo"] == "valval"
submit_form_noaction = '''
<html>
<body>
<form id="choose-submit-form">
<input type="text" name="text1" value="someValue1" />
<input type="text" name="text2" value="someValue2" />
<input type="submit" name="save" />
</form>
</body>
</html>
'''
def test_form_noaction():
browser, url = setup_mock_browser()
browser.open_fake_page(submit_form_noaction)
browser.select_form('#choose-submit-form')
with pytest.raises(ValueError, match="no URL to submit to"):
browser.submit_selected()
submit_form_noname = '''
<html>
<body>
<form id="choose-submit-form" method="post" action="mock://form.com/post">
<textarea>Value</textarea> <!-- no name -->
<select> <!-- no name -->
<option value="tofu" selected="selected">Tofu Stir Fry</option>
<option value="curry">Red Curry</option>
<option value="tempeh">Tempeh Tacos</option>
</select>
</form>
</body>
</html>
'''
def test_form_noname():
browser, url = setup_mock_browser(expected_post=[])
browser.open_fake_page(submit_form_noname, url=url)
browser.select_form('#choose-submit-form')
response = browser.submit_selected()
assert response.status_code == 200 and response.text == 'Success!'
submit_form_multiple = '''
<html>
<body>
<form id="choose-submit-form" method="post" action="mock://form.com/post">
<select name="foo" multiple>
<option value="tofu" selected="selected">Tofu Stir Fry</option>
<option value="curry">Red Curry</option>
<option value="tempeh" selected="selected">Tempeh Tacos</option>
</select>
</form>
</body>
</html>
'''
def test_form_multiple():
browser, url = setup_mock_browser(expected_post=[('foo', 'tofu'),
('foo', 'tempeh')])
browser.open_fake_page(submit_form_multiple, url=url)
browser.select_form('#choose-submit-form')
response = browser.submit_selected()
assert response.status_code == 200 and response.text == 'Success!'
def test_upload_file(httpbin):
browser = mechanicalsoup.StatefulBrowser()
browser.open(httpbin + "/forms/post")
# Create two temporary files to upload
def make_file(content):
path = tempfile.mkstemp()[1]
with open(path, "w") as f:
f.write(content)
return path
path1, path2 = (make_file(content) for content in
("first file content", "second file content"))
# The form doesn't have a type=file field, but the target action
# does show it => add the fields ourselves, and add enctype too.
browser.select_form()
browser._StatefulBrowser__state.form.form[
"enctype"] = "multipart/form-data"
browser.new_control("file", "first", path1)
browser.new_control("file", "second", "")
browser["second"] = path2
browser.get_current_form().print_summary()
response = browser.submit_selected()
files = response.json()["files"]
assert files["first"] == "first file content"
assert files["second"] == "second file content"
def test_with():
"""Test that __enter__/__exit__ properly create/close the browser."""
with mechanicalsoup.StatefulBrowser() as browser:
assert browser.session is not None
assert browser.session is None
def test_select_form_nr():
"""Test the nr option of select_form."""
forms = """<form id="a"></form><form id="b"></form><form id="c"></form>"""
with mechanicalsoup.StatefulBrowser() as browser:
browser.open_fake_page(forms)
form = browser.select_form()
assert form.form['id'] == "a"
form = browser.select_form(nr=1)
assert form.form['id'] == "b"
form = browser.select_form(nr=2)
assert form.form['id'] == "c"
with pytest.raises(mechanicalsoup.LinkNotFoundError):
browser.select_form(nr=3)
def test_select_form_tag_object():
"""Test tag object as selector parameter type"""
forms = """<form id="a"></form><form id="b"></form><p></p>"""
soup = BeautifulSoup(forms, "lxml")
with mechanicalsoup.StatefulBrowser() as browser:
browser.open_fake_page(forms)
form = browser.select_form(soup.find("form", {"id": "b"}))
assert form.form['id'] == "b"
with pytest.raises(mechanicalsoup.LinkNotFoundError):
browser.select_form(soup.find("p"))
def test_referer_follow_link(httpbin):
browser = mechanicalsoup.StatefulBrowser()
open_legacy_httpbin(browser, httpbin)
start_url = browser.get_url()
response = browser.follow_link("/headers")
referer = response.json()["headers"]["Referer"]
actual_ref = re.sub('/*$', '', referer)
expected_ref = re.sub('/*$', '', start_url)
assert actual_ref == expected_ref
submit_form_headers = '''
<html>
<body>
<form method="get" action="{}" id="choose-submit-form">
<input type="text" name="text1" value="someValue1" />
<input type="text" name="text2" value="someValue2" />
<input type="submit" name="save" />
</form>
</body>
</html>
'''
def test_referer_submit(httpbin):
browser = mechanicalsoup.StatefulBrowser()
ref = "https://example.com/my-referer"
page = submit_form_headers.format(httpbin.url + "/headers")
browser.open_fake_page(page, url=ref)
browser.select_form()
response = browser.submit_selected()
headers = response.json()["headers"]
referer = headers["Referer"]
actual_ref = re.sub('/*$', '', referer)
assert actual_ref == ref
def test_referer_submit_headers(httpbin):
browser = mechanicalsoup.StatefulBrowser()
ref = "https://example.com/my-referer"
page = submit_form_headers.format(httpbin.url + "/headers")
browser.open_fake_page(page, url=ref)
browser.select_form()
response = browser.submit_selected(
headers={'X-Test-Header': 'x-test-value'})
headers = response.json()["headers"]
referer = headers["Referer"]
actual_ref = re.sub('/*$', '', referer)
assert actual_ref == ref
assert headers['X-Test-Header'] == 'x-test-value'
@pytest.mark.parametrize('expected, kwargs', [
pytest.param('/foo', {}, id='none'),
pytest.param('/get', {'text': 'Link'}, id='text'),
pytest.param('/get', {'url_regex': 'get'}, id='regex'),
])
def test_follow_link_arg(httpbin, expected, kwargs):
browser = mechanicalsoup.StatefulBrowser()
html = '<a href="/foo">Bar</a><a href="/get">Link</a>'
browser.open_fake_page(html, httpbin.url)
browser.follow_link(**kwargs)
assert browser.get_url() == httpbin + expected
def test_link_arg_multiregex(httpbin):
browser = mechanicalsoup.StatefulBrowser()
browser.open_fake_page('<a href="/get">Link</a>', httpbin.url)
with pytest.raises(ValueError, match="link parameter cannot be .*"):
browser.follow_link('foo', url_regex='bar')
def file_get_contents(filename):
with open(filename, "rb") as f:
return f.read()
def test_download_link(httpbin):
"""Test downloading the contents of a link to file."""
browser = mechanicalsoup.StatefulBrowser()
open_legacy_httpbin(browser, httpbin)
tmpdir = tempfile.mkdtemp()
tmpfile = tmpdir + '/nosuchfile.png'
current_url = browser.get_url()
current_page = browser.get_current_page()
response = browser.download_link(file=tmpfile, link='image/png')
# Check that the browser state has not changed
assert browser.get_url() == current_url
assert browser.get_current_page() == current_page
# Check that the file was downloaded
assert os.path.isfile(tmpfile)
assert file_get_contents(tmpfile) == response.content
# Check that we actually downloaded a PNG file
assert response.content[:4] == b'\x89PNG'
def test_download_link_nofile(httpbin):
"""Test downloading the contents of a link without saving it."""
browser = mechanicalsoup.StatefulBrowser()
open_legacy_httpbin(browser, httpbin)
current_url = browser.get_url()
current_page = browser.get_current_page()
response = browser.download_link(link='image/png')
# Check that the browser state has not changed
assert browser.get_url() == current_url
assert browser.get_current_page() == current_page
# Check that we actually downloaded a PNG file
assert response.content[:4] == b'\x89PNG'
def test_download_link_to_existing_file(httpbin):
"""Test downloading the contents of a link to an existing file."""
browser = mechanicalsoup.StatefulBrowser()
open_legacy_httpbin(browser, httpbin)
tmpdir = tempfile.mkdtemp()
tmpfile = tmpdir + '/existing.png'
with open(tmpfile, "w") as f:
f.write("initial content")
current_url = browser.get_url()
current_page = browser.get_current_page()
response = browser.download_link('image/png', tmpfile)
# Check that the browser state has not changed
assert browser.get_url() == current_url
assert browser.get_current_page() == current_page
# Check that the file was downloaded
assert os.path.isfile(tmpfile)
assert file_get_contents(tmpfile) == response.content
# Check that we actually downloaded a PNG file
assert response.content[:4] == b'\x89PNG'
def test_download_link_404(httpbin):
"""Test downloading the contents of a broken link."""
browser = mechanicalsoup.StatefulBrowser(raise_on_404=True)
browser.open_fake_page('<a href="/no-such-page-404">Link</a>',
url=httpbin.url)
tmpdir = tempfile.mkdtemp()
tmpfile = tmpdir + '/nosuchfile.txt'
current_url = browser.get_url()
current_page = browser.get_current_page()
with pytest.raises(mechanicalsoup.LinkNotFoundError):
browser.download_link(file=tmpfile, link_text='Link')
# Check that the browser state has not changed
assert browser.get_url() == current_url
assert browser.get_current_page() == current_page
# Check that the file was not downloaded
assert not os.path.exists(tmpfile)
def test_download_link_referer(httpbin):
"""Test downloading the contents of a link to file."""
browser = mechanicalsoup.StatefulBrowser()
ref = httpbin + "/my-referer"
browser.open_fake_page('<a href="/headers">Link</a>',
url=ref)
tmpfile = tempfile.NamedTemporaryFile()
current_url = browser.get_url()
current_page = browser.get_current_page()
browser.download_link(file=tmpfile.name, link_text='Link')
# Check that the browser state has not changed
assert browser.get_url() == current_url
assert browser.get_current_page() == current_page
# Check that the file was downloaded
with open(tmpfile.name) as f:
json_data = json.load(f)
headers = json_data["headers"]
assert headers["Referer"] == ref
def test_refresh_open():
url = 'mock://example.com'
initial_page = BeautifulSoup('<p>Fake empty page</p>', 'lxml')
reload_page = BeautifulSoup('<p>Fake reloaded page</p>', 'lxml')
browser, adapter = prepare_mock_browser()
mock_get(adapter, url=url, reply=str(initial_page))
browser.open(url)
mock_get(adapter, url=url, reply=str(reload_page),
additional_matcher=lambda r: 'Referer' not in r.headers)
browser.refresh()
assert browser.get_url() == url
assert browser.get_current_page() == reload_page
def test_refresh_follow_link():
url = 'mock://example.com'
follow_url = 'mock://example.com/followed'
initial_content = '<a href="{url}">Link</a>'.format(url=follow_url)
initial_page = BeautifulSoup(initial_content, 'lxml')
reload_page = BeautifulSoup('<p>Fake reloaded page</p>', 'lxml')
browser, adapter = prepare_mock_browser()
mock_get(adapter, url=url, reply=str(initial_page))
mock_get(adapter, url=follow_url, reply=str(initial_page))
browser.open(url)
browser.follow_link()
refer_header = {'Referer': url}
mock_get(adapter, url=follow_url, reply=str(reload_page),
request_headers=refer_header)
browser.refresh()
assert browser.get_url() == follow_url
assert browser.get_current_page() == reload_page
def test_refresh_form_not_retained():
url = 'mock://example.com'
initial_content = '<form>Here comes the form</form>'
initial_page = BeautifulSoup(initial_content, 'lxml')
reload_page = BeautifulSoup('<p>Fake reloaded page</p>', 'lxml')
browser, adapter = prepare_mock_browser()
mock_get(adapter, url=url, reply=str(initial_page))
browser.open(url)
browser.select_form()
mock_get(adapter, url=url, reply=str(reload_page),
additional_matcher=lambda r: 'Referer' not in r.headers)
browser.refresh()
assert browser.get_url() == url
assert browser.get_current_page() == reload_page
assert browser.get_current_form() is None
def test_refresh_error():
browser = mechanicalsoup.StatefulBrowser()
# Test no page
with pytest.raises(ValueError):
browser.refresh()
# Test fake page
with pytest.raises(ValueError):
browser.open_fake_page('<p>Fake empty page</p>', url='http://fake.com')
browser.refresh()
if __name__ == '__main__':
pytest.main(sys.argv)