summaryrefslogtreecommitdiffstats
path: root/testing/perfdocs/generated/running.rst
diff options
context:
space:
mode:
Diffstat (limited to 'testing/perfdocs/generated/running.rst')
-rw-r--r--testing/perfdocs/generated/running.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/testing/perfdocs/generated/running.rst b/testing/perfdocs/generated/running.rst
new file mode 100644
index 0000000000..7325f8ed60
--- /dev/null
+++ b/testing/perfdocs/generated/running.rst
@@ -0,0 +1,46 @@
+Running a performance test
+==========================
+
+You can run `perftest` locally or in Mozilla's CI
+
+Running locally
+---------------
+
+Running a test is as simple as calling it using `mach perftest` in a mozilla-central source
+checkout::
+
+ $ ./mach perftest
+
+The `mach` command will bootstrap the installation of all required tools for the
+framework to run, and display a selection screen to pick a test. Once the
+selection is done, the performance test will run locally.
+
+If you know what test you want to run, you can use its path explicitely::
+
+ $ ./mach perftest perftest_script.js
+
+`mach perftest` comes with numerous options, and the test script should provide
+decent defaults so you don't have to bother with them. If you need to tweak some
+options, you can use `./mach perftest --help` to learn about them.
+
+
+Running in the CI
+-----------------
+
+You can run in the CI directly from the `mach perftest` command by adding the `--push-to-try` option
+to your locally working perftest call.
+
+This call will run the fuzzy selector and then send the job into our CI::
+
+ $ ./mach perftest --push-to-try
+
+We have phones on bitbar that can run your android tests. Tests are fairly fast
+to run in the CI because they use sparse profiles. Depending on the
+availability of workers, once the task starts, it takes around 15mn to start
+the test.
+
+.. warning::
+
+ If you plan to run tests often in the CI for android, you should contact the android
+ infra team to make sure there's availability in our pool of devices.
+