The C# Ecosystem is a Set of Plugins
The C# Ecosystem offers the following plugins:
- Mandatory plugins:
- Optional plugins adding features from external tools:
- .NET FxCop: launches FxCop analyses to detect violations relating to potential bugs, tight coupling, globalization, etc.
- .NET Gendarme: launches Gendarme analyses to detect violations relating to coding bad practices, smell detection, performance, etc
- .NET Gallio: launches Gallio to run tests and gets execution report as well as coverage report (using PartCover or OpenCover or NCover or ...).
- .NET NDeps: launches a dependency parser tool, built on Mono Cecil, to get dependency data between assemblies and classes.
- C# StyleCop: launches StyleCop analyses to detect violations mainly relating to coding style (formatting, comments, ...).
The C# Ecosystem has the following requirements on top of the Sonar ones:
- Your C# code base must be developed with Visual Studio, and thus must contain a ".sln" file (.NET Solution).
- If you want test metrics, unit tests must be isolated from the main code base in dedicated Visual Studio Projects. Also the test framework must be compatible with Gallio.
Supported versions are:
Up to 5.0
2.0, 3.5, 4.0 and 4.5
3, 4 and 5
Tested with VS 2008, VS 2010 and VS 2012 ".sln" files.
Older versions may also be supported (feel free to give feedback)
Installing the C# Ecosystem Plugins
- Install the .NET and C# plugins from the Update Center
- Prior to Sonar 3.5: you need to click on the "Install" button of all the 7 plugins
- Since Sonar 3.5: you just need to click on the "Install" button of the C# group, this will install everything including the .NET plugins
- Restart the Sonar server
Installing the External Tools
Depending on which plugins you chose to install, you may need to install the corresponding external tools. If you can, we advise you to install the same versions as the one we use for testing (i.e. the one in bold in the below table).
|Where to Install the External Tools|
This may sound obvious if you are already familiar with Sonar: Sonar analysis is not necessarily performed on the same machine as the one running your Sonar server. This means that you can run Sonar on a Linux box and run analyses on Windows boxes. The external tools have to be installed on the Windows boxes where analyses are performed.
Install required if plugin selected?
Web site / download / install guide
Supported versions (Tested one in bold)
NO, StyleCop 4.7 binaries are embedded in the plugin.
NO, Gendarme 2.10 binaries are embedded in the plugin.
3.1 Update 2 + (3.2.3)
YES if you want to use PartCover as the coverage engine.
2.2, 2.3 and 4.0 (4.0)
YES if you want to use NCover as the coverage engine
YES if you want to use OpenCover as the coverage engine.
1.0.X, 2.0.X, 4.0.X (4.0.1118)
|JetBrains dotCover||YES if you want to use dotCover as the coverage engine.||http://www.jetbrains.com/dotcover/||1.X, 2.X (1.2 & 2.0)|
|NDeps||NO, binaries are embedded in the plugin.||https://github.com/grozeille/DependencyParser|
- These external tools need the .Net framework to be installed. FxCop10 needs .Net 4 but the other ones runs fine with .Net 3.5.
- StyleCop plugin relies on MsBuild to run the analysis.
- Former versions of the StyleCop plugin (1.3 and before) were embedding StyleCop 4.4, whereas new versions (1.4+) are embedding StyleCop 22.214.171.124.