Closed Bug 1614443 Opened 6 months ago Closed 4 months ago

./mach browsertime --help should document passing args to browsertime

Categories

(Testing :: Performance, enhancement, P3)

Version 3
enhancement

Tracking

(firefox76 fixed)

RESOLVED FIXED
mozilla76
Tracking Status
firefox76 --- fixed

People

(Reporter: barret, Assigned: myeongjun.ko, Mentored)

References

(Blocks 1 open bug)

Details

(Keywords: good-first-bug, Whiteboard: [lang=py])

User Story

See here for information on how to contribute: https://wiki.mozilla.org/TestEngineering/Performance/NewContributors

Attachments

(2 files)

./mach browsertime supports passing arugments to the browsertime script via, e.g., ./mach browsertime -- --firefox.binaryPath /usr/bin/firefox, but this is not documented and therefore unrecoverable. The --help docs should be updated to indicate this is possible, maybe with a list of pertinent/common browsertime flags.

Mentor: gmierz2
User Story: (updated)
Keywords: good-first-bug

Hello.
I have some questions about this issue.
I checked browsertime arguments more than 20 (e.g - --firefox.binaryPath, --firefox.geckodriverPath, --firefox.nightly and so on).
It have many arguments (command) than I think. It want add all argument?
Also, I wonder if this is the right approach.
I'll attach a command example as an attachment.

Hi Myeongjun! Thanks for your interest in this issue.

Rather than add the options one at a time, you'll have to have our ./mach browsertime tool output the command line options from browsertime itself. You'll have to add something here to do the output: https://dxr.mozilla.org/mozilla-central/source/tools/browsertime/mach_commands.py#551

You'll need to add a --browsertime-help flag, and then output the browsertime help message when it's given. We won't be able to use the --help command because we need to have browsertime setup to be able to find all the command-line options (if we use --help, we'll break the standard help message that will tell people how to setup).

Assignee: nobody → myeongjun.ko
Status: NEW → ASSIGNED

Thanks Greg :)
I submitted patch.
Please let me know if there is anything that needs to be modified.

Pushed by gmierz2@outlook.com:
https://hg.mozilla.org/integration/autoland/rev/9911fb331155
added browsertime usage command(--browsertime-help) r=sparky,perftest-reviewers
Status: ASSIGNED → RESOLVED
Closed: 4 months ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla76
You need to log in before you can comment on or make changes to this bug.