Wie funktioniert SonarQube?

SonarQube besteht aus drei Komponenten

1. Einem Modul für Build-Management-Tools wie Apache Maven oder Apache Ant. (Hauptsächlich für die Analyse des Quelltextes hinsichtlich verschiedener Qualitätsmerkmale.)
2. Einer Datenbank, für Speicherung der Ergebnisse der Qualitätsanalyse.
3. Einer Website für die visuelle Darstellung, Auswertung und das Management der Qualitätsanalyse-Ergebnisse.

Durch diese Architektur kann man sowohl eine Prüfung des Quelltextes auf dem Entwicklungsrechner ermöglichen als auch eine Einbindung von SonarQube in den Entwicklungsprozess gewährleisten. Dies unterstützt die Ermittlung der Qualitätsmetriken auf einem Build-Server für die kontinuierliche Integration.

SonarQube analysiert den Quelltext hinsichtlich der Abdeckung durch Modultests, checkt den Quellcode nach doppeltem Code und in Bezug auf die Komplexität. Auch werden unter anderem potenzielle Fehler im Code, Kodier-Richtlinien als auch Kommentare überprüft.

Modularer Aufbau und Erweiterungen

SonarQube ist modular aufgebaut und integriert selbst einige bekannte Entwicklungswerkzeuge zur Analyse der Codequalität, darunter PMD und Checkstyle für die Erkennung von doppeltem Code für die Prüfung von Kodier-Richtlinien. Damit wird unter anderem auch nach ineffizientem Code gesuche. FindBugs dient beispielsweise zum Aufdecken potenzieller Fehler sowie Surefire und Cobertura zur Messung der Qualität der Modultests.

Diese Werkzeuge nutzen entsprechend ihrer Natur und Einsatzgebiete Metriken, um die jeweiligen Auswertungen bzw. Statistiken zu erzeugen. Der Name „Metrik“ trägt jedoch wenig Bedeutung von dem in sich, was eine Metrik ausmacht. Schlägt man nämlich nach woher der Name kommt, landet man im Lateinischen: „ars metrica„, die Lehre von den Maßen. Fragt man jedoch das Institute of Electrical and Electronics Engineers, was eine Softwaremetrik ist, erhält man folgende Antwort:

„software quality metric: A function whose inputs are software data and whose output is a single numerical value that can be interpreted as the degree to which software possesses a given attribute that affects its quality.“ „Eine Softwarequalitätsmetrik ist eine Funktion, die eine Software-Einheit in einen Zahlenwert abbildet, der als Erfüllungsgrad einer Qualitätseigenschaft der Software-Einheit interpretierbar ist.“ – IEEE Standard 1061, 1998

Folglich bedeutet dies, dass es sich bei einer Metrik am Ende des Tages um eine Funktion handelt, die für beliebige Eingaben Zahlen erzeugt. Die Beschaffenheit ist so, dass sie, nur so 

lange sie von derselben Funktion erzeugt wurden, vergleichbar sind. Dadurch kann man Rückschlüsse auf die Eingabe mit Hinblick auf die Funktion erzielen.

Ein Beispiel dafür ist die McCabe-Metrik, auch zyklomatische Komplexität genannt. Diese sehr grundlegende Metrik berechnet die Anzahl der unterschiedlichen Pfade durch ein Stück Code. Die Formel ist relativ einfach: Es wird die Anzahl an Kontrollstrukturen wie if, while, case und boolescher Operatoren wie && und || summiert und nochmals mit 1 addiert. Möchte man diese Information nochmals anhand eines Beispiels betrachten, sieht es folgendermaßen aus:

String nameDesWochenTags(int nr) {
  switch(nr) {
    case 1: return "Montag";
    case 2: return "Dienstag";
    case 3: return "Mittwoch";
    case 4: return "Donnerstag";
    case 5: return "Freitag";
    case 6: return "Samstag";
    case 7: return "Sonntag";
  }
  return "";
}

Diese relativ einfache Methode gibt den Namen eines Wochentages entsprechend seiner 1-indizierten Position innerhalb der Woche zurück. Ihre zyklomatische Komplexität beträgt 8. Zumal 1 + 7 x case. Dies ist ein verhältnismäßig hoher Wert. Ein Maximalwert von 10 gilt als allgemein akzeptiert und ausreichend erprobt. Um also die Komplexität dieser Methode zu verringern, findet eine Refaktorisierung statt, die folgendermaßen aussehen kann:

