Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: Port from CDP to BiDi browser automation #20832

Merged
merged 7 commits into from
Aug 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,12 @@ clean-local::
find $(builddir) -name '*.gc??' -delete
find $(srcdir) -name '*.pyc' -delete

# required for running unit and integration tests; commander and ws are deps of chrome-remote-interface
# required for running integration tests
node_modules/%: $(srcdir)/package-lock.json
@true

EXTRA_DIST += \
node_modules/chrome-remote-interface \
node_modules/commander \
node_modules/sizzle \
node_modules/ws \
$(NULL)

check: export VERBOSE=1
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ module = [
# test/common
'cdp',
'testlib',
'webdriver_bidi',
]

[tool.pylint]
Expand Down
68 changes: 4 additions & 64 deletions test/common/cdp.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def path(self, show_browser: bool) -> str:

@abc.abstractmethod
def cmd(
self, cdp_port: int, env: Mapping[str, str], show_browser: bool, browser_home: str, download_dir: str
self, cdp_port: int, env: Mapping[str, str], show_browser: bool, download_dir: str
) -> Sequence[str]:
pass

Expand Down Expand Up @@ -96,7 +96,7 @@ def _path(self, show_browser: bool) -> str | None:

@override
def cmd(
self, cdp_port: int, env: Mapping[str, str], show_browser: bool, browser_home: str, download_dir: str
self, cdp_port: int, env: Mapping[str, str], show_browser: bool, download_dir: str
) -> Sequence[str]:
exe = self.path(show_browser)

Expand All @@ -110,65 +110,6 @@ def cmd(
"--v=0", f"--remote-debugging-port={cdp_port}", "about:blank"]


class Firefox(Browser):
NAME = "firefox"
EXECUTABLES = ["firefox-developer-edition", "firefox-nightly", "firefox"]
CDP_DRIVER_FILENAME = f"{TEST_DIR}/common/firefox-cdp-driver.js"

@override
def _path(self, show_browser: bool) -> str | None:
"""Return path to Firefox browser."""
return self.find_exe()

@override
def cmd(
self, cdp_port: int, env: Mapping[str, str], show_browser: bool, browser_home: str, download_dir: str
) -> Sequence[str]:
exe = self.path(show_browser)

subprocess.check_call([exe, "--headless", "--no-remote", "-CreateProfile", "blank"], env=env)
profile = glob.glob(os.path.join(browser_home, ".mozilla/firefox/*.blank"))[0]

with open(os.path.join(profile, "user.js"), "w") as f:
f.write(f"""
user_pref("remote.enabled", true);
user_pref("remote.frames.enabled", true);
user_pref("app.update.auto", false);
user_pref("datareporting.policy.dataSubmissionEnabled", false);
user_pref("toolkit.telemetry.reportingpolicy.firstRun", false);
user_pref("dom.disable_beforeunload", true);
user_pref("browser.download.dir", "{download_dir}");
user_pref("browser.download.folderList", 2);
user_pref("signon.rememberSignons", false);
user_pref("dom.navigation.locationChangeRateLimit.count", 9999);
// HACK: https://bugzilla.mozilla.org/show_bug.cgi?id=1746154
user_pref("fission.webContentIsolationStrategy", 0);
user_pref("fission.bfcacheInParent", false);
""")

with open(os.path.join(profile, "handlers.json"), "w") as f:
f.write('{'
'"defaultHandlersVersion":{"en-US":4},'
'"mimeTypes":{"application/xz":{"action":0,"extensions":["xz"]}}'
'}')

cmd = [exe, "-P", "blank", f"--remote-debugging-port={cdp_port}", "--no-remote", "localhost"]
if not show_browser:
cmd.insert(3, "--headless")
return cmd


def get_browser(browser: str) -> Browser:
browser_classes = [
Chromium,
Firefox,
]
for cls in browser_classes:
if browser == cls.NAME:
return cls()
raise SystemError(f"Unsupported browser: {browser}")


def jsquote(obj: object) -> str:
return json.dumps(obj)

Expand All @@ -195,7 +136,7 @@ def __init__(
self.trace = trace
self.inject_helpers = inject_helpers
self.start_profile = start_profile
self.browser = get_browser(os.environ.get("TEST_BROWSER", "chromium"))
self.browser = Chromium()
self.show_browser = bool(os.environ.get("TEST_SHOW_BROWSER", ""))
self.download_dir = tempfile.mkdtemp()
self._driver = None
Expand Down Expand Up @@ -322,8 +263,7 @@ def start(self) -> None:
except KeyError:
pass

cmd = self.browser.cmd(cdp_port, environ, self.show_browser,
self._browser_home, self.download_dir)
cmd = self.browser.cmd(cdp_port, environ, self.show_browser, self.download_dir)

# sandboxing does not work in Docker container
self._browser = subprocess.Popen(
Expand Down
Loading