1. Getting Started with GNATdashboard
1.1. Prerequisites
a SonarQube Scanner installation configured for the targeted SonarQube instance, and in your
$PATH
(see Prerequisites for more information on supported versions of SonarQube and SonarQube Scanner).a GNAT Pro installation (the most recent installed on the system), and in your
$PATH
(optional, and recommended) a GNAT SAS installation, in your
$PATH
1.2. GNATdashboard setup
(on Windows) run the installer, and place
<install_prefix>bin
in your$PATH
(on *NIX) extract the installation directory from the archive, and place
<install_prefix>/bin
in your$PATH
(on all platforms) copy
<install_prefix>/share/sonar/extensions/plugins/*.jar
into the equivalent place in your SonarQube installation, and restart SonarQube
1.3. The 5-lines manual to GNATdashboard
GNATdashboard contains a driver program, GNAThub, which:
executes all GNAT tools and stores the results in a database
creates a configuration file for your project ready to use by sonar-scanner (
sonar-project.properties
)launches the sonar-scanner
The SonarQube Scanner is reading the results from the database created by the driver GNAThub.
For more information, the full manual is available at:
<install_prefix>/share/doc/gnatdashboard/html
<install_prefix>/share/doc/gnatdashboard/pdf
And online at https://docs.adacore.com/gnatdashboard-docs/.
1.4. Trying with an example
A complete example is provided at:
<install_prefix>/share/example/gnatdashboard/sdc
This contains an Ada project and a Makefile
which builds the project,
computes coverage information using Gcov, then launches the GNAThub driver.
The Makefile
also launches a Python script which does a simple textual
dump of the contents of the database - this is to demonstrate the scripting
capabilities of the GNATdashboard driver.