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 | ||
|---|---|---|
| ||
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 Name | Property Code | Required | Description |
|---|---|---|---|
| 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
...
| Input Name | Input Code | Required | Description |
|---|---|---|---|
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 |
Outputs
Output Name | Description |
|---|---|
| FDSQ_OUT_QUALITY_GATE_STATUS | 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. |
| 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. |
| FDSQ_OUT_TASK_ID | Id of the task being retrieved. |
| FDSQ_OUT_TASK_TYPE | Task type. Possible Values: REPORT |
| Component Id. | |
| FDSQ_OUT_TASK_COMPONENT_KEY | Component Key. |
| FDSQ_OUT_TASK_COMPONENT_NAME | Component Name. |
| Component Qualifier. | |
| FDSQ_OUT_TASK_ANALYSIS_ID | Analysis Id. |
| Task status. Possible values: SUCCESS, FAILED, CANCELED, PENDING, IN_PROGRESS |
Artifacts
...
Step 2: Create a SonarQube Analysis Tool Account
- Under SonarQube Account define:
- SonarQube Instance URL (http://host:port with no extra "/" at the end).
- Token OR username AND password for SonarQube Instance.
...