Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rgl/sonarqube-windows-vagrant
Vagrant Environment for a SonarQube based Source Code Analysis service
https://github.com/rgl/sonarqube-windows-vagrant
msbuild sonarqube sonarqube-scanner vagrant windows
Last synced: 29 days ago
JSON representation
Vagrant Environment for a SonarQube based Source Code Analysis service
- Host: GitHub
- URL: https://github.com/rgl/sonarqube-windows-vagrant
- Owner: rgl
- Created: 2016-09-17T13:00:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-07-20T22:40:17.000Z (over 5 years ago)
- Last Synced: 2024-10-04T18:41:22.963Z (3 months ago)
- Topics: msbuild, sonarqube, sonarqube-scanner, vagrant, windows
- Language: PowerShell
- Size: 24.4 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is a [Vagrant](https://www.vagrantup.com/) Environment for a [SonarQube](http://www.sonarqube.org) based Source Code Analysis service.
This will:
* Install a SonarQube instance and configure it through its [Web API](http://docs.sonarqube.org/display/DEV/Web+API).
* With LDAP integration (this assumes that [rgl/windows-domain-controller-vagrant](https://github.com/rgl/windows-domain-controller-vagrant) is up and running).
* Login as `john.doe` (belongs to the `sonar-administrators` group).
* Login as `jane.doe` (does not belong to the `sonar-administrators` group).
* Install [Visual Studio Build Tools 2019](https://www.visualstudio.com/downloads/).
* Install the [SonarScanner for MSBuild](http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+MSBuild).
* Analyse a C# project ([MailBounceDetector](https://github.com/rgl/MailBounceDetector)); including its [XUnit](https://xunit.github.io/) Unit Tests and an [OpenCover](https://github.com/OpenCover/opencover) Code Coverage report.
# Usage
Build and install the [Windows 2019 Base Box](https://github.com/rgl/windows-2016-vagrant).
Install the needed plugins:
```bash
vagrant plugin install vagrant-reload # https://github.com/aidanns/vagrant-reload
```
Then start this environment:
```bash
vagrant up
```
# Excluding Projects from SonarQube Analysis
[`sonar.exclusions`](http://docs.sonarqube.org/display/SONAR/Narrowing+the+Focus)
(and other paths) are relative to the project directory, as such, they can only
exclude files inside a project. to exclude the project itself you have to use
one of the following (before calling `SonarScanner.MSBuild begin`):
1. Modify each `.csproj` file to have the following element:
```xml
true
```
1. Create a `.csproj.user` file (on the same directory as `.csproj`) with:
```xml
true
```
1. Implement some global logic by placing a MSBuild snippet (e.g. a `.targets` file)
inside the current user or the local machine MSBuild directories, that is, at one of:
```
C:\Users\\AppData\Local\Microsoft\MSBuild\15.0\Microsoft.Common.targets\ImportBefore
C:\Program Files (x86)\MSBuild\15.0\Microsoft.Common.Targets\ImportBefore
```
**NB** these directories are scanned before the `.csproj.user` file.
**NB** before importing the files MSBuild sorts them by file name; e.g. to import a file
last give it a, e.g. `ZZZ` prefix.
For more information see:
* [SonarQube jira issue (closed as won't fix): Add the ability to filter the projects to be analyzed by path](https://jira.sonarsource.com/browse/SONARMSBRU-191)
* [SonarQube for Visual Studio Plugin: Appendix 3: Advanced SonarQube Scanner for MSBuild configuration](https://github.com/SonarSource-VisualStudio/sonar-.net-documentation/blob/master/doc/appendix-3.md)
* [SonarQube: Excluding Artifacts from the Analysis](http://docs.sonarqube.org/display/SCAN/Excluding+Artifacts+from+the+Analysis)
* [SonarQube: Narrowing the Focus](http://docs.sonarqube.org/display/SONAR/Narrowing+the+Focus#NarrowingtheFocus-patterns)
* [SonarQube: Analyzing with SonarQube Scanner for MSBuild](http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+MSBuild)
* [MSBuild Documentation](https://msdn.microsoft.com/en-us/library/dd393574.aspx)