Bug 1216054 - Update web-platform-tests README file, r=Ms2ger DONTBUILD
authorJames Graham <james@hoppipolla.co.uk>
Mon, 19 Oct 2015 14:14:28 +0100
changeset 303536 e5f87a0504e3a7be3c9795b89a36ba20ddc46943
parent 303535 1deba998864fdc156c7d891b71f307ec71786527
child 303537 75c673cd65ea3e539e3665e64b6ed744b0e37a96
push id1001
push userraliiev@mozilla.com
push dateMon, 18 Jan 2016 19:06:03 +0000
treeherdermozilla-release@8b89261f3ac4 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersMs2ger
bugs1216054
milestone44.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1216054 - Update web-platform-tests README file, r=Ms2ger DONTBUILD
testing/web-platform/README.md
--- a/testing/web-platform/README.md
+++ b/testing/web-platform/README.md
@@ -24,21 +24,35 @@ FAQ
 
   You need to update the expectation data for those tests. See the
   section on expectations below.
 
 * I want to write some new tests for the web-platform-tests
   testsuite. How do I do that?
 
   See the section on tests below. You can commit the tests directly to
-  the Mozilla repository and they will be upstreamed next time the
-  test is imported. For this reason please ensure that any tests you
-  write are testing correct-pre-spec behaviour even if we don't yet
-  pass, get proper review, and have a commit message that makes sense
-  outside of the Mozilla context.
+  the Mozilla repository under `testing/web-platform/tests` and they
+  will be upstreamed next time the test is imported. For this reason
+  please ensure that any tests you write are testing correct-per-spec
+  behaviour even if we don't yet pass, get proper review, and have a
+  commit message that makes sense outside of the Mozilla
+  context. If you are writing tests that should not be upstreamed yet
+  for some reason they must be located under
+  `testing/web-platform/mozilla/tests`.
+
+  It is important to note that in order for the tests to run the
+  manifest file must be updated; this should not be done by hand, but
+  by running `mach web-platform-tests --manifest-update`.
+
+  `mach web-platform-tests-create <path>` is a helper script designed
+  to help create new web-platform-tests. It opens a locally configured
+  editor at `<path>` with web-platform-tests boilerplate filled in,
+  and in the background runs `mach web-platform-tests
+  --manifest-update <path>`, so the test being developed is added to
+  the manifest and opened for interactive development.
 
 * How do I write a test that requires the use of a Mozilla-specific
   feature?
 
   Tests in the `mozilla/tests/` directory use the same harness but are
   not synced with any upstream. Be aware that these tests run on the
   server with a `/_mozilla/` prefix to their URLs.
 
@@ -183,22 +197,31 @@ Test Format
 -----------
 
 Javascript tests are written using
 [testharness.js](http://github.com/w3c/testharness.js/). Reftests are
 similar to standard Gecko reftests without an explicit manifest file,
 but with in-test or filename conventions for identifying the
 reference.
 
-New tests must presently be submitted upstream before they can be run
-on Mozilla infrastructure. This situation is expected to be temporary.
-
 Full documentation on test authoring and submission can be found on
 [testthewebforward.org](http://testthewebforward.org/docs).
 
+Test Manifest
+-------------
+
+web-platform-tests use a large auto-generated JSON file as their
+manifest. This stores data about the type of tests, their references,
+if any, and their timeout, gathered by inspecting the filenames and
+the contents of the test files.
+
+In order to update the manifest it is recommended that you run `mach
+web-platform-tests --manifest-update`. This rescans the test directory
+looking for new, removed, or altered tests.
+
 Running Tests In Other Browsers
 -------------------------------
 
 web-platform-tests is cross browser, and the runner is compatible with
 multiple browsers. Therefore it's possible to check the behaviour of
 tests in other browsers. This is somewhat more involved than running
 them in Firefox since extra dependencies may be required. For example
 to test in Chrome: