How to make Sonar ignore some classes for codeCoverage metric

Question

I have a Sonar profile in Maven  Everything works fine except the code coverage metric  I want to make Sonar ignore some classes only for the code coverage metric  I have the following profile      lt profile gt       lt id gt sonar lt  id gt       lt properties gt           lt sonar exclusions gt    beans jaxb    lt  sonar exclusions gt       lt  properties gt       lt build gt           lt plugins gt               lt plugin gt                   lt groupId gt org apache maven plugins lt  groupId gt                   lt artifactId gt maven-surefire-plugin lt  artifactId gt                   lt version gt   maven surefire plugin version  lt  version gt                   lt configuration gt                       lt redirectTestOutputToFile gt true lt  redirectTestOutputToFile gt                       lt excludes gt                           lt exclude gt     Suite  java lt  exclude gt                           lt exclude gt     RemoteTest java lt  exclude gt                           lt exclude gt     SpringTest java lt  exclude gt                           lt exclude gt     CamelTest java lt  exclude gt                           lt exclude gt     FunctionalTest java lt  exclude gt                           lt exclude gt     IntegrationTest java lt  exclude gt                           lt exclude gt     DaoBeanTest java lt  exclude gt                       lt  excludes gt                   lt  configuration gt               lt  plugin gt                               lt  plugins gt       lt  build gt   lt  profile gt    Please help  I tried to add something like    lt exclude gt com qwerty dw publisher Main class lt  exclude gt    but it didn t help  UPDATE  I have a correct Cobertura profile  I tried to add it to the Sonar profile  but still I have 53  instead about 95  like in the Cobertura profile   lt profile gt       lt id gt sonar lt  id gt       lt properties gt           lt sonar exclusions gt    beans jaxb    lt  sonar exclusions gt           lt sonar core codeCoveragePlugin gt cobertura lt  sonar core codeCoveragePlugin gt       lt  properties gt       lt build gt           lt plugins gt               lt plugin gt                   lt groupId gt org apache maven plugins lt  groupId gt                   lt artifactId gt maven-surefire-plugin lt  artifactId gt                   lt version gt   maven surefire plugin version  lt  version gt                   lt configuration gt                       lt redirectTestOutputToFile gt true lt  redirectTestOutputToFile gt                       lt excludes gt                           lt exclude gt     Suite  java lt  exclude gt                           lt exclude gt     RemoteTest java lt  exclude gt                           lt exclude gt     SpringTest java lt  exclude gt                           lt exclude gt     CamelTest java lt  exclude gt                           lt exclude gt     FunctionalTest java lt  exclude gt                           lt exclude gt     IntegrationTest java lt  exclude gt                           lt exclude gt     DaoBeanTest java lt  exclude gt                       lt  excludes gt                   lt  configuration gt               lt  plugin gt               lt plugin gt                   lt groupId gt org codehaus mojo lt  groupId gt                   lt artifactId gt cobertura-maven-plugin lt  artifactId gt                   lt version gt   cobertura maven plugin version  lt  version gt                   lt configuration gt                       lt instrumentation gt                           lt excludes gt                               lt exclude gt com qwerty dw dao   lt  exclude gt                               lt exclude gt com qwerty dw domain   lt  exclude gt                               lt exclude gt com qwerty dw beans      lt  exclude gt                               lt exclude gt com qwerty dw daemon exception   lt  exclude gt                               lt exclude gt com qwerty dw daemon Main class lt  exclude gt                               lt exclude gt com qwerty dw sink Main class lt  exclude gt                               lt exclude gt com qwerty dw publisher Main class lt  exclude gt                               lt exclude gt com qwerty dw publisher dao   lt  exclude gt                               lt exclude gt com qwerty dw publisher domain   lt  exclude gt                           lt  excludes gt                       lt  instrumentation gt                       lt formats gt                           lt format gt html lt  format gt                       lt  formats gt                       lt aggregate gt true lt  aggregate gt                       lt check gt                           lt haltOnFailure gt true lt  haltOnFailure gt                           lt branchRate gt 60 lt  branchRate gt                           lt lineRate gt 60 lt  lineRate gt                           lt totalBranchRate gt 60 lt  totalBranchRate gt                           lt totalLineRate gt 60 lt  totalLineRate gt                       lt  check gt                   lt  configuration gt                   lt executions gt                       lt execution gt                           lt goals gt                               lt goal gt clean lt  goal gt                               lt goal gt check lt  goal gt                           lt  goals gt                       lt  execution gt                   lt  executions gt               lt  plugin gt           lt  plugins gt       lt  build gt   lt  profile gt

User · Answer

For jacoco  use this properties   -Dsonar jacoco excludes     View java

User · Answer

