0x646e78/sonarq

sonarq - Local SonarQube Scanning

sonarq.py provides a quick & easy local sonarqube scanner & server solution driven from the cli.

sonarq was created to assist whitebox application assessments. It uses docker to run ephemeral scanners and a sonarqube server which is available locally.

Use

./sonarq.py <code_path>

Further options can be viewed with --help

A link to the completed scan will be printed to stdout. By default the server will be avaiable on http://localhost:9000

If the required docker images aren't already on disk they will be pulled. If you want to pull them as a separate task you can do so with --pull

The server container can be stopped with --stop-server or removed completely with --kill-server

Install

Prerequisites

python3
docker

Try the alpha from PyPI testing

sonarq is presently in TestPyPI

python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps sonarq-runner

Run from source

Set up & source a python virtual env

python3 -m venv venv
. venv/bin/activate

Install libraries

pip3 install -r requirements.txt

Example

$ ./sonarq.py ./
Beginning sonarq tasks for /Users/dnx/dev/pub/sonarq
Creating docker network sonarq for project sonarq
Launching a new sonarqube server
SonarQube server is available at http://127.0.0.1:9000
Creating a new Sonarqube project named sonarq
Starting a sonarqube scan of sonarq. This could take a while.
Scan complete. Results are available at the following url (user/pass = admin/admin)

http://127.0.0.1:9000/dashboard?id=sonarq

0x646e78 / sonarq