yWorks Ant Explorer - Walkthrough

Diese Seite soll eine kurze Einführung in die Fähigkeiten und die Funktionsweise des yWorks Ant Explorers geben.

Grundsätzlicher Aufbau

Auf der linken Seite werden die verschiedenen Targets eines Ant-Projekts dargestellt. Dabei werden sowohl die im ursprünglich ausgewählten Build-File enthaltenen Targets dargestellt, als auch die in importierten Files enthaltenen ("import").

Die Kanten zwischen den einzelnen Targets visualisieren die Abhängigkeiten der Targets (z.B. über "depends" oder auch "AntCalls"). Besondere Abhängigkeiten werden durch bestimmte Linien-Stile dargestellt. So sind beispielsweise Dependencies zu Targets in anderen Files gestrichelt dargestellt, während sich durch AntCalls ergebende Linien in einem dunklen rot eingefärbt sind.

Transitive Kanten

Eine Besonderheit sind die "transitiven" Kanten, welche grau dargestellt werden. Diese Abhängigkeiten sind im analysierten Ant-File explizit definiert, eigentlich jedoch nicht notwendig, da sie durch andere Abhängigkeiten implizit bereits vorhanden sind.
Um die Übersichtlichkeit zu erhöhen, können diese Kanten über einen Button auf der Toolbar komplett ausgeblendet werden.

Benutzte Properties anzeigen

Die in einem Target enthaltenen Ant-Tasks (z.B. über den Tooltip einsehbar) benutzen verschiedene Properties. Diese Properties können über das Popup-Menü eines Targets direkt angezeigt bzw. selektiert werden.

Properties analysieren

Die Properties-View erlaubt den Zugriff auf die "Entstehung" und den wahrscheinlichen Wert eines Properties.
Der Wert eines Properties kann von einem oder mehreren anderen Properties abhängen. Diese Abhängigkeiten sind jeweils durch Kanten visualisiert.

Der wahrscheinliche Inhalt eines Properties wird vom yWorks Ant Explorer ausgewertet und dargestellt.
Der Name des Properties wird oberhalb des Trennstrichs dargestellt; der Ausdruck befindet sich direkt unterhalb des Trennstrichs während der ausgewertete Wert sich darunter befindet. Der vollständige Ausdruck wird im Tooltip eines jeden Properties dargestellt.

Der Ausdruck eines Properties kann zur Laufzeit jedoch einen anderen Wert annehmen. Dies ist insbesondere bei Custom-Tasks, "Verzweigungen" durch "if"/"unless"-Konstrukte und natürlich manuell überschriebene Werte möglich.

Arten von Properties

Die "Herkunft" der einzelnen Properties kann anhand der Farbe unterschieden werden:

• Hellgrün:
  "Implizit" vorhandene Properties wie z.B. bestimmte System-Variablen werden in einem hellen Grün dargestellt.
• Grün:
  Properties welche innerhalb der XML-Datei deklariert werden, sind grün hinterlegt.
• Dunkelgrün:
  Aus einer ".properties"-Datei ausgelesene Properties werden in einem dunklen Grün dargestellt.
• Rot:
  Properties, die zwar von anderen Properties verwendet werden, aber nirgendwo deklariert werden. Ein rot markiertes Property kann auf einen Fehler im Build-Skript hinweisen.
  Bestimmte Custom Tasks können jedoch nicht korrekt erkannt werden, so dass unter Umständen auch zur Laufzeit tatsächlich bekannte Properties rot dargestellt werden.
• Dunkelrot:
  Bei einem Ant-Call können Parameter mit übergeben werden. Die Werte dieser Parameter nehmen zur Laufzeit jedoch i.d.R. verschiedene Werte an. Deshalb werden die Properties vom yWorks Ant Explorer nicht aufgelöst.

Goto Source

Der yWorks Ant Explorer erlaubt für jedes Target bzw. Property die Navigation hin zum Text-File. Der entsprechende Eintrag im Popup-Menü öffnet je nach Plattform die entsprechende Quelldatei.

Ausführen eines Ant-Tasks

Ant-Targets können auch direkt aus dem yWorks Ant Explorer heraus über das Popup-Menü der Targets ausgeführt werden. Optional können Properties über das sich öffnende Dialog-Fenster eingefügt bzw. geändert werden.
In der Version 1.0 wird das Ant-File in der JVM des yWorks Ant Explorers und mit dessen Classpath ausgeführt. Daher empfiehlt es sich bei komplexeren Build-Files auf die "Wrapper"-Version auszuweichen.

Je nach Status eines Targest wird die Farbe geändert. Grüne Targets sind bereits erfolgreich durchlaufen worden, Targets mit Warnungen bzw. Fehlermeldungen (im Protokoll-Fenster) sind gelb bzw. rot dargestellt.

Das momentan aktive Target ist orange dargestellt. Die Progress-Bar innerhalb des Targets zeigt den Prozentsatz der ausgeführten Tasks und den momentan in Arbeit befindlichen Task an.

Dependency Progress Bar

Unterhalb der Targets befindet sich die Dependency-Progress-Bar. Jeder Teil dieser Progress-Bar steht für ein Target, welches vorher ausgeführt werden muss. Entsprechend verändern sich bei der Ausführung eines Targets die Dependeny-Progress-Bars von allen davon abhängigken Targets, auch wenn diese selbst nicht ausgeführt werden.