Accordingly to this document for SonarQube 7 1     sonar exclusions - Comma-delimited list of file path patterns to be   excluded from analysis   sonar coverage exclusions - Comma-delimited   list of file path patterns to be excluded from coverage   calculations   This document gives some examples on how to create path patterns    Exclude all classes ending by  Bean    Matches org sonar api MyBean java  org sonar util MyOtherBean java  org sonar util MyDTO java  etc  sonar exclusions     Bean java     DTO java    Exclude all classes in the  src main java org sonar  directory   Matches src main java org sonar MyClass java  src main java org sonar MyOtherClass java   But does not match src main java org sonar util MyClassUtil java sonar exclusions src main java org sonar      Exclude all COBOL programs in the  bank  directory and its sub-directories   Matches bank ZTR00021 cbl  bank data CBR00354 cbl  bank data REM012345 cob sonar exclusions bank         Exclude all COBOL programs in the  bank  directory and its sub-directories whose extension is  cbl   Matches bank ZTR00021 cbl  bank data CBR00354 cbl sonar exclusions bank      cbl   If you are using Maven for your project  Maven command line parameters can be passed like this for example -Dsonar coverage exclusions    config      model    I was having problem with excluding single class explicitly  Below my observations       GlobalExceptionhandler java - not working for some reason  I was expecting such syntax should work com some package name GlobalExceptionhandler java - not working src main java com some package name GlobalExceptionhandler java - good  class excluded explicitly without using wildcards

User · Answer

Sometimes  Clover is configured to provide code coverage reports for all non-test code  If you wish to override these preferences  you may use configuration elements to exclude and include source files from being instrumented    lt plugin gt       lt groupId gt com atlassian maven plugins lt  groupId gt       lt artifactId gt maven-clover2-plugin lt  artifactId gt       lt version gt   clover-version  lt  version gt       lt configuration gt            lt excludes gt                lt exclude gt     Dull java lt  exclude gt            lt  excludes gt        lt  configuration gt   lt  plugin gt    Also  you can include the following Sonar configuration    lt properties gt       lt sonar exclusions gt             domain   java             transfer   java      lt  sonar exclusions gt   lt  properties gt

User · Answer

When using sonar-scanner for swift  use sonar coverage exclusions in your sonar-project properties to exclude any file for only code coverage  If you want to exclude files from analysis as well  you can use sonar exclusions  This has worked for me in swift  sonar coverage exclusions     ViewController swift     Cell swift     View swift

User · Answer

At the time of this writing  which is with SonarQube 4 5 1   the correct property to set is sonar coverage exclusions  e g     lt properties gt       lt sonar coverage exclusions gt foo         bar   lt  sonar coverage exclusions gt   lt  properties gt    This seems to be a change from just a few versions earlier  Note that this excludes the given classes from coverage calculation only  All other metrics and issues are calculated   In order to find the property name for your version of SonarQube  you can try going to the General Settings section of your SonarQube instance and look for the Code Coverage item  in SonarQube 4 5 x  that s General Settings  rarr  Exclusions  rarr  Code Coverage   Below the input field  it gives the property name mentioned above   Key  sonar coverage exclusions

User · Answer

I am able to achieve the necessary code coverage exclusions by updating jacoco-maven-plugin configuration in pom xml  lt plugin gt                   lt groupId gt org jacoco lt  groupId gt                   lt artifactId gt jacoco-maven-plugin lt  artifactId gt                   lt version gt 0 8 6 lt  version gt                   lt executions gt                       lt execution gt                           lt id gt pre-test lt  id gt                           lt goals gt                               lt goal gt prepare-agent lt  goal gt                           lt  goals gt                           lt configuration gt                               lt propertyName gt jacocoArgLine lt  propertyName gt                               lt destFile gt   project test result directory  jacoco jacoco exec lt  destFile gt                           lt  configuration gt                       lt  execution gt                       lt execution gt                           lt id gt post-test lt  id gt                           lt phase gt test lt  phase gt                           lt goals gt                               lt goal gt report lt  goal gt                           lt  goals gt                           lt configuration gt                               lt dataFile gt   project test result directory  jacoco jacoco exec lt  dataFile gt                               lt outputDirectory gt   project test result directory  jacoco lt  outputDirectory gt                           lt  configuration gt                       lt  execution gt                   lt  executions gt                   lt configuration gt                       lt excludes gt                           lt exclude gt    GlobalExceptionHandler    lt  exclude gt                           lt exclude gt    ErrorResponse    lt  exclude gt                       lt  excludes gt                   lt  configuration gt               lt  plugin gt   this configuration excludes the GlobalExceptionHandler java and ErrorResponse java in the jacoco coverage  And the following two lines does the same for sonar coverage        lt sonar exclusions gt      GlobalExceptionHandler         ErrorResponse   lt  sonar exclusions gt           lt sonar coverage exclusions gt      GlobalExceptionHandler         ErrorResponse     lt  sonar coverage exclusions gt

User · Answer

For me this worked  basically pom xml level global properties    lt properties gt       lt sonar exclusions gt    Name  java lt  sonar exclusions gt   lt  properties gt   According to  http   docs sonarqube org display SONAR Narrowing the Focus NarrowingtheFocus-Patterns  It appears you can either end it with  quot  java quot  or possibly  quot   quot  to get the java classes you re interested in

User · Answer

I had to struggle for a little bit but I found a solution  I added -Dsonar coverage exclusions          and the coverage metric was cancelled from the dashboard at all  so I realized that the problem was the path I was passing  not the property  In my case the path to exclude was java org acme exceptions  so I used    -Dsonar coverage exclusions    exceptions           and it worked  but since I don t have sub-folders it also works with -Dsonar coverage exclusions    exceptions

User · Answer

I think you  re looking for the solution described in this answer Exclude methods from code coverage with Cobertura Keep in mind that if you re using Sonar 3 2 you have specify that your coverage tool is cobertura and not jacoco   default    which doesn t support this kind of feature yet

[java] How to make Sonar ignore some classes for codeCoverage metric?

Examples related to java

Examples related to maven

Examples related to sonarqube