[BUG] [RULES] Some rules are being triggered in comments

[abrugaro]

Is there an existing issue for this?

• I have searched the existing issues

Konveyor version

0.5 beta 1

Priority

Undefined (Default)

Current Behavior

Some rules are triggering false positives when detecting incidents in code comments

Anything else?

Examples:

azure-file-system-02000

azure-file-system-03000

hardcoded-ip-address

[konveyor-ci-bot]

This issue is currently awaiting triage.
If contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.
The triage/accepted label can be added by org members.

[shawn-hurley]

I don't know if I agree that this is a bug, the rule in question is asking for all the file contents to be searched and is finding the correct values. In some cases, we would still very much want this to find things in comments.

I can think of something that we are already considering for these cases, where you can explictly ignore certain incidents, and they will not show up again.

The other option, is that we would need to have a new provider capabability, that would tell us what the comments look like, and then add an option to the builtin to ask all the providers what the comments look like and an optional field that would ignore incidents in comments.

The third option, is to fix the rules, by taking the line found and chaining it to another conditon that would look for the specific comment lines, like * or \\ and seeing if that particular line has those, for that particular rule.

I think the provider capability is probably not worth doing, I would rather focus on rule fixes here IMO. But I did want to make sure that we added the context of what is happening.