summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/docs/running_tests.md
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /testing/web-platform/tests/docs/running_tests.md
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'testing/web-platform/tests/docs/running_tests.md')
-rw-r--r--testing/web-platform/tests/docs/running_tests.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/testing/web-platform/tests/docs/running_tests.md b/testing/web-platform/tests/docs/running_tests.md
new file mode 100644
index 000000000..98fcd4135
--- /dev/null
+++ b/testing/web-platform/tests/docs/running_tests.md
@@ -0,0 +1,34 @@
+In simple cases individual tests can be run by simply loading the page
+in a browser window. For running larger groups of tests, or running
+tests frequently, this is not a practical approach, and several better
+options exist.
+
+## From Inside a Browser
+
+For running multiple tests inside a browser, there is the test runner,
+located at
+
+ /tools/runner/index.html
+
+This allows all the tests, or those matching a specific prefix
+(e.g. all tests under `/dom/`) to be run. For testharness.js tests,
+the results will be automatically collected, whilst the runner
+provides a simple UI for manually comparing reftest rendering and
+running manual tests.
+
+Because it runs entirely in-browser, this runner cannot deal with
+edge-cases like tests that cause the browser to crash or hang.
+
+## By Automating the Browser
+
+For automated test running designed to be robust enough to use in a CI
+environment, the [wptrunner](http://github.com/w3c/wptrunner) test runner
+can be used. This is a test runner written in Python and designed to
+control the browser from the outside using some remote control
+protocol such as WebDriver. This allows it to handle cases such as the
+browser crashing that cannot be handled by an in-browser harness. It
+also has the ability to automatically run both testharness-based tests
+and reftests.
+
+Full instructions for using wptrunner are provided in its own
+[documentation](http://wptrunner.readthedocs.org).