Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titleWarning

This page documents versions 2.1 and below of the C# plugin. For newer versions, consult this page.

If you reached this page from a link, please send a note to dev@sonar.codehaus.org (you'll have to join first.)

If you reached this page from a bookmark, please update it.

Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel1

...

There are two different ways to feed the SonarQube platform with information on unit tests test execution and code coverage:

  1. Letting Let the SonarQube platform drive the execution of the unit tests and the code coverage tool
  2. Reusing Reuse reports that have been generated by external tools prior to the SonarQube analysis

These two Both ways use are handled by Gallio. So , so you first have to install itGallio on the machine(s) running the SonarQube analysis. You also have to install the code coverage tool of your choice that will be driven by Gallio. Supported tools are dotCover, NCover, OpenCover and PartCover.

...

Log in as a System administrator and go to Settings > Configuration > General Settings > .NET Gallio.

  • Set the path to the Gallio installation directory through the sonar.gallio.installDirectory property.
  • Define which tool to use to compute the code coverage through the sonar.gallio.coverage.tool property. Then , set the installation directory of this code coverage tool through the sonar.dotcover.installDirectory or sonar.opencover.installDirectory or sonar.partcover.installDirectory property. Note that there is not such a property for NCover as because the installation path location of NCover is automatically discovered by Gallio.

...

This is the default mode.

The first and unique step is to tell SonarQube which projects are unit test projects. To do so, set the sonar.donetdotnet.visualstudio.testProjectPattern property.

Code Block
languagebash
# Semicolon-separated list of patterns to identify unit test projects
# Default value is *.Tests
sonar.donetdotnet.visualstudio.testProjectPattern=*.Tests;*.UnitTests

Then, you just have to run a SonarQube analysis and you'll get data on unit tests and code coverage. Indeed, the The paths to the unit test assemblies are automatically retrieved from the Visual Studio ".csproj" files. And , and the execution of unit tests and the driving of the coverage tool is automatically performed by Gallio.

...

Code Block
languagenone
sonar.gallio.mode=reuseReport

Then , you just need to provide SonarQube with the following reports: unit tests configure the paths to the unit test execution and code coverage reports.

Code Block
languagebash
# Paths are relative to the Solution base directory

# Path to the unit tests execution report
sonar.gallio.reports.path=reports/gallio-report.xml

# Path to the code coverage report
sonar.gallio.coverage.reports.path=reports/coverage-report.xml

 

The following command lines are launched while letting the SonarQube platform drive reuseReport mode has been tested with the output of the following commands, which are the ones used when the SonarQube platform drives the execution of the unit tests and the code coverage tool. The reuseReport mode has been tested with those command lines. That's why, it It is highly recommend to that you generate your reports by running using similar command lines:

Code Block
languagehtml/xml
# Based on the following solution sample: https://github.com/SonarCommunity/sonar-dotnet/tree/master/sonar/dotnet/sonar-dotnet-plugin/src/test/resources/solution/Example

# dotCover
C:\Program Files\JetBrains\dotCover\v2.2\Bin\dotCover.exe a /TargetExecutable=C:\Program Files\Gallio\bin\Gallio.Echo.exe /TargetWorkingDir=C:\Example\target\sonar "/TargetArguments=\"/r:Local\" \"/report-directory:C:\Example\target\sonar\" \"/report-name-format:gallio-report\" \"/report-type:Xml\" \"C:\Example\Example.Core.Tests\bin\Debug\Example.Core.Tests.dll\"" /Filters=+:module=Example.Application;class=*;function=*;+:module=Example.Core;class=*;function=*; /ReportType=TeamCityXML /Output=C:\Example\target\sonar\coverage-report.xml

# NCover
C:\Program Files\Gallio\bin\Gallio.Echo.exe /r:NCover3 /report-directory:C:\Example\target\sonar /report-name-format:gallio-report /report-type:Xml C:\Example\Example.Core.Tests\bin\Debug\Example.Core.Tests.dll /runner-property:NCoverCoverageFile=C:\Example\target\sonar\coverage-report.xml /runner-property:NCoverArguments=//ias Example.Application;Example.Core

# OpenCover
C:\Program Files\OpenCover\OpenCover.Console.exe -register:user -target:C:\Program Files\Gallio\bin\Gallio.Echo.exe -targetdir:C:\Example\target\sonar "-targetargs:\"/r:IsolatedAppDomain\" \"/report-directory:C:\Example\target\sonar\" \"/report-name-format:gallio-report\" \"/report-type:Xml\" \"C:\Example\Example.Core.Tests\bin\Debug\Example.Core.Tests.dll\"" "-filter:+[Example.Application]* +[Example.Core]* " -mergebyhash -output:C:\Example\target\sonar\coverage-report.xml

# PartCover
C:\Program Files\PartCover\PartCover .NET 4.0\PartCover.exe --target C:\Program Files\Gallio\bin\Gallio.Echo.exe --target-work-dir C:\Example\target\sonar --target-args \"/r:IsolatedAppDomain\" \"/report-directory:C:\Example\target\sonar\" \"/report-name-format:gallio-report\" \"/report-type:Xml\" \"C:\Example\Example.Core.Tests\bin\Debug\Example.Core.Tests.dll\" --include [Example.Application]* --include [Example.Core]* --output C:\Example\target\sonar\coverage-report.xml

...

Integration Tests and Code Coverage

As Because the principles are very similar to the those for unit tests. , please read the Unit Tests and Code Coveragebefore.

Letting the SonarQube platform drive the execution of the unit tests and the code coverage tool

...

Code Block
languagenone
sonar.gallio.it.mode=active

The first and unique step is to tell SonarQube which projects are integration test projects. To do so, set the sonar.donetdotnet.visualstudio.itProjectPattern property.

Code Block
languagebash
# Semicolon-separated list of patterns to identify integration test projects
sonar.donetdotnet.visualstudio.itProjectPattern=*.Integration.Tests;*.IntegrationTests

Then , you you just have to run a SonarQube analysis and you'll get data on integration tests and code coverage. Indeed, the The paths to the integration test assemblies are automatically retrieved from the Visual Studio ".csproj" files. And , and the execution of integration tests and the driving of the coverage tool is automatically performed by Gallio.

...

Code Block
languagenone
sonar.gallio.it.mode=reuseReport

Then , you just need to provide SonarQube with the following reports: configure the paths to the integration tests execution report and the code coverage report.

Code Block
languagebash
# Paths are relative to the Solution base directory

# Path to the integration tests execution report
sonar.gallio.it.reports.path=reports/it-gallio-report.xml

# Path to the code coverage report
sonar.gallio.it.coverage.reports.path=reports/it-coverage-report.xml

Due to SONAR-4101, as execution data for integration tests are not currently stored as such. Thus, the C# plugin merged those merges integration test data with unit test onesdata.

Deactivating Integration Tests and Code Coverage

...

This might happen if you have generated the reports then moved the files of your solution. Indeed, in 's files. In the XML coverage files, the paths to the C# source files must be the same as the paths specified in the ".csproj" files, otherwise the coverage data are simply not taken into account.

When using OpenCover with Gallio, I get 0% code coverage

...

, but I do have test classes that are covered by tests

Most probably, you should use the following property to run the tests in an isolated process:

...

This error happens when one of the dotnet config files (app.config, web.config, ...) of in your Visual Studio solution specifies a runtime version not supported by the instance of Gallio. This is often the case when the following XML fragment appears in an app.config file:

...

The "sku" attribute is not something understandable by Gallio understands. .. If you remove replace the above XML fragment by with the one below, the issue is solved:

Code Block
<startup>
    <supportedRuntime version="v4.0.30319"/>
</startup>

...

The NCover Complete Edition allows you to run tests from multiple projects and merge the coverage data, the NCover Classic Edition does not.

...

Set the sonar.gallio.timeoutMinutes property (default value is 30).

How can I run Gallio and PartCover on

...

64-bit Windows?

Gallio and PartCover work perfectly out-of-the-box on x86 Windows, but not on 64-bit versions. To make them work:

...

If in the logs you get something such aslike:

Code Block
[INFO] [23:30:05.643] A fatal exception occurred while running tests.  Possible causes include invalid test runner parameters and stack overflows.
[INFO] [23:30:05.727]   Gallio.Model.ModelException: An exception occurred while invoking a test driver. ---> Gallio.Model.ModelException: Gallio.Model.ModelException: Could not load test assembly from 'C:\whatever\MyTestAssembly.Test.dll'. ---> System.BadImageFormatException: Could not load file...

that it might be because some of your assemblies have been compiled with a x86 profile (32 bits-bit) while Gallio is configured to run in an "Any CPU" mode, hence 64bits 64-bit on your system.
This problem might be solved using corflags tool to force Gallio to run in a 32 bits -bit mode as shown below:

Code Block
corFlags.exe Gallio.Echo.exe /32BIT+ /Force

...

The problem might be solved if you modify your installation of Gallio. Add the following XML fragment in files Gallio.Host.x86.exe.config and/or Gallio.Host.x64.exe.config:

Code Block
<startup useLegacyV2RuntimeActivationPolicy="true">
    <supportedRuntime version="v4.0"/>
</startup>