Executes a sonar scan. This operation takes inputs for both a Sonar project properties path and an analysis properties file. If both are provided, the plugin will use the analysis properties and do nothing with the path.

Analysis Tool Instance Properties

Property Name	Property Code	Required	Description
SonarQube Scanner Home	FDSONARQUBEACCT_SCANNER_HOME	Yes	SonarQube Scanner Home Directory
SonarQube instance URL	FDSONARQUBEACCT_INSTANCE_URL	Yes	SonarQube Server Instance URL (example: https://localhost:9000)
SonarQube Token	FDSONARQUBEACCT_TOKEN	No	SonarQube Server Token provides credentials to run code scans or to invoke web services as a replacement of the user login. Provide a token or username and password.
SonarQube Username	FDSONARQUBEACCT_USERNAME	No	The username for your SonarQube Server Instance. Provide a token or username and password.
SonarQube Password	FDSONARQUBEACCT_PASSWORD	No	The password for your SonarQube Server Instance. Provide a token or username and password.

Environment/Instance Properties

...

Property Name	Property Code	Required	Description
SonarQube Project Key	FDSQ_PROJECT_KEY	Yes	Unique identifier for a given SonarQube instance project.

Inputs

Input Name	Input Code	Required	Description
SonarQube Account Code	FDSQ_INP_ANALYSIS_TOOL_ACCOUNT_CODE	Yes	The SonarQube account with all the required properties like Sonar Scanner Home, Instance Url, Token for running SonarQube Instance.
Sonar Project Properties Path	FDSQ_INP_PROPERTIES_FILE_PATH	No	Absolute file path of the sonar-project.properties file.
Analysis Properties	FDSQ_INP_ANALYSIS_PROPERTIES	No	Define the sonar project properties manually. This will override all other fields. Required property: sonar.projectKey

...

Output Name	Description
FDSQ_OUT_TASK_ID	Id of the task or Sonar scan started.
FDSQ_OUT_DASHBOARD_URL	SonarQube instance dashboard url. Note that you will be able to access the updated dashboard once the server has processed the submitted analysis report.

Artifacts

This operation doesn’t consume or produce any artifacts.

...

If you choose to use a token over username and password for authentication you can generate it on your SonarQube Server. To get a SonarQube Token: login to your SonarQube Instance (http://host:port ex: http://localhost:9000/) and navigate to My Account->Security->Generate New Token. Make sure you copy and save this token somewhere secure because after you leave this screen you will not be able to see your token again.

Image RemovedImage Added

Step 2: Create your a SonarQube Analysis Tool Account

Image RemovedImage Added

Under SonarQube Account define:
- The bin folder location of your sonar scanner on your environment.
- SonarQube Instance URL (http://host:port with no extra "/" at the end).
- Token OR username AND password for SonarQube Instance.

...

Navigate to your SonarQube installation location. We'll refer to it as $install_directory in the next steps.
Update the global settings to point to your SonarQube server by editing $install_directory/conf/sonar-scanner.properties:
Code Block
title sonar-scanner.properties
#----- Default SonarQube server #sonar.host.url=http://localhost:9000 #Don't forget to remove the "#" here if it is there by default

Step 4: Define sonar project properties (2 options)

Option 1: Create a configuration file in the root directory of the project and name it sonar-project.properties, then give the file path to this file under Sonar Project Properties Path.
Option 2: Create the sonar project properties from the Workflow screen under Analysis Properties.Image RemovedImage Added

Info
title Note
Sonar Project Properties Path or Analysis Properties is required but not both. If both are defined then Analysis Properties will take precedence.
For a list of all possible properties available visit SonarQube Analysis Properties.