Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 100 Next »

Table of Contents

Below:

  • "Project" means one project of a solution defined by a ".csproj" file.
  • "Assembly" means a compiled project of a solution (dll or executable).

Requirements

Your .NET solution must be compiled if you want to use the following plugins:

  • FxCop
  • Gendarme
  • Gallio
  • NDeps

If your solution is not compiled (or if you do not want to use some of the external tools for your analysis), you can deactivate them:

Running an Analysis with the SonarQube Runner

  1. Compile your solution. SonarQube's primary goal is to analyze source code, so everything has been made to work seamlessly after the compilation of a solution. In other words, if you have a build process that moves the assemblies and package your application, it is definitely best to run SonarQube before (or in a separate process).

  2. Create a sonar-project.propeties file and place it in the same folder as the solution file (.sln):

    sonar-project.properties



  3. Run the following command from the directory containing the sonar-project.properties file (= the directory containing the solution):



A sample project is available on GitHub that can be browsed or downloaded: /projects/languages/csharp.

Path Patterns

Always use "/" instead of "\" (even if it looks weird on a Windows box).

When noted as so, Ant style wildcard patterns can be used. * means any files or any directories. ** means any directories and subdirectories:

 

In some advanced use cases (which should not occur too often if you follow our best practices), the following placeholders can be used in path patterns:

ExpressionDescription
$(SolutionDir)Root directory of the solution, this is the directory where the ".sln" file is located.
$(ProjectName)Name of the currently analyzed project of the solution.
$(AssemblyName)Name of the assembly generated by the currently analyzed solution. Works only for non-ASP projects.
$(AssemblyVersion)Version of the assembly generated by the currently analyzed solution.
$(OutputType)Type of the assembly. Can be "dll" or "exe".
$(RootNamespace)Root namespace of the currently analyzed project.

For example:

Avoid too much complex configuration of paths

Icon

If you start using absolute paths or placeholders in path patterns, this means that your configuration becomes more complex and you are likely to face issues sooner or later. Everything has been done to make sure you need to write as few configuration lines as possible.

 

Advanced Usage

Setting the .NET SDK to use

To set the default version of the .NET SDK to be used, log in as a System administrator and go to Settings > Configuration > General Settings > .NET and set the sonar.dotnet.version property. Note that you can override this default value in your analysis configuration file.

The same parametrization is available for the Silverlight Framework: sonar.silverlight.version property.

Setting exclusions

By default, the generated code is excluded from the analysis (Reference.cs or *.designer.cs files): sonar.dotnet.excludeGeneratedCode is set to true.

To exclude projects, use the sonar.skippedModules property. It is a comma-separated list of project names. The names that must be used are the identifiers in the solution file: first string right after the equals sign on a project definition. 

To exclude files, see Project Administration.

On some specific resources, you can also prevent issues to be raised against a set of coding rules: see the Switch Off Violations plugin.

Detecting issues with external tools

See FxCop, Gendarme and StyleCop.

Unit tests, integration tests and code coverage

See Unit Tests, Integration Tests and Code Coverage.

Architecture check

See NDeps plugin.

FAQ

Analysis succeeds but too few issues are found

Some tools like FxCop or Gendarme require assemblies. Having too few issues most often comes from the following reasons:

  • The solution has not been compiled prior to the SonarQube analysis
  • The solution has been compiled but the corresponding assemblies have been moved somewhere else (because of a specific build process) and SonarQube cannot find them
  • The solution has been compiled and the assemblies have not been moved, but the whole solution folder has been moved to another location (and therefore the debug PDB files no longer point to the original source locations)

I cannot place the analysis configuration file in the directory containing my solution

Before following this workaround, make sure that you've got strong reasons not to put the analysis configuration file into the folder containing the solution. Note that this workaround may lead to further tricky configuration and issues.

SonarQube cannot retrieve the assemblies

The configuration defined to build the solution will be used to locate the assemblies during the SonarQube analysis. Two properties are taken into account:

  • sonar.dotnet.buildConfiguration property (default value is Debug)
  • sonar.dotnet.buildPlatform property (default value is AnyCPU)

Let's take the folowing example:

".csproj" file

If you use the default configuration (Debug|AnyCPU), SonarQube will try to retrieve the assembly of this project in <project_directory>/bin/Debug.

If you set the properties to:

SonarQube will try to retrieve the assembly of this project in <project_directory>/bin/Release.

Depending on when you run SonarQube in your continuous integration process, it is very important to properly set those properties. A proper configuration will allow SonarQube to automatically retrieve the assemblies and smoothly perform the analysis. It is highly recommend to run SonarQube right after the compilation phase.

Indeed, if you run SonarQube after the packaging phase that moves for example all the assemblies into a single directory, you will face over-complicated configuration. You will have to tell SonarQube, for each project, where to find its assembly. To do so, set the sonar.dotnet.assemblies property. It is a path pattern that will be used to find the assembly of the analyzed project. Path pattern can be absolute or relative to the directory containing the ".csproj" file.

SonarQube C# parser known limitations

How can I integrate SonarQube in my existing TFS Build environment processes?

Most people want to add SonarQube as an additional step in existing processes, which usually brings a lot of troubles because those processes manipulate assemblies - whereas the SonarQube C# plugins rely best on information found in the source files (mostly "csproj" files).

Generally speaking, it's best / easier to set up a separate "continuous inspection" process that just:

  1. Compiles the solution
  2. Runs a SonarQube analysis

in order to keep the SonarQube-related configuration as simple as possible.

You can read this thread to see how this has been achieved by C# plugin users.

Why do I get MSBuild error such as "error MSB4126: The specified solution configuration "Debug|HPD" is invalid"?

You are using a 64-bit windows OS. There is an environment variable "Platform=HPD" that makes msbuild fail. Try to run:

On Windows 7 I get "The Silverlight 3/4 SDK is not installed" error message

64-bit msbuild cannot be used with Silverlight. Check that you are not using a 64-bit msbuild by taking a look at dotnet.3.5.sdk.directory properties. "Framework64" should not be present in the path.

The analysis fails with an OutOfMemory exception

The Java process performing the analysis might need more memory. Use the "-Xmx" option to specify the amount of memory that can be used. See the SonarQube Runner documentation for more details

  • No labels