Page History
...
Finally, Maven and SonarQube need to be configured with the correct properties to be able to read your Blueriq Model of interest. Maven takes care of this by reading a pom.xml file.
You will have to create the pom.xml yourself, and then configure it for your own Blueriq installation, repository, branch and project(s).
Below, you can seefind
- An example of a pom.xml
- The location where to save the pom.xml
- An explanation of the properties in the pom.xml
An example
...
configuration in this pom file looks like this:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>SingleModule</groupId>
<artifactId>singlemodule-test</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>SingleModuleTest</name>
<properties>
<sonar.blueriq.managementservice>http://my-studio-server/Studio/Server/Services/ManagementService</sonar.blueriq.managementservice>
<sonar.blueriq.repository>RubikTest</sonar.blueriq.repository>
<sonar.blueriq.branch>Trunk</sonar.blueriq.branch>
<sonar.blueriq.projects>Kinderbijslag,TestProject</sonar.blueriq.projects>
<sonar.blueriq.username>admin</sonar.blueriq.username>
<sonar.blueriq.password>welcome</sonar.blueriq.password>
<sonar.blueriq.authentication>BASIC</sonar.blueriq.authentication>
<sonar.blueriq.skipanalysis>false</sonar.blueriq.skipanalysis>
<sonar.blueriq.workingDir>target/bq</sonar.blueriq.workingDir>
</properties>
</project> |
The correctly configured pom file needs to be placed inside the directory in which Maven’s root directory is installed, for instance:
The properties in the pom file:
...
| Property | Required | Default | Description |
|---|---|---|---|
sonar.blueriq.managementservice | Required for managementservice | Url to the management service, if this property is set then all other managementservice properties must also be set. If this is not set, then the branchexportlocation must be set. | |
sonar.blueriq.repository | Required for managementservice | Name of the repository. | |
sonar.blueriq.branch | Required for managementservice | Name of the branch. | |
sonar.blueriq.username | Required for managementservice | Studio username credential. | |
sonar.blueriq.password | Required for managementservice | Studio password credential. | |
| sonar.blueriq.authentication | Required for managementservice | Studio authentication mode, currently only BASIC is supported | |
| sonar.blueriq.branchexportlocation | Required for export file | Location of a branch export zip from the studio, if this is set then the managementservice property must not be set. | |
sonar.blueriq.projects | Required | A comma separated list of blueriq project names. | |
| sonar.blueriq.workingDir | Required | Relative path inside the executing directory where the BMA plugin creates files to index issues and measures. | |
| sonar.blueriq.skipanalysis | Optional | false | Set to true if the BMA plugin shouldn't be triggered for the current project. This is useful when scanning projects without Blueriq, or when no connection can be made to the management service. |
The following properties are default SonarQube properties. More information can be found here.
| Property | Required | Default | Description |
|---|---|---|---|
sonar.host.url | Optional | localhost:9000 | Url and port to the sonarQube host. |
| sonar.projectKey | Optional when using Maven | The key for the SonarQube project. In case of Maven the default is based on the Maven project name. | |
| sonar.projectName | Optional when using Maven | The name of the SonarQube project. In case of Maven the default is based on the Maven project name. | |
| sonar.branch | Optional | Use when importing the results of a feature branch to SonarQube. |
An example configuration in this pom file looks like this:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>SingleModule</groupId>
<artifactId>singlemodule-test</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>SingleModuleTest</name>
<properties>
<sonar.blueriq.managementservice>http://my-studio-server/Studio/Server/Services/ManagementService</sonar.blueriq.managementservice>
<sonar.blueriq.repository>RubikTest</sonar.blueriq.repository>
<sonar.blueriq.branch>Trunk</sonar.blueriq.branch>
<sonar.blueriq.projects>Kinderbijslag,TestProject</sonar.blueriq.projects>
<sonar.blueriq.username>admin</sonar.blueriq.username>
<sonar.blueriq.password>welcome</sonar.blueriq.password>
<sonar.blueriq.authentication>BASIC</sonar.blueriq.authentication>
<sonar.blueriq.skipanalysis>false</sonar.blueriq.skipanalysis>
<sonar.blueriq.workingDir>target/bq</sonar.blueriq.workingDir>
</properties>
</project> |
The correctly configured pom file needs to be placed inside the directory in which Maven’s root directory is installed, for instance:
The installation is now completed. You should be able to analyse your Blueriq Models now.
...
Overview
Content Tools