SonarQube MSBuild fails to exclude files

Question

I am running an analysis using msbuild on debian, using the following command:

 mono /msbuild/SonarQube.Scanner.MSBuild.exe begin /d:sonar.login=<sonarqubetoken> /d:sonar.host.url=https://<my-server> /d:sonar.exclusions=test/**/* /k:<my-project-key>

However in the end command:

INFO: Index files
INFO: Excluded sources: 
INFO:   test/**/*
INFO: 17 files indexed
INFO: 0 files ignored because of inclusion/exclusion patterns
INFO: Quality profile for cs: Sonar way
INFO: Excluded sources for coverage: 
INFO:   test/**

and the analysis on the UI of my server includes files from test/ folder.

Why does it fail to ignore the specific files?

Using SonarQube 6.7 and sonar-scanner:3.3

LGTM. It's definitely `test/` in the root and not `tests/` or `[space]test/`? — ta.speot.is, Feb 08 '18 at 12:33
the paths and the cases are correct ... no idea what's happening — pkaramol, Feb 08 '18 at 13:39

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

1

Exclusions are difficult to set correctly from the analysis side, as demonstrated by your attempt. Your best bet is to set these from the UI.

answered Feb 08 '18 at 12:34

G. Ann - SonarSource Team

22,346
4
40
76

this is not very automatable or scalable. I would not consider this a solution for real companies with a large software footprint – red888 Feb 28 '20 at 22:33

score 0 · Accepted Answer · answered Feb 08 '18 at 14:25

0

The only way I have managed to get around this situation is by adding the following line to the .csproj file of the projects I want excluded

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

answered Feb 08 '18 at 14:25

pkaramol

16,451
43
149
324

This did not work for me. SonarQube still processed the project. – Ed Bayiates Apr 03 '19 at 19:30

score 0 · Answer 3 · answered Feb 09 '18 at 12:27

I had the same problem with after I upgraded to SonarQube Scanner for MSBuild 4.0.2

As pkaramol stated and by looking at the docs [1,2] this seems to be the only solution because sonar.exclusions matches only files in each project folder and not the solution folder. I wrote a python (>= 3.5) script for my CI which adds those lines to projects I want to be excluded.

import os
import glob
import shutil

SOURCEDIR_PATH = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

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

def add_sq_exclude_tag(project_name):
    search_path = os.path.join(SOURCEDIR_PATH, '**', '{}.csproj'.format(project_name))
    for file_path in glob.iglob(search_path, recursive=True):
        with open(file_path, 'r', encoding='utf8') as outfile:
            lines = outfile.readlines()
            project_end_tag = lines[-1]
            lines[-1] = SQ_EXCLUDE_TAG
            lines.append(project_end_tag)
        with open(file_path, 'w', encoding='utf8') as outfile:
            outfile.writelines(lines)
        print('Added sonarqube exclude tag to {}'.format(file_path))


if __name__ == '__main__':
    add_sq_exclude_tag('*csprojFileConatainsThisString*')
    add_sq_exclude_tag('exactCsprojFileNameWithoutFileEnding')

SonarQube MSBuild fails to exclude files

3 Answers3

Linked