# 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
from typing import Callable
import pytest
from playwright.async_api import Browser, Error
from tests.server import Server, TestServerRequest
async def test_should_throw_for_bad_server_value(
browser_factory: "Callable[..., asyncio.Future[Browser]]",
) -> None:
with pytest.raises(Error) as exc_info:
await browser_factory(proxy={"server": 123})
assert "proxy.server: expected string, got number" in exc_info.value.message
async def test_should_use_proxy(
browser_factory: "Callable[..., asyncio.Future[Browser]]", server: Server
) -> None:
server.set_route(
"/target.html",
lambda r: (
r.write(b"Served by the proxy"),
r.finish(),
),
)
browser = await browser_factory(proxy={"server": f"localhost:{server.PORT}"})
page = await browser.new_page()
await page.goto("http://non-existent.com/target.html")
assert await page.title() == "Served by the proxy"
async def test_proxy_should_allow_none_for_optional_settings(
browser_factory: "Callable[..., asyncio.Future[Browser]]", server: Server
) -> None:
server.set_route(
"/target.html",
lambda r: (
r.write(b"Served by the proxy"),
r.finish(),
),
)
browser = await browser_factory(
proxy={
"server": f"localhost:{server.PORT}",
"username": None,
"password": None,
"bypass": None,
}
)
page = await browser.new_page()
await page.goto("http://non-existent.com/target.html")
assert await page.title() == "Served by the proxy"
async def test_should_use_proxy_for_second_page(
browser_factory: "Callable[..., asyncio.Future[Browser]]", server: Server
) -> None:
server.set_route(
"/target.html",
lambda r: (
r.write(b"Served by the proxy"),
r.finish(),
),
)
browser = await browser_factory(proxy={"server": f"localhost:{server.PORT}"})
page1 = await browser.new_page()
await page1.goto("http://non-existent.com/target.html")
assert await page1.title() == "Served by the proxy"
page2 = await browser.new_page()
await page2.goto("http://non-existent.com/target.html")
assert await page2.title() == "Served by the proxy"
async def test_should_work_with_ip_port_notion(
browser_factory: "Callable[..., asyncio.Future[Browser]]", server: Server
) -> None:
server.set_route(
"/target.html",
lambda r: (
r.write(b"Served by the proxy"),
r.finish(),
),
)
browser = await browser_factory(proxy={"server": f"127.0.0.1:{server.PORT}"})
page = await browser.new_page()
await page.goto("http://non-existent.com/target.html")
assert await page.title() == "Served by the proxy"
async def test_should_authenticate(
browser_factory: "Callable[..., asyncio.Future[Browser]]", server: Server
) -> None:
def handler(req: TestServerRequest) -> None:
auth = req.getHeader("proxy-authorization")
if not auth:
req.setHeader(
b"Proxy-Authenticate", b'Basic realm="Access to internal site"'
)
req.setResponseCode(407)
else:
req.write(f"{auth}".encode("utf-8"))
req.finish()
server.set_route("/target.html", handler)
browser = await browser_factory(
proxy={
"server": f"localhost:{server.PORT}",
"username": "user",
"password": "secret",
}
)
page = await browser.new_page()
await page.goto("http://non-existent.com/target.html")
assert await page.title() == "Basic " + base64.b64encode(b"user:secret").decode(
"utf-8"
)
async def test_should_authenticate_with_empty_password(
browser_factory: "Callable[..., asyncio.Future[Browser]]", server: Server
) -> None:
def handler(req: TestServerRequest) -> None:
auth = req.getHeader("proxy-authorization")
if not auth:
req.setHeader(
b"Proxy-Authenticate", b'Basic realm="Access to internal site"'
)
req.setResponseCode(407)
else:
req.write(f"{auth}".encode("utf-8"))
req.finish()
server.set_route("/target.html", handler)
browser = await browser_factory(
proxy={"server": f"localhost:{server.PORT}", "username": "user", "password": ""}
)
page = await browser.new_page()
await page.goto("http://non-existent.com/target.html")
assert await page.title() == "Basic " + base64.b64encode(b"user:").decode("utf-8")