Gets information about a completed sonar scan such as quality gate status, task status, and project name. This operation takes SonarQube Account Code, SonarQube project key, and taskId (scan Id), as input.
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. | |
| Task Id | FDSQ_INP_TASK_ID | Yes | Id of the task/scan to be retrieved. |
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 |
...
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.
...
Step 5: Define output names for all outputs you wish to return (FDSQ_OUT_QUALITY_GATE_STATUS, FDSQ_OUT_DASHBOARD_URL, FDSQ_OUT_TASK_ID, ect..) and create variables with matching names.
...