© Stefan Rinderle
Kontinuierliche Architekturanalyse

Softwarevisualisierung mit SonarQube in 3-D


Mithilfe von Visualisierungen können große und komplexe Softwaresysteme einfach und übersichtlich erscheinen. Durch Technologien wie WebGL lassen sich komplexe 3-D-Visualisierungen erzeugen, die im Browser für alle Projektbeteiligten verfügbar sind. Das in diesem Artikel beschriebene SonarQube-Plug-in SoftVis3D bietet neben der Darstellung der Software als „Code-City“ ein neues Konzept, um die Abhängigkeiten zwischen den Klassen des Projekts zu visualisieren.

Jede Visualisierungsform bietet einen bestimmten Blick auf die dargestellte Softwarekomponente. Leider wird bei der Vorstellung von neuen Ansätzen immer wieder ein konkretes Problem deutlich: der Kontext. Was ist damit gemeint? Die Darstellung sollte einen direkten Bezug zu bereits existierendem Wissen herstellen. Ein Beispiel: Die Navigation innerhalb einer Stadt ist durch eine entsprechende Kartendarstellung deutlich vereinfacht. Straßen werden rot oder gelb dargestellt, Wald und Wiesenflächen in grün und Stadtteile und Gebäude in grau. Trotz dieser einheitlichen Darstellung wirken diese Karten aber je nach Kontext. Machen Sie einen Versuch: Als Erstes betrachten Sie eine Karte Ihrer Heimatstadt und versuchen diese zu interpretieren. Danach versuchen Sie die Interpretation mit einer Ihnen unbekannten Stadt. In der Heimatstadt lassen sich durch frühere Erfahrungen viel schneller Zusammenhänge erkennen. Die Interpretation ist dadurch vereinfacht und bringt effektiver Probleme oder Risiken zum Vorschein. Bei der unbekannten Stadt hingegen werden Sie einen groben Überblick bekommen, eine Interpretation wird Ihnen aber nur schwer möglich sein.

Die Herausforderung, einen geeigneten Kontext zu erzeugen, liegt bei der zugrunde liegenden Datenbasis. Die Visualisierung sollte die bisherigen Erfahrungen bzw. die zur Verfügung stehenden Metriken widerspiegeln. Die statische Codeanalyse ist hier ein gutes Beispiel. Es ist wichtig, dass erkannte Fehler in der Entwicklungsumgebung, dem Build-Server und natürlich auch in der Visualisierung gleichermaßen sichtbar sind. Besteht hier ein Bruch in der Datenbasis, ist eine Interpretation deutlich schwieriger.

Viele sehr gute Ansätze scheitern gerade an dieser Hürde. Beispiele erscheinen sinnvoll und erzeugen ein hohes Interesse des Publikums, lassen sich aber nur sehr schwer oder gar nicht auf das selbst zu entwickelnde Projekt abbilden oder umsetzen. Damit wird der Effekt der Visualisierungsform durch den fehlenden Kontext deutlich geschwächt und der Interpretationsspielraum verringert.

Continuous Inspection mit SonarQube

SonarQube schließt eine entscheidende Lücke im modernen Entwicklungszyklus und hat sich als Plattform für das Management von Codequalität etabliert. Durch die einfache Integration und die Vielzahl an unterstützten Sprachen und Analysen lassen sich schnell erste Ergebnisse generieren. Diese helfen allen Projektbeteiligten, die Qualität der gelieferten Software zu überwachen und zu steuern. Gerade im Java-Umfeld ist die Integration von SonarQube in den Entwicklungsprozess einfach und unkompliziert. Die Analyse des Projekts mit Maven wird über den Continuous-Integration-Server gesteuert und ist danach sofort verfügbar. Das Jenkins-Plug-in von SonarQube erleichtert die Konfiguration und stellt Links zu den Ergebnissen des jeweiligen Builds zur Verfügung.

Was wird analysiert? Einerseits werden bei der Analyse des Projekts Basismetriken wie die Anzahl an Codezeilen oder die Anzahl der Funktionen pro Klasse erstellt. Zusätzliche zur Verfügung stehende Metriken, wie die Ergebnisse der Unit Tests und der Codeabdeckung, werden einfach über Plug-ins integriert. Bestehende Konfigurationen von statischen Codeanalysetools wie PMD, FindBugs oder Check­style können ebenfalls eingebunden werden. Es entsteht schnell ein über alle Ebenen einheitlicher Blick auf die Softwarequalität.

Einsatzbeispiel Quality Gates

SonarQube bietet nicht nur die Möglichkeit, die Ergebnisse der Analysen über die Zeit zu betrachten und zu analysieren. „Quality Gates“ ermöglichen es dem Entwicklungsteam, sich auf bestimmte Qualitätsmerkmale zu fokussieren und den eigenen Anspruch zu erfüllen. Beispielsweise einigt sich das Team darauf, dass die statische Codeanalyse keine Probleme mit der Stärke (Severity) Major oder höher aufweisen darf und alle Unit Tests erfolgreich sein müssen. Zudem ist ein zeitlicher Bezug möglich, was die Definition gerade für Wartungsprojekte oder Legacy-Software vereinfacht. Ein Beispiel hierfür wäre, dass neu geschriebener Code eine Testabdeckung von mindestens 80 Prozent aufweisen muss, oder die Testabdeckung seit der letzten Analyse nicht sinken darf.

Ob die Software der geforderten Qualität entspricht, wird bei jeder Analyse berechnet. Durch das Plug-in...

headline from sands settings