How to make Sonarqube exclude a .NET (C#) project from coverage measures

Question

Sonarqube allows for individual files to be excluded from code coverage by adding patterns in the sonar.coverage.exclusions key. This can be done on a project level by adding them in the UI and even in a .csproj file by specifying a SonarQubeSetting element. I.e.

<SonarQubeSetting Include="sonar.coverage.exclusions"> <Value>**/*.cs</Value> </SonarQubeSetting>

However, both of these approaches don't seem to work. Playing with the patterns, as specified in the SonarQube documentation doesn't provide the desired result. I'm also aware of the existence of the SonarQubeExclude MSBuild property, but I don't want to go down that path as it would exclude my project from all other analysis.

Is there another possibility that I'm missing? Or is it simply not possible to exclude all of the classes within a project from code coverage?

Did you try to pass arguments in command line like this: `SonarQube.Scanner.MSBuild.exe" begin /d:sonar.coverage.exclusions=**\MyLib1\MyPath1*,**\MyLib2\MyPath2*` Works like a charm in my case. — Peska, Mar 23 '18 at 10:09
@Peska What version of SonarQube/MSBuild scanner are you running? In my case this isn't working as desired. — mvandevy, Mar 28 '18 at 13:34
SonarQube Version 6.7.1.35068. SonarScanner MSBuild 4.0.2.892. Here is a whole sample: `"C:\PathToSonarQubeScanner\SonarQube.Scanner.MSBuild.exe" begin /k:"ProjectKey" /n:"ProjectName" /v:"1.0.0" /d:sonar.coverage.exclusions=**\PathToExclude\**,**\PathToExlude2\**` `"C:\PathToMSBuild\MSBuild.exe" SolutionFile.sln /t:Rebuild` `"C:\PathToSonarQubeScanner\SonarQube.Scanner.MSBuild.exe" end` — Peska, Mar 29 '18 at 06:12

Naveen R Kumar · Answer 1 · 2019-09-17T11:03:50.427

Summing up the above mentioned answers and also adding one point to it.

To exclude a project from SonarQube Analysis from csproj we can achieve by adding the below code in .csproj of that project
```
<PropertyGroup>

<SonarQubeExclude>true</SonarQubeExclude>
</PropertyGroup>
```

To exclude a file from a project

 <ItemGroup>
 <SonarQubeSetting Include="sonar.coverage.exclusions">
 <Value>**/FileName.cs</Value>
 </SonarQubeSetting>
 </ItemGroup>

And for multiple files

<ItemGroup>
<SonarQubeSetting Include="sonar.coverage.exclusions">
<Value>**/FileName1.cs, **/FileName2.cs</Value>
</SonarQubeSetting>
</ItemGroup>

Also can refer this for regex patterns used

Jonas Mohammed · Answer 2 · 2019-05-24T14:13:14.993

12

Not enough rep to comment, but if you apply both answers here, you can simply add:

<PropertyGroup>
    <!-- Exclude the project from analysis -->
    <SonarQubeExclude>true</SonarQubeExclude>
</PropertyGroup>

in the .csproj file to exclude the entire project instead of individual files, or relying on sonarqube filters.

edited May 24 '19 at 14:13

answered May 24 '19 at 14:01

Jonas Mohammed

377
4
14

vernou · Answer 3 · 2021-02-26T08:44:51.380

Some notion :

A .NET solution is SonarQube's project. A .NET solutions's project is SonarQube's project's module.

The specific SonarQube MsBuild analyser will find all csproj/vbproj. For each .NET project, the analyser apply the SonarQube's project settings.

If you repository is :

MyApp.sln
MyApp.Shell\
    MyApp.Shell.csproj
    Windows\MainWindows.cs
MyApp.Core\
    MyApp.Core.csproj
    FooService.cs

To ignore the code coverage on MyApp.Shell project, you will intuitively add the setting sonar.coverage.exclusions=MyApp.Shell\*. But the MsBuild analyser analyse each .NET project separately and the root directely is at csproj/vbproj directory. When MyApp.Shell.csproj is analysed, the ignore patern MyApp.Shell\* is apply on Windows\MainWindows.cs.

To exclure a specific project from code coverage, we need to apply this setting al SonarQube's module (.NET project) level. I find two solutions to do that.

1) Add the property "sonar.coverage.exclusions" in csproj

In your <.NET project>.csproj, add :

<Project ...>
  ...
    <ItemGroup>
      <SonarQubeSetting Include="sonar.coverage.exclusions">
        <Value>**</Value>
      </SonarQubeSetting>
    </ItemGroup>
  ...
</Project>

2) Configure exclusion from Web UI Sonarqube

From update to SonarQube 8.*, I can't retrieve the option in IHM.

From : SonarQube MSBuild Scanner doesn't exclude files from analysis

Open Sonarqube's project -> Code (in top menu)
Open Sonarqube's module (left icon 'Open Component's Page) -> Administration (in top menu) -> General Settings
Add ** in Codecoverage exclusion :

