97
edits
TestEngineering/Performance/NewContributors: Difference between revisions
TestEngineering/Performance/NewContributors (view source)
Revision as of 22:09, 28 April 2020
, 28 April 2020Added information on how to hack on PerfDocs.
(Link to onboarding review section.) |
(Added information on how to hack on PerfDocs.) |
||
| Line 13: | Line 13: | ||
== Getting the code, running tests == | == Getting the code, running tests == | ||
=== Performance Testing === | |||
The first thing to do is to get your build environment set up. Follow the Getting Started instructions [https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions#Getting_started here]. You can find more instructions [https://firefox-source-docs.mozilla.org/contributing/how_to_contribute_firefox.html here] as well. We suggest using an artifact build when you’re asked since speeds everything up a lot. After you have the build ready and ran `./mach run` successfully you should be good to go. If you hit any issues getting ready, we can help you in [https://chat.mozilla.org/#/room/#perftest:mozilla.org #perftest]. | The first thing to do is to get your build environment set up. Follow the Getting Started instructions [https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions#Getting_started here]. You can find more instructions [https://firefox-source-docs.mozilla.org/contributing/how_to_contribute_firefox.html here] as well. We suggest using an artifact build when you’re asked since speeds everything up a lot. After you have the build ready and ran `./mach run` successfully you should be good to go. If you hit any issues getting ready, we can help you in [https://chat.mozilla.org/#/room/#perftest:mozilla.org #perftest]. | ||
| Line 27: | Line 27: | ||
The code for these tools resides in [https://dxr.mozilla.org/mozilla-central/source/testing/raptor this folder]. Browsertime code can also be found [https://dxr.mozilla.org/mozilla-central/source/tools/browsertime here] after it’s installed. | The code for these tools resides in [https://dxr.mozilla.org/mozilla-central/source/testing/raptor this folder]. Browsertime code can also be found [https://dxr.mozilla.org/mozilla-central/source/tools/browsertime here] after it’s installed. | ||
=== PerfDocs === | |||
Even though are primary focus is on performance testing harnesses, like Raptor, we have many other projects to work on too! If you come across bugs that talk about <tt>PerfDocs</tt>, then read on for more information on how to hack on it - it's a bit simpler. | |||
This project is for building up documentation about all of our tests dynamically, and you can find it in the [https://firefox-source-docs.mozilla.org/testing/perfdocs/raptor.html Firefox Source Tree Docs]. It has two stages, a verification stage, and a generation stage. The verification stage ensures that all tests are documented and that all documented tests exist. The generation stage, as you may have guessed, generates the documentation! The first stage can be run with: | |||
./mach lint -l perfdocs | |||
This should pass because we can't land patches unless perfdocs is passing. The generation stage is run by calling: | |||
./mach lint -l perfdocs --fix | |||
If no errors are found during the verification (which is always run before generation), then the documentation information is produced. The actual document that was linked above in the source tree docs is produced in continuous integration (you can also do it locally with <tt>./mach doc</tt> if you're interested. | |||
The whole system is relatively simple, and you can find the code for it in [https://searchfox.org/mozilla-central/source/tools/lint/perfdocs this folder]. | |||
== Work on bugs and get code review == | == Work on bugs and get code review == | ||