Executes a sonar scan, waits for it complete, and then returns the information on completed scan. This operation takes inputs for both a Sonar project properties path and an analysis properties file but only requires one. If both are provided, the plugin will use the analysis properties and do nothing with the path. This operation only returns information including but not limited to quality gate status, dashboard url, task Id, analysis Id, and task status.
There are a significant amount of analysis parameters available to augment a Sonar scan. It is recommended to research which parameters are necessary for your projects and sonar scans.
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.
The username for your SonarQube Server Instance. Provide a token or username and password.
The password for your SonarQube Server Instance. Provide a token or username and password.
SonarQube Client path
SonarQube Client path in the server (e.g. /u01/sonarClinet/sonar-scanner-18.104.22.1681-linux/bin)
The SonarQube account with all the required properties like Sonar Scanner Home, Instance Url, Token for running SonarQube Instance.
Sonar Project Properties Path
Absolute file path of the sonar-project.properties file.
Define the sonar project properties manually. This will override all other fields. Required property: sonar.projectKey
Defines the status of the project based on all the quality gate(s) defined for the project. Possible values: OK, WARN, ERROR, NONE. The NONE status is returned when there is no quality gate associated with the analysis.
SonarQube instance dashboard url. Note that you will be able to access the updated dashboard once the server has processed the submitted analysis report.
Id of the task being retrieved.
Task type. Possible Values: REPORT
Task status. Possible values: SUCCESS, FAILED, CANCELED, PENDING, IN_PROGRESS
This operation doesn’t consume or produce any artifacts.
This operation delegates the selection to the workflow developer to determine.
This operations delegates the execution to the workflow developer to decide.
SonarQube instance required
Get started with a SonarQube Instance in two minutes
As anon-rootuser, unzip it, let's say inC:\sonarqubeor/opt/sonarqube.
As anon-rootuser, start the SonarQube Server:
# On Windows, execute:
# On other operating systems, as a non-root user execute:
If you're having trouble starting your server for the first time (or any subsequent time!) the first thing to do is check your server logs. You'll find them in$SONARQUBE_HOME/logs:
sonar.log - Log for the main process. Holds general information about startup and shutdown. You'll get overall status here but not details. Look to the other logs for that.
web.log - Information about initial connection to the database, database migration and reindexing, and the processing of HTTP requests. This includes database and search engine logs related to those requests.
ce.log - Information about background task processing and the database and search engine logs related to those tasks.
es.log - Ops information from the search engine, such as Elasticsearch startup, health status changes, cluster-, node- and index-level operations, etc.
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.
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.
Sonar Project Properties Path or Analysis Properties is required but not both. Notice both are defined in this example, therefore, the analysis properties will take precedence.
Omitting sonar.sources or sonar.projectBaseDir properties means the sonar scan will default to scanning all files in the base directory of the workflow execution → Endpoint Base Directory/ProjectId/WorkflowExecutionId (I.E.: prod/flexdeploy/fdtlt04/work/302231/198535/)