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
|
import os
import sys
import tempfile
import pytest
import setpath # noqa:F401, must come before 'import mechanicalsoup'
from bs4 import BeautifulSoup
from requests.cookies import RequestsCookieJar
from utils import mock_get, prepare_mock_browser
import mechanicalsoup
def test_submit_online(httpbin):
"""Complete and submit the pizza form at http://httpbin.org/forms/post """
browser = mechanicalsoup.Browser()
page = browser.get(httpbin + "/forms/post")
form = page.soup.form
form.find("input", {"name": "custname"})["value"] = "Philip J. Fry"
# leave custtel blank without value
assert "value" not in form.find("input", {"name": "custtel"}).attrs
form.find("input", {"name": "size", "value": "medium"})["checked"] = ""
form.find("input", {"name": "topping", "value": "cheese"})["checked"] = ""
form.find("input", {"name": "topping", "value": "onion"})["checked"] = ""
form.find("textarea", {"name": "comments"}).insert(0, "freezer")
response = browser.submit(form, page.url)
# helpfully the form submits to http://httpbin.org/post which simply
# returns the request headers in json format
json = response.json()
data = json["form"]
assert data["custname"] == "Philip J. Fry"
assert data["custtel"] == "" # web browser submits "" for input left blank
assert data["size"] == "medium"
assert data["topping"] == ["cheese", "onion"]
assert data["comments"] == "freezer"
assert json["headers"]["User-Agent"].startswith('python-requests/')
assert 'MechanicalSoup' in json["headers"]["User-Agent"]
def test_get_request_kwargs(httpbin):
"""Return kwargs without a submit"""
browser = mechanicalsoup.Browser()
page = browser.get(httpbin + "/forms/post")
form = page.soup.form
form.find("input", {"name": "custname"})["value"] = "Philip J. Fry"
request_kwargs = browser.get_request_kwargs(form, page.url)
assert "method" in request_kwargs
assert "url" in request_kwargs
assert "data" in request_kwargs
assert ("custname", "Philip J. Fry") in request_kwargs["data"]
def test_get_request_kwargs_when_method_is_in_kwargs(httpbin):
"""Raise TypeError exception"""
browser = mechanicalsoup.Browser()
page = browser.get(httpbin + "/forms/post")
form = page.soup.form
kwargs = {"method": "post"}
with pytest.raises(TypeError):
browser.get_request_kwargs(form, page.url, **kwargs)
def test_get_request_kwargs_when_url_is_in_kwargs(httpbin):
"""Raise TypeError exception"""
browser = mechanicalsoup.Browser()
page = browser.get(httpbin + "/forms/post")
form = page.soup.form
kwargs = {"url": httpbin + "/forms/post"}
with pytest.raises(TypeError):
# pylint: disable=redundant-keyword-arg
browser.get_request_kwargs(form, page.url, **kwargs)
def test__request(httpbin):
form_html = f"""
<form method="post" action="{httpbin.url}/post">
<input name="customer" value="Philip J. Fry"/>
<input name="telephone" value="555"/>
<textarea name="comments">freezer</textarea>
<fieldset>
<legend> Pizza Size </legend>
<p><input type=RADIO name=size value="small">Small</p>
<p><input type=radiO name=size value="medium" checked>Medium</p>
<p><input type=radio name=size value="large">Large</p>
</fieldset>
<fieldset>
<legend> Pizza Toppings </legend>
<p><input type=CHECKBOX name="topping" value="bacon" checked>Bacon</p>
<p><input type=checkBox name="topping" value="cheese">Extra Cheese</p>
<p><input type=checkbox name="topping" value="onion" checked>Onion</p>
<p><input type=checkbox name="topping" value="mushroom">Mushroom</p>
</fieldset>
<select name="shape">
<option value="round">Round</option>
<option value="square" selected>Square</option>
</select>
</form>
"""
form = BeautifulSoup(form_html, "lxml").form
browser = mechanicalsoup.Browser()
response = browser._request(form)
data = response.json()['form']
assert data["customer"] == "Philip J. Fry"
assert data["telephone"] == "555"
assert data["comments"] == "freezer"
assert data["size"] == "medium"
assert data["topping"] == ["bacon", "onion"]
assert data["shape"] == "square"
assert "application/x-www-form-urlencoded" in response.request.headers[
"Content-Type"]
valid_enctypes_file_submit = {"multipart/form-data": True,
"application/x-www-form-urlencoded": False
}
default_enctype = "application/x-www-form-urlencoded"
@pytest.mark.parametrize("file_field", [
"""<input name="pic" type="file" />""",
""])
@pytest.mark.parametrize("submit_file", [
True,
False
])
@pytest.mark.parametrize("enctype", [
pytest.param("multipart/form-data"),
pytest.param("application/x-www-form-urlencoded"),
pytest.param("Invalid enctype")
])
def test_enctype_and_file_submit(httpbin, enctype, submit_file, file_field):
# test if enctype is respected when specified
# and if files are processed correctly
form_html = f"""
<form method="post" action="{httpbin.url}/post" enctype="{enctype}">
<input name="in" value="test" />
{file_field}
</form>
"""
form = BeautifulSoup(form_html, "lxml").form
valid_enctype = (enctype in valid_enctypes_file_submit and
valid_enctypes_file_submit[enctype])
expected_content = b"" # default
if submit_file and file_field:
# create a temporary file for testing file upload
file_content = b":-)"
pic_filedescriptor, pic_path = tempfile.mkstemp()
pic_filename = os.path.basename(pic_path)
os.write(pic_filedescriptor, file_content)
os.close(pic_filedescriptor)
if valid_enctype:
# Correct encoding => send the content
expected_content = file_content
else:
# Encoding doesn't allow sending the content, we expect
# the filename as a normal text field.
expected_content = os.path.basename(pic_path.encode())
tag = form.find("input", {"name": "pic"})
tag["value"] = open(pic_path, "rb")
browser = mechanicalsoup.Browser()
response = browser._request(form)
if enctype not in valid_enctypes_file_submit:
expected_enctype = default_enctype
else:
expected_enctype = enctype
assert expected_enctype in response.request.headers["Content-Type"]
resp = response.json()
assert resp["form"]["in"] == "test"
found = False
found_in = None
for key, value in resp.items():
if value:
if "pic" in value:
content = value["pic"].encode()
assert not found
assert key in ("files", "form")
found = True
found_in = key
if key == "files" and not valid_enctype:
assert not value
assert found == bool(file_field)
if file_field:
assert content == expected_content
if valid_enctype:
assert found_in == "files"
if submit_file:
assert ("filename=\"" + pic_filename + "\""
).encode() in response.request.body
else:
assert b"filename=\"\"" in response.request.body
else:
assert found_in == "form"
if submit_file and file_field:
os.remove(pic_path)
def test__request_select_none(httpbin):
"""Make sure that a <select> with no options selected
submits the first option, as it does in a browser."""
form_html = f"""
<form method="post" action={httpbin.url}/post>
<select name="shape">
<option value="round">Round</option>
<option value="square">Square</option>
</select>
</form>"""
form = BeautifulSoup(form_html, "lxml").form
browser = mechanicalsoup.Browser()
response = browser._request(form)
assert response.json()['form'] == {'shape': 'round'}
def test__request_disabled_attr(httpbin):
"""Make sure that disabled form controls are not submitted."""
form_html = f"""
<form method="post" action="{httpbin.url}/post">
<input disabled name="nosubmit" value="1" />
</form>"""
browser = mechanicalsoup.Browser()
response = browser._request(BeautifulSoup(form_html, "lxml").form)
assert response.json()['form'] == {}
@pytest.mark.parametrize("keyword", [
pytest.param('method'),
pytest.param('url'),
])
def test_request_keyword_error(keyword):
"""Make sure exception is raised if kwargs duplicates an arg."""
form_html = "<form></form>"
browser = mechanicalsoup.Browser()
with pytest.raises(TypeError, match="multiple values for"):
browser._request(BeautifulSoup(form_html, "lxml").form,
'myurl', **{keyword: 'somevalue'})
def test_no_404(httpbin):
browser = mechanicalsoup.Browser()
resp = browser.get(httpbin + "/nosuchpage")
assert resp.status_code == 404
def test_404(httpbin):
browser = mechanicalsoup.Browser(raise_on_404=True)
with pytest.raises(mechanicalsoup.LinkNotFoundError):
browser.get(httpbin + "/nosuchpage")
resp = browser.get(httpbin.url)
assert resp.status_code == 200
def test_set_cookiejar(httpbin):
"""Set cookies locally and test that they are received remotely."""
# construct a phony cookiejar and attach it to the session
jar = RequestsCookieJar()
jar.set('field', 'value')
assert jar.get('field') == 'value'
browser = mechanicalsoup.Browser()
browser.set_cookiejar(jar)
resp = browser.get(httpbin + "/cookies")
assert resp.json() == {'cookies': {'field': 'value'}}
def test_get_cookiejar(httpbin):
"""Test that cookies set by the remote host update our session."""
browser = mechanicalsoup.Browser()
resp = browser.get(httpbin + "/cookies/set?k1=v1&k2=v2")
assert resp.json() == {'cookies': {'k1': 'v1', 'k2': 'v2'}}
jar = browser.get_cookiejar()
assert jar.get('k1') == 'v1'
assert jar.get('k2') == 'v2'
def test_post(httpbin):
browser = mechanicalsoup.Browser()
data = {'color': 'blue', 'colorblind': 'True'}
resp = browser.post(httpbin + "/post", data)
assert resp.status_code == 200 and resp.json()['form'] == data
def test_put(httpbin):
browser = mechanicalsoup.Browser()
data = {'color': 'blue', 'colorblind': 'True'}
resp = browser.put(httpbin + "/put", data)
assert resp.status_code == 200 and resp.json()['form'] == data
@pytest.mark.parametrize("http_html_expected_encoding", [
pytest.param((None, 'utf-8', 'utf-8')),
pytest.param(('utf-8', 'utf-8', 'utf-8')),
pytest.param(('utf-8', None, 'utf-8')),
pytest.param(('utf-8', 'ISO-8859-1', 'utf-8')),
])
def test_encoding(httpbin, http_html_expected_encoding):
http_encoding = http_html_expected_encoding[0]
html_encoding = http_html_expected_encoding[1]
expected_encoding = http_html_expected_encoding[2]
url = 'mock://encoding'
text = (
'<!doctype html>'
+ '<html lang="fr">'
+ (
(
'<head><meta charset="'
+ html_encoding
+ '"><title>Titleéàè</title></head>'
) if html_encoding
else ''
)
+ '<body></body>'
+ '</html>'
)
browser, adapter = prepare_mock_browser()
mock_get(
adapter,
url=url,
reply=(
text.encode(http_encoding)
if http_encoding
else text.encode("utf-8")
),
content_type=(
'text/html'
+ (
';charset=' + http_encoding
if http_encoding
else ''
)
)
)
browser.open(url)
assert browser.page.original_encoding == expected_encoding
if __name__ == '__main__':
pytest.main(sys.argv)
|