Add reportingConfiguration.kind

[ghost]

Some analysis tools have rules that detect desirable conditions in the code rather than defects. Results from such rules are marked with "kind": "pass", for example:

{ # A result object.
  "ruleId": "CS1001",
  "kind": "pass",
  "message": {
    ...
  }
}

But there is no way to declare such a rule in the rule metadata, because the reportingConfiguration object does not have a kind property:

{
  "tool": {
    "driver": {
      "name": "CodeScanner",
      "rules": [
        {
          "id": "CS1001",
          "defaultConfiguration": {
            "kind": "pass"                 # Illegal: no such property
          },
          ...
        },
        ...
      ]

So, for example, if a tool has a command line option to --dump-rules, there will be no way to identify in the output those rules that detect desirable conditions.

Consider adding a property reportingConfiguration.kind. reportingConfiguration's kind and level properties should have the same mutual defaulting behavior as they do in the result object (if level is any of "error", "warning", or "note", then kind defaults to "fail"; if kind is anything except "fail", then level defaults to "none").

[schlaman-ms]

Document location for issue:

§3.50 reportingConfiguration object
§3.50.6 kind property (proposed)

lgolding:

"Some analysis tools have rules that detect desirable conditions in the code rather than defects... But there is no way to declare such a rule in the rule metadata, because the reportingConfiguration object does not have a kind property"

Propose new kind property