Bug 1575570 - Mention yarn in prerequisites for running devtools node tests r=ochameau
authorJulian Descottes <jdescottes@mozilla.com>
Thu, 22 Aug 2019 16:14:26 +0000
changeset 553224 29f5987dc9351ed3fbce4657a723cf0cdc8f9e42
parent 553223 068a65420ddda3940ba6b138dc17f1b19c8c5bf7
child 553225 e18558240aab248c3fed1dd90f584f5a3dd4f234
push id2165
push userffxbld-merge
push dateMon, 14 Oct 2019 16:30:58 +0000
treeherdermozilla-release@0eae18af659f [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersochameau
bugs1575570
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 1575570 - Mention yarn in prerequisites for running devtools node tests r=ochameau Differential Revision: https://phabricator.services.mozilla.com/D42894
devtools/docs/tests/node-tests.md
--- a/devtools/docs/tests/node-tests.md
+++ b/devtools/docs/tests/node-tests.md
@@ -1,34 +1,37 @@
 # DevTools node tests
 
 In addition to mochitests and xpcshell tests, some panels in DevTools are using node test libraries to run unit tests. For instance, several panels are using [Jest](https://jestjs.io/) to run React component unit tests.
 
-## DevTools node tests on Try
-### Find the node tests on Try
+## Find the node tests on Try
 
 The DevTools node tests are split in two different test suites on try:
 - `node(devtools)`: all the DevTools node tests, except the ones for the debugger
 - `node(debugger)`: only the Debugger node tests
 
 They are running on the `Linux 64 opt` platform. They are both tier 1 jobs, which means that any failure will lead to a backout.
 
-### On Try
+## Run Tests On Try
 
 To run the DevTools node tests on try, you can use `./mach try fuzzy` and look for the jobs named `source-test-node-debugger-tests` and `source-test-node-devtools-tests`.
 
 They are also run when using the "devtools" preset: `./mach try --preset devtools`.
 
 ### Node tests try job definition
 
 The definition of those try jobs can be found at [taskcluster/ci/source-test/node.yml](https://searchfox.org/mozilla-central/source/taskcluster/ci/source-test/node.yml).
 
 The definition also contains the list of files that will trigger the node test jobs. Currently the debugger tests run when any file is modified under `devtools/client/debugger`, the devtools tests run when any file is modified under `devtools/client` or `devtools/shared`.
 
-## Locally
+## Run Tests Locally
+
+### Prerequisite: yarn
+
+You will need yarn to be installed in order to run both the debugger and the DevTools tests. See https://yarnpkg.com/docs/install/.
 
 ### Debugger
 
 To run the debugger node tests:
 ```
 > cd devtools/client/debugger/
 > yarn && node bin/try-runner.js
 ```