Sonarqube: Was ist das und warum sollte man es verwenden?

SonarQube ist ein universelles Tool für die statische Codeanalyse, das mehr oder weniger zum Industriestandard geworden ist. Mit SonarQube ist es auch viel einfacher, den Code sauber, einfach und leicht lesbar zu halten.

Haben Sie schon einmal von SonarQube gehört? Möchten Sie wissen, was es ist? Und wie man es verwendet? Und welche Vorteile es für die Produktionsphase der Softwareentwicklung bietet. Dann sind Sie hier richtig. In diesem Tutorial zu SonarQube werde ich Ihnen jeden Aspekt von SonarQube näherbringen.

Lasst 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, Code-Smells, Schwachstellen und Code-Duplikate liefert.

Es unterstützt über 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 Code-Duplikate und optimiert so die Lebensdauer von Anwendungen.
2. Steigern Sie die Produktivität – Reduziert den Umfang, die Wartungskosten und das Risiko der Anwendung. Dadurch entfällt die Notwendigkeit, mehr Zeit mit der Änderung des Codes zu verbringen.
3. Qualitätscode – Die Codequalitätskontrolle ist ein untrennbarer Bestandteil des Softwareentwicklungsprozesses.
4. Fehler erkennen – Erkennt Fehler im Code und weist Entwickler darauf hin, diese automatisch zu beheben, bevor sie zur Ausgabe übermittelt werden.
5. Erhöhen Sie die Konsistenz – Ermittelt, wo die Codekriterien verletzt werden und verbessert die Qualität
6. Skalierung des Geschäfts – Keine Beschränkung der Anzahl der zu evaluierenden Projekte
7. Verbessern Sie die Fähigkeiten der Entwickler – Regelmäßiges Feedback zu Qualitätsproblemen hilft Entwicklern, ihre Programmierkenntnisse zu verbessern

Warum SonarQube?

Entwickler müssen mit engen Fristen rechnen, um dem Kunden die erforderliche Funktionalität zu liefern. Für Entwickler ist dies so wichtig, dass sie häufig Kompromisse bei der Codequalität, potenziellen Fehlern, Code-Duplikationen und einer schlechten Verteilung der Komplexität eingehen.

Darüber hinaus neigen sie dazu, ungenutzte Variablen, Methoden usw. zurückzulassen. In diesem Szenario würde der Code wie gewünscht funktionieren.

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

Die Antwort ist NEIN.

Um diese Probleme im Code zu vermeiden, sollten Entwickler immer die guten Programmierpraktiken befolgen. Manchmal ist es jedoch nicht möglich, die Regeln einzuhalten und die gute Qualität aufrechtzuerhalten, da dies viele Gründe haben kann.

Um eine kontinuierliche Codeintegration und -bereitstellung zu erreichen, benötigen Entwickler ein Tool, das nicht nur einmal funktioniert, um den Code zu überprüfen und ihnen die Probleme darin mitzuteilen, sondern auch, um den Code zu verfolgen und zu steuern, um die kontinuierliche Codequalität zu überprüfen. Um all diese Anforderungen zu erfüllen, kommt SonarQube ins Spiel.

So richten Sie das SonarQube-Plugin ein und verwenden es

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

Voraussetzungen:

Die einzige Voraussetzung zum Ausführen von SonarQube ist, dass Java (Oracle JRE 11 oder OpenJDK 11) auf Ihrem Computer installiert ist. [ Details ]

Legen Sie die Systemvariable PATH fest: ( https://www.java.com/en/download/help/path.xml )[https://www.java.com/en/download/help/path.xml]

Hinweis: Um JavaScript-Code analysieren zu können, muss auf dem Computer, auf dem der Scan ausgeführt wird, Node.js >= 8 installiert sein. Wenn kein Standardknoten verfügbar ist, müssen Sie die Eigenschaft sonar.nodejs.executableauf einen absoluten Pfad zur ausführbaren Node.js-Datei setzen. [ Details ]

Downloads Sonarqube und Sonar Scanner:

• LTS-Version von Sonarqube ( https://www.sonarqube.org/downloads )
• Laden Sie den Sonar-Scanner basierend auf Ihrer Plattform herunter ( https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/ ). Fügen Sie nach dem obigen Vorgang den Pfad des Sonar-Scanners zu den Umgebungsvariablen hinzu.

Führen Sie den Sonarqube-Server aus:

• Um den Sonar-Server zu starten, öffnen Sie cmd oder Terminal, legen Sie den SonarQube-Bin-Ordnerpfad fest, wählen Sie die Plattform und führen Sie den folgenden Befehl aus. Beispiele:
• http://localhost:9000Sobald der Sonar-Server erfolgreich hochgefahren ist, melden Sie sich mit den Anmeldeinformationen des Systemadministrators an (Anmeldename=admin, Kennwort=admin).

Erstellen und Analysieren eines Projekts:

• Gehen Sie zu „Neues Projekt erstellen“, geben Sie den Projektschlüssel und die Anzeigenamendetails ein (+-Zeichen oben rechts).
• Stellen Sie ein Token bereit, indem Sie entweder ein Token generieren oder ein vorhandenes Token verwenden (vorhandenes Token finden Sie auf http://localhost:9000/account/securityder Seite).
• Führen Sie eine Analyse des Projekts durch, indem Sie die im Repository verwendete Programmiersprache und Ihr Systembetriebssystem 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. Er sieht wie folgt aus:

Nachdem die Analyse abgeschlossen ist, können Sie entweder den bereitgestellten Link durchsuchen, um den Sonarbericht direkt anzuzeigen [Beispiel: http://localhost:9000/dashboard?id=], oder zum Projektbereich 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 „Verwaltung“ und navigieren Sie zu den allgemeinen Einstellungen, wählen Sie die verwendete Programmiersprache aus und legen Sie eine Liste mit Dateipfadmustern fest, die von der Analyse ausgeschlossen werden sollen.

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

Mehr lesen: Was ist shadcn-ui? Ein tiefer Einblick in die moderne UI-Bibliothek

Fazit

Das Ziel von SonarQube ist es, Entwicklern in erster Linie mehr Möglichkeiten zu geben und eine offene Community rund um die Qualität und Sicherheit von Code aufzubauen. Ich hoffe, dass Sie mit diesem kurzen Tutorial zu SonarQube eine grundlegende Vorstellung der Funktionen bekommen haben. Wenn Sie das glauben, hinterlassen Sie einen Kommentar und zeigen Sie Ihre Unterstützung.