GoogleGit

  1. 0d31818  Merge pull request #1684 from Ms2ger/blockquote by Ms2ger - 4 days ago master
  2. 869332f  Try to ensure that travis has all submodules. by James Graham - 4 days ago
  3. 0629b0a  Move the tools directory into its own repo. by James Graham - 4 days ago
  4. 5053f55  Merge pull request #1685 from Ms2ger/pe-explicit-done by Matt Brubeck - 7 days ago
  5. 09e49e7  Rewrite pointerevent_constructor to avoid the explicit_done. by Ms2ger - 7 days ago

The Web Platform Tests Project IRC chat

These are test suites for 60+ Web-platform specifications, along with test-infrastructure code for running the tests.

Running the Tests

The tests are designed to be run from your local computer. The test environment requires Python 2.7+ (but not Python 3.x). You will also need a copy of OpenSSL. For users on Windows this is available from the openssl website.

To get the tests running, you need to set up the test domains in your hosts file. The following entries are required:

127.0.0.1	web-platform.test
127.0.0.1	www.web-platform.test
127.0.0.1	www1.web-platform.test
127.0.0.1	www2.web-platform.test
127.0.0.1	xn--n8j6ds53lwwkrqhv28a.web-platform.test
127.0.0.1	xn--lve-6lad.web-platform.test

Because web-platform-tests uses git submodules, you must ensure that these are up to date. In the root of your checkout, run:

git submodule update --init --recursive

The test environment can then be started using

./serve

This will start HTTP servers on two ports and a websockets server on one port. By default one web server starts on port 8000 and the other ports are randomly-chosen free ports. Tests must be loaded from the first HTTP server in the output. To change the ports, edit the config.json file, for example, replacing the part that reads:

"http": [8000, "auto"]

to some port of your choice e.g.

"http":[1234, "auto"]

If you installed OpenSSL in such a way that running openssl at a command line doesn’t work, you also need to adjust the path to the OpenSSL binary. This can be done by adding a section to config.json like:

"ssl": {"openssl": {"binary": "/path/to/openssl"}}

Test Runner

There is a test runner that is designed to provide a convenient way to run the web-platform tests in-browser. It will run testharness.js tests automatically but requires manual work for reftests and manual tests.

The runner can be found at /tools/runner/index.html on the local server i.e.

http://web-platform.test:8000/tools/runner/index.html

in the default configuration. The first time you use this it has to generate a manifest of all tests. This may take some time, so please be patient.

Publication

The master branch is automatically synced to http://w3c-test.org/.

Pull requests that have been checked are automatically mirrored to http://w3c-test.org/submissions/.

Finding Things

Each top-level directory represents a W3C specification: the name matches the shortname used after the canonical address of the said specification under http://www.w3.org/TR/ .

For some of the specifications, the tree under the top-level directory represents the sections of the respective documents, using the section IDs for directory names, with a maximum of three levels deep.

So if you’re looking for tests in HTML for “The History interface”, they will be under html/browsers/history/the-history-interface/.

Various resources that tests depend on are in common, images, and fonts.

If you’re looking at a section of the specification and can’t figure out where the directory is for it in the tree, just run:

node tools/scripts/id2path.js your-id

Branches

In the vast majority of cases the only upstream branch that you should need to care about is master. If you see other branches in the repository, you can generally safely ignore them.

Contributing

Save the Web, Write Some Tests!

Absolutely everyone is welcome (and even encouraged) to contribute to test development, so long as you fulfill the contribution requirements detailed in the Contributing Guidelines. No test is too small or too simple, especially if it corresponds to something for which you’ve noted an interoperability bug in a browser.

The way to contribute is just as usual:

A lint is available to test for common mistakes in testcases. It can be run with:

./lint

in the root of the checkout. It is also run for every submitted pull request, and branches with lint errors will not get merged. In the unusual case that the lint is reporting an error for something that is essential to your test, there is a whitelist at tools/lint/lint.whitelist that may be updated.

Adding command-line scripts (“tools” subdirs)

Sometimes you may want to add a script to the repository that’s meant to be used from the command line, not from a browser (e.g., a script for generating test files). If you want to ensure (e.g., for security reasons) that such scripts won’t be handled by the HTTP server, but will instead only be usable from the command line, then place them in either:

Any files in those tools directories won’t be handled by the HTTP server; instead the server will return a 404 if a user navigates to the URL for a file within them.

If you want to add a script for use with a particular set of tests but there isn’t yet any tools subdir at the root of a top-level directory in the repository containing those tests, you can create a tools subdir at the root of that top-level directory and place your scripts there.

For example, if you wanted to add a script for use with tests in the notifications directory, create the notifications/tools subdir and put your script there.

Test Review

We can sometimes take a little while to go through pull requests because we have to go through all the tests and ensure that they match the specification correctly. But we look at all of them, and take everything that we can.

Getting Involved

If you wish to contribute actively, you’re very welcome to join the public-test-infra@w3.org mailing list (low traffic) by signing up to our mailing list. The mailing list is archived.

Join us on irc #testing (irc.w3.org, port 6665). The channel is archived.

Documentation

Branches

More...