(Screenshot in French, but you get the idea)

This two solutions work for me, but I would prefer a global setting for Sonarqube's project (.NET Solution).

@FrankyHollywood, I worked with a old SonarQube version 6.*, after a update to 8.* I also need remove the target part. I edited my answer. — vernou, Feb 26 '21 at 08:24

André Mendonça · Answer 4 · 2019-05-16T16:15:20.733

5

After trying a thousand things I finally found the solution. It's necessary to add an item group in the .csproj.

<ItemGroup>
    <Compile Update="ClassToExclude.cs">
      <!-- Exclude the file from analysis -->
      <SonarQubeExclude>true</SonarQubeExclude>
    </Compile>
  </ItemGroup>

edited May 16 '19 at 16:15

answered May 15 '19 at 21:36

André Mendonça

658
8
13

worked for me in WebForms to exclude a file. Thanks – Pramesh Aug 23 '23 at 16:06

score 1 · Answer 5 · answered Feb 08 '18 at 14:34

I had the same problem, and it took me a while to figure it out:

Set up a Directory.Build.props file in the solution directory with this content:

<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">

  <!-- This target customises the SonarQube MSBuild runner targets to limit the projects that are analysed.

       Projects whose full path and file name match the specified filter will be marked as "excluded".

       Note that this targets file does not ever set $(SonarQubeExclude) to "false". This is to allow other
       targets to exclude projects for other reasons (e.g. a Fakes projects should always be excluded, regardless
       of whether or not they match the project filter).

       Also, this project will do nothing if $(SonarQubeExclude) has already been set.

       The regular expression uses the normal .NET regular expression syntax.

       Usage:
       (1) include the target in the projects being built, either by directly importing it or by
           dropping it in the one of the standard "ImportBefore" folders.

       (2) set $(SQExclusionFilter) to the desired regular expression
           e.g. the following example matches all projects with "CodeSense\Services" in the path:  .*\\CodeSense\\Services\\.*

  -->
  <PropertyGroup Condition=" $(SonarQubeExclude) == '' AND $(SQExclusionFilter) != '' ">

      <MatchesSQExclusionFilter Condition="$([System.Text.RegularExpressions.Regex]::IsMatch($(MSBuildProjectFullPath), $(SQExclusionFilter), System.Text.RegularExpressions.RegexOptions.IgnoreCase)) ">true</MatchesSQExclusionFilter>
      <SonarQubeExclude Condition="$(MatchesSQExclusionFilter) == 'true' " >true</SonarQubeExclude>

  </PropertyGroup>

  <!-- This target is not required: it simply writes out additional information to simplify debugging -->
  <Target Name="AnalysisProjectInfoExclude_DEBUG" BeforeTargets="CoreCompile"
          Condition="$(SQExclusionFilter) != '' ">

    <Message Importance="high" Text="ExclusionFilter: filter has been set.  Filter= $(SQExclusionFilter)" />
    <Message Importance="high" Text="ExclusionFilter: current project = $(MSBuildProjectFullPath)" />
    <Message Importance="high" Text="ExclusionFilter: match result = $(MatchesSQExclusionFilter)" />

    <Message Importance="high" Condition="$(MatchesSQExclusionFilter) == 'true' "
       Text="ExclusionFilter: project is excluded" />

    <Message Importance="high" Condition="$(MatchesSQExclusionFilter) != 'true' "
       Text="ExclusionFilter: project has not been excluded by the exclusion filter" />

  </Target>

</Project>

This fragment will be included in all project files as explained here https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-your-build

Set the regex in the environment variable SQExclusionFilter accordingly. Use double-backslashes for path separation. In windows shell escape pipe characters with a caret: e.g.

set SQExclusionFilter=(path1\\project)^|(path2\\project)

Credits to Duncan Pocklington from SQ/MS!

https://jira.sonarsource.com/browse/SONARMSBRU-191?focusedCommentId=155587&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-155587

I've looked at your solution, but I'm failing to see the relation between these MSBuild variables and SonarQube. Are these variable predefined within SonarQube? Could it also be that by this you are trying to exclude the whole project while I'm only looking to exclude the code coverage? — mvandevy, Feb 09 '18 at 08:28
@mvandevy, you are right, the solution exludes a project from all analyses. If the filter hits a project it adds an XML fragment true to the project and by that suppresses SonarQube for that project. — Reinhard Mayr, Feb 19 '18 at 12:10
It's pretty horrible that this complexity is needed simply to exclude a file from code coverage analysis in SonarQube. — Paul Siersma, Oct 24 '18 at 15:14

score 1 · Answer 6 · answered May 06 '20 at 03:15

This is an old question, but a more accurate answer is posted here: https://stackoverflow.com/a/49904805/987191

Essentially, the code tab allows drilling down to settings for a project and we can use ** in administration (for the project) -> General Settings -> Analysis Scope -> Coverage exclusions

How to make Sonarqube exclude a .NET (C#) project from coverage measures

6 Answers6

Linked