0% found this document useful (0 votes)
13 views3 pages

SonarQube Flow Plugin Installation Guide

The document describes the quick setup of the sonar-flow-plugin, which analyzes webMethods flow code. It explains how to download and install the plugin jar into a local or Docker SonarQube server. It also provides instructions on configuring the SonarQube scanner to point to the server and run analysis on a sample Integration server package to view results and detected code smells in the SonarQube UI.

Uploaded by

Ridam Misra
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
13 views3 pages

SonarQube Flow Plugin Installation Guide

The document describes the quick setup of the sonar-flow-plugin, which analyzes webMethods flow code. It explains how to download and install the plugin jar into a local or Docker SonarQube server. It also provides instructions on configuring the SonarQube scanner to point to the server and run analysis on a sample Integration server package to view results and detected code smells in the SonarQube UI.

Uploaded by

Ridam Misra
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Quick setup | sonar-flow-plugin [Link]

sonar-flow-plugin
A sonarqube plugin to analyse webmethods flow code

View the Project on GitHub

Quick setup
Download the sonar-flow-plugin jar to your working directory. The jar can be found
on the GitHub release page.

wget [Link]

Install the plugin on the SonarQube server
To install this plugin just add the downloaded jar to your SonarQube server in the
plugins folder /opt/sonarqube/extensions/plugins/. You will need to restart your
server.

(Optional) Create a SonarQube server with flow plugin using
docker

If you do not have a SonarQube server, you can quickly create one using docker.
For this part we will use the sonarqube docker image from the docker hub and add
the sonar-flow-plugin jar to it. More info about this image can be found on:
[Link]

Create a folder and download the dockerfile

Create a the structure sonar-flow-plugin/target inside your folder and put the
downloaded in the target folder. Next is to build this container and run it using
following commands from the Dockerfile location:

docker build . -t i8c/sonarqube-flow


docker run --name sonarqube-flow -p 9000:9000 i8c/sonarqube-flow

Now you should have a running SonarQube server with the sonar-flow-plugin
installed on port 9000 of your dockerhost.

1 of 3 24-06-2021, 20:58
Quick setup | sonar-flow-plugin [Link]

Configure the SonarQube Scanner
The documentation for the scanner can be found here. Download the scanner to
your filesystem and unzip it.

wget [Link]
unzip [Link]

Now configure the SonarQube scanner to point to your SonarQube server. This is
done using the config file at sonar-scanner-cli-3.1.0.1141/conf/sonar-
[Link]. The content of this file should look like this:

#No information about specific project should appear here

#----- Default SonarQube server


[Link]=[Link]

#----- Default source code encoding


[Link]=UTF-8

Run the SonarQube Scanner
Go in your filesystem to the webMethods Integration server package you want to
check. And make a new file [Link] with following content:

# Must be unique in a given SonarQube instance


[Link]=sonar-flow-tutorial

# this is the name displayed in the SonarQube UI


[Link]=Sonar flow plugin tutorial
[Link]=1.0

# Path is relative to the [Link] file.


[Link]=./ns

# Encoding of the source code. Default is default system encoding


[Link]=UTF-8
[Link]=false

And finally run SonarQube Scanner script inside this directory.

../sonar-scanner-cli-3.1.0.1141/bin/sonar-scanner

View results

2 of 3 24-06-2021, 20:58
Quick setup | sonar-flow-plugin [Link]

Now go to your browser and go to [Link] SonarQube host ip>:9000. Here you’ll


see that the project “Sonar flow plugin tutorial” has been added and 2 code smells
were detected in this Integration server package.

When you look at those 2 issues you’ll see that I should have added a comment
and removed the savePipeline flow.

This project is maintained by I8C

Hosted on GitHub Pages — Theme by orderedlist

3 of 3 24-06-2021, 20:58

You might also like