The Blueriq Model Analyzer consists out of three components: Blueriq Sonar Plugin, Blueriq Sonar Scanner, Blueriq Sonar Quality Gate. This page will explain how to install and setup all of these component.

Installation requirements

All of the components require the Java to be available on the machine from where the components are ran. You can either install Java with a Java Installer, which makes Java globally available on your system, or you can extract Java to a specific folder. This installation manual will provide information for both options. Make sure you download the correct Java version (32/64bit). See the Blueriq Model Analyzer Platform Support page which version of Java is support for your Blueriq Model Analyzer version.

Blueriq Sonar Plugin

The Blueriq Sonar Plugin is a plugin for SonarQube, which makes it possible to perform an analysis on you Blueriq Models created in the Blueriq Studio. The Blueriq Sonar Plugin needs to be placed inside a SonarQube instance. This manual will provide information on how to install SonarQube and how to place the Blueriq Sonar Plugin in the correct directory of Sonarqube so it becomes available.

Installing Sonarqube

Download SonarQube from https://www.sonarqube.org/downloads/.

Select the supported 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:

# Path to JVM executable. By default it must be available in PATH.
# Can be an absolute path, for example:
#wrapper.java.command=/path/to/my/jdk/bin/java
wrapper.java.command=C:/Program Files/Java/jdk-11.0.2/bin/java

...

Installing Blueriq Sonar Plugin in Sonarqube

The Blueriq Sonar Plugin called bma-sonar-plugin.jar needs to be placed inside the installation directory of SonarQube. Navigate to the subdirectory extensions/plugin inside the installation directory of SonarQube, and copy the bma-sonar-plugin.jar into the directory.

Running SonarQube

When the Blueriq Sonar 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.