sonarci

cover

A simple CLI to help you integrate Sonar inspections with CI pipelines.

What does it do?

Sor far, basically, SonarCI can decorate your pull requests with a quality report (and also other cool things :smiley:)

Like that:

Quality Report

Metric	Rating
New Coverage
New Duplicated Lines Density
New Code Smells
Reliability
Security
Maintainability

Or something simpler, if you want:

Installation

To get started quickly and easily install use the following commands.

Global

To install globally, run the following command:

curl -sSL https://raw.githubusercontent.com/odair-pedro/sonarci/master/install.sh | sudo sh

Note: If the command sonarci fails after installation, check your path. You can also create a symbolic link to /usr/bin or any other directory in your path.

Example:

sudo ln -s /usr/local/bin/sonarci /usr/bin/sonarci

Local

To install locally in current directory, run the following command:

curl -sSL https://raw.githubusercontent.com/odair-pedro/sonarci/master/install-local.sh | sh

From source

To build and install locally from source code use the following command (on root directory):

make install

Note: SonarCI will be installed on current directory

Runing with Docker

If you prefer to use SonarCI CLI with Docker, just run the following command:

docker run odairpedro/sonarci-cli -- [command]

or the following command for help and usage:

docker run odairpedro/sonarci-cli -- --help

Example

docker run -e SONARCI_DECORATION_TYPE="azrepos" \
-e SONARCI_DECORATION_PROJECT="MY-ORGANIZATION/MY-TEAM-PROJECT" \
-e SONARCI_DECORATION_REPOSITORY="my-repository-name" \
-e SONARCI_DECORATION_TOKEN="azdevops-personal-access-token" \
odairpedro/sonarci-cli:latest -- -s "https://mysonar.server.com" -o "sonar-token" decorate -r 999 -p "sonar-project-key"

See more here: https://hub.docker.com/repository/docker/odairpedro/sonarci-cli

Usage

sonarci --help

SonarCI is a CLI library for help you integrate and use SonarQube inspections.

Usage:
  sonarci [command]

Available Commands:
  decorate       Decorate pull request with the quality gate report
  help           Help about any command
  search         Search for SonarQube projects
  server-version Get SonarQube server version
  validate       Validate quality gate status

Flags:
  -h, --help            help for sonarci
  -s, --server string   SonarQube server address
  -t, --timeout int     Timeout in milliseconds. Default value is 30000 ms
  -o, --token string    Authentication Token
  -v, --version         version for sonarci

Use "sonarci [command] --help" for more information about a command.

Command: Decorate

Decorate pull request with the SonarQube’s quality gate report.

sonarci decorate --help

Decorate pull request with the SonarQube's quality gate report.

Usage:
  sonarci decorate [flags]

Flags:
  -h, --help                  help for decorate
  -p, --project string        SonarQube projects key
  -r, --pull-request string   Pull request ID

Global Flags:
  -s, --server string   SonarQube server address
  -t, --timeout int     Timeout in milliseconds. Default value is 30000 ms
  -o, --token string    Authentication Token

For more detail about how to configure pull request decoration, read the section Environment Variables

Command: Search projects

Search and retrieve information about the specified SonarQube projects.

sonarci search --help

Search and retrieve information about the specified SonarQube projects.

Usage:
  sonarci search [flags]

Flags:
  -h, --help              help for search
  -p, --projects string   SonarQube projects key. Eg: my-sonar-project | my-sonar-project-1,my-sonar-project-2

Global Flags:
  -s, --server string   SonarQube server address
  -t, --timeout int     Timeout in milliseconds. Default value is 30000 ms
  -o, --token string    Authentication Token

Comand: Server version

Get SonarQube server version.

sonarci server-version --help

Get SonarQube server version

Usage:
  sonarci server-version [flags]

Flags:
  -h, --help   help for server-version

Global Flags:
  -s, --server string   SonarQube server address
  -t, --timeout int     Timeout in milliseconds. Default value is 30000 ms
  -o, --token string    Authentication Token

Command: Validate

Validate a branch or pull request status on SonarQube.

sonarci validate --help

Validate a branch or pull request status on SonarQube.

Usage:
  sonarci validate [command]

Available Commands:
  branch      Validate branch status
  pr          Validate pull request status

Flags:
  -h, --help   help for validate

Global Flags:
  -s, --server string   SonarQube server address
  -t, --timeout int     Timeout in milliseconds. Default value is 30000 ms
  -o, --token string    Authentication Token

Branch validation

Validate a branch status on SonarQube.

sonarci validate branch --help

Validate a branch status on SonarQube.

Usage:
  sonarci validate branch [branch name] [flags]

Flags:
  -h, --help             help for branch
  -p, --project string   SonarQube projects key

Global Flags:
  -s, --server string   SonarQube server address
  -t, --timeout int     Timeout in milliseconds. Default value is 30000 ms
  -o, --token string    Authentication Token

Pull request validation

Validate a pull request status on SonarQube.

sonarci validate pr --help

Validate a pull request status on SonarQube.

Usage:
  sonarci validate pr [pull request id] [flags]

Flags:
  -d, --decorate         Decorate a pull request with quality gate results
  -h, --help             help for pr
  -p, --project string   SonarQube projects key

Global Flags:
  -s, --server string   SonarQube server address
  -t, --timeout int     Timeout in milliseconds. Default value is 30000 ms
  -o, --token string    Authentication Token

Environment Variables

For pull request decoration you need to set the following environment variables:

Name	Type	Description
SONARCI_DECORATION_TYPE	String	Allowed values: azrepos or github
SONARCI_DECORATION_PROJECT	String	Project URI
SONARCI_DECORATION_REPOSITORY	String	Repository name
SONARCI_DECORATION_TOKEN	String	PAT

Looking for examples?

Azure Pipeline

You can use the following example to integrate a pipeline pull request analyzer with SonarCI

trigger:
- none

pool:
  vmImage: 'ubuntu-latest'

steps:
- script: |
    curl -sSL https://raw.githubusercontent.com/odair-pedro/sonarci/master/install.sh | sudo sh

    export SONARCI_DECORATION_TYPE="azrepos"
    export SONARCI_DECORATION_PROJECT="$(AZDEVEOPS-COMPANY-NAME)/$(System.TeamProject)"
    export SONARCI_DECORATION_REPOSITORY="$(Build.Repository.Name)"
    export SONARCI_DECORATION_TOKEN=$(AZDEVEOPS-PAT)

    sonarci --version
    sonarci -s "$(SONAR-SERVER)" -o $(SONAR-TOKEN) decorate -r $(System.PullRequest.PullRequestId) -p "$(SONAR-PROJECT-KEY)"
  displayName: 'SonarCI'

GitHub Action

Coming soon …