Findings

A finding is a deviation from a standard practice (Rules) defined in the analysis model.

A finding contains the location of the deviation (with regard to the artefact it is attached to), the name of the standard practice it deviates from, the number of occurrences and such.

Default statuses

A status is also attached to the finding, in order to be able to derogate and justify some deviations. Here are the default findings statuses:

  • Open is the default status for new findings, which means no relaxation

  • Open (Confirmed) means no relaxation, plus indicates that this finding has been reviewed and its status is validated as open.

  • Relaxed (Derogation) means that you are relaxing a true violation for an exceptional reason

  • Relaxed (False positive) can be used to work around a violation that was falsely detected by a Data Provider

  • Relaxed (Legacy system) is used when a violation is detected in a piece of code that was analysed but cannot or will not be fixed.

To add your own custom finding status in your model. See the Custom statuses section to know more.

Custom statuses

Additional findings statuses can be created alongside default ones using the FindingStatus element.

<FindingStatus id="CONFIRMED_CUSTOM_STATUS" type="CONFIRMED" />
<FindingStatus id="RELAXED_CUSTOM_STATUS" type="RELAXED" />

The attributes allowed in the FindingStatus tag are the following:

  • id (mandatory): the unique identifier of the finding’s status. It must be prefixed by the status type.

  • type (mandatory): the finding’s status type. Accepted values are:

    • CONFIRMED: will be included in the project’s rating computation.

    • RELAXED: will be excluded from the project’s rating computation.