Skip to content

[uss_qualifier] skip documented checks in situations where they do not need to be run #1107

@Shastick

Description

@Shastick

background

As part of #975 we cleaned up most documented but not run checks, which we would like to generally avoid, as they indicate either incorrect documentation or faulty scenario implementations.

There are legitimate situations where a documented check is not run, mostly for certain scenario preparation steps that might need to do some cleanup, but usually don't. Currently, there is no clear way to identify and differentiate such checks.

We have the option of explicitly skipping a check (via check.skip()). In test reports this is currently not reported in a way that is distinguishable from a "forgotten" check, but that can likely easily be changed: currently, checks that are not run and documented with a TODO are rendered in yellow in reports (see screenshot)

Image

proposal

  • Call check.skip() on all documented checks in situations where they do not need to be run.
  • Render skipped checks in a recognizable way in test reports

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3Lower priorityenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions