Install requirements

Install Java

Java needs to be installed on the machine on which analysis will be carried out. To make sure Java is installed on your machine, you can open a command prompt and type

java –version 

If Java is installed you will be prompted with the installed Java version, like this:

If Java is not installed on your machine, you can download it from https://java.com/nl/download/  and follow instructions  from there.

Install Sonarqube

SonarQube can be downloaded from http://www.sonarqube.org/downloads/

Select the version mentioned in Blueriq Model Analyzer Platform Support, and store it on your machine. Unzip the downloaded zip-file to the destination folder of your choice. The contents of the unzipped folder should look like this:

Install Maven

Apache Maven can be downloaded from https://maven.apache.org/download.cgi

Select the download of your choice, and store it on your machine. Then, unzip the downloaded zip-file to the destination folder of your choice. The contents of the unzipped folder should look like this:

Add maven to path

to be able to run sonarqube analysis you need to add maven to your path. This is done by opening a command prompt window in administrator mode and typing the following command:

setx path "%path%;<maven installation location>\bin"

Install Blueriq Model Analyzer for Sonarqube

The Blueriq Model Analyzer plugin called bma-sonar-plugin.jar needs to be placed inside the SonarQube directory in the subdirectory called extensions/plugin, for instance /sonarqube-5.6.6/extensions/plugins

After installation

When the Blueriq Model Analyzer plugin is in place, start the SonarQube service by running the StartSonar.bat in the subdirectory of the bin folder corresponding to your operating system. For instance /sonarqube-5.6.6/bin/windows-x86-x64

Configure Maven POM file

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 find

• 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:

<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:

The following properties are default SonarQube properties. More information can be found here.

The installation is now completed. You should be able to analyse your Blueriq Models now.