Verybench: grafisches Frontend für Testwell CMT++ Code Complexity Measures Tool

Transkript

1 Verybench: grafisches Frontend für Testwell CMT++ Code Complexity Measures Tool Testwell CMT++ ist ein von der finnischen Firma Testwell Oy ( entwickeltes konsolenbasiertes Werkzeug zur Messung der Komplexität von C- und C++-Code. Das Tool berechnet McCabes Cyclomatic Number, Lines-of-Code- sowie Halstead-Metriken und den Wartbarkeitsindex (Maintainability Index). Die Ausgabe der Text-, HTML-, XML- und CSV-Reporte erfolgte bisher in tabellarischer Form und ohne weitere Aufbereitung (siehe Abbilidungen 1 und 2). Abb. 1: Testwell CMT++ HTML-Report Abb. 2: Testwell CMT++ Text-Report Mit Verybench, einem bei Verifysoft Technology ( entwickeltem Frontend für Testwell CMT++ werden die Ausgabemöglichkeiten erheblich erweitert. Verybench ermöglicht das Generieren von Metriken über eine grafische Benutzeroberfläche (GUI), stellt die gewonnenen Kennzahlen visuell dar und bietet hierfür verschiedene Ausgabeformate. Da die unterschiedlichen an der Softwareentwicklung beteiligten Personengruppen in der Regel spezielle an ihre jeweiligen Bedürfnisse angepaßten Auswertungen der generierten Metriken benötigen, bietet Verybench vier verschiedene Sichten mit entsprechend angepaßten Reporten: Management-Sicht Controlling-Sicht Review-Sicht und Development-Sicht. Zusätzlich lassen sich Verybench PDF-Reporte mit einer aussagekräftigen Darstellung der Daten für jede dieser Sichten erzeugen. Vorhandene Abweichungen von den Qualitätsvorgaben werden somit schnell erkannt. Zur Ausgabe der CMT++-Metriken, die über das CMT++-Backend im Hintergrund generiert werden, interagiert der Nutzer nur mit Verybench. Ebenfalls werden die zu messenden Dateien über Verybench ausgewählt. Das Frontend ermöglicht es, alle von Testwell CMT++ unterstützten Reporte (Text, HTML, CSV, XML Short Report, XML Long Report) zu generieren. Verybench liest den von Testwell CMT++ erzeugten XML-Long-Report ein und zeigt die eingelesenen Messwerte mit Hilfe von unterschiedlichen Diagrammen im Frontend an. Je nach Bedarf kann der Nutzer aus den erzeugten Diagrammen PDF-Reporte generieren oder die einzelnen Diagramme als Bild abspeichern und in eigene Dokumente einbauen. Abbildung 3 zeigt das Gesamtsystem Testwell CMT++ mit Verybench.

2 Abb. 3: Testwell CMT++ und Verybench Gesamtsystem Verybench-GUI Die Verybench-Benutzeroberfläche ist in zwei Hauptbereiche unterteilt (siehe Abbildung 4): Navigationsleiste (1) für Navigation und Aktionen innerhalb eines Projektes sowie Ausgabebereich (2). Der Ausgabebereich besteht aus den vier Sichten (Management, Controlling, Review und Development), die über Tabs eingeblendet werden können. Abbildung 4: Aufteilung der GUI

3 Reporte Im Bereich Reports der Benutzeroberfläche werden die bereits erzeugten Reporte des aktuellen Projektes angezeigt. Sichtbar sind jeweils die Reporte der gerade ausgewählten Session sowie die sessionunabhängigen Reporte. Über die Icon-Leiste lassen sich neue Reporte generieren. Zum Generieren eines HTML-, XML-, Text- oder CSV-Reports muss die letzte Report- Session, deren Source-Dateien seit der Erzeugung der Session nicht verändert wurden, ausgewählt werden. Entspricht die neueste Session nicht dem aktuellen Stand der Source- Dateien, wird eine Dialogbox angezeigt, die den Benutzer auffordert eine neue Session zu erzeugen. Die Erzeugung eines PDF-Reports kann jederzeit aus den Daten jeder Session erfolgen, da hierfür die Source-Dateien des Projektes nicht mehr benötigt werden. Verybench kann vier verschiedene PDF-Reporte für die jeweiligen Sichten aus dem Rollenmodell erzeugen. Zum Erzeugen eines PDF-Reports muss der Benutzer zunächst die gewünschte Report- Session, also den Stand des Projektes auswählen und die Sicht öffnen deren Inhalt in die PDF-Datei geschrieben werden soll. Nach dem Klicken auf den PDF-Icon im Report-Bereich oder über das Navigationsmenü des Frames wird dann ein PDF-Report erzeugt und in der Report-Liste angezeigt. Durch einen Klick auf einen Eintrag in der Liste wird dann der ausgewählte Report im Standard-Viewer des Betriebssystems angezeigt. Alarme Der Bereich in der Navigationsleiste mit der Überschrift Alarms zeigt eine Zusammenfassung der berechneten Metriken einer Report-Session an. Hier wird der Anteil der Dateien und der Funktionen angegeben, die für eine bestimmte Metrik außerhalb der gesetzten Limits liegen. Hinter dieser Prozentzahl wird in Klammern die Anzahl der alarmierten Dateien oder Funktionen und deren Gesamtanzahl angegeben. Development-Sicht Entwickler haben ein detailliertes Wissen ihres Sourcecodes und möchten die Qualität ihrer Arbeit messen um eventuelle Verbesserungen am Code durchführen zu können. Oft benötigt der Entwickler ebenfalls detailliertes Wissen über den Code anderer Entwickler um diesen zu erweitern oder Fremdsoftware zu bewerten. Hierfür sind die Metriken der einzelnen Dateien und Funktionen des Projekt sowie eine Sicht auf den zugehörigen Quellcode notwendig. Die Development-Sicht verfügt deshalb über einen Tree-Table, der alle analysierten Dateien und Funktionen einer Report-Session sowie die zugehörigen Ergebnisse der Messungen anzeigt. Abbildung 5 zeigt Verybench mit ausgewähltem Development-Tab. Im Tree-Table der Development-Sicht werden alle Messwerte, die nicht innerhalb der vorgegebenen Limits liegen, durch leuchtende Birnchen gekennzeichnet. Die Spalte Alarms und die Metriken LOCpro und LOCcom werden zusätzlich durch Progress-Bars visualisiert. Diese zeigen den Anteil der berechneten Werte in einer Funktion oder Datei die ausserhalb der vorgegebenen Limits liegen sowie den Anteil von Kommentarzeilen und Programmcodezeilen im Verhältnis zur Gesamtzeilenanzahl. Beim Öffnen der Development-Sicht wird der Baum des Tree-Table zunächst auf Datei- Ebene angezeigt. Durch Anklicken einer bestimmten Datei kann in eine detailliertere Sicht gewechselt werden, in der zusätzlich die Funktionen dieser Datei angezeigt werden. Beim Auswählen einer Datei oder Funktion wird unterhalb des Tree-Tables der zugehörige Code eingeblendet. Im Fall einer Funktion wird der Code automatisch zu der ausgewählten Funktion gescrollt.

4 . Abbildung 5: Development-Sicht Drückt der Benutzer bei geöffneter Development-Sicht auf den Create Pdf Report -Button wird ein PDF-Report generiert, der den gerade angezeigten Tree-Table und die Daten, die im Bereich Alarms stehen, beinhaltet (siehe Abbildung 6). Abbildung 6: PDF-Report aus den Daten der Development-Sicht

5 Review-Sicht Zur Vorbereitung eines Code-Reviews sollten kritische Bereiche eines Moduls identifiziert werden, die bei der Überprüfung besonderer Beachtung bedürfen. In der Review-Sicht werden deshalb nur die Dateien einer Report-Session gezeigt, die nicht innerhalb der vorgegebenen Alarm-Limits liegen. Management-Sicht Die Management-Sicht (Abbildungen 7 und 8) gibt einen schnellen Überblick über den Entwicklungsstand und die Qualität des Projektes. Die Übersicht störende Einzelheiten werden in dieser Sicht nicht angezeigt. Die Durchschnittswerte der Metriken aller Quelldateien einer Session werden in einem Kiviat-Diagramm dargestellt. Abbildung 7: Management-Sicht (1) Zusätzlich werden für alle Metriken Säulendiagramme angelegt, die die Verteilungen der Metriken auf Funktions-Ebene zeigen. Hiermit lassen sich Tendenzen innerhalb der Metrikenwerte erkennen. Unter anderem wird sichtbar, ob die meisten Werte gerade noch im gültigen Bereich liegen oder gleichmäßig verteilt sind. Funktionen, die außerhalb der gesetzten Limits liegen, werden rot markiert. Anhand des Kiviat-Diagramms (Abbildung 7) ist sofort erkennbar, dass das gerade geöffnete Projekt unzureichend kommentiert ist. An dem Säulendiagramm der Komplexitätszahl v(g) sieht man, dass die meisten Funktionen eine Komplexität von 1 haben und die Funktionen allgemein zu einer niedrigen Komplexität neigen. Der Grund für die niedrige Komplexität wird bei Betrachtung des Säulendiagramms mit der Anzahl der Programmcode-Zeilen pro Funktion deutlich. Man sieht, dass das Projekt aus vielen kleinen Funktionen mit lediglich vier bis acht Zeilen Programmcode besteht.

6 Abbildung 8: Management-Sicht (2) Controlling-Sicht Die Controlling-Sicht ermöglicht es, Statistiken über mehrere Report-Sessions zu erzeugen und die zeitliche Entwicklung der Komplexität eines Projektes zu verfolgen. Es können Statistiken auf der Basis der Summary- oder Durchschnittswerte einer Report- Session sowie für Werte einer bestimmten Funktion erzeugt werden. Die Metriken werden durch Säulendiagramme visualisiert (Abbildung 9). Abbildung 9: Controlling-Sicht

7 Die Controlling-Sicht besteht im Gegensatz zu den anderen Sichten aus zwei Bereichen. Im linken Bereich werden ausgewählte Statistiken angezeigt. Auswahl und Erzeugen von Statistiken erfolgt im rechten Bereich. Dort werden in einem Baum bereits erzeugte Statistiken angezeigt, die über die Icon-Leiste gelöscht werden können. Drückt der Benutzer den Icon zum Erstellen einer Statistik, wird eine Dialog-Box zum Erstellen von Statistiken geöffnet (siehe Abbildung 10). Abbildung 10: Dialog-Box zum Erzeugen von Statistiken In der ersten Ebene wird der Name der Statistik eingetragen und ausgewählt über welche Metrikenwerte die Statistik aufgebaut werden soll. Zur Auswahl stehen die Summary- und Durchschnittswerte einer Session oder die Werte einer bestimmten Funktion. In der zweiten Ebene der Dialogbox kann ausgewählt werden welche Sessions verglichen werden sollen. Die dritte Ebene wird nur dann eingeblendet, wenn in der ersten Ebene eine Funktion zum Vergleichen der Werte ausgewählt wurde. Dort kann dann eine Funktion des Projektes ausgewählt werden. Um einen PDF-Report einer bestimmten Statistik zu erzeugen, muss diese ausgewählt werden und der Create Pdf Report -Button im Bereich Reports gedrückt werden. Der PDF-Report der Controlling-Sicht besteht aus jeweils einer Tabelle pro Report-Session und allen in der Statistik enthaltenen Diagrammen. Die Tabellen zeigen die Anzahl alarmierter Dateien und die eingestellten Limitwerte für die jeweilige Session. Abb. 11: PDF-Report einer Statistik der Controlling-Sicht

8 Abbildung 12: PDF-Report einer Statistik der Controlling-Sicht Copyright 2009: Verifysoft Technology GmbH Stand: Testwell CMT++ is a product of Testwell Oy, Tampere (Finland) Verybench is a product of Verifysoft Technology GmbH, Offenburg (Germany) Verifysoft Technology GmbH bedankt sich bei Eugenia Drosdezki, Konstantin Schuraev, Professor Dr. Klaus Dorer und Professor Dr. Daniel Fischer (Hochschule Offenburg) für die Beratung und Unterstützung bei der Erstellung von Verybench.