gecko-dev/remote
Henrik Skupin a5b7336880 Bug 1751361 - [marionette] Replace assertions for Firefox with Desktop. r=webdriver-reviewers,jdescottes
WebDriver commands that currently assert for Firefox should
actually check for desktop because Thunderbird also supports
all of these.

Differential Revision: https://phabricator.services.mozilla.com/D136574
2022-01-21 16:03:23 +00:00
..
cdp Bug 1741425 - Enable more mochitest with socket process, r=ahal,webdriver-reviewers,preferences-reviewers,whimboo 2022-01-11 09:49:45 +00:00
components Bug 1735162 - [marionette] Write Marionette port to MarionetteActivePort file in profile directory. r=webdriver-reviewers,jdescottes 2021-10-15 14:45:28 +00:00
doc Bug 1749000 - [remote] Fix broken links and outdated documentation. r=webdriver-reviewers,jgraham DONTBUILD 2022-01-17 10:49:42 +00:00
marionette Bug 1751361 - [marionette] Replace assertions for Firefox with Desktop. r=webdriver-reviewers,jdescottes 2022-01-21 16:03:23 +00:00
server Bug 1746953 - [remote] Update error message when validating origin header r=webdriver-reviewers,whimboo 2021-12-21 07:17:46 +00:00
shared Bug 1749675 - [remote] Don't apply session data for modules that don't exist for a given destination. r=webdriver-reviewers,jdescottes 2022-01-20 07:28:38 +00:00
test Bug 1732958 - [puppeteer] Skip 2 new mandatory tests on Firefox r=webdriver-reviewers,whimboo 2022-01-04 12:11:45 +00:00
webdriver-bidi Bug 1749507 - [remote] Add support for internal message handler events. r=webdriver-reviewers,jdescottes 2022-01-13 09:46:32 +00:00
.eslintrc.js Bug 1719850 - [marionette] Enforce no-unused-vars for global variables in marionette eslint configuration r=webdriver-reviewers,whimboo 2021-07-09 17:22:09 +00:00
.gitignore
README.md Bug 1701674 - [remote] Add handling of expectation data to readme. r=remote-protocol-reviewers,jdescottes 2021-04-27 12:43:31 +00:00
jar.mn Bug 1747222 - [remote] Move browsing context APIs from browser.js and WindowManager to TabManager r=webdriver-reviewers,whimboo 2022-01-14 21:19:53 +00:00
mach_commands.py Bug 1736859 - Explicitly disable fission if '--enable-fission' is not set in |mach puppeteer-test|, r=jgraham,webdriver-reviewers 2021-10-28 14:52:29 +00:00
moz.build Bug 1694136 - [remote] Move all documentation files for remote protocols under remote/doc r=webdriver-reviewers,whimboo 2021-12-01 20:04:44 +00:00

README.md

The Firefox remote agent is a low-level debugging interface based on the CDP protocol.

With it, you can inspect the state and control execution of documents running in web content, instrument Gecko in interesting ways, simulate user interaction for automation purposes, and debug JavaScript execution.

This component provides an experimental and partial implementation of a remote devtools interface using the CDP protocol and transport layer.

See https://firefox-source-docs.mozilla.org/remote/ for documentation.

It is available in Firefox and is started this way:

% ./mach run --remote-debugging-port

Puppeteer

Puppeteer is a Node library which provides a high-level API to control Chrome, Chromium, and Firefox over the Chrome DevTools Protocol. Puppeteer runs headless by default, but can be configured to run full (non-headless) browsers.

To verify that our implementation of the CDP protocol is valid we do not only run xpcshell and browser-chrome mochitests in Firefox CI but also the Puppeteer unit tests.

Expectation Data

With the tests coming from upstream, it is not guaranteed that they all pass in Gecko-based browsers. For this reason it is necessary to provide metadata about the expected results of each test. This is provided in a manifest file under test/puppeteer-expected.json.

For each test of the Puppeteer unit test suite an equivalent entry will exist in this manifest file. By default tests are expected to PASS.

Tests that are intermittent may be marked with multiple statuses using a list of possibilities e.g. for a test that usually passes, but intermittently fails:

"Page.click should click the button (click.spec.ts)": [
  "PASS", "FAIL"
],

Disabling Tests

Tests are disabled by using the manifest file test/puppeteer-expected.json. For example, if a test is unstable, it can be disabled using SKIP:

"Workers Page.workers (worker.spec.ts)": [
  "SKIP"
],

For intermittents it's generally preferable to give the test multiple expectations rather than disable it.

Autogenerating Expectation Data

After changing some code it may be necessary to update the expectation data for the relevant tests. This can of course be done manually, but mach is able to automate the process:

mach puppeteer-test --write-results

By default it writes the output to test/puppeteer-expected.json.

Given that the unit tests run in Firefox CI only for Linux it is advised to download the expectation data (available as artifact) from the TaskCluster job.