Sonarqube: Was es ist und warum es zu benutzen?

Haben Sie schon einmal von SonarQube gehört? Möchten Sie wissen, was es ist? Und wie benutzt man es? Und seine Vorteile für die Produktionsphase der Softwareentwicklung. Dann sind Sie an der richtigen Stelle; in diesem Tutorial von SonarQube, Ich werde Ihnen eine exemplarische Vorgehensweise für jeden Aspekt von SonarQube geben.

Lass uns eintauchen!!!

Was ist SonarQube?

SonarQube ist eine von SonarSource entwickelte Open-Source-Plattform zur kontinuierlichen Überprüfung der Codequalität. Sonar führt eine statische Codeanalyse durch, die einen detaillierten Bericht über Fehler, Codegerüche, Schwachstellen und Codeduplikationen liefert.

Es unterstützt mehr als 25 wichtige Programmiersprachen durch integrierte Regelsätze und kann auch mit verschiedenen Plugins erweitert werden.

Vorteile von SonarQube

1. Nachhaltigkeit – Reduziert Komplexität, mögliche Schwachstellen und Codeduplikationen und optimiert die Lebensdauer von Anwendungen.
2. Steigerung der Produktivität – Reduziert den Umfang, die Wartungskosten und das Risiko der Anwendung; somit entfällt die Notwendigkeit, mehr Zeit mit dem Ändern des Codes zu verbringen
3. Qualitätscode – Die Codequalitätskontrolle ist ein untrennbarer Bestandteil des Softwareentwicklungsprozesses.
4. Fehler erkennen – Erkennt Fehler im Code und warnt Entwickler, diese automatisch zu beheben, bevor sie zur Ausgabe gesendet werden.
5. Erhöhen Sie die Konsistenz – Bestimmt, wo die Code-Kriterien verletzt werden und verbessert die Qualität
6. Business Scaling – Keine Beschränkung der Anzahl der zu bewertenden Projekte
7. Verbessern Sie die Fähigkeiten der Entwickler – Regelmäßiges Feedback zu Qualitätsproblemen hilft Entwicklern, ihre Programmierkenntnisse zu verbessern

Warum SonarQube?

Entwickler, die mit harten Fristen arbeiten, um dem Kunden die erforderliche Funktionalität zu liefern. Es ist so wichtig für Entwickler, dass sie oft mit der Codequalität, potenziellen Fehlern, Code-Duplikaten und einer schlechten Verteilung der Komplexität Kompromisse eingehen.

Außerdem neigen sie dazu, ungenutzte Variablen, Methoden usw. zu belassen. In diesem Szenario würde der Code auf die gewünschte Weise funktionieren.

Denken Sie, dass dies ein geeigneter Weg ist, um Funktionalität bereitzustellen?

Die Antwort lautet NEIN.

Um diese Probleme im Code zu vermeiden, sollten Entwickler immer die gute Codierungspraxis befolgen, aber manchmal ist es nicht möglich, die Regeln zu befolgen und die gute Qualität beizubehalten, da es viele Gründe geben kann.

Um eine kontinuierliche Code-Integration und -Bereitstellung zu erreichen, benötigen Entwickler ein Tool, das nicht nur einmal funktioniert, um die Probleme im Code zu überprüfen und mitzuteilen, sondern auch den Code zu verfolgen und zu kontrollieren, um die kontinuierliche Codequalität zu überprüfen. Um all diese Anforderungen zu erfüllen, kommt hier SonarQube ins Bild.

Einrichten und Verwenden des Sonarqube-Plugins

In diesem Abschnitt werden die Schritte oder Verfahren zum Konfigurieren des Sonarqube-Plugins für alle wichtigen Programmiersprachen erläutert.

Voraussetzungen:

Die einzige Voraussetzung für die Ausführung von SonarQube ist, dass Java (Oracle JRE 11 oder OpenJDK 11) auf Ihrem Computer installiert ist.

Setzen Sie die Systemvariable PATH: (https://www.java.com/en/download/help/path.xml)

Hinweis: Um JavaScript-Code zu analysieren, benötigen Sie Node .js >= 8 auf dem Computer installiert, auf dem der Scan ausgeführt wird. Wenn kein Standardknoten verfügbar ist, müssen Sie die Eigenschaft sonar.nodejs.executable auf einen absoluten Pfad zum Knoten setzen.js ausführbar.

Sonarqube und Sonarscanner herunterladen:

Sonarqube Server ausführen:

Projekt erstellen und analysieren:

• Gehen Sie zu Neues Projekt erstellen, geben Sie den Projektschlüssel ein und zeigen Sie die Namensdetails an. (+ Zeichen oben rechts).
• Stellen Sie ein Token bereit, indem Sie entweder ein Token generieren oder ein vorhandenes Token verwenden (vorhandenes Token finden Sie auf der Seite http://localhost:9000/account/security).
• Führen Sie die Analyse des Projekts durch, indem Sie die im Repository verwendete Programmiersprache und das Betriebssystem Ihres Systems auswählen.
• Da wir den Sonar-Scanner-Pfad bereits heruntergeladen und eingerichtet haben, müssen Sie ihn nicht erneut herunterladen.

• Kopieren Sie nun den angezeigten Befehl, gehen Sie zu Ihrem Projektpfad und führen Sie den kopierten Befehl aus. Es sieht aus wie unten:

  sonar-scanner.bat -D"sonar.projectKey=rtetre" -D"sonar.sources=."-D"sonar.host.url=http://localhost:9000" -D"sonar.login=e932dxxxxx9a8e5c7903xxxxxx96928xxxxxxx"

Nach Abschluss der Analyse können Sie entweder den bereitgestellten Link durchsuchen, um den Sonarbericht direkt anzuzeigen, oder zum Abschnitt Projekt gehen, um den neu generierten Sonarbericht Ihres Projekts anzuzeigen.

Wenn Sie einige Dateien von der Analyse ausschließen möchten (z. B. Testdateien), gehen Sie zum Abschnitt Administration und navigieren Sie zur allgemeinen Einstellung, wählen Sie die verwendete Programmiersprache aus und legen Sie eine Liste der Dateipfadmuster fest, die von der Analyse ausgeschlossen werden sollen.

Führen Sie nun den oben angegebenen Analysebefehl erneut aus, um einen aktualisierten Sonarbericht zu erhalten.

Fazit