String nameDesWochenTags(int nr) {
  String[] names = new String[] {
    "Montag", "Dienstag", "Mittwoch",
    "Donnerstag", "Freitag", "Samstag",
    "Sonntag"
  };
  if(nr) > 0 && <= names.length) {
    return names[nr - 1];
  }
  return "";
}

Die zyklomatische Komplexität dieser Methode beträgt 3. Zumal 1 + 1 x if + 1 x &&. Durch den unterschiedlichen Ansatz kann man die Komplexität verringern. Dennoch ist es relativ unstrittig, dass die erste Version leichter zu verstehen ist.

Will man nun also alle Tools gemeinsam benutzen, muss man alle konfigurieren und ihre Ergebnisse zusammenführen, damit sich ein Gesamtbild darstellen lässt. Außerdem kommt es dabei zwangsweise zu Dopplungen in ausgewerteten Metriken oder anderen Kennzahlen. PMD beispielsweise besitzt durch seinen relativ vagen Aufgabenbereich Überschneidungen im Hinblick auf Codestil mit checkstyle, während es aber auch genauso wie FindBugs auf toten Code achtet. An solchen und weiteren Stellen kann SonarQube Verbesserungen herbeiführen.

Neben der visuellen Anzeige der Ergebnisse der einzelnen Bereiche, ermöglicht SonarQube das Drill-Down der Ergebnisse bis auf die einzelne Metrik und Codezeile sowie die Verknüpfung der einzelnen Metriken sowie die Darstellung ihrer historischen Entwicklung in einer recht übersichtlichen grafischen Oberfläche.

Über einen ausgeklügelten Plugin-Mechanismus ist eine relativ einfache Integration von Erweiterungen möglich. Neben den Erweiterungen für die Analyse zusätzlicher Programmiersprachen gibt es Plugins für ergänzende Metriken, Governance, Schnittstellen zu Entwicklungsumgebungen, Visualisierungen, Integration sowie zur Berechnung der technischen Schuld(en).

Fazit

Ich arbeite noch nicht so lange mit SonarQube. Um genau zu sein, habe ich es mir erst heute das erste Mal angeschaut. Zusammenfassend kann ich folgendes sagen:

Statistiken sind zwar interessant und es kann Spaß machen, sich diese anzuschauen, doch ist eine statische Codeanalyse erst dann wirklich vollständig, wenn ein Mindestmaß an Interpretation hineingeflossen ist.

Die Codeanalyse liefert ein gutes Gefühl für die Codebasis. Erst so kann man fundierte Aussagen darüber treffen, welche Bereiche des Projekts besonders gefährdet, instabil oder verbesserungsfähig sind.

Regelmäßige Analysen können die Teammotivation erhöhen. Eine positive Issuebilanz am Ende eines Sprints und aufwärtszeigende Historiengraphen sollten gute Treiber für eine Gruppe Entwickler und ein Beweis für die eigene Leistung sein.

Alles in allem sind Analyseergebnisse immer gut als Argumentationsgrundlage. Mit Hilfe der Projekthistorie, die eine Auswahl gut darstellbarer Kennzahlen beinhaltet, kann man vor Kunden oder Entscheidern besser über ein eventuell nötiges technisches Release diskutieren.

Der Beitrag SonarQube – Das Code-Qualitätsmanagement-Tool erschien zuerst auf CEOsBay.

Kurze Zeitreise

Es wurde 1999 von Netscape Communications entwickelt. Damals stand die Abkürzung für RDF Site Summary, eine Technologie, die im Rahmen des individualisierbaren Nachrichtenangebots My Netscape Network zum Einsatz kam. Bereits ein Jahr später wurde das Ressource Description Framework (RDF) durch ein einfacheres XML-Format ersetzt, was eine Umdeutung der Abkürzung RSS in Rich Site Summary zur Folge hatte. Siehe meinen Beitrag über XML. Mit der Version 2.0 wurde dann die Bezeichnung Really Simple Syndication eingeführt. Als Nachfolger gilt das daran angelehnte Format Atom. Dies thematisiere ich dann in einem zukünftigen Beitrag.

Solche Dienste waren in den späteren 2000er-Jahren populär und meist auf speziellen Service-Websites vorzufinden, sogenannten RSS-Channels. Ein solcher gewöhnlicher Channel versorgt den Adressaten, ähnlich einem Nachrichtenticker, mit kurzen Informationsblöcken, die aus einer Schlagzeile mit Textanriss und einem Link zur Originalseite bestehen. Zunehmend werden aber auch komplette Inhalte klassischer Webangebote ergänzend als Volltext-RSS bereitgestellt.

