mozilla/mozci-tools

refactor `dump_failures` script to have an excluded manifest list instead of harcoded in the middle of the logic

Open

#9 opened on Sep 29, 2021

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Python (11 forks)auto 404
good first issue

Repository metrics

Stars
 (7 stars)
PR merge metrics
 (PR metrics pending)

Description

in dump_failures.py, there is some code like this:

            if manifest in ("dom/canvas/test/mochitest.ini",):
                continue

the reason for this is the format of test names and output is not supported yet (due to being a sub test suite) in dump_failures, so until we have logic to handle these sub test suites it is simpler to skip these as seen in the current code.

To solve this issue here are some recommendations:

  1. build a list of manifests that are defined at the top of the file in a constant (SKIPPED_MANIFESTS = ...)
  2. replace the current code to use the new list of defined tests
  3. add a comment in code to help out with this, update any documentation as needed

Contributor guide

Research direction
Create a constant SKIPPED MANIFESTS at the top of dump failures.py, move the hardcoded manifest into it, and replace the inline check with a membership test. Update documentation to explain why manifests are skipped.
Tech stack
python
Domain
testing
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75