Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 path. This operation only returns its task Id and browsable url on the specified SonarQube instance.

Info

Analysis Properties

There is a significant amount of analysis parameters available to augment a Sonar scan. It is recommended to research which parameters are necessary for your projects and sonar scans.

...

FDSONARQUBEACCT_TOKEN

FDSONARQUBEACCT_USERNAME

Property Name

Property Code

Required

Description

SonarQube instance URL

code

FDSONARQUBEACCT_INSTANCE_URL

Yes

SonarQube Server Instance URL (example: https://localhost:9000)

SonarQube Token

Code Block

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

Code Block

No

The username for your SonarQube Server Instance. Provide a token or username and password.

SonarQube Password

code

FDSONARQUBEACCT_PASSWORD

No

The password for your SonarQube Server Instance. Provide a token or username and password.

SonarQube Clinet path

code

FDSONARQUBEACCT_SONAR_HOME

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

code

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.

Sonar Project Properties Path

code

FDSQ_INP_PROPERTIES_FILE_PATH

No

Absolute file path of the sonar-project.properties file.

Analysis Properties

code

FDSQ_INP_ANALYSIS_PROPERTIES

No

Define the sonar project properties manually. This will override all other fields. Required property: sonar.projectKey

Outputs

Output Name

Description

FDSQ_OUT_TASK_ID

Id of the task or Sonar scan started.

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.

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

Insert excerpt
analyzeCode
analyzeCode
nameInstalling SonarQube
nopaneltrue

Example

Insert excerpt
analyzeCode
analyzeCode
nameSonar Authentication
nopaneltrue

...