[JENKINS-69907] Suppress logging with optional param

[viradan]

Goal: reduce console output in jenkins job when printing file name and num of issues found.
Change: introduced new param quiet to mute logging.

See: JENKINS-69907

Comments for initial suggestion with sysproperty - #1403

• Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
• Ensure that the pull request title represents the desired changelog entry
• Please describe what you did
• Link to relevant issues in GitHub or Jira
• Link to relevant pull requests, esp. upstream and downstream changes
• Ensure you have provided tests - that demonstrates feature works or fixes the issue

[codecov]

Codecov Report

Merging #1416 (dbe52bf) into master (6c180a8) will increase coverage by 0.01%.
The diff coverage is 83.33%.

@@             Coverage Diff              @@
##             master    #1416      +/-   ##
============================================
+ Coverage     79.87%   79.88%   +0.01%     
- Complexity     1452     1461       +9     
============================================
  Files           252      252              
  Lines          5594     5622      +28     
  Branches        424      425       +1     
============================================
+ Hits           4468     4491      +23     
- Misses          976      981       +5     
  Partials        150      150              

Impacted Files	Coverage Δ
...plugins/analysis/core/steps/ScanForIssuesStep.java	85.24% <40.00%> (-2.48%)	⬇️
...plugins/analysis/core/steps/PublishIssuesStep.java	57.14% <71.42%> (+0.35%)	⬆️
...ns/plugins/analysis/core/steps/IssuesRecorder.java	68.01% <90.90%> (+0.59%)	⬆️
...ins/plugins/analysis/core/steps/IssuesScanner.java	93.54% <100.00%> (+0.08%)	⬆️
.../plugins/analysis/core/steps/RecordIssuesStep.java	60.66% <100.00%> (+0.95%)	⬆️
...jenkins/plugins/analysis/core/util/LogHandler.java	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[uhafner]

The code looks almost good now! Thanks for improving.

One little thing would be helpful: Change one of the tests in StepsITest so that it runs one time with quite and one time without. And then check the console log accordingly. (Example in test shouldSkipBlaming)

[viradan]

@uhafner many thx for support! I'd possibly need one more hint, here is wrong assumption. Not sure what would be best...

• what part of getConsoleLog(baseline) is output log only? Looks like even pipeline snippet is included
• or add & check new log line for quiet option (eg smthg like "Logging is suppressed as requested")?

[uhafner]

I think there is no way to suppress or work on the whole log. I think you simply should

assertThat(getConsoleLog(baseline)).doesNotContain("Searching for all files in");

You can also use a ParameterizedTest with a ValueSource(booleans = {true, false} and then use the same test:

if (isQuite) {
   assertThat(getConsoleLog(baseline)).doesNotContain("Searching for all files in");
} 
else {
   assertThat(getConsoleLog(baseline)).contains("Searching for all files in");
}

[viradan]

Not sure I get it right, does console log really contains LogHandler output or its feeded separately without LogHandler? Whatever I've tried console contained all content.
Also, the other option add & check new log line would make it not completely muted (not a big issue, but...)

[uhafner]

Should be fixed now, there was still one method left that had no guard. Now the guard is at the lowest method in the call stack.

[viradan]

Is there direct correlation between description here and suppressing here - like error logger should not be suppressed?

[uhafner]

Is there direct correlation between description here and suppressing here - like error logger should not be suppressed?

You are right, I copied the text from another plugin. I fixed the text now.

[uhafner]

🎉

[viradan]

thank you! 👍

[uhafner]

Thanks for your pull request! This is a much more versatile approach as the first one.

I will extract the main parts of this PR to apply the same pattern for my other plugins (code coverage).