Executes a sonar scan. This operation takes inputs for both a Sonar project properties path and an analysis properties file. If both are provided, the plugin will use the analysis properties and do nothing with the pathGets 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

Project Properties

Environment/Instance Properties

...

Inputs

Outputs

Artifacts

This operation doesn’t consume or produce any artifacts.

Endpoint Selection

This operation will select all available endpoints associated to the environment/instancedelegates the selection to the workflow developer to determine.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which oneoperations delegates the execution to the workflow developer to decide.

Special Considerations

• SonarQube instance required

  expand

  As anon-rootuser, start the SonarQube Server: 

  Code Block
  theme Eclipse
  # 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

  Info
  title 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.

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

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

Insert excerpt

title	Get started with a SonarQube Instance in two minutes

• Download the SonarQube Community Edition.

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

analyzeCode analyzeCode name Installing SonarQube

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

...

Insert excerpt
analyzeCode analyzeCode name Sonar Authentication nopanel true

Step 2: Create a SonarQube Analysis Tool Account

Image Removed

...

• Under SonarQube Account define:

  The bin folder location of your sonar scanner on your environment.

  
  

  • SonarQube Instance URL (http://host:port with no extra "/" at the end).

  • Token OR username AND password for SonarQube Instance.

Step 3: Set your host url

...

Code Block
title sonar-scanner.properties
#----- Default SonarQube server #sonar.host.url=http://localhost:9000 #Don't forget to remove the "#" here if it is there by default

Step 4: Define sonar project properties (2 options)

...

Info
title Note
Sonar Project Properties Path or Analysis Properties is required but not both. If both are defined then Analysis Properties will take precedence.

...

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_TASK_ID and FDSQQUALITY_GATE_STATUS, FDSQ_OUT_DASHBOARD_URL, FDSQ_OUT_TASK_ID, ect..) and create variables with matching names.

Image Removed

...

Step 6: Create a project, select your sonar scan workflow, and instance, and set the SonarQube Project Key under project properties.

...

...

If you want to create a new project on your SonarQube Instance then define a unique project key here. Otherwise, you run a new sonar on an exisiting project, in this case find the project key on your SonarQube Instance under Projects→Overview at the bottom right of the screen it will be labeled clearly with the title: Key.

Image Removed

Step 7: Run the workflow to start your sonar scan. 

Example output: Image Removed

...