Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Blueriq Model Analyzer consists out of three components: Blueriq Sonar Plugin, Blueriq Quality Gate, Blueriq Sonar Scanner. Only the Blueriq Sonar Plugin and the Blueriq Quality Gate have to installed before being analyzing your Blueriq Models. The Blueriq Sonar Scanner it is used to execute the analysis and only therefor has to be made available on the machine environment from which where you want to execute the analysis of you Blueriq Models.

Installation requirements

All of the components require the Java to be available on the machine environment from where the components are ran. You can either install Java with a Java Installer, which makes Java globally available on your systemenvironment, or you can extract Java to a specific folderdirectory. This installation manual guide 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.

...

The Blueriq Sonar Plugin is a plugin for SonarQube, which executes performs the analysis on your Blueriq Models created in the Blueriq Studio. The Blueriq Sonar Plugin needs to be placed inside a SonarQube instance. This manual installation guide 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.

...

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 directory of your choice. The contents of the unzipped folder directory should look like this:

Info
titleConfiguring Java

If you do not have Java globally available on your system, you will need to set the path to the installation directory of Java. This can be done by editting editing the wrapper.conf file which is located in the conf directory of your SonarQube installation folderdirectory

Below is an example of how the wrapper.conf should look when you Java installation folder directory is located here: C:\Program Files\Java\jdk-11.0.2

Code Block
languagetext
titlewrapper.conf
# 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

...

...

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 directorysubdirectory.

Note

Only copy the bma-sonar-plugin.jar to extensions/plugin. If any non SonarQube plugin jars are placed into the extensions/plugin directory, Sonarqube will to start.

...

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

Blueriq Quality Gate

...

The Blueriq Quality Gate called bma-qualitygate-installer.jar can be runs by using java -jar bma-qualitygate-installer.jar. When running this command you will be prompted with several questions.

Prompt

Input

hostnameThe url to your SonarQube instance. This should be either yoururl.here[:PORT] or http[s]://yoururl.here[:PORT]/
usernameA username for a user with the Administer Quality Gates permission. (default: admin)
passwordThe password for the above mentioned user. (default: admin)

Clean install? (y/n)

Decide whether to delete the current quality gate and overwrite it with a new one. If the answer is not "Y", the script will only install missing conditions.

Image Modified

Info
titlecommand line arguments

It is possible pass command line arguments into the bma-qualitygate-installer.jar for information see this page Quality Gate Installer

During the installation of the Blueriq Quality Gate you will be informed of the progress. After the Quality Gate installation is finished, you can verify that the Blueriq Quality Gate is present in SonarQube. This can be done by navigating to the Quality Gates tab in SonarQube.

Image Modified

Blueriq Sonar Scanner

The Blueriq Sonar Scanner is a SonarQube Scanner. A SonarQube Scanner , which is a tools to analyze your projects. For Blueriq we have introduces introduced our own Blueriq Sonar Scanner, do due to implications we cannot provide an analysis using the default SonarQube Scanners. The Blueriq Sonar Scanner is a Spring Boot Java Command Line Interface runner, which can be used to execute the analysis of your Blueriq Models.

Where to place the Sonar Scanner

The Blueriq Sonar Scanner is used to execute the analysis of you Blueriq Models. Commonly Commonly a quality analysis is executeed performed on Continuous Integration(CI) Server Servers like for instance Jenkins. With the older versions of the Blueriq Model Analyzer it was possible to use the Maven Sonar Scanner to execute an analysis, and therefor only a connection to a central maven repository had to be setup. From the Blueriq Model Analyzer version 3 or higher you will need to place the Blueriq Sonar Scanner called bma-sonar-scanner.jar on the environment you which to execute the analysis from. 

...

See the User documentation on how to execute an analysis of your Blueriq Models.