Versions Compared

Key

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

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.

Info
titleAnalysis Properties

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.

Analysis Tool Instance Properties

Property NameProperty CodeRequiredDescription
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
NoThe username for your SonarQube Server Instance. Provide a token or username and password.
SonarQube Password
FDSONARQUBEACCT_PASSWORD
NoThe password for your SonarQube Server Instance. Provide a token or username and password.

Environment/Instance Properties

...

Input NameInput CodeRequiredDescription
FDSQ_INP_ANALYSIS_TOOL_ACCOUNT_CODE
YesThe 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
NoAbsolute file path of the sonar-project.properties file.
Analysis Properties
FDSQ_INP_ANALYSIS_PROPERTIES
NoDefine the sonar project properties manually. This will override all other fields. Required property: sonar.projectKey

Outputs

Output Name
Description
FDSQ_OUT_QUALITY_GATE_STATUSDefines 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.
FDSQ_OUT_DASHBOARD_URLSonarQube instance dashboard url. Note that you will be able to access the updated dashboard once the server has processed the submitted analysis report.
FDSQ_OUT_TASK_IDId of the task being retrieved.
FDSQ_OUT_TASK_TYPETask type. Possible Values: REPORT
Component Id.
FDSQ_OUT_TASK_COMPONENT_KEYComponent Key.
FDSQ_OUT_TASK_COMPONENT_NAMEComponent Name.
Component Qualifier.
FDSQ_OUT_TASK_ANALYSIS_IDAnalysis Id.
Task status. Possible values: SUCCESS, FAILED, CANCELED, PENDING, IN_PROGRESS

Artifacts

...

Step 2: Create a SonarQube Analysis Tool Account

Image RemovedImage Added

  • Under SonarQube Account define:
    • SonarQube Instance URL (http://host:port with no extra "/" at the end).
    • Token OR username AND password for SonarQube Instance.

...