AOQML-Massenvalidierung

Es kommt vereinzelt vor, dass Projekte in AOQML sehr groß werden und mit unserem AOQML-Editor kaum bis gar nicht mehr zu managen sind. In der Regel werden solche Projekte von erfahrenen AOQML-Autoren geschrieben, die häufig die Leiste mit den Codeschnipseln nicht mehr benötigen und andere Editoren verwenden, mit denen sie erfahrungsgemäß einfach schneller arbeiten. Trotzdem kann es nicht schaden, ein Projekt zum Abschluss auf grundsätzliche Validität zu prüfen. Zu diesem Zweck hat Enno ein Skript geschrieben, das alle XML-Dateien in einem Ordner und dessen Unterordnern gegen die XSD prüft und bei sämtlichen Links per include oder choice evaluiert, ob die verlinkten Dateien vorhanden sind und das Ergebnis der Prüfung als Textdatei ausgibt.

Anwendung

Die Einrichtung und Anwendung unterscheidet sich je nach Betriebssystem und ist nicht explizit auf Benutzerfreundlichkeit ausgelegt, sondern richtet sich eher an Nutzer mit Programmierkenntnissen oder gewisser Frusttolleranz bei der Einrichtung neuer Software/Apps. Daher hier folgend Anleitungen für Windows und Linux. Das Skript funktioniert grundsätzlich aber auch mit macOS.

Das Skript selbst ist in Python 2.7 geschrieben, aber lauffähig von 2.6 bis mindestens 3.6 und verwendet Java für den eigentlichen Abgleich. Es sollten demnach das JDK und Python installiert sein.

Windows 8.1

1. Python installieren, wenn noch nicht geschehen. Idealerweise auf der Hauptebene einer Festplatte, also zum Beispiel unter C:\Python36.
2. Eine halbwegs aktuelle Javaversion installieren, wenn noch nicht geschehen.
3. Python als Befehl in Windows' Kommandozeilentool (Eingabeaufforderung; cmd) einrichten. (Optional, wir gehen hier in der Folge davon aus, dass es gemacht wurde.) Dazu in die Systemsteuerung gehen, System, Erweiterte Systemeinstellungen, Erweitert, Umgebungsvariablen und dort bei Path ans Ende euren Pfad zum Pythonordner eintragen. Mit einem Semikolon davor, damit Windows weiß, dass dort ein neuer Pfad beginnt.
   
4. Das Skript für die Massenvalidierung herunterladen und in einen schicken, leicht zugänglichen Ordner packen. Wenn all eure Projekte für Antamar in einem Ordner liegen, würde der sich anbieten.
5. Eingabeaufforderung starten und in den Ordner navigieren, in dem ihr das Skript abgelegt habt. Da Konsolenbefehle nicht mehr zum Allgemeinwissen gehören, hier ein Beispiel.
   Antamarprojekte liegen auf einer zweiten Festplatte (D) im Ordner Antamar und ihr müsst dort von C aus hinnavigieren:
   
6. Dort angekommen und unter der Annahme, dass ihr dort die Dateien aus dem Archiv hin kopiert habt und die Umgebungsvariable erweitert, gebt ihr checkintegrity.py PfadzumPrüfordner > foo.txt ein und startet das Skript mit der Eingabetaste.
   
   Ihr könnt natürlich auch volle Pfade der Form C:\Antamar\Projekt1\Quest1 angeben, müsst es sogar, wenn sich die Ordner nicht im gleichen Verzeichnis wie das Skript befinden. Hängt man das > name.txt hinten dran, wird eine Textdatei erstellt, die die Auswertung enthält, lässt man es weg, werden die Fehler direkt in der Konsole ausgegeben, wie auf dieser Grafik zu sehen. Der Name der Datei ist frei wählbar.
   Falls ihr Schritt drei ausgelassen habt, müsstet ihr zum Starten jedes Mal sehr viel mehr tippen, das kann dann in etwa so aussehen: C:\Python36\python.exe checkintegrity.py D:\Antamar\Quest1 > fehler.txt.
   Und ja, natürlich könnt ihr das Skript auch ci.py nennen und dann darüber aufrufen. Kein Problem.

Linux (Ubuntu)

1. Linux liefert Python direkt mit und Linuxnutzern muss in der Regel auch die Konsole nicht mehr erklärt werden, daher kann man sich hier kurz fassen. Wenn nötig, JDK installieren. (Open JDK macht Probleme)
2. Das ZIP-Archiv mit dem Skript und den Hilfsdateien runterladen und an einer schönen Stelle platzieren.
3. python checkintegrity.py /PfadZumPrüfordner/ > foo.txt in der Konsole ausführen, nachdem man zum passenden Ordner navigiert ist.
4. Über Ergebnis freuen oder ärgern. Selbiges findet sich entweder in der angegebenen Textdatei im Ordner in dem auch das Skript liegt oder wird direkt in der Konsole ausgegeben, wenn man > foo.txt weglässt. Auch hier kann der Name des Skripts natürlich verkürzt werden, wenn man weniger tippen will und der Name der Auswertungsdatei ist ebenso frei wählbar.

Bekannte Probleme aka. TODO für die Zukunft

• Wenn in Links Variablen genutzt werden, kann nicht evaluiert werden, ob die Dateien existieren, da es zu aufwendig würde, sämtliche Dateien nach möglichen Werten für die Variable zu durchforsten und diese dann zu prüfen. Dazu sollte zumindest ein Hinweis ausgegeben werden.
• Bei Verwendung von Funktionen aus der AOQML-Bibliothek wird nicht geprüft, ob die Bib tatsächlich existiert. [Array mit Libkandidaten nachrüsten?]
• Verschachtelte includes mit Ebenenwechsel können zu falschen Fehlermeldungen führen.
• Hohe Laufdauer des Skripts bei sehr vielen Dateien ist normal und kein Grund zur Besorgnis. Einfach warten, es schließt irgendwann ab. Skriptoptimierung ist möglich.
• Nachdem ein toter Link gefunden wurde, wird der Rest der entsprechenden Datei nicht weiter nach selbigen durchsucht.
• Nach einer Meldung der Form "references missing file" folgt im Textdokument nur ein einfacher Zeilenumbruch, statt mehrerer, wie sonst überall.

Download des Skripts

Hier die aktuelle Version des Skripts zum Download.

Datei:Questbatch validation.zip