This directory contains code related to the
fuchsia.web FIDL API. Specifically, it contains the implementation of Fuchsia WebEngine and code related to it, including the Runners that use it. Code in this directory must not be used outside it and its subdirectories.
General information about Chromium on Fuchsia is here.
Each of the following subdirectories contain code for a specific Fuchsia service:
./commoncontains code shared by both WebEngine and Runners.
./runnerscontains implementations of Fuchsia
./runners/castEnables the Fuchsia system to launch Cast applications.
./runners/webEnables the Fuchsia system to launch HTTP or HTTPS URLs.
./shellcontains WebEngineShell, a simple wrapper for launching URLs in WebEngine from the command line.
./webenginecontains the WebEngine implementation. WebEngine is an implementation of
fuchsia.webthat enables Fuchsia Components to render web content using Chrome's Content layer.
./webinstance_hostcontains code for WebEngine clients to directly instantiate a WebInstance Component (
web_instance.cm) using the WebEngine package.
There are 3 major types of tests within this directory:
//fuchsia_web/webengine:web_engine_integration_testsmake use of the
//fuchsia_web/webengine:web_enginecomponent. The test code runs in a separate process in a separate Fuchsia Component, allowing only access to the published API of the component under test.
Integration tests are more resource-intensive than browser tests, which are in turn more expensive than unit tests. Therefore, when writing new tests, it is preferred to write unit tests over browser tests over integration tests.
As a general rule, test-only code should live in the same directory as the code under test with an explicit file name, either
*_ browsertest.cc or
Test code that is shared across Components should live in
a dedicated ``test directory. For example, the
//fuchsia_web/webengine/test directory, which contains code shared by all browser tests, and
//fuchsia_web/common/test, which contains code shared by tests for both WebEngine and Runners.
When you build
web_runner, Chromium will automatically generate scripts for you that will automatically provision a device with Fuchsia and then install
web_runner and its dependencies.
To build and run
web_runner, follow these steps:
(Optional) Ensure that you have a device ready to boot into Fuchsia.
If you wish to have
web_runner manage the OS deployment process, then you should have the device booting into Zedboot.
$ autoninja -C out/fuchsia web_runner
For devices running Zedboot:
$ out/fuchsia/bin/install_web_runner -d
For devices already booted into Fuchsia:
You will need to add command line flags specifying the device's IP address and the path to the
ssh_config used by the device (located at
$ out/fuchsia/bin/install_web_runner -d --ssh-config $PATH_TO_SSH_CONFIG
Press Alt-Esc key on your device to switch back to terminal mode or run
fx shell from the host.
Launch a webpage.
$ tiles_ctl add https://www.chromium.org/
Press Alt-Esc to switch back to graphical view if needed. The browser window should be displayed and ready to use.
You can deploy and run new versions of Chromium without needing to reboot.
First kill any running processes:
$ killall context_provider.cmx; killall web_runner.cmx
Then repeat steps 1 through 6 from the installation instructions, excluding step #3 (running Tiles).
Press the Windows key to return to the terminal.
Instruct tiles_ctl to remove the webpage‘s window tile. The tile’s number is reported by step 6, or it can be found by running
tiles_ctl list and noting the ID of the “url” entry.
$ tiles_ctl remove TILE_NUMBER