bug 1523104: remote: update testing documentation; r=ochameau
authorAndreas Tolfsen <ato@sny.no>
Sun, 17 Feb 2019 15:18:47 +0000
changeset 463205 705542bc7f142ef317e748e703ea7289be81bf3a
parent 463204 0c3648638c85610915983b21fbd0ff6c1cd8d0ac
child 463206 275ad4598e7597a4b4400b1923322937a36bb1f7
push id35669
push userbtara@mozilla.com
push dateFri, 08 Mar 2019 21:53:37 +0000
treeherdermozilla-central@67424fa758d4 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersochameau
bugs1523104
milestone67.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 1523104: remote: update testing documentation; r=ochameau
remote/doc/Testing.md
remote/test/browser/README.md
--- a/remote/doc/Testing.md
+++ b/remote/doc/Testing.md
@@ -1,19 +1,35 @@
 Testing
 =======
 
-xpcshell unit tests
--------------------
+The remote agent has unit- and functional tests located under
+`remote/test/{unit,browser}`.
+
+You may run all the tests locally using `mach test` like this:
+
+	% ./mach test remote/test
 
-The remote agent has a set of [xpcshell] unit tests located in
-_remote/test/unit_.  These can be run this way:
+The tests are currently not run on try.
+
 
-	% ./mach test remote/test/unit
+Unit tests
+----------
 
-Because tests are run in parallel and xpcshell itself is quite
+Because tests are run in parallel and [xpcshell] itself is quite
 chatty, it can sometimes be useful to run the tests in sequence:
 
-	% ./mach test --sequential remote/test/unit/test_Assert.js
+	% ./mach xcpshell --sequential remote/test/unit/test_Assert.js
 
 The unit tests will appear as part of the `X` jobs on Treeherder.
 
 [xpcshell]: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Writing_xpcshell-based_unit_tests
+
+
+Functional tests
+----------------
+
+We also have a set of functional [browser chrome] tests located
+under _remote/test/browser_:
+
+	% ./mach mochitest -f browser remote/test/browser/browser_cdp.js
+
+[browser chrome]: https://developer.mozilla.org/en-US/docs/Mozilla/Browser_chrome_tests
--- a/remote/test/browser/README.md
+++ b/remote/test/browser/README.md
@@ -1,11 +1,11 @@
-# Update chrome-remote-interface.js
+Update chrome-remote-interface.js
+=================================
 
-Upstream instructions on (github)[https://github.com/cyrus-and/chrome-remote-interface#using-vanilla-javascript].
+Upstream instructions on
+https://github.com/cyrus-and/chrome-remote-interface#using-vanilla-javascript:
 
-```
-$ git clone https://github.com/cyrus-and/chrome-remote-interface.git
-$ cd chrome-remote-interface
-$ npm install
-$ TARGET=var DEBUG=true npm run webpack
-$ cp chrome-remote-interface.js ../
-```
+	% git clone https://github.com/cyrus-and/chrome-remote-interface.git
+	% cd chrome-remote-interface
+	% npm install
+	% TARGET=var DEBUG=true npm run webpack
+	% cp chrome-remote-interface.js ../