retrieveSonarScan
- Karl Henselin
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 |
| Yes | SonarQube Server Instance URL (example:Ā https://localhost:9000) |
SonarQube 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 |
| No | The username for your SonarQube Server Instance.Ā Provide a token or username and password. |
SonarQube Password |
| No | The password for your SonarQube Server Instance.Ā Provide a token or username and password. |
SonarQube Clinet path |
| No | SonarQube Client path in the server (e.g. /u01/sonarClinet/sonar-scanner-3.1.0.1141-linux/bin) |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
SonarQube Account Code |
| Yes | The SonarQube account with all the required properties like Sonar Scanner Home, Instance Url, Token for running SonarQube Instance. |
Task Id |
| Yes | Id of the task/scan to be retrieved. |
Outputs
Output Name | Description |
|---|---|
| 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 |
| Component Id. |
| Component Key. |
| Component Name. |
| Component Qualifier. |
| Analysis Id. |
| Task status. Possible values: SUCCESS, FAILED, CANCELED, PENDING, IN_PROGRESS |
Artifacts
This operation doesnāt consume or produce any artifacts.
Endpoint Selection
This operation delegates the selection to the workflow developer to determine.
Endpoint Execution
This operations delegates the execution to the workflow developer to decide.
Special Considerations
SonarQube instance required
Sonar Scanner installed on target environment
DownloadĀ the CLI Sonar Scanner
Example
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 3: Get the task id for the scan you want to retrieve. You can do this two ways.
If you ran a startScan operation then you can use the task id returned from its outputĀ
OR
If you have admin access on your SonarQube Instance, then you can access the task Id for any projects scan directly by going to Projectsāselecting a projectāAdministrationāBackground Tasks. The task id is under the ID column.
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.
Step 6: Create a project, select your sonar scan workflow, and instance.
Step 7: Run the workflow to start your sonar scan.Ā
Example output:
Ā
- style