Skip to content

Commit

Permalink
[wptrunner] Reset permissions between tests for Chrome
Browse files Browse the repository at this point in the history 
Similar to web-platform-tests#48106, permission changes may leak between tests that use
the same WebDriver session (i.e., browser process). For now, add a
Chromium-specific `Browser.resetPermissions` call to reset permission
defaults.

To consolidate calls that reset state, refactor the WebDriver executor's
testharness window management to align with web-platform-tests#45735.
  • Loading branch information
@jonathan-j-lee
jonathan-j-lee committed Oct 14, 2024
1 parent 4452d36 commit 3c7e678
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 127 deletions.
93 changes: 37 additions & 56 deletions tools/wptrunner/wptrunner/executors/executorchrome.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,53 +93,41 @@ def setup(self):
self.test_window = None
self.reuse_window = self.parent.reuse_window

def close_test_window(self):
if self.test_window:
self._close_window(self.test_window)
self.test_window = None

def close_old_windows(self):
self.webdriver.actions.release()
for handle in self.webdriver.handles:
if handle not in {self.runner_handle, self.test_window}:
self._close_window(handle)
if not self.reuse_window:
self.close_test_window()
if not self.reuse_window and self.test_window:
self._close_window(self.test_window)
self.test_window = None
self.webdriver.window_handle = self.runner_handle
# TODO(web-platform-tests/wpt#48078): Find a cross-platform way to clear
# cookies for all domains.
self.parent.cdp.execute_cdp_command("Network.clearBrowserCookies")
self._reset_browser_state()
return self.runner_handle

def open_test_window(self, window_id):
if self.test_window:
# Try to reuse the existing test window by emulating the `about:blank`
# page with no history you would get with a new window.
try:
self.webdriver.window_handle = self.test_window
# Reset navigation history with Chrome DevTools Protocol:
# https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-resetNavigationHistory
self.parent.cdp.execute_cdp_command("Page.resetNavigationHistory")
self.webdriver.url = "about:blank"
return
except error.NoSuchWindowException:
self.test_window = None
super().open_test_window(window_id)

def get_test_window(self, window_id, parent, timeout=5):
if self.test_window:
return self.test_window
# Poll the handles endpoint for the test window like the base WebDriver
# protocol part, but don't bother checking for the serialized
# WindowProxy (not supported by Chrome currently).
deadline = time.time() + timeout
while time.time() < deadline:
self.test_window = self._poll_handles_for_test_window(parent)
if self.test_window is not None:
assert self.test_window != parent
return self.test_window
time.sleep(0.03)
raise Exception("unable to find test window")
def _reset_browser_state(self):
"""Reset browser-wide state that normally persists between tests."""
# TODO(web-platform-tests/wpt#48078): Find a cross-vendor way to clear
# cookies for all domains.
self.parent.cdp.execute_cdp_command("Network.clearBrowserCookies")
# Reset default permissions that `test_driver.set_permission(...)` may
# have altered.
self.parent.cdp.execute_cdp_command("Browser.resetPermissions")
# Chromium requires the `background-sync` permission for reporting APIs
# to work. Not all embedders (notably, `chrome --headless=old`) grant
# `background-sync` by default, so this CDP call ensures the permission
# is granted for all origins, in line with the background sync spec's
# recommendation [0].
#
# WebDriver's "Set Permission" command can only act on the test's
# origin, which may be too limited.
#
# [0]: https://wicg.github.io/background-sync/spec/#permission
params = {
"permission": {"name": "background-sync"},
"setting": "granted",
}
self.parent.cdp.execute_cdp_command("Browser.setPermission", params)


class ChromeDriverFedCMProtocolPart(WebDriverFedCMProtocolPart):
Expand Down Expand Up @@ -227,23 +215,16 @@ def __init__(self, *args, reuse_window=False, **kwargs):
super().__init__(*args, **kwargs)
self.protocol.reuse_window = reuse_window

def setup(self, runner, protocol=None):
super().setup(runner, protocol)
# Chromium requires the `background-sync` permission for reporting APIs
# to work. Not all embedders (notably, `chrome --headless=old`) grant
# `background-sync` by default, so this CDP call ensures the permission
# is granted for all origins, in line with the background sync spec's
# recommendation [0].
#
# WebDriver's "Set Permission" command can only act on the test's
# origin, which may be too limited.
#
# [0]: https://wicg.github.io/background-sync/spec/#permission
params = {
"permission": {"name": "background-sync"},
"setting": "granted",
}
self.protocol.cdp.execute_cdp_command("Browser.setPermission", params)
def get_test_window(self, protocol):
if protocol.reuse_window and self.protocol.testharness.test_window:
# Mimic the "new window" WebDriver command by loading `about:blank`
# with no other browsing history.
protocol.base.set_window(self.protocol.testharness.test_window)
protocol.base.load("about:blank")
protocol.cdp.execute_cdp_command("Page.resetNavigationHistory")
else:
self.protocol.testharness.test_window = super().get_test_window(protocol)
return self.protocol.testharness.test_window

