python/mozperftest/perfdocs/running.rst

   1 Running a performance test
   2 ==========================
   3
   4 You can run `perftest` locally or in Mozilla's CI
   5
   6 Running locally
   7 ---------------
   8
   9 Running a test is as simple as calling it using `mach perftest` in a mozilla-central source
  10 checkout::
  11
  12     $ ./mach perftest
  13
  14 The `mach` command will bootstrap the installation of all required tools for the
  15 framework to run, and display a selection screen to pick a test. Once the
  16 selection is done, the performance test will run locally.
  17
  18 If you know what test you want to run, you can use its path explicitely::
  19
  20     $ ./mach perftest perftest_script.js
  21
  22 `mach perftest` comes with numerous options, and the test script should provide
  23 decent defaults so you don't have to bother with them. If you need to tweak some
  24 options, you can use `./mach perftest --help` to learn about them.
  25
  26
  27 Running in the CI
  28 -----------------
  29
  30 You can run in the CI directly from the `mach perftest` command by adding the `--push-to-try` option
  31 to your locally working perftest call.
  32
  33 This call will run the fuzzy selector and then send the job into our CI::
  34
  35     $ ./mach perftest --push-to-try
  36
  37 We have phones on bitbar that can run your android tests. Tests are fairly fast
  38 to run in the CI because they use sparse profiles. Depending on the
  39 availability of workers, once the task starts, it takes around 15mn to start
  40 the test.
  41
  42 .. warning::
  43
  44    If you plan to run tests often in the CI for android, you should contact the android
  45    infra team to make sure there's availability in our pool of devices.
  46