Confirmed users
1,759
edits
ReleaseEngineering/TryServer: Difference between revisions
m
→Re-running tasks with custom parameters from Treeherder
m (Update notes) |
|||
| (28 intermediate revisions by 13 users not shown) | |||
| Line 5: | Line 5: | ||
To use the try server, you'll need [http://www.mozilla.org/hacking/commit-access-policy/ Level 1 Commit Access]. You can learn more about Mozilla's commit access policies and start the process of signing up for an account here: [http://www.mozilla.org/hacking/committer/ Becoming a Mozilla Contributor] | To use the try server, you'll need [http://www.mozilla.org/hacking/commit-access-policy/ Level 1 Commit Access]. You can learn more about Mozilla's commit access policies and start the process of signing up for an account here: [http://www.mozilla.org/hacking/committer/ Becoming a Mozilla Contributor] | ||
After you have level 1 commit access, you'll need to do a bit of setup before you'll be able to push. See [https:// | After you have level 1 commit access, you'll need to do a bit of setup before you'll be able to push. See [https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/auth.html this guide] for instructions. | ||
== Configuration == | == Configuration == | ||
Before using try, there is some recommended configuration you should set up. This can be accomplished by running: | Before using try, there is some recommended configuration you should set up. This can be accomplished by running: | ||
$ ./mach | $ ./mach vcs-setup | ||
Be sure to at least enable the [http://mozilla-version-control-tools.readthedocs.org/en/latest/hgmozilla/firefoxtree.html firefoxtree extension] and the push-to-try extension. The push-to-try extension is required if you wish to use the |mach try| command (see below). Firefoxtree will give you a handy 'try' alias you can use for pushing, and prevent you from accidentally pushing multiple heads. If for some reason you prefer not to use firefoxtree, you can set the same alias up manually in your hgrc: | Be sure to at least enable the [http://mozilla-version-control-tools.readthedocs.org/en/latest/hgmozilla/firefoxtree.html firefoxtree extension] and the push-to-try extension. The push-to-try extension is required if you wish to use the |mach try| command (see below). Firefoxtree will give you a handy 'try' alias you can use for pushing, and prevent you from accidentally pushing multiple heads. If for some reason you prefer not to use firefoxtree, you can set the same alias up manually in your hgrc: | ||
| Line 22: | Line 22: | ||
== How to push to try == | == How to push to try == | ||
There are | There are a few ways to schedule jobs on try. | ||
=== Attach new jobs from the review === | |||
For every patch submitted for review in Phabricator, a new Try run is automatically created. This run is created for static analysis, linting and other tasks. | |||
As described below, attaching new jobs to the run is easy and doesn't require more actions from the developer. | |||
Just click on the ''Treeherder Jobs''. | |||
[[File:Screenshot 2019-10-07 ⚙ D48316 Bug 1585593 - Enable Fission for Raptor.png]] | |||
For more details, see: | |||
https://firefox-source-docs.mozilla.org/tools/try/index.html#attaching-new-jobs-from-a-review | |||
=== Scheduling jobs with Mach Try === | |||
The recommended way to [https://firefox-source-docs.mozilla.org/tools/try/index.html interact with try] is via the command line tool |mach try|. Since try can be used for a wide range of use cases, by developers with varying levels of experience, there is no one size fits all solution when it comes to selecting which tasks to run. Therefore |mach try| offers a range of subcommands called "selectors" for a variety of purposes. To see a list of available selectors, run: | |||
$ mach try --help | |||
For deeper information on a given selector, run: | |||
$ mach try <selector> --help | |||
If you don't specify a selector/subcommand to try, it will default to using the `syntax` selector. You can change which selector gets used by default by creating ~/.mozbuild/machrc and adding: | |||
[try] | |||
default=<selector> | |||
See [https://firefox-source-docs.mozilla.org/tools/try/selectors/index.html this documentation] for more information on all the available selectors, and [https://firefox-source-docs.mozilla.org/tools/try/presets.html this document] for a list of available presets (derived from [https://searchfox.org/mozilla-central/source/tools/tryselect/try_presets.yml try_presets.yml]). | |||
=== Scheduling jobs with Treeherder === | === Scheduling jobs with Treeherder === | ||
Select the drop-down arrow at the top right of your push, and choose "Add new Jobs". It might take | You can push to try with: | ||
$ ./mach try empty | |||
Once the push succeeds, you can open it in Treeherder and then sign in to schedule jobs manually. | |||
Select the drop-down arrow at the top right of your push, and choose "Add new Jobs". It might take several seconds for the jobs to load ({{bug|1288028}}) : | |||
https://s3.amazonaws.com/media-p.slid.es/uploads/185196/images/2042414/TH_dropdown.png | https://s3.amazonaws.com/media-p.slid.es/uploads/185196/images/2042414/TH_dropdown.png | ||
Click the job symbols you wish to schedule. If you select a test job, the required build will automatically be scheduled: | If it helps, you can use the filter box in the site header to restrict the list of runnable jobs being displayed. Click the job symbols you wish to schedule. | ||
If you select a test job, the required build will automatically be scheduled: | |||
https://s3.amazonaws.com/media-p.slid.es/uploads/185196/images/2042426/TH_with_jobs.png | https://s3.amazonaws.com/media-p.slid.es/uploads/185196/images/2042426/TH_with_jobs.png | ||
| Line 38: | Line 75: | ||
NOTE: An action task gets scheduled which will schedule all the tasks you chose. | NOTE: An action task gets scheduled which will schedule all the tasks you chose. | ||
=== Scheduling jobs with | === Scheduling jobs with Treeherder (Search) === | ||
Similar to the above method, there is now an additional way to add jobs to an existing push via Treeherder. Open the push in Treeherder and then choose "Add New Jobs (Search)" from the push's menu: | |||
[[File:Add New Jobs Search.png]] | |||
Treeherder will then fetch the list of runnable jobs in the background, then pop up a dialog window listing those jobs: | |||
[[File:Addnewjobssearchinterface.png]] | |||
At the top of the dialog, there is a search bar. Type part of your desired job name into the search bar and press 'Enter' to filter the list of jobs. (This uses a fuzzy search library, so some minimal typos are allowed). From the filtered list of jobs, select as many of the results as you want (ctrl/shift modifiers work on this list for selecting multiple jobs): | |||
[[File:Filteredaddnewjobssearch.png]] | |||
Then click the green "Add Selected" button to add the selected jobs to the list of jobs to be run (or click the green "Add All" button to add the entire list of jobs currently in view. | |||
Repeat the filter and selection process until you have all of your desired jobs added to the list. You can remove jobs from the list to be run using the red buttons lower on the dialog if you selected them in error: | |||
[[File:Addnewjobssearchselectedjobs.png]] | |||
When you are happy with your selection, click the blue "Trigger (X) Selected Jobs" button at the bottom of the dialog. Treeherder will send out a request for those jobs to be run, and an action task will be spawned to do all of the behind the scenes magic to make that happen. | |||
==== | === Pushing Directly === | ||
It's also possible to push to try directly from hg (for now). This might be required if you're using [https://www.mercurial-scm.org/wiki/MqExtension mercurial queues]. In this case, the only way to select tasks is by manually adding try syntax to your commit message: | |||
$ hg commit -m "try: -b o -p linux64 -u mochitest" | |||
$ hg push -f try | |||
Using |mach try| is recommended as that will automatically create and cleanup a temporary commit no your behalf, whereas with this method you are responsible for cleaning up any extra commits you make or commit messages you modify. | |||
== Viewing the results == | == Viewing the results == | ||
You can see the results of your tryserver build in a number of ways: | You can see the results of your tryserver build in a number of ways: | ||
* You'll get an email on a successful push with a link to treeherder for your revision as well as optional emails on any non-successful build/test/talos results | * You'll get an email on a successful push with a link to treeherder for your revision as well as optional emails on any non-successful build/test/talos results | ||
* You can have the results of your try run posted to bug(s) automatically at the completion of the run using the --post-to-bugzilla flag in your try syntax | * You can have the results of your try run posted to bug(s) automatically at the completion of the run using the --post-to-bugzilla flag in your try syntax | ||
* The link to treeherder will be printed on the command line. | * The link to treeherder will be printed on the command line. | ||
* Look for your changeset on [https://treeherder.mozilla.org/#/jobs?repo=try Treeherder]. You can add '''&author=YOUR.EMAIL''' to only see your pushes. | * Look for your changeset on [https://treeherder.mozilla.org/#/jobs?repo=try Treeherder]. You can add '''&author=YOUR.EMAIL''' to only see your pushes. | ||
* Download your completed builds from [http://ftp.mozilla.org/pub/mozilla.org/firefox/try-builds/?C=M;O=D firefox/tryserver-builds on ftp.m.o]. | * Download your completed builds from [http://ftp.mozilla.org/pub/mozilla.org/firefox/try-builds/?C=M;O=D firefox/tryserver-builds on ftp.m.o]. | ||
== Using a custom mozconfig == | == Using a custom mozconfig == | ||
| Line 81: | Line 121: | ||
Android mozconfigs are in mobile/android/config/mozconfigs. | Android mozconfigs are in mobile/android/config/mozconfigs. | ||
If you modify a mozconfig file named <tt>nightly</tt>, please make sure you also change any mozconfig file named <tt>beta</tt> and/or <tt>release</tt> in the same directory, otherwise the test_compare_mozconfigs test will fail. | |||
Note: | Note: | ||
* TryServer purpose is to tell what will happen on Tinderbox, not to check every possible build option/configuration. | * TryServer purpose is to tell what will happen on Tinderbox, not to check every possible build option/configuration. | ||
** Any non-standard feature is implicitly unsupported. You may try them, but don't complain if they break. | ** Any non-standard feature is implicitly unsupported. You may try them, but don't complain if they break. | ||
== Re-running tasks with custom parameters from Treeherder == | |||
It is possible to run a task again, with certain types of changes to its run time environment and parameters. This feature is commonly used to enable debug logging, or run a test repeatedly to reproduce test failures. | |||
In treeherder, select the job you want to re-run (Note: it currently only works for [https://searchfox.org/mozilla-central/source/taskcluster/taskgraph/actions/retrigger_mochitest.py#30-31 some jobs]). The details panel should open. Look for the 3 dots icon ("Other job details") and select "Custom actions...". | |||
[[File:Custom-action.png|thumb|Selecting "Custom Action..." in treeherder.]] | |||
The <tt>retrigger-custom</tt> action is the one selected in the drop-down menu. Modify the task parameters as desired and select "Trigger". | |||
[[File:Custom Taskcluster Job Actions.png|thumb|Treeherder modal to request an action associated to a task]] | |||
This will schedule the task with your specified parameters. The new task will be labeled as <tt>custom-<original_task_name></tt>. | |||
Some of the parameters that you can change are (see screenshot above): | |||
* Environment variables (e.g. <tt>MOZ_LOG</tt>) | |||
* Modify Python's logging level | |||
* Path of the test to execute | |||
* Gecko preferences (think of <tt>about:config</tt>) | |||
* Run a test repeatedly | |||
* Run until the test fails | |||
Common problems: | |||
* By default the entire task is re-run, running all the tests in the original task. If repeat/runUntilFailure is specified, it may take a long time to repeat all the tests, and the log file may be huge. Consider using the path: parameter to limit the run to the test(s) of interest. | |||
== Getting debug symbols == | == Getting debug symbols == | ||
NOTE: You might be able to accomplish this by re-running a build task from Treeherder by adding the env variable to the new task. | |||
By default native debug symbols are not uploaded for Try server builds because of their size. If you want to debug your builds locally you must add <tt>MOZ_CRASHREPORTER_UPLOAD_FULL_SYMBOLS=1</tt> to the in-tree mozconfigs. You can do this for all platforms by importing [http://hg.mozilla.org/users/tmielczarek_mozilla.com/mq/raw-file/b44faf6cd177/enable-full-symbols this patch] into your mq and pushing it along with your changes to Try. This will cause a ...crashreporter-symbols-full.zip package to be uploaded to the builds directory for each platform built. | By default native debug symbols are not uploaded for Try server builds because of their size. If you want to debug your builds locally you must add <tt>MOZ_CRASHREPORTER_UPLOAD_FULL_SYMBOLS=1</tt> to the in-tree mozconfigs. You can do this for all platforms by importing [http://hg.mozilla.org/users/tmielczarek_mozilla.com/mq/raw-file/b44faf6cd177/enable-full-symbols this patch] into your mq and pushing it along with your changes to Try. This will cause a ...crashreporter-symbols-full.zip package to be uploaded to the builds directory for each platform built. | ||
| Line 164: | Line 235: | ||
Please retry your push. If you see messages indicating the same process has been pushing for more than 15 minutes, treat as [[#long_try_push|above]]. | Please retry your push. If you see messages indicating the same process has been pushing for more than 15 minutes, treat as [[#long_try_push|above]]. | ||
== | == CiDuty issues == | ||
=== How do I trigger additional talos/test runs for a given try build? === | === How do I trigger additional talos/test runs for a given try build? === | ||
If your | If your syntax included the tests you'd like more of, then select the job you want on Treeherder and use the + button. For test suites you didn't request originally you can use the "Add New Jobs" interface in Treeherder. | ||
=== How do I cancel existing jobs? === | === How do I cancel existing jobs? === | ||
For individual jobs, select the relevant one on Treeherder and use the cancel button. To cancel all jobs, use the menu arrow shown on the header row for each push, and then the "Cancel all" option. | For individual jobs, select the relevant one on Treeherder and use the cancel button. To cancel all jobs, use the menu arrow shown on the header row for each push, and then the "Cancel all" option. | ||
== See Also == | == See Also == | ||
* https://developer.mozilla.org/en/Creating_Mercurial_User_Repositories | * https://developer.mozilla.org/en/Creating_Mercurial_User_Repositories | ||
* https://wiki.mozilla.org/Sheriffing/How:To:Recommended_Try_Practices | * https://wiki.mozilla.org/Sheriffing/How:To:Recommended_Try_Practices | ||
* https://wiki.mozilla.org/ReleaseEngineering:Autoland | * https://wiki.mozilla.org/ReleaseEngineering:Autoland | ||
* [http://build.mozilla.org/buildapi/self-serve Manage Submissions] [[https://build.mozilla.org/buildapi/self-serve/try try]] | * [http://build.mozilla.org/buildapi/self-serve Manage Submissions] [[https://build.mozilla.org/buildapi/self-serve/try try]] | ||
* [https:// | * [https://catlee.github.io/highscores/highscores.html Scoreboard] | ||