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
|
# Copyright (c) Microsoft Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import asyncio
import base64
import json
from typing import Any, Callable, cast
from urllib.parse import parse_qs
import pytest
from playwright.async_api import Browser, BrowserContext, Error, FilePayload, Page
from tests.server import Server, TestServerRequest
from tests.utils import must
async def test_get_should_work(context: BrowserContext, server: Server) -> None:
response = await context.request.get(server.PREFIX + "/simple.json")
assert response.url == server.PREFIX + "/simple.json"
assert response.status == 200
assert response.status_text == "OK"
assert response.ok is True
assert response.headers["content-type"] == "application/json"
assert {
"name": "Content-Type",
"value": "application/json",
} in response.headers_array
assert await response.text() == '{"foo": "bar"}\n'
async def test_fetch_should_work(context: BrowserContext, server: Server) -> None:
response = await context.request.fetch(server.PREFIX + "/simple.json")
assert response.url == server.PREFIX + "/simple.json"
assert response.status == 200
assert response.status_text == "OK"
assert response.ok is True
assert response.headers["content-type"] == "application/json"
assert {
"name": "Content-Type",
"value": "application/json",
} in response.headers_array
assert await response.text() == '{"foo": "bar"}\n'
async def test_should_throw_on_network_error(
context: BrowserContext, server: Server
) -> None:
server.set_route("/test", lambda request: request.loseConnection())
with pytest.raises(Error, match="socket hang up"):
await context.request.fetch(server.PREFIX + "/test")
async def test_should_add_session_cookies_to_request(
context: BrowserContext, server: Server
) -> None:
await context.add_cookies(
[
{
"name": "username",
"value": "John Doe",
"url": server.EMPTY_PAGE,
"expires": -1,
"httpOnly": False,
"secure": False,
"sameSite": "Lax",
}
]
)
[server_req, response] = await asyncio.gather(
server.wait_for_request("/empty.html"),
context.request.get(server.EMPTY_PAGE),
)
assert server_req.getHeader("Cookie") == "username=John Doe"
@pytest.mark.parametrize(
"method", ["fetch", "delete", "get", "head", "patch", "post", "put"]
)
async def test_should_support_query_params(
context: BrowserContext, server: Server, method: str
) -> None:
expected_params = {"p1": "v1", "парам2": "знач2"}
[server_req, _] = await asyncio.gather(
server.wait_for_request("/empty.html"),
getattr(context.request, method)(
server.EMPTY_PAGE + "?p1=foo", params=expected_params
),
)
assert list(map(lambda x: x.decode(), server_req.args["p1".encode()])) == [
"foo",
"v1",
]
assert server_req.args["парам2".encode()][0].decode() == "знач2"
@pytest.mark.parametrize(
"method", ["fetch", "delete", "get", "head", "patch", "post", "put"]
)
async def test_should_support_params_passed_as_object(
context: BrowserContext, server: Server, method: str
) -> None:
params = {
"param1": "value1",
"парам2": "знач2",
}
[server_req, _] = await asyncio.gather(
server.wait_for_request("/empty.html"),
getattr(context.request, method)(server.EMPTY_PAGE, params=params),
)
assert server_req.args["param1".encode()][0].decode() == "value1"
assert len(server_req.args["param1".encode()]) == 1
assert server_req.args["парам2".encode()][0].decode() == "знач2"
@pytest.mark.parametrize(
"method", ["fetch", "delete", "get", "head", "patch", "post", "put"]
)
async def test_should_support_params_passed_as_strings(
context: BrowserContext, server: Server, method: str
) -> None:
params = "?param1=value1¶m1=value2&парам2=знач2"
[server_req, _] = await asyncio.gather(
server.wait_for_request("/empty.html"),
getattr(context.request, method)(server.EMPTY_PAGE, params=params),
)
assert list(map(lambda x: x.decode(), server_req.args["param1".encode()])) == [
"value1",
"value2",
]
assert len(server_req.args["param1".encode()]) == 2
assert server_req.args["парам2".encode()][0].decode() == "знач2"
@pytest.mark.parametrize(
"method", ["fetch", "delete", "get", "head", "patch", "post", "put"]
)
async def test_should_support_fail_on_status_code(
context: BrowserContext, server: Server, method: str
) -> None:
with pytest.raises(Error, match="404 Not Found"):
await getattr(context.request, method)(
server.PREFIX + "/this-does-clearly-not-exist.html",
fail_on_status_code=True,
)
@pytest.mark.parametrize(
"method", ["fetch", "delete", "get", "head", "patch", "post", "put"]
)
async def test_should_support_ignore_https_errors_option(
context: BrowserContext, https_server: Server, method: str
) -> None:
response = await getattr(context.request, method)(
https_server.EMPTY_PAGE, ignore_https_errors=True
)
assert response.ok
assert response.status == 200
async def test_should_not_add_context_cookie_if_cookie_header_passed_as_parameter(
context: BrowserContext, server: Server
) -> None:
await context.add_cookies(
[
{
"name": "username",
"value": "John Doe",
"url": server.EMPTY_PAGE,
"expires": -1,
"httpOnly": False,
"secure": False,
"sameSite": "Lax",
}
]
)
[server_req, _] = await asyncio.gather(
server.wait_for_request("/empty.html"),
context.request.get(server.EMPTY_PAGE, headers={"Cookie": "foo=bar"}),
)
assert server_req.getHeader("Cookie") == "foo=bar"
async def test_should_support_http_credentials_send_immediately_for_browser_context(
context_factory: "Callable[..., asyncio.Future[BrowserContext]]", server: Server
) -> None:
context = await context_factory(
http_credentials={
"username": "user",
"password": "pass",
"origin": server.PREFIX.upper(),
"send": "always",
}
)
# First request
server_request, response = await asyncio.gather(
server.wait_for_request("/empty.html"), context.request.get(server.EMPTY_PAGE)
)
expected_auth = "Basic " + base64.b64encode(b"user:pass").decode()
assert server_request.getHeader("authorization") == expected_auth
assert response.status == 200
# Second request
server_request, response = await asyncio.gather(
server.wait_for_request("/empty.html"),
context.request.get(server.CROSS_PROCESS_PREFIX + "/empty.html"),
)
# Not sent to another origin.
assert server_request.getHeader("authorization") is None
assert response.status == 200
async def test_support_http_credentials_send_immediately_for_browser_new_page(
server: Server, browser: Browser
) -> None:
page = await browser.new_page(
http_credentials={
"username": "user",
"password": "pass",
"origin": server.PREFIX.upper(),
"send": "always",
}
)
server_request, response = await asyncio.gather(
server.wait_for_request("/empty.html"), page.request.get(server.EMPTY_PAGE)
)
assert (
server_request.getHeader("authorization")
== "Basic " + base64.b64encode(b"user:pass").decode()
)
assert response.status == 200
server_request, response = await asyncio.gather(
server.wait_for_request("/empty.html"),
page.request.get(server.CROSS_PROCESS_PREFIX + "/empty.html"),
)
# Not sent to another origin.
assert server_request.getHeader("authorization") is None
assert response.status == 200
await page.close()
@pytest.mark.parametrize("method", ["delete", "patch", "post", "put"])
async def test_should_support_post_data(
context: BrowserContext, method: str, server: Server
) -> None:
async def support_post_data(fetch_data: Any, request_post_data: Any) -> None:
[request, response] = await asyncio.gather(
server.wait_for_request("/simple.json"),
getattr(context.request, method)(
server.PREFIX + "/simple.json", data=fetch_data
),
)
assert request.method.decode() == method.upper()
assert request.post_body == request_post_data
assert response.status == 200
assert response.url == server.PREFIX + "/simple.json"
assert request.getHeader("Content-Length") == str(len(must(request.post_body)))
await support_post_data("My request", "My request".encode())
await support_post_data(b"My request", "My request".encode())
await support_post_data(["my", "request"], json.dumps(["my", "request"]).encode())
await support_post_data({"my": "request"}, json.dumps({"my": "request"}).encode())
with pytest.raises(Error, match="Unsupported 'data' type: <class 'function'>"):
await support_post_data(lambda: None, None)
async def test_should_support_application_x_www_form_urlencoded(
context: BrowserContext, server: Server
) -> None:
[request, response] = await asyncio.gather(
server.wait_for_request("/empty.html"),
context.request.post(
server.PREFIX + "/empty.html",
form={
"firstName": "John",
"lastName": "Doe",
"file": "f.js",
},
),
)
assert request.method == b"POST"
assert request.getHeader("Content-Type") == "application/x-www-form-urlencoded"
assert request.post_body
body = request.post_body.decode()
assert request.getHeader("Content-Length") == str(len(body))
params = parse_qs(request.post_body)
assert params[b"firstName"] == [b"John"]
assert params[b"lastName"] == [b"Doe"]
assert params[b"file"] == [b"f.js"]
async def test_should_support_multipart_form_data(
context: BrowserContext, server: Server
) -> None:
file: FilePayload = {
"name": "f.js",
"mimeType": "text/javascript",
"buffer": b"var x = 10;\r\n;console.log(x);",
}
[request, _] = await asyncio.gather(
server.wait_for_request("/empty.html"),
context.request.post(
server.PREFIX + "/empty.html",
multipart={
"firstName": "John",
"lastName": "Doe",
"file": file,
},
),
)
assert request.method == b"POST"
assert cast(str, request.getHeader("Content-Type")).startswith(
"multipart/form-data; "
)
assert must(request.getHeader("Content-Length")) == str(
len(must(request.post_body))
)
assert request.args[b"firstName"] == [b"John"]
assert request.args[b"lastName"] == [b"Doe"]
assert request.args[b"file"][0] == file["buffer"]
async def test_should_add_default_headers(
context: BrowserContext, page: Page, server: Server
) -> None:
[request, response] = await asyncio.gather(
server.wait_for_request("/empty.html"),
context.request.get(server.EMPTY_PAGE),
)
assert request.getHeader("Accept") == "*/*"
assert request.getHeader("Accept-Encoding") == "gzip,deflate,br"
assert request.getHeader("User-Agent") == await page.evaluate(
"() => navigator.userAgent"
)
async def test_should_work_after_context_dispose(
context: BrowserContext, server: Server
) -> None:
await context.close(reason="Test ended.")
with pytest.raises(Error, match="Test ended."):
await context.request.get(server.EMPTY_PAGE)
async def test_should_retry_ECONNRESET(context: BrowserContext, server: Server) -> None:
request_count = 0
def _handle_request(req: TestServerRequest) -> None:
nonlocal request_count
request_count += 1
if request_count <= 3:
assert req.transport
req.transport.abortConnection()
return
req.setHeader("content-type", "text/plain")
req.write(b"Hello!")
req.finish()
server.set_route("/test", _handle_request)
response = await context.request.fetch(server.PREFIX + "/test", max_retries=3)
assert response.status == 200
assert await response.text() == "Hello!"
assert request_count == 4
|