Bug 1572834 [wpt PR 18358] - [docs] Consolidate and improve information on test organization, a=testonly
authorMike Pennisi <mike@mikepennisi.com>
Wed, 14 Aug 2019 10:58:06 +0000
changeset 488132 1c1240e0078c851156d74d9b059cf264ad3f1270
parent 488131 0c9c596c83a953c4ee1e529fa3111808c0130189
child 488133 bc4e4bdc9e5d745b64e28a6aac3703db45f92e42
push id36435
push usercbrindusan@mozilla.com
push dateThu, 15 Aug 2019 09:46:49 +0000
treeherdermozilla-central@0db07ff50ab5 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerstestonly
bugs1572834, 18358
milestone70.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 1572834 [wpt PR 18358] - [docs] Consolidate and improve information on test organization, a=testonly Automatic update from web-platform-tests [docs] Reorganize content on test organization Consolidate content in the README and the comprehensive project documentation. -- [docs] Extend list of shared resource directories -- [docs] Add hyperlinks -- wpt-commits: 78fe39d8a9f88abbf26ff571fa6ce49ae0c56c25, 9d37ca75bc4b5fca60d267d422ccfa02bd3b93f4, d358ae4d7bd3f703d3adf09d5d6baa04f3367cce wpt-pr: 18358
testing/web-platform/tests/README.md
testing/web-platform/tests/docs/test-suite-design.md
--- a/testing/web-platform/tests/README.md
+++ b/testing/web-platform/tests/README.md
@@ -186,33 +186,16 @@ Publication
 The master branch is automatically synced to http://w3c-test.org/.
 
 Pull requests are
 [automatically mirrored](http://w3c-test.org/submissions/) except those
 that modify sensitive resources (such as `.py`). The latter require
 someone with merge access to comment with "LGTM" or "w3c-test:mirror" to
 indicate the pull request has been checked.
 
-Finding Things
-==============
-
-Each top-level directory matches the shortname used by a standard, with
-some exceptions. (Typically the shortname is from the standard's
-corresponding GitHub repository.)
-
-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`.
-
 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
--- a/testing/web-platform/tests/docs/test-suite-design.md
+++ b/testing/web-platform/tests/docs/test-suite-design.md
@@ -5,34 +5,40 @@ be loaded in a browser and either progra
 provide a set of steps to run the test and obtain the result.
 
 The tests are, in general, short, cross-platform, and self-contained,
 and should be easy to run in any browser.
 
 
 ## Test Layout
 
-Each top level directory in the repository corresponds to tests for a
-single specification, with the exception of `css/` which contains
-test suites for CSS WG specifications. For W3C specs, these directories
-are typically named after the shortname of the spec (i.e. the name
-used for snapshot publications under `/TR/`); for WHATWG specs, they
-are typically named after the subdomain of the spec (i.e. trimming
-`.spec.whatwg.org` from the URL); for other specs, something deemed
-sensible is used. In any case, there are occasional exceptions for
-historic reasons.
+Most of the repository's top-level directories hold tests for specific web
+standards. For [W3C specs](https://www.w3.org/standards/), these directories
+are typically named after the shortname of the spec (i.e. the name used for
+snapshot publications under `/TR/`); for [WHATWG
+specs](https://spec.whatwg.org/), they are typically named after the subdomain
+of the spec (i.e. trimming `.spec.whatwg.org` from the URL); for other specs,
+something deemed sensible is used. The `css/` directory contains test suites
+for [the CSS Working Group
+specifications](https://www.w3.org/Style/CSS/current-work).
 
 Within the specification-specific directory there are two common ways
 of laying out tests: the first is a flat structure which is sometimes
 adopted for very short specifications; the alternative is a nested
 structure with each subdirectory corresponding to the id of a heading
 in the specification. The latter provides some implicit metadata about
 the part of a specification being tested according to its location in
 the filesystem, and is preferred for larger specifications.
 
+For example, tests in HTML for ["The History
+interface"](https://html.spec.whatwg.org/multipage/history.html#the-history-interface)
+are located in `html/browsers/history/the-history-interface/`.
+
+Various resources that tests depend on are in `common`, `images`, `fonts`,
+`media`, and `resources`.
 
 ## Test Types
 
 Tests in this project use a few different approaches to verify expected
 behavior. The tests can be classified based on the way they express
 expectations:
 
 * Rendering tests ensure that the browser graphically displays pages as