Difference between revisions of "SonarQube"

From Embedded Lab Vienna for IoT & Security
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 29: Line 29:
Sofern mit den Default-Settings weiter gemacht werden kann müssen für den ersten Test keine weiteren Änderungen getroffen werden.
Sofern mit den Default-Settings weiter gemacht werden kann müssen für den ersten Test keine weiteren Änderungen getroffen werden.
Nun kann aus dem Sonarscanner Ordner das CMD geöffnet werden. Der Scanner kann getestet werden mit: sonar-scanner.bat -h.
Nun kann aus dem Sonarscanner Ordner das CMD geöffnet werden. Der Scanner kann getestet werden mit: sonar-scanner.bat -h.


=== Step 3 ===
=== Step 3 ===
Line 51: Line 52:
[[File:Projects.jpg]]
[[File:Projects.jpg]]


Fühlt Parameter aus wie Projektname und Token-Name und kann dann sich den fertigen Befehl zum ausführen generieren lassen.
[[File:generate.jpg]]


* War and Peace
Diesen fertigen Befehl führt man im CMD aus dem Ordner in dem das Projekt liegt aus. Hier z.B.
* Lord of the Rings
sonar-scanner.bat -D"sonar.projectKey=test123" -D"sonar.sources=." -D"sonar.host.url=http://localhost:9000" -D"sonar.login=sqp_bca0809d04f7c5dd53babb9e4c57c3312ed46eab"
* The Baroque Cycle
 
== Used Hardware ==
 
[[Device to be used with this documentation]]
[[Maybe another device to be used with this documentation]]


== Courses ==
Der Output im CMD schaut wie folgt aus:
[[File:Befehl.jpg]]


* [[A course where this documentation was used]] (2017, 2018)
Am SonarQube Server kann man sich weiter Details zur Analyse anschauen.
* [[Another one]] (2018)
[[File:Test2.jpg]]


== References ==
== References ==


* https://wikipedia.org
* https://docs.sonarqube.org/latest
* https://google.com


[[Category:Documentation]]
[[Category:Documentation]]

Latest revision as of 17:39, 27 January 2023

Summary

Diese Dokumentation bezieht sich darauf, eine erst Installation und die Basis-Funktionen von SonarQube, zu erklären.

Requirements

  • Operating system: Windows
  • Packages: sonarqube-9.8.0.63668.zip
  • Packages: sonar-scanner-cli-4.7.0.2747-windows.zip


Description

Step 1

Im ersten Schritt kann man über die Seite: https://www.sonarsource.com/products/sonarqube/downloads/.

Den Installer für den Server runterladen und dieses entpacken. Danach können hier: <SONARQUBE_HOME>/conf/sonar.properties die Datenbank settings angepasst werden. Man kann auch mit den Default Einstellungen weiter arbeiten. Sofern man mit den Defaulteinstellungen weiter machen kann, muss nur mehr noch im letzten Schritt unter diesem Pfad:<SONARQUBE_HOME>/bin/windows-x86-64/StartSonar.bat der Server gestartet werden und mit http://localhost:9000 aufgerufen werden. Mit Username:admin und Passwort:admin kann man sich das erste mal einloggen.


Step 2

Sonarscanner installieren.

Der Scanner kann von der Folgenden Seite runtergeladen werden:https://docs.sonarqube.org/latest/analyzing-source-code/scanners/sonarscanner/. Sofern mit den Default-Settings weiter gemacht werden kann müssen für den ersten Test keine weiteren Änderungen getroffen werden. Nun kann aus dem Sonarscanner Ordner das CMD geöffnet werden. Der Scanner kann getestet werden mit: sonar-scanner.bat -h.


Step 3

Sonar properties für das Projekt definieren.

Im letzten Setup Schritt muss nun im Projekt Ordner, von dem Ziel-Projekt welches analysiert gehört, eine Datei mit dem Namen: sonar-project.properties In diesem Ordner können Eigenschaften definiert wie: sonar.projectKey=python sonar.projectName=python sonar.projectVersion=1.0

sonar.sources= C:/Users/Robert/source/repos/python

Wichtig ist hier, dass unter dem Punkt sonar.sources der genau Projekt Pfad angeben wird.

Step 4

Analyse

Nun kann man auf der GUI des SonarQube-Servers unter Projects, ein neues Project erstellen. Projects.jpg

Fühlt Parameter aus wie Projektname und Token-Name und kann dann sich den fertigen Befehl zum ausführen generieren lassen. Generate.jpg

Diesen fertigen Befehl führt man im CMD aus dem Ordner in dem das Projekt liegt aus. Hier z.B. sonar-scanner.bat -D"sonar.projectKey=test123" -D"sonar.sources=." -D"sonar.host.url=http://localhost:9000" -D"sonar.login=sqp_bca0809d04f7c5dd53babb9e4c57c3312ed46eab"

Der Output im CMD schaut wie folgt aus: Befehl.jpg

Am SonarQube Server kann man sich weiter Details zur Analyse anschauen. Test2.jpg

References