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 2 Next »

Table of Contents

Unit Tests and Code Coverage

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

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

Those two ways are handled by Gallio. So you first have to install it 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.

Configuring Gallio

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 the installation path of NCover is automatically discovered by Gallio.

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

This is the default mode.

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

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

Reusing existing reports

To activate this mode, add the following line to your project configuration file:

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

Deactivating Unit Tests and Code Coverage

Add the following line to your project configuration file:

Integration Tests and Code Coverage

As the principles are very similar to the unit tests. please read the Unit Tests and Code Coverage before.

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

To activate this mode, add the following line to your project configuration file:

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

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

Reusing existing reports

To activate this mode, add the following line to your project configuration file:

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

Deactivating Integration Tests and Code Coverage

This is the default mode.

FAQ

My unit tests and integration tests are defined within the same assemblies, how can I run my unit tests only?

Define the sonar.gallio.filter property (or the sonar.gallio.it.filter property for integration tests):

How can I exclude some specific assemblies and/or namespaces from code coverage computation?

Define the sonar.gallio.coverage.excludes property. Note that this property is shared between unit and integration tests.

SonarQube cannot retrieve the compiled unit test assemblies

If for some reasons, compiled unit test assemblies are moved after the build (no longer available in directories defined in "csproj" files), you can tell SonarQube where to find them thanks to the sonar.dotnet.test.assemblies property (sonar.dotnet.it.assemblies property for integration tests):

How to define the Gallio runner type?

Set the sonar.gallio.runner property. As describe in the Gallio documentation, possible values are IsolatedAppDomain (PartCover default runner type), IsolatedProcess and Local.

Does not apply to NCover.

NCover, the analysis succeeded but only one test assembly is taken into account

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

The workaround is to activate the Gallio safe mode (sonar.gallio.safe.mode=true). Gallio will then be launched for each test assembly and the generated XML reports will be merged.

How to set Gallio's timeout?

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

How can I run Gallio and PartCover on a 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:

  1. Download the latest Gallio x64 installer and install it in a folder, but not under "Program Files".
  2. Download the latest PartCover installer and install it in a folder, but not under "Program Files".
  3. Run corflags.exe on Gallio and PartCover executables:

See http://www.planetgeek.ch/2009/10/15/get-partcover-running-on-x64-windows/

  • No labels