Durchsetzen konnte es sich um das Jahr 2005. Besonders durch den Blog Hype, da die meisten Autoren sehr früh RSS-Feeds für ihre Artikel anboten und viele Blogs diese automatisch generierten und es heute noch machen. Ursprünglich ging es dabei vor allem um Text. In der zweiten Hälfte der 2000er wurden auch Podcasts darüber verbreitet, die dann z. B. auf mobile Endgeräte geladen wurden und bis heute noch geladen werden.

Die Bereitstellung von Daten im RSS-Format bezeichnet man auch als RSS-Feed, von engl. to feed – im Sinne von füttern, einspeisen, zuführen. Wenn ein Benutzer einen Channel abonniert hat, so sucht der Client in regelmäßigen Abständen beim Server nach Aktualisierungen im RSS-Feed.

Wie funktioniert ein RSS-Feed?

Wenn man einen RSS-Feed abonniert, kann man die Nachrichten mit einem Feedreader einlesen. Als Abonnent kann man sich dann den (in vielen Feeds enthaltenen) Inhalt direkt anzeigen lassen oder den angebotenen Links folgen und die vollständige Meldung der verlinkten Seite lesen. Die Adresse eines RSS-Feeds entspricht dem Aufbau einer URL, wie sie auch für Webseiten verwendet wird.

Zum Lesen eines RSS-Feeds dienen spezielle Programme, die auf die Ähnlichkeit zum Nachrichtenticker angepasst sind. Diese nennt man (synonym) RSS-Aggregatoren, RSS-Reader oder Feedreader. Einige E-Mail-Programme bieten oder boten RSS-Lesefunktionen, teils via Plugins, an. Früher unterstützten einige populäre Webbrowser dies ebenfalls. Neben diesen nutzte man auch Anwendungen, die wie als Bildschirmschoner agierten. Statt umherfliegende Seifenblasen oder prozedural generierte Rohrsysteme, bekam man dann eben bei Inaktivität die abonnierten Feeds angezeigt.

Im Unterschied zur Benachrichtigung per E-Mail geht die Initiative bei RSS vom Empfänger aus, der den Feed abonniert hat. Dies bedeutet, dass der Anbieter die Leser nicht auswählen kann, sich im Gegenzug aber auch nicht um eine Verwaltung des Leserstammes (zum Beispiel mit einer Mailinglisten-Software) kümmern muss. Der Leser muss nicht offenlegen, dass er die Quelle beobachtet, und kann Quellen wesentlich leichter abonnieren bzw. das Abonnement widerrufen, indem er einfach die Einstellung in seinem Aggregator vornimmt.

Es vereinfacht die Beobachtung einer großen Menge von Quellen wie z. B. Blogs, in denen es eher selten zu Änderungen kommt, deren Aktualisierung der Leser aber ggf. nicht verpassen möchte.

Syndikation

Da Inhalte via RSS in einem standardisierten Format vorliegen, eignen sie sich auch für die maschinelle Weiterverarbeitung. So lassen sich damit beispielsweise Texte einer Webseite automatisch mit Hilfe eines Parsers in eine andere Webseite integrieren oder sehr einfach auf verschiedenen Endgeräten speziell aufbereitet darstellen.

Das Aufbereiten von Informationen in ein standardisiertes Austauschformat/-objekt nennt man auch Aggregation, das Veröffentlichen auf anderen Seiten Content-Syndication. Websites können damit automatisch mit den neuesten Nachrichten aktualisiert werden, ohne dass der Seitenbetreiber jeweils eine Aktualisierung vornehmen muss. Eine Reihe von Content-Management-Systemen wie WordPress unterstützen diese Funktionalität. Auch dieser Blog wurde mit WordPress erstellt.

Fazit

Wenn man lediglich ein paar Webseiten gerne regelmäßig mehrmals in der Woche liest, dann kann die Nutzung eines RSS-Feeds etwas übertrieben sein. Für Vielleser führt jedoch weiterhin kein sinnvoller Weg an Rich Site Summary und einem RSS-Reader vorbei.

Der Beitrag RSS – Immer auf dem Laufenden bleiben erschien zuerst auf CEOsBay.