Sonar - Ignore Lombok code via custom annotation

Question

I'm trying to ignore Lombok code (generated code) from Sonar analysis based on files which have a custom annotation, @ExcludeLombok. I've tried this guide which did not work.

In fact, I've even tried excluding an entire directory from analysis and it still wouldn't work.

I've also tirelessly searched through StackOverflow looking for a solution, and I've seen this has been discussed a good bit on here, but I've seen that people have been suggesting to write a single test to get the coverage up, which is pointless since we should not test auto generated code.

The solution I'm looking for is to exclude files based on a custom annotation. But so far, anything I attempt to exclude does not get excluded.

Any help would be greatly appreciated.

Answer 1

There is currently no easy way to exclude issues raised by the SonarQube rules from the SonarQube Java Analyzer, except from using approaches described in the "Narrowing the focus" documentation you quote.

Now, we introduced recently the concept of issue filters in the SonarQube Java Analyzer. This mechanism is at the moment only used internally to exclude issues raised by rules at analysis time, based on specific criteria.

We plan to extends this mechanism in order to allow users to implements their own custom issue filters, the same way custom rules can be implemented. This approach would cover your case and allow you to filter any rules on code annotated with your custom annotation. This new feature will be handled in the following JIRA ticket: SONARJAVA-1761