Open Bug 1972863 Opened 7 months ago Updated 7 months ago

[Perfdocs] Adding comments in the manifest files causes perfdocs to append the incorrect line number for the test definition

Categories

(Testing :: Performance, defect, P3)

Product:
Testing
Component:
Performance
Type:
defect

Tracking

(Not tracked)

People

(Reporter: afinder, Unassigned)

References

(Blocks 1 open bug)

Details

(Whiteboard: [fxp])

Steps to reproduce:

  • using the # sign, add a comment to a .toml manifest file (e.g. testing/raptor/raptor/tests/benchmarks/twitch-animation.toml)
  • run the mach lint -l perfdocs --outgoing --fix command to generate the perfdocs

Actual results:

  • comment lines are ignored by the perfdocs linter

Expected results:

  • when comments are inserted in the toml manifest files, they are incorrectly identified as the subsection where the test is defined within their corresponding manifest files in searchfox (e.g. for the twitch-animation.toml in a previous patch)
Blocks: perfdocs
No longer blocks: 1955007
No longer depends on: 1959123

Just want to note that the comment line needs to include the test name for this bug to occur.

You need to log in before you can comment on or make changes to this bug.