Running suppress command can edit files whitespace even with no suppressions

[JustinSchneiderPBI]

Describe the bug
Suppress command edits the whitespace in many files listed in a sarif result (a problem on its own). Surprisingly, this even affects files with violations outside the --rules list. Looks like EOF newlines removed sometimes. There might have been an encoding change on a file too?

To Reproduce
devskim suppress --source-code -O "" --rules DS173237

Expected behavior
Only files with DS173237 rule violations would be edited

Versions(please complete the following information):

• OS: Windows 11 Enterprise 23H2 22631.4037
• Devskim Version 1.0.33+9dba5c6c1f

Screenshots

Additional context
In this case I was expecting just 2 files to be edited. Instead I had to sort through my changes and these whitespace changes to git commit.

[gfs]

I think I've identified the issue here. If there is a file that has detected issue in the sarif but their rule ids don't match the ones selected for suppression the file wasn't being skipped, so it was just being rewritten in place. #632 adds a check for this to skip processing those files since doing so is essentially a no-op (other than possibly messing with trailing whitespace as you encountered).

[JustinSchneiderPBI]

Thanks for the quick fix! There's probably technically 2 bugs here, unless there's magic in the code I haven't seen. The unaddressed issue is that the whitespace is changed at all for a suppression command. #632 will help with the UX when filtering specific issues. The whitespace changes could still be painful and noisy when large numbers of files are getting suppressed.

[gfs]

That's a fair point. I'll try to see this afternoon if I can do something about modifying whitespace when there actually is an issue detected as well. We use ReadAllLines and then glue the lines back together with Environment.NewLine, but that inserts newlines based on the OS being used so there's definitely some edge cases.

[gfs]

@JustinSchneiderPBI Added a second fix for the whitespace bug to the same PR.

[JustinSchneiderPBI]

Thank you very much!