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.

Analysis Tool Instance Properties

Inputs

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

• A SonarQube instance is required. Here is guidance on installing that if necessary.

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 a non-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 Sonar

   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 of complete sonar implementation

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. 

You may be asked for a token type. A global Analysis Token is appropriate.

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: Set your host url

• Navigate to your SonarQube installation location. We'll refer to it as $install_directory in the next steps.

• Update the global settings to point to your SonarQube server by editing $install_directory/conf/sonar-scanner.properties:

  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)

• Option 1: Create a configuration file in the root directory of the project and name it sonar-project.properties, then give the file path to this file under Sonar Project Properties Path.

• Option 2: Create the sonar project properties from the Workflow screen under Analysis Properties.

  

Note

Sonar Project Properties Path or Analysis Properties is required but not both. Notice both are defined in this example, therefore, the analysis properties will take precedence.

Note

Omitting sonar.sources or sonar.projectBaseDir properties means the sonar scan will default to scanning all files in the base directory of the workflow execution → Endpoint Base Directory/ProjectId/WorkflowExecutionId (I.E.: prod/flexdeploy/fdtlt04/work/302231/198535/)

• For a list of all possible properties available visit SonarQube Analysis Properties.

Step 5: Define output names for FDSQ_OUT_TASK_ID and FDSQ_OUT_DASHBOARD_URL 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: