1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
---
title: SonarScanner for Azure DevOps
url: /scan/sonarscanner-for-azure-devops/
---
[[info]]
| By [SonarSource](https://www.sonarsource.com/) – GNU LGPL 3 – [Issue Tracker](https://jira.sonarsource.com/browse/VSTS) – [Source](https://github.com/SonarSource/sonar-scanner-vsts)
| **SonarScanner for Azure DevOps**
The <!-- sonarqube -->[SonarQube](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube)<!-- /sonarqube --> <!-- sonarcloud -->[SonarCloud](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarcloud)<!-- /sonarcloud --> extension for Azure DevOps <!-- sonarqube -->Server<!-- /sonarqube --> makes it easy to integrate analysis into your build pipeline. The extension allows the analysis of all languages supported by {instance}.
<!-- sonarcloud -->
Microsoft has published a [dedicated lab](https://aka.ms/sonarcloudlab) describing how to integrate Azure DevOps Pipelines and SonarCloud. The lab includes setting up a Branch Policy in Azure DevOps to block a Pull Request from being submitted if the changed code does not meet the quality bar.
<!-- /sonarcloud -->
## Compatibility
Version <!-- sonarqube -->4.x<!-- /sonarqube --><!-- sonarcloud -->1.x<!-- /sonarcloud --> is compatible with:
* TFS 2017 Update 2+
* TFS 2018
* Azure DevOps Server 2019
* Azure DevOps
<!-- sonarqube -->
The SonarQube Extension embeds its own version of the [SonarScanner for MSBuild](/scan/sonarscanner-for-msbuild/).
<!-- /sonarqube -->
## Installation
1. Install the extension [from the marketplace](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube).
If you are using [Microsoft-hosted build agents](https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/hosted?view=azure-devops) then there is nothing else to install. The extension will work with all of the hosted agents (Windows, Linux, and MacOS).
2. If you are self-hosting the build agents make sure at least the minimal version of Java supported by {instance} is installed.
In addition, make sure the appropriate build tools are installed on the agent for the type of project e.g. .NET Framework v4.6+/NET Core 2.0+ if building using MSBuild, Maven for Java projects etc.
## Configure
The first thing to do is to declare <!-- sonarqube -->your SonarQube server<!-- /sonarqube --><!-- sonarcloud -->SonarCloud<!-- /sonarcloud --> as a service endpoint in your Azure DevOps project settings.
1. Open the Connections page in your Azure DevOps project: **Project Settings > Pipelines > Service Connections**.
1. Click on **New service connection** and choose **{instance}**.
<!-- sonarqube -->
1. Specify a **Connection name**, the **Server URL** of your SonarQube Server (including the port if required) and the [Authentication Token](/user-guide/user-token/) to use.
<!-- /sonarqube -->
<!-- sonarcloud -->
1. Specify a **Connection name** and **SonarCloud token**. There is a link in the dialog that will take you to the account security page on SonarCloud where you can create a new token if necessary. You can also button that lets you verify that connection is correctly configured.
<!-- /sonarcloud -->
Each extension provides three tasks you will use in your build definitions to analyze your projects:
* **Prepare Analysis Configuration** task, to configure all the required settings before executing the build.
* This task is mandatory.
* In case of .NET solutions or Java projects, it helps to integrate seamlessly with MSBuild, Maven and Gradle tasks.
* **Run Code Analysis** task, to actually execute the analysis of the source code.
* This task is not required for Maven or Gradle projects, because scanner will be run as part of the Maven/Gradle build.
* **Publish Quality Gate Result** task, to display the Quality Gate status in the build summary and give you a sense of whether the application is ready for production "quality-wise".
* This tasks is optional.
* It can significantly increase the overall build time because it will poll {instance} until the analysis is complete. Omitting this task will not affect the analysis results on {instance} - it simply means the Azure DevOps Build Summary page will not show the status of the analysis or a link to the project dashboard on {instance}.
When creating a build definition you can filter the list of available tasks by typing "Sonar" to display only the relevant tasks.
## Analysing a .NET solution
1. In your build definition, add:
* At least **Prepare Analysis Configuration** task and **Run Code Analysis** task
* Optionally **Publish Quality Gate Result** task
1. Reorder the tasks to respect the following order:
* **Prepare Analysis Configuration** task before any **MSBuild** or **Visual Studio Build** tasks.
* **Run Code Analysis** task after the **Visual Studio Test task**.
* **Publish Quality Gate Result** task after the **Run Code Analysis** task
1. Click on the **Prepare Analysis Configuration** build step to configure it:
* You must specify the service connection (i.e. {instance}) to use. You can:
* select an existing endpoint from the drop down list
* add a new endpoint
* manage existing endpoints
<!-- sonarcloud -->* specify which **SonarCloud Organization** to use by choosing an organization from the drop-down<!-- /sonarcloud -->
* Keep **Integrate with MSBuild** checked and specify at least the project key
* **Project Key** - the unique project key in {instance}
* **Project Name** - the name of the project in {instance}
* **Project Version** - the version of the project in {instance}
1. Click the **Visual Studio Test** task and check the **Code Coverage Enabled** checkbox to process the code coverage and have it imported into {instance}. (Optional but recommended)
Once all this is done, you can trigger a build.
## Analysing a Java project with Maven or Gradle
1. In your build definition, add:
* At least **Prepare Analysis Configuration** task
* Optionaly **Publish Quality Gate Result** task
1. Reorder the tasks to respect the following order:
* **Prepare Analysis Configuration** task before the **Maven** or **Gradle** task.
* **Publish Quality Gate Result** task after the **Maven** or **Gradle** task.
1. Click on the Prepare Analysis Configuration build step to configure it:
* Select the **SonarQube Server**
* Select **Integrate with Maven or Gradle**
1. On the Maven or Gradle task, in **Code Analysis**, check **Run SonarQube or SonarCloud Analysis**
Once all this is done, you can trigger a build.
## Analysing other project types
If you are not developing a .NET application or a Java project, here is the standard way to trigger an analysis:
1. In your build definition, add:
* At least **Prepare Analysis Configuration** task and **Run Code Analysis** task
* Optionaly **Publish Quality Gate Result** task
1. Reorder the tasks to respect the following order:
1. **Prepare Analysis Configuration**
2. **Run Code Analysis**
3. **Publish Quality Gate Result**
1. Click on the Prepare Analysis Configuration build step to configure it:
* Select the **SonarQube Server**
* Select **Use standalone scanner**
* Then:
* Either the SonarQube properties are stored in the (standard) `sonar-project.properties` file in your SCM, and you just have to make sure that "Settings File" correctly points at it. This is the recommended way.
* Or you don't have such a file in your SCM, and you can click on **Manually provide configuration** to specify it within your build definition. This is not recommended because it's less portable.
Once all this is done, you can trigger a build.
## Branch and Pull Request analysis
<!-- sonarqube -->
_Branch and Pull Request analysis are available as part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) and [above](https://www.sonarsource.com/plans-and-pricing/)_
<!-- /sonarqube -->
### Branches
When a build is run on a branch of your project, the extension automatically configures the analysis to be pushed to the relevant project branch in {instance}. The same build definition can apply to all your branches, whatever type of Git repository you are analyzing,
If you are working with branches on TFVC projects, you still need to manually specify the branch to be used on {instance}: in the **Prepare Analysis Configuration** task, in the **Additional Properties**, you need to set `sonar.branch.name`.
### PRs
{instance} can analyze the code of the new features and annotate your pull requests in TFS with comments to highlight issues that were found.
Pull request analysis is supported for any type of Git repositories. To activate it:
1. In the **Branch policies** page of your main development branches (e.g. "master"), add a build policy that runs your build definition
1. Create an Azure DevOps token with "Code (read and write)" scope
1. <!-- sonarqube -->In SonarQube, in the **[Administration > General Settings > Pull Requests](/#sonarqube-admin#/admin/settings?category=pull_request)** page,<!-- /sonarqube --><!-- sonarcloud -->In SonarCloud,<!-- /sonarcloud --> set this token in the **VSTS/TFS** section
Next time some code is pushed in the branch of a pull request, the build definition will execute a scan on the code and publish the results in {instance} which will decorate the pull request in TFS.
## FAQ
**Is it possible to trigger analyses on Linux or macOS agents?**
This becomes possible from version <!-- sonarqube -->4.0 of the SonarQube task<!-- /sonarqube --><!-- sonarcloud -->1.0 of the SonarCloud extension<!-- /sonarcloud -->, in which the extension was fully rewritten in Node.js. The mono dependency was dropped in version <!-- sonarqube -->4.3<!-- /sonarqube --><!-- sonarcloud -->1.3<!-- /sonarcloud -->.
This is not possible with previous versions of the extension.
**How do I break the build based on the quality gate status?**
This is not possible with the new version of the extension if you are using the most up-to-date versions of the tasks. We believe that breaking a CI build is not the right approach. Instead, we are providing pull request decoration (to make sure that issues aren't introduced at merge time) and we'll soon add a way to check the quality gate as part of a Release process.
|
