在Jenkins的多模块项目中从Sonar Qube扫描中排除目录而不修改项目

Question

I have created a Jenkins job which performs a SONAR QUBE analysis. I have added the SONAR scan as a generic build step. I have not made any modifications to the project to enable the SONAR integration since the project should not have to care about SONAR. (ie no changes to POM.xml and no properties file(s) added)

My SONAR integration is working, without any mods necessary to the project, which is great.

However, it is a multi module project and now I want to exclude one of the modules from the scan, since this module contains auto generated code. Here are the Maven commands that I'm using to trigger the SONAR scan in Jenkins:

sonar:sonar
-Dsonar:host.url=http://url.com:9000/sonar
-Dsonar.login=myusername
-Dsonar.password=mypassword

Here is my project structure:

    root
      Project A
      Project B
      Project C

I want to exclude ProjectB from the scan.

I have tried -Dsonar.exclusions=/ProjectB and it did not work.

Here is an excerpt from the log:

[INFO] ------------- Scan Project B
[INFO] Base dir: /workspace/jenkins/…/workspace/CI-JOB-NAME/projectB
[INFO] Working dir: /workspace/jenkins/…/workspace/CI-JOB-NAME/projectB/target/sonar
[INFO] Source paths: pom.xml, src/main/java
[INFO] Binary dirs: target/classes
[INFO] Source encoding: UTF-8, default locale: en_US
[INFO] Index files
[INFO] Excluded sources: 
[INFO]   /projectB
[INFO] 44 files indexed
[INFO] 0 files ignored because of inclusion/exclusion patterns

As shown in the log, the excluded sources property is set but not working since it says 0 files ignored...

Question: How do I exclude everything inside the project B directory from the scan? (Preferably using a command in the Jenkins job and not adding any properties files or other modifications to the project itself)

Is the “Excluded sources path” relative to the “Base dir” path or the Root?? Should I define the exclusion path as an absolute path?

Answer 1

The documentation has a dedicated section for this. The options that seem suitable for your case:

• use build profiles to exclude some module (like for integration tests)
• use Advanced Reactor Options (such as -pl ). For example mvn sonar:sonar -pl !module2

For example using this last one, you could do:

sonar:sonar -pl "!projectB"
-Dsonar:host.url=http://url.com:9000/sonar
-Dsonar.login=myusername
-Dsonar.password=mypassword

---

Is the “Excluded sources path” relative to the “Base dir” path or the Root?? Should I define the exclusion path as an absolute path?

According to the documentation on exclusions , patterns are relative to the base directory, so not absolute paths. In any case, I don't think this option is useful in your case, because in a multi-module maven project, the files of a sub-module are indexed with the path relative to the module's base directory. So a pattern like projectB/** will not match anything, as projectB is not part of the paths used. If you have some unique package name in the module, let's say someuniquepackage , located at src/main/java/someuniquepackage , then the pattern src/main/java/someuniquepackage/** would work.

In anycase, I recommend the -pl option above, or using Maven's profile feature.