def _get_next_message_classic(self, protocol, url, test_window):
try:
Expand Down
79 changes: 8 additions & 71 deletions tools/wptrunner/wptrunner/executors/executorwebdriver.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
import os
import socket
import threading
import time
import traceback
import uuid
from urllib.parse import urljoin

from .base import (AsyncCallbackHandler,
Expand Down Expand Up @@ -82,6 +80,9 @@ def set_timeout(self, timeout):
body = {"type": "script", "ms": timeout * 1000}
self.webdriver.send_session_command("POST", "timeouts", body)

def create_window(self, type="tab", **kwargs):
return self.webdriver.new_window(type_hint=type)

@property
def current_window(self):
return self.webdriver.window_handle
Expand Down Expand Up @@ -228,8 +229,6 @@ def setup(self):
self.runner_handle = None
with open(os.path.join(here, "runner.js")) as f:
self.runner_script = f.read()
with open(os.path.join(here, "window-loaded.js")) as f:
self.window_loaded_script = f.read()

def load_runner(self, url_protocol):
if self.runner_handle:
Expand Down Expand Up @@ -258,66 +257,6 @@ def _close_window(self, window_handle):
except webdriver_error.NoSuchWindowException:
pass

def open_test_window(self, window_id):
self.webdriver.execute_script(
"window.open('about:blank', '%s', 'noopener')" % window_id)

def get_test_window(self, window_id, parent, timeout=5):
"""Find the test window amongst all the open windows.
This is assumed to be either the named window or the one after the parent in the list of
window handles
:param window_id: The DOM name of the Window
:param parent: The handle of the runner window
:param timeout: The time in seconds to wait for the window to appear. This is because in
some implementations there's a race between calling window.open and the
window being added to the list of WebDriver accessible windows."""
test_window = None
end_time = time.time() + timeout
while time.time() < end_time:
try:
# Try using the JSON serialization of the WindowProxy object,
# it's in Level 1 but nothing supports it yet
win_s = self.webdriver.execute_script("return window['%s'];" % window_id)
win_obj = json.loads(win_s)
test_window = win_obj["window-fcc6-11e5-b4f8-330a88ab9d7f"]
except Exception:
pass

if test_window is None:
test_window = self._poll_handles_for_test_window(parent)

if test_window is not None:
assert test_window != parent
return test_window

time.sleep(0.1)

raise Exception("unable to find test window")

def _poll_handles_for_test_window(self, parent):
test_window = None
after = self.webdriver.handles
if len(after) == 2:
test_window = next(iter(set(after) - {parent}))
elif after[0] == parent and len(after) > 2:
# Hope the first one here is the test window
test_window = after[1]
return test_window

def test_window_loaded(self):
"""Wait until the page in the new window has been loaded.
Hereby ignore Javascript execptions that are thrown when
the document has been unloaded due to a process change.
"""
while True:
try:
self.webdriver.execute_script(self.window_loaded_script, asynchronous=True)
break
except webdriver_error.JavascriptErrorException:
pass


class WebDriverPrintProtocolPart(PrintProtocolPart):
CM_PER_INCH = 2.54
Expand Down Expand Up @@ -828,7 +767,6 @@ def __init__(self, logger, browser, server_config, timeout_multiplier=1,
self._get_next_message = self._get_next_message_classic

self.close_after_done = close_after_done
self.window_id = str(uuid.uuid4())
self.cleanup_after_test = cleanup_after_test

def is_alive(self):
Expand Down Expand Up @@ -857,20 +795,16 @@ def do_test(self, test):
def do_testharness(self, protocol, url, timeout):
# The previous test may not have closed its old windows (if something
# went wrong or if cleanup_after_test was False), so clean up here.
parent_window = protocol.testharness.close_old_windows()
protocol.testharness.close_old_windows()

# If protocol implements `bidi_events`, remove all the existing subscriptions.
if hasattr(protocol, 'bidi_events'):
# Use protocol loop to run the async cleanup.
protocol.loop.run_until_complete(protocol.bidi_events.unsubscribe_all())

# Now start the test harness
protocol.testharness.open_test_window(self.window_id)
test_window = protocol.testharness.get_test_window(self.window_id,
parent_window,
timeout=5*self.timeout_multiplier)
test_window = self.get_test_window(protocol)
self.protocol.base.set_window(test_window)

# Wait until about:blank has been loaded
protocol.base.execute_script(self.window_loaded_script, asynchronous=True)

Expand Down Expand Up @@ -975,6 +909,9 @@ async def process_bidi_event(method, params):

return rv, extra

def get_test_window(self, protocol):
return protocol.base.create_window()

def _get_next_message_classic(self, protocol, url, _):
"""
Get the next message from the test_driver using the classic WebDriver async script execution. This will block
Expand Down

0 comments on commit 3c7e678

Please sign in to comment.