In version 5.0, we changed the name of the SonarScanner for MSBuild to SonarScanner for .NET.
The documentation is updated with the new name and we will call the scanner SonarScanner for .NET moving forward.
The SonarScanner for .NET is the recommended way to launch an analysis for projects built using MSBuild
or dotnet
. It is the result of acollaboration between SonarSource and Microsoft.
SonarScanner for .NET is distributed as a standalone command line executable, as an extension forAzure DevOps Server, and as a plugin forJenkins.
It supports .NET Core on every platform (Windows, macOS, Linux).
Prerequisites
- At least the minimal version of Java supported by your SonarQube server
- Java 17 is required to run this version of the scanner. If you are running a previous version of Java, you will need a previous version of the scanner.
- The SDK corresponding to your build system:
- If you are using the .NET Framework version of the scanner you will need.NET Framework v4.6.2 or above. For commercial versions of SonarQube to benefit from security analysis you will need.NET Framework v4.7.2 or above
- If you are using the .NET version of the scanner or the.NET Core Global Toolyou will need.NET Core SDK 3.1 or above
- The minimum supported version for SonarQube is now 8.9.
- The scanner will fail to start if an older version of SonarQube is detected.
The flavor used to compile the Scanner for .NET (either .NET Framework, .NET Core or .NET) is independent of the .NET version the project you want to analyze has been built with. Concretely, you can analyze .NET Core code with the .NET Framework version of the Scanner. It's only relevant depending on your OS, and on the versions of .NET SDKs that are installed on your build machine.
Installation
Standalone executable
- Expand the downloaded file into the directory of your choice. We'll refer to it as
<INSTALL_DIRECTORY>
in the next steps.- On Windows, you might need to unblock the ZIP file first (right-clickfile > Properties > Unblock).
- On Linux/OSX you may need to set execute permissions on the files in
<INSTALL_DIRECTORY>/sonar-scanner-(version)/bin
.
- Uncomment, and update the global settings to point to your SonarQube server by editing
<INSTALL_DIRECTORY>/SonarQube.Analysis.xml
. Values set in this file will be applied to all analyses of all projects unless overwritten locally.
Consider setting file system permissions to restrict access to this file.
<SonarQubeAnalysisProperties xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.sonarsource.com/msbuild/integration/2015/1"> <Property Name="sonar.host.url">http://localhost:9000</Property> <Property Name="sonar.login">[my-user-token]</Property></SonarQubeAnalysisProperties>
- Add
<INSTALL_DIRECTORY>
to yourPATH
environment variable.
.NET Core global tool
dotnet tool install --global dotnet-sonarscanner --version x.x.x
The--version
argument is optional. If it is omitted the latest version will be installed. The full list of releases is available on theNuGet page.
.NET Core Global Tool is available from .NET Core 3.1+.
On Linux/OSX, if your SonarQube server is secured
- Copy the server's CA certs to
/usr/local/share/ca-certificates
- Run
sudo update-ca-certificates
Use
You can invoke the Scanner using arguments with both dash (-
) or forward-slash (/
) separators. Either of the following will work:
SonarScanner.MSBuild.exe begin /k:"project-key"
SonarScanner.MSBuild.exe begin -k:"project-key"
There are two versions of the SonarScanner for .NET. In the following commands, you need to pass anauthentication tokenusing thesonar.login
property. Any project file accepted by MSBuild.exe or dotnet can be used, for example.sln
,.proj
,.csproj
, or.vbproj
.
"Classic" .NET framework invocation
The first version is based on the "classic" .NET Framework. To use it, execute the following commands from the root folder of your project:
SonarScanner.MSBuild.exe begin /k:"project-key" /d:sonar.login="myAuthenticationToken"MSBuild.exe <path to project file or .sln file> /t:RebuildSonarScanner.MSBuild.exe end /d:sonar.login="myAuthenticationToken"
Note: On macOS or Linux, you can also usemono <path to SonarScanner.MSBuild.exe>
.
.NET Core and .NET Core global tool invocation
The second version is based on .NET Core which has a very similar usage:
dotnet <path to SonarScanner.MSBuild.dll> begin /k:"project-key" /d:sonar.login="<token>"dotnet build <path to project file or .sln file>dotnet <path to SonarScanner.MSBuild.dll> end /d:sonar.login="<token>"
The .NET Core version can also be used as a .NET Core Global Tool. After installing the Scanner as a global tool as described above it can be invoked as follows:
dotnet tool install --global dotnet-sonarscannerdotnet sonarscanner begin /k:"project-key" /d:sonar.login="<token>"dotnet build <path to project file or .sln file>dotnet sonarscanner end /d:sonar.login="<token>"
Scanner Flavor | Invocation |
---|---|
.NET Core Global Tool | dotnet sonarscanner begin etc. |
.NET Core 3.1+ | dotnet <path to SonarScanner.MSBuild.dll> etc. |
.NET Framework 4.6.2+ | SonarScanner.MSBuild.exe begin etc. |
Notes:
- The .NET Core version of the scanner does not support TFS XAML builds and automatic finding/conversion of Code Coverage files. Apart from that, all versions of the Scanner have the same capabilities and command line arguments.
Analysis steps
Begin
The begin step is executed when you add thebegin
command line argument. It hooks into the build pipeline, downloads SonarQube quality profiles and settings, and prepares your project for analysis.
Command Line Parameters:
Parameter | Description |
---|---|
/k:<project-key> | [required] Specifies the key of the analyzed project in SonarQube |
/n:<project name> | [optional] Specifies the name of the analyzed project in SonarQube. Adding this argument will overwrite the project name in SonarQube if it already exists. |
/v:<version> | [recommended] Specifies the version of your project. |
/d:sonar.login=<token> | [recommended] Specifies theauthentication tokenused to authenticate with to SonarQube. If this argument is added to the begin step, it must also be added to the end step. |
/d:sonar.clientcert.path=<ClientCertificatePath> | [optional] Specifies the path to a client certificate used to access SonarQube. The certificate must be password protected. |
/d:sonar.clientcert.password=<ClientCertificatePassword> | [optional] Specifies the password for the client certificate used to access SonarQube. Required if a client certificate is used. |
/d:sonar.verbose=true | [optional] Sets the logging verbosity to detailed. Add this argument before sending logs for troubleshooting. |
/d:sonar.dotnet.excludeTestProjects=true | [optional] Excludes Test Projects from analysis. Add this argument to improve build performance when issues should not be detected in Test Projects. |
/d:<analysis-parameter>=<value> | [optional] Specifies an additional SonarQubeanalysis parameter, you can add this argument multiple times. |
/s:<custom.analysis.xml> | [optional] Overrides the$install_directory/SonarQube.Analysis.xml . You need to give the absolute path to the file. |
For detailed information about all available parameters, seeanalysis parameters.
The "begin" step will modify your build like this:
- the active
CodeAnalysisRuleSet
will be updated to match the SonarQube quality profile WarningsAsErrors
will be turned off
If your build process cannot tolerate these changes we recommend creating a second build job for SonarQube analysis.
Build
Between thebegin
andend
steps, you need to build your project, execute tests and generate code coverage data. This part is specific to your needs and it is not detailed here. See.NET test coveragefor details.
End
The end step is executed when you add the "end" command line argument. It cleans the MSBuild/dotnet build hooks, collects the analysis data generated by the build, the test results, the code coverage and then uploads everything to SonarQube
There are only two additional arguments that are allowed for the end step:
Parameter | Description |
---|---|
/d:sonar.login=<token> | This argument is required if it was added to the begin step. |
/d:sonar.clientcert.password=<ClientCertificatePassword> | This argument is required if it was added to the begin step. Specifies the password for the client certificate used to access SonarQube. |
Known limitations
- MSBuild versions older than 15 are not supported.
- Web Application projects are supported. Legacy Web Site projects are not.
- Projects targeting multiple frameworks and using preprocessor directives could have slightly inaccurate metrics (lines of code, complexity, etc.) because the metrics are calculated only from the first of the built targets.
Code coverage
See.NET test coveragefor details.
Excluding projects from analysis
Some project types, such asMicrosoft Fakes, are automatically excluded from analysis. To manually exclude a different type of project from the analysis, place the following in its .xxproj file.
<!-- in .csproj –-><PropertyGroup> <!-- Exclude the project from analysis --> <SonarQubeExclude>true</SonarQubeExclude></PropertyGroup>
Advanced topics
Analyzing MSBuild 12, 14, and 15 projects with MSBuild 16
The Sonar Scanner for .NET requires your project to be built with MSBuild 14.0. We recommend installing Visual Studio 2017 or later on the analysis machine in order to benefit from the integration and features provided with the Visual Studio ecosystem (VSTest, MSTest unit tests, etc.).
Projects targeting older versions of the .NET Framework can be built using MSBuild 16 by setting the "TargetFrameworkVersion" MSBuild property as documented by Microsoft:
For example, if you want to build a .NET 3.5 project, but you are using a newer MSBuild version:
MSBuild.exe /t:Rebuild /p:TargetFramework=net35
If you do not want to switch your production build to MSBuild 16, you can set up a separate build dedicated to the SonarQube analysis.
Detection of test projects
You can read a full description of that subject on our wikihere.
Per-project analysis parametersSome analysis parameters can be set for a single MSBuild project by adding them to its .csproj file.
<!-- in .csproj --><ItemGroup> <SonarQubeSetting Include="sonar.stylecop.projectFilePath"> <Value>$(MSBuildProjectFullPath)</Value> </SonarQubeSetting></ItemGroup>
Analyzing languages other than C# and VB
For newer SDK-style projects (used by .NET Core, .NET 5, and later), the SonarScanner for .NET will analyze all file types that are supported by the available language plugins unless explicitly excluded.
For older-style projects, the scanner will only analyze files that are listed in the.csproj
or.vbproj
project file. Normally this means that only C# and VB files will be analyzed. To enable the analysis of other types of files, include them in the project file.
More specifically, any files included by an element of one of theItemTypes
inthis listwill be analyzed automatically. For example, the following line in your.csproj
or.vbproj
file
<Content Include="foo\bar\*.js" />
will enable the analysis of all JS files in the directoryfoo\bar
becauseContent
is one of theItemTypes
whose includes are automatically analyzed.
You can also addItemTypes
to the default list by following these directions.
You can check which files the scanner will analyze by looking in the file .sonarqube\out\sonar-project.properties after MSBuild has finished.
Using SonarScanner for .NET with a proxy
On build machines that connect to the Internet through a proxy server you might experience difficulties connecting to SonarQube. To instruct the Java VM to use the system proxy settings, you need to set the following environment variable before running the SonarScanner for .NET:
SONAR_SCANNER_OPTS = "-Djava.net.useSystemProxies=true"
To instruct the Java VM to use specific proxy settings or when there is no system-wide configuration use the following value:
SONAR_SCANNER_OPTS = "-Dhttp.proxyHost=yourProxyHost -Dhttp.proxyPort=yourProxyPort"
WhereyourProxyHostandyourProxyPortare the hostname and the port of your proxy server. There are additional proxy settings for HTTPS, authentication and exclusions that could be passed to the Java VM. For more information see the following article:https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html.
You also need to set the appropriate proxy environment variables used by .NET.HTTP_PROXY
,HTTPS_PROXY
,ALL_PROXY
, andNO_PROXY
are all supported. You can find more detailshere.
Known issues
I have multiple builds in the same pipeline, each of them getting analyzed even if the Run Code Analysis has already been executed
We don't uninstall the globalImportBefore
targets to support concurrent analyses on the same machine. The main effect is that if you build a solution where a .sonarqube folder is located nearby, then the sonar-dotnet analyzer will be executed along your build task.
To avoid that, you can disable the targets file by adding a build parameter:
msbuild /p:SonarQubeTargetsImported=truedotnet build -p:SonarQubeTargetsImported=true