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

FDSONARQUBEACCT_INSTANCE_URL

FDSONARQUBEACCT_TOKEN

FDSONARQUBEACCT_USERNAME

FDSONARQUBEACCT_PASSWORD

FDSONARQUBEACCT_SONAR_HOME

Environment/Instance Properties

Project Properties

Inputs

FDSQ_INP_ANALYSIS_TOOL_ACCOUNT_CODE

FDSQ_INP_TASK_ID

Outputs

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

   Get started with a SonarQube Instance in two minutes

  1. Download the SonarQube Community Edition.

  2. As a non-root user, unzip it, let's say in C:\sonarqube or /opt/sonarqube.

  3. As anon-rootuser, start the SonarQube Server: 

     # On Windows, execute:
     C:\sonarqube\bin\windows-x86-xx\StartSonar.bat
     
     # On other operating systems, as a non-root user execute:
     /opt/sonarqube/bin/[OS]/sonar.sh console

     Troubleshooting

     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.

  4. Log in to http://localhost:9000 with System Administrator credentials (login=admin, password=admin).

  5. Click the Create new project button to analyze your first project.

• Sonar Scanner installed on target environment
  • Download the CLI Sonar Scanner

Example

Step 1: Gather authentication information.

• 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. 

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: