README.md

web-platform-tests dashboard 📈

A dashboard of cross-browser results for web-platform-tests.

It consists of 3 parts:

• Running: VMs scheduled to run tests locally and on Sauce daily (thanks to Sauce Labs for providing us with infrastructure to run Edge + Safari builds)
• Serving: An App Engine app for storing test run metadata and serving HTML
• Visualizing: Polymer elements for loading and visualizing test results

Setting up your environment

You'll need Docker. With Docker installed, build the base image and development image, and start a development server instance:

docker build -t wptd-base -f Dockerfile.base .
docker build -t wptd-dev -f Dockerfile.dev .
./util/docker-dev/run.sh

This starts a Docker instance named wptd-dev-instance.

Running locally

Once the instance is running, you can fire up the web server in another terminal:

./util/docker-dev/web_server.sh

This will build dependencies and start the Google App Engine development server inside wptd-dev-instance.

With the webserver running, you'll also need to populate the app datastore with some initial data. In another terminal, execute the script which leverages util/populate_dev_data.go by running:

./util/docker-dev/dev_data.sh

IMPORTANT: If this command fails, you may need to authorize your development environment by running ./util/docker-dev/dev_auth.sh and following the instructions. Once complete, rerun ./util/docker-dev/dev_data.sh.

See CONTRIBUTING.md for more information on local development.

Running the tests

We run the tests in the development environment with a Python script run/run.py which is a thin wrapper around WPT's wpt run. If you're triaging test failures, use wpt run.

Running

Ensure that the Docker development image is running (./util/docker-dev/run.sh). To run a directory of WPT, pass the platform ID and a test path to run/run.py on the development server:

docker exec -it -u $(id -u $USER):$(id -g $USER) wptd-dev-instance \
    run/run.py firefox-56.0-linux --path battery-status

Filesystem and network output

• This script will only write files under config['build_path'].
• One run will write approximately 111MB to the filesystem.
• If --upload is specified, it will upload that 111MB of results to GCS.
• To upload results, you must be logged in with gcloud in the wptdashboard project.

Using the data

All test result data is public. There are two types of gzipped JSON data files we store: test run summary files, and individual test result files.

Test run summary files

These are of the pattern: {sha[0:10]}/{platform_id}-summary.json.gz

• sha[0:10]: the first 10 characters of the WPT commit hash that run was tested against
• platform_id: the key of the platform configuration in webapp/browsers.json

Example: https://storage.googleapis.com/wptd/791e95323d/firefox-56.0-linux-summary.json.gz

(Note that wptd is the bucket name)

Structure: An object where the key is the test file name and the value is a list of the type [number passing subtests, total number subtests].

{
    "/test/file/name1.html": [0, 1],
    "/test/file/name2.html": [5, 10]
}

Individual test result files

These are of the pattern: {sha[0:10]}/{platform_id}/{test_file_path}

• sha[0:10]: the first 10 characters of the WPT commit hash that run was tested against
• platform_id: the key of the platform configuration in webapp/browsers.json
• test_file_path: the full WPT path of the test file

Example: https://storage.googleapis.com/wptd/b12daf6ead/safari-10-macos-10.12-sauce/IndexedDB/abort-in-initial-upgradeneeded.html

Structure:

{
    "test": "/test/file/name.html",
    "status": "OK",
    "message": "The failure message, if exists",
    "subtests": [
        {
            "status": "FAIL",
            "name": "The subtest name",
            "message": "The failure message, if exists"
        }
    ]
}

Large-scale analysis

There is no public API for TestRuns, so if you need to access only the most recent results, looking at the main page will give you the latest test SHAs. If you need to access earlier results, an exhaustive search is the only way to do that (see issue #73 and #43).

Miscellaneous

WPT documentation page for each browser

• Chromium: https://chromium.googlesource.com/chromium/src/+/master/docs/testing/web_platform_tests.md
• Firefox: https://wiki.mozilla.org/Auto-tools/Projects/web-platform-tests
• WebKit: https://trac.webkit.org/wiki/WebKitW3CTesting

Location of the WPT in each browser’s source tree

• Chromium: src/third_party/WebKit/LayoutTests/imported/wpt
• Firefox: testing/web-platform/tests
• WebKit: LayoutTests/imported/w3c/web-platform-tests

You can run almost any WPT test on w3c-test.org

Try out http://w3c-test.org/html/semantics/forms/the-input-element/checkbox.html

This doesn't work with some HTTPS tests. Also be advised that the server is not intended for frequent large-scale test runs.

Sources of inspiration

• ECMAScript 6 compatibility table - https://kangax.github.io/compat-table/es6/
• https://html5test.com/

Appendix

Terminology

Platform ID

These are the keys in webapp/browsers.json. They're used to identify a tuple (browser name, browser version, os name, os version).