1633437 - tests metadata

Status: RESOLVED FIXED

(Testing :: mozperftest, enhancement)

Description

[Tarek Ziadé (:tarek)]

Right now tests can be composed of three globals:

• setUp
• tearDown
• test

We'd like to extend these with:

• owner : name or email. (can be a person or a team)
• description: a one sentence description of the test
• long_description: a paragraph, or more

what other metadata could we add? supported browser ? supported platforms?

Comment 1

[Andrew Creskey [:acreskey] [he/him]]

Will the sample usage will go in the description?
e.g.

./mach perftest testing/performance/perftest_applink.js --android-install-apk ~/fenix.v2.fennec-nightly.2020.04.22.apk --hooks testing/performance/hooks_applink.py --android-app-name org.mozilla.fennec_aurora --perfherder-metrics processLaunchToNavStart

Comment 2

[Tarek Ziadé (:tarek)]

I was thinking that the description would be a plain english sentence of what this test is for,
and then the long_description more details, so maybe that's where we can have a sample usage?

Comment 3

[Andrew Creskey [:acreskey] [he/him]]

Supported browser and platforms are both good.

Comment 4

[Tarek Ziadé (:tarek)]

Attachment: Bug 1633437 - Support for test metadata

This patch adds support for tests metadata. A test script parser is added as
well as a new "doc" flavor that can be used to display the script info in the
command line. This parser will be the basis for building automated docs and
scripts verifications if we want to do this.

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c4a72c937045
Support for test metadata r=acreskey

Comment 6

[Oana Pop-Rus]

https://hg.mozilla.org/mozilla-central/rev/c4a72c937045