splunk / splunk/contentctl

Align test reporting more closely w/ status enums (as it related to "untested")

Open
#267 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
139
Forks
52
Avg merge
1h 16m
Merged PRs (30d)
3

Description

  • the difference between "skipped" and "untested" is not obvious to the unitiated
  • we should:
    • add a new UNSET status enum that is the default for TestResult.status (also good in that we no longer need to worry about the None type)
    • eliminate total_untested and untested_detections
    • If testing fails in an unhandled way that causes contentctl to stop altogether, then we iterate over all tests, and for any that remain UNSET after testing completes, we mark the status as ERROR with a message like TEST FAILED (ERROR): testing end state failed to be set, testing may have ended prematurely

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating TestResult.status, total_untested, and untested_detections, then trace how test results are initialized, reported, and finalized after an unhandled failure. Done means UNSET is the default status, the obsolete untested fields are removed, and remaining UNSET results become ERROR with the specified message when testing ends prematurely.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.