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
|
# 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 os
from pathlib import Path
from typing import (
Any,
AsyncGenerator,
Awaitable,
Callable,
Dict,
List,
Literal,
Optional,
Sequence,
Tuple,
)
import pytest
from playwright.async_api import (
BrowserContext,
BrowserType,
Cookie,
Error,
Page,
expect,
)
from tests.server import Server
from tests.utils import must
from .utils import Utils
@pytest.fixture()
async def launch_persistent(
tmp_path: Path, launch_arguments: Dict, browser_type: BrowserType
) -> AsyncGenerator[Callable[..., Awaitable[Tuple[Page, BrowserContext]]], None]:
context: Optional[BrowserContext] = None
async def _launch(**options: Any) -> Tuple[Page, BrowserContext]:
nonlocal context
if context:
raise ValueError("can only launch one persistent context")
context = await browser_type.launch_persistent_context(
str(tmp_path), **{**launch_arguments, **options}
)
assert context
return (context.pages[0], context)
yield _launch
await must(context).close()
async def test_context_cookies_should_work(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
default_same_site_cookie_value: str,
) -> None:
(page, context) = await launch_persistent()
await page.goto(server.EMPTY_PAGE)
document_cookie = await page.evaluate(
"""() => {
document.cookie = 'username=John Doe';
return document.cookie;
}"""
)
assert document_cookie == "username=John Doe"
assert _filter_cookies(await page.context.cookies()) == [
{
"name": "username",
"value": "John Doe",
"domain": "localhost",
"path": "/",
"expires": -1,
"httpOnly": False,
"secure": False,
"sameSite": default_same_site_cookie_value,
}
]
async def test_context_add_cookies_should_work(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
default_same_site_cookie_value: Literal["Lax", "None", "Strict"],
) -> None:
(page, context) = await launch_persistent()
await page.goto(server.EMPTY_PAGE)
await page.context.add_cookies(
[
{
"url": server.EMPTY_PAGE,
"name": "username",
"value": "John Doe",
"sameSite": default_same_site_cookie_value,
}
]
)
assert await page.evaluate("() => document.cookie") == "username=John Doe"
assert _filter_cookies(await page.context.cookies()) == [
{
"name": "username",
"value": "John Doe",
"domain": "localhost",
"path": "/",
"expires": -1,
"httpOnly": False,
"secure": False,
"sameSite": default_same_site_cookie_value,
}
]
def _filter_cookies(cookies: Sequence[Cookie]) -> List[Cookie]:
return list(
filter(lambda cookie: not cookie["domain"].endswith("microsoft.com"), cookies)
)
async def test_context_clear_cookies_should_work(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent()
await page.goto(server.EMPTY_PAGE)
await page.context.add_cookies(
[
{"url": server.EMPTY_PAGE, "name": "cookie1", "value": "1"},
{"url": server.EMPTY_PAGE, "name": "cookie2", "value": "2"},
]
)
assert await page.evaluate("document.cookie") == "cookie1=1; cookie2=2"
await page.context.clear_cookies()
await page.reload()
assert _filter_cookies(await page.context.cookies([])) == []
assert await page.evaluate("document.cookie") == ""
async def test_should_not_block_third_party_cookies(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
is_firefox: bool,
) -> None:
(page, context) = await launch_persistent()
await page.goto(server.EMPTY_PAGE)
await page.evaluate(
"""src => {
let fulfill;
const promise = new Promise(x => fulfill = x);
const iframe = document.createElement('iframe');
document.body.appendChild(iframe);
iframe.onload = fulfill;
iframe.src = src;
return promise;
}""",
server.CROSS_PROCESS_PREFIX + "/grid.html",
)
document_cookie = await page.frames[1].evaluate(
"""() => {
document.cookie = 'username=John Doe';
return document.cookie;
}"""
)
await page.wait_for_timeout(2000)
allows_third_party = is_firefox
assert document_cookie == ("username=John Doe" if allows_third_party else "")
cookies = await context.cookies(server.CROSS_PROCESS_PREFIX + "/grid.html")
if allows_third_party:
assert cookies == [
{
"domain": "127.0.0.1",
"expires": -1,
"httpOnly": False,
"name": "username",
"path": "/",
"sameSite": "None",
"secure": False,
"value": "John Doe",
}
]
else:
assert cookies == []
async def test_should_support_viewport_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
utils: Utils,
) -> None:
(page, context) = await launch_persistent(viewport={"width": 456, "height": 789})
await utils.verify_viewport(page, 456, 789)
page2 = await context.new_page()
await utils.verify_viewport(page2, 456, 789)
async def test_should_support_device_scale_factor_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(device_scale_factor=3)
assert await page.evaluate("window.devicePixelRatio") == 3
async def test_should_support_user_agent_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
server: Server,
) -> None:
(page, context) = await launch_persistent(user_agent="foobar")
assert await page.evaluate("() => navigator.userAgent") == "foobar"
[request, _] = await asyncio.gather(
server.wait_for_request("/empty.html"),
page.goto(server.EMPTY_PAGE),
)
assert request.getHeader("user-agent") == "foobar"
async def test_should_support_bypass_csp_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
server: Server,
) -> None:
(page, context) = await launch_persistent(bypass_csp=True)
await page.goto(server.PREFIX + "/csp.html")
await page.add_script_tag(content="window.__injected = 42;")
assert await page.evaluate("() => window.__injected") == 42
async def test_should_support_javascript_enabled_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
is_webkit: bool,
) -> None:
(page, context) = await launch_persistent(java_script_enabled=False)
await page.goto('data:text/html, <script>var something = "forbidden"</script>')
with pytest.raises(Error) as exc:
await page.evaluate("something")
if is_webkit:
assert "Can't find variable: something" in exc.value.message
else:
assert "something is not defined" in exc.value.message
async def test_should_support_http_credentials_option(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(
http_credentials={"username": "user", "password": "pass"}
)
server.set_auth("/playground.html", "user", "pass")
response = await page.goto(server.PREFIX + "/playground.html")
assert response
assert response.status == 200
async def test_should_support_offline_option(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(offline=True)
with pytest.raises(Error):
await page.goto(server.EMPTY_PAGE)
async def test_should_support_has_touch_option(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(has_touch=True)
await page.goto(server.PREFIX + "/mobile.html")
assert await page.evaluate('() => "ontouchstart" in window')
@pytest.mark.skip_browser("firefox")
async def test_should_work_in_persistent_context(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
# Firefox does not support mobile.
(page, context) = await launch_persistent(
viewport={"width": 320, "height": 480}, is_mobile=True
)
await page.goto(server.PREFIX + "/empty.html")
assert await page.evaluate("() => window.innerWidth") == 980
async def test_should_support_color_scheme_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(color_scheme="dark")
assert (
await page.evaluate('() => matchMedia("(prefers-color-scheme: light)").matches')
is False
)
assert await page.evaluate(
'() => matchMedia("(prefers-color-scheme: dark)").matches'
)
async def test_should_support_timezone_id_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(timezone_id="America/Jamaica")
assert (
await page.evaluate("() => new Date(1479579154987).toString()")
== "Sat Nov 19 2016 13:12:34 GMT-0500 (Eastern Standard Time)"
)
async def test_should_support_contrast_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, _) = await launch_persistent(contrast="more")
assert await page.evaluate('() => matchMedia("(prefers-contrast: more)").matches')
assert not await page.evaluate(
'() => matchMedia("(prefers-contrast: no-preference)").matches'
)
async def test_should_support_locale_option(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(locale="fr-FR")
assert await page.evaluate("() => navigator.language") == "fr-FR"
async def test_should_support_geolocation_and_permission_option(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(
geolocation={"longitude": 10, "latitude": 10}, permissions=["geolocation"]
)
await page.goto(server.EMPTY_PAGE)
geolocation = await page.evaluate(
"""() => new Promise(resolve => navigator.geolocation.getCurrentPosition(position => {
resolve({latitude: position.coords.latitude, longitude: position.coords.longitude});
}))"""
)
assert geolocation == {"latitude": 10, "longitude": 10}
async def test_should_support_ignore_https_errors_option(
https_server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(ignore_https_errors=True)
response = await page.goto(https_server.EMPTY_PAGE)
assert response
assert response.ok
async def test_should_support_extra_http_headers_option(
server: Server,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(extra_http_headers={"foo": "bar"})
[request, _] = await asyncio.gather(
server.wait_for_request("/empty.html"),
page.goto(server.EMPTY_PAGE),
)
assert request.getHeader("foo") == "bar"
async def test_should_accept_user_data_dir(
tmp_path: Path,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent()
# Note: we need an open page to make sure its functional.
assert len(os.listdir(tmp_path)) > 0
await context.close()
assert len(os.listdir(tmp_path)) > 0
async def test_should_restore_state_from_userDataDir(
browser_type: BrowserType,
launch_arguments: Dict,
server: Server,
tmp_path_factory: pytest.TempPathFactory,
) -> None:
user_data_dir1 = tmp_path_factory.mktemp("test")
browser_context = await browser_type.launch_persistent_context(
user_data_dir1, **launch_arguments
)
page = await browser_context.new_page()
await page.goto(server.EMPTY_PAGE)
await page.evaluate('() => localStorage.hey = "hello"')
await browser_context.close()
browser_context2 = await browser_type.launch_persistent_context(
user_data_dir1, **launch_arguments
)
page2 = await browser_context2.new_page()
await page2.goto(server.EMPTY_PAGE)
assert await page2.evaluate("() => localStorage.hey") == "hello"
await browser_context2.close()
user_data_dir2 = tmp_path_factory.mktemp("test")
browser_context3 = await browser_type.launch_persistent_context(
user_data_dir2, **launch_arguments
)
page3 = await browser_context3.new_page()
await page3.goto(server.EMPTY_PAGE)
assert await page3.evaluate("() => localStorage.hey") != "hello"
await browser_context3.close()
async def test_should_have_default_url_when_launching_browser(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent()
urls = list(map(lambda p: p.url, context.pages))
assert urls == ["about:blank"]
@pytest.mark.skip_browser("firefox")
async def test_should_throw_if_page_argument_is_passed(
browser_type: BrowserType, server: Server, tmp_path: Path, launch_arguments: Dict
) -> None:
options = {**launch_arguments, "args": [server.EMPTY_PAGE]}
with pytest.raises(Error) as exc:
await browser_type.launch_persistent_context(tmp_path, **options)
assert "can not specify page" in exc.value.message
async def test_should_fire_close_event_for_a_persistent_context(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent()
fired_event: "asyncio.Future[bool]" = asyncio.Future()
context.on("close", lambda _: fired_event.set_result(True))
await context.close()
await fired_event
async def test_should_support_reduced_motion(
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent(reduced_motion="reduce")
assert await page.evaluate("matchMedia('(prefers-reduced-motion: reduce)').matches")
async def test_should_support_har_option(
assetdir: Path,
launch_persistent: "Callable[..., asyncio.Future[Tuple[Page, BrowserContext]]]",
) -> None:
(page, context) = await launch_persistent()
await page.route_from_har(har=assetdir / "har-fulfill.har")
await page.goto("http://no.playwright/")
assert await page.evaluate("window.value") == "foo"
await expect(page.locator("body")).to_have_css("background-color", "rgb(255, 0, 0)")
|