- Über das Prüftool
- Konfigurationen
- Grundsätzlicher Ablauf einer Prüfung
- Verwendung
- Build-Anweisungen
- Konfiguration des Prüftools
- Qualitätssicherung
In seiner 23. Sitzung hat der IT-Planungsrat mit Beschluss 2017/22 (6a) die Koordinierungsstelle für IT-Standards (KoSIT) im Rahmen des Betriebs des Standards XRechnung mit der dauerhaften„…Bereitstellung eines Moduls zur Konformitätsprüfung elektronischer Rechnungen als offene Referenzimplementierung sowie …“ aller zugehöriger Artefakte beauftragt. Im Rahmen dieser Beauftragung wurde die hier bereitgestellte Software "Prüftool" entwickelt und (vor-) konfiguriert.
Das Prüftool ist ein Programm, welches XML-Dateien (Dokumente) in Abhängigkeit von ihren Dokumenttypen gegen verschiedene Validierungsregeln (XML Schema und Schematron) prüft und das Ergebnis zu einem Konformitätsbericht (Konformitätsstatus valid oder invalid) mit einer Empfehlung zur Weiterverarbeitung (accept) oder Ablehnung (reject) aggregiert. Mittels Konfiguration kann bestimmt werden, welche der Konformitätsregeln durch ein Dokument, das zur Weiterverarbeitung empfohlen (accept) wird, verletzt sein dürfen.
Das Prüftool selbst ist fachunabhängig und kennt keine spezifischen Dokumentinhalte noch Validierungsregeln. Diese werden im Rahmen einer Prüftool-Konfiguration definiert, welche zur Anwendung des Prüftools erforderlich ist.
Fach- bzw. Standardspezifische Prüfkonfigurationen sind in eigene Module bzw. Repositories ausgelagert.
Eine eigenständige Konfiguration für den Standard XRechnung wird ebenfalls auf GitHub bereitgestellt (Releases). Diese enthält alle notwendigen Ressourcen zu der Norm EN16931 (XML-Schema und [Schematron Regeln] (https://github.com/CenPC434/validation) u.a.) und die XRechnung Schematron Regeln in ihren aktuellen Versionen.
Der geregelte Betrieb dieser Konfiguration wird im Rahmen des Betriebs des Standards XRechnung erfolgen.
Eine eigenständige Konfiguration für den Standard XGewerbeanzeige wird ebenfalls auf GitHub bereitgestellt (Releases).
Der geregelte Betrieb dieser Konfiguration wird im Rahmen des Betriebs des Standards XGewerbeanzeige erfolgen.
Eine zu prüfende Datei durchläuft die folgenden Schritte
- Grundsätzliche XML-Prüfung: Es muss sich bei der zu prüfenden Datei um wohlgeformtes XML handeln, andernfalls werden keine weiteren Prüfungen durchgeführt und ein [Prüfbericht] mit Status invalid und Empfehlung reject generiert.
- Identifikation des anzuwendenden Prüfszenarios: Für den Dokumenttyp der zu prüfenden XML-Datei muss in der Konfigurationsdatei ein Prüfszenario definiert sein (die Identifikation des Dokumenttyps erfolgt durch einen XPath-Test), andernfalls werden keine weiteren Prüfungen durchgeführt und ein [Prüfbericht] mit Status invalid und Empfehlung reject generiert.
- Prüfung gegen das XML-Schema des identifizierten Dokumenttyps: Das zu prüfende Dokument muss valide bzgl. des Schemas sein, andernfalls werden keine weiteren Prüfungen durchgeführt und ein [Prüfbericht] mit Status invalid und Empfehlung reject generiert.
- Prüfung gegen die Schematron-Regeln des identifizierten Dokumenttyps
- Aggregation und Bewertung der einzelnen Prüfungen zu einem [Prüfbericht]: Die Ergebnisse der
vorherigen Schritte werden in einem einheitlichen Berichtsformat zusammengefasst und bewertet:
- Sofern mindestens einer der zuvor durchgeführten Prüfschritte einen Fehler (error) oder eine Warnung (warning) geliefert hat, erhält der Prüfbericht den Status invalid, andernfalls erhält er den Status valid.
- Sofern einer der Prüfschritte einen Fehler geliefert hat, erhält der Prüfbericht grundsätzlich die Empfehlung reject, andernfalls erhält er die Empfehlung accept.
- In der Konfigurationsdatei kann für einzelne Prüfregeln festgelegt werden, dass sie für die Bewertung einer anderen Meldungsart zuzuordnen sind (z. B. warning anstelle von error).
- Der Prüfbericht ist ein für die maschinelle Auswertung geeignetes XML-Dokument. Darin eingebettet ist auch eine für menschliche Leser bestimmte HTML-Aufbereitung des Prüfergebnisses. Die Details dieser HTML-Aufbereitung können bei Bedarf angepasst werden.
Das Prüftool steht in zwei Varianten zur Verfügung:
- als Standalone-Version, die von der Kommandozeile aus aufgerufen werden kann
- als Bibliothek, die in eigene Anwendungen integriert werden kann
Zur Ausführung und zum Durchführen des Maven-Builds wird Java 8 Update 111 oder höher benötigt.
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> [OPTIONS] [FILE] [FILE] [FILE] ...Eine Liste der möglichen Optionen kann mit den Schalter --help angezeigt werden.
Aufruf, um die mitgelieferten Test-Dokumente zu validieren und dabei neben den XML-Prüfberichten auch die eingebetteten HTML-Dokumente als eingeständige Dateien auszugeben:
unzip validationtool-dist-<version>-standalone.zip
unzip validator-configuration-xrechnung_<xrechnung-version>_<release-datum>.zip
java -jar validationtool-<version>-standalone.jar -s scenarios.xml -o test/reports -h test/instances/*.xml
Der Aufruf erzeugt im Verzeichnis test/reports für jede validierte Eingabedatei
einen gleichnamige [Prüfbericht]-Datei.
Eine Übersicht über die Eigenschaften der Testdateien in
/validator-configuration-xrechnung/src/test/instances findet sich in
/validator-configuration-xrechnung/src/test/instances/assertions.xlsx.
Daneben kann das Prüftool auch in eigene Anwendungen integriert werden.
Die Bibliothek steht derzeit noch nicht im Maven-Central-Repository zur Verfügung. Sie muss manuell im lokalen oder unternehmensweiten Maven-Repository bereitgestellt werden (siehe vgl. Maven Dokumentation).
- Maven
<dependency>
<groupId>de.kosit</groupId>
<artifactId>validationtool</artifactId>
<version>1.0.0</version>
</dependency>
- Gradle
dependencies {
compile group: 'de.kosit', name: 'validationtool', version: '1.0.0'
}
Voraussetzung für die Verwendung ist eine valide Prüfszenarien-Definition (xml-Datei) und das dazugehörige Repository mit den von den definierten Szenarien benötigten Artefakten. Der folgende Quellcode zeigt die Erzeugung einer neuen Prüf-Instanz:
//Vorbereitung der Konfiguration
URI scenarios = URI.create("scenarios.xml");
CheckConfiguration config = new CheckConfiguration();
config.setScenarioDefinition(scenarios);
//Instanziierung der DefaultCheck-Implementierung
Check implemenation = new DefaultCheck(config);Weitere Konfigurationsoption ist der Pfad zum Repository. Standardmäßig wird das Repository relativ zur Szenarien-Defintion unter "repository" gesucht.
Die so erzeugte Prüfinstanz initialisiert sämtliche Szenarien und deren Prüfartefakte. Ein etwaiger Konfigurationsfehler wird frühzeitig mitgeteilt.
Die eigentlich Prüfung erfolgt mit den beiden Methoden des Check-Interfaces:
...
Check pruefer = new DefaultCheck(config);
//einzelne Datei prüfen
Input pruefKandidat = InputFactory.read(new File("rechnung.xml"));
Document report = pruefer.implemenation(pruefKandidat);
//Batch-Prüfung
List<File> files = Files.list(Paths.get("rechnungen")).map(path -> path.toFile()).collect(Collectors.toList());
List<Input> toCheck = files.stream().map(InputFactory::read).collect(Collectors.toList());
List<Document> reports = pruefer.implemenation(toCheck);Eine einmal initialisierte Prüfinstanz ist threadsafe und kann beliebig oft wieder verwendet
werden. XML-Artefakte wie Schema oder XSLT-Executables werden bei Instantiierung des DefaultCheck initialisiert und
wiederverwendet. Da diese Objekte relativ aufwändig zu Erzeugen sind, empfielt sich die Wiederverwendung der Check-Instanz.
Die Batch-Verarbeitung erfolgt grundsätzlich seriell. Der DefaultCheck implementiert keine Parallelverarbeitung.
Einziges Eingabeobjekt ist Input, welches sich mit den verschiedenen Methoden der InputFactory aus div. Eingabe-Resourcen
erzeugen lässt. Die InputFactory erzeugt für jedes Eingabe-Objekt eine Prüfsumme, die im Report mitgeführt wird. Der
verwendete Algorithmus ist über die read-Methoden der InputFactory definierbar. Standardmäßig wird SHA-256 des JDK
verwendet
Das Prüftool stellt auch eine HTTP-Schnittstelle bereit, über die die Funktionalität angesprochen werden kann. Dazu wird die Anwendung im Daemon-Mode gestartet:
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> -DIn der Default-Konfiguration stellt dieser Aufruf einen HTTP-Server unter localhost und Port 8080 bereit.
Host und Port lassen sich anpassen:
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> -D -H 192.168.1.x -P 8081 Im Daemon-Mode nimmt der HTTP-Server POST-Anfragen unter / entgegen, verarbeitet den darüber bereitgestellten Prüfling und gibt das Ergebnis-Dokument als Antwort zurück.
Zur Integration in Monitoring-Systeme wird eine Health-Check angeboten. Dieser ist über einen GET-Request unter /health erreichbar.
Das Projekt wird mit Apache Maven gebaut.
Mittels mvn install werden im Unterverzeichnis dist zwei Pakete gebaut:
-
die Standalone-Distribution enthält das Uber-Jar mit allen Klassen zur Verarbeitung von Eingaben aus der Kommandozeile, sowie für Ausgabeoptionen für Ergebnisse. Sämtliche Abhängigkeiten sind im Jar gebundlet und das Jar-File ist 'ausführbar'.
-
die Full-Distribution enthält darüber sämtlichen weiteren Varianten des
validationtoolssowie die benötigten Abhängigkeiten.
Die Konfiguration besteht aus einer Konfigurationsdatei (XML-Dokument im Namensraum
http://www.xoev.de/de/validator/framework/1/scenarios) sowie Resourcen (XML Schemata und XSLT-Dateien) in einem "Repository" genanntem Verzeichnis, auf welche die Konfigurationsdatei verweist.
Der Aufbau der Konfigurationsdatei ist im entsprechenden Schema scenarios.xsd erläutert.
Der Aufbau des Prüfberichts ist im entsprechenden Schema report.xsd erläutert. Die für die maschinelle Auswertung des Prüfberichts wesentlichsten Angaben sind
- der Konformitätsstatus (valid oder invalid, Attribut rep:report/@valid)
- die Empfehlung zur Annahme (accept - Element rep:report/rep:assessment/rep:accept) oder Ablehnung (reject - Element rep:report/rep:assessment/rep:reject) des geprüften Dokuments.
Grundsätzlich werden für die Verarbeitungen alle Meldungen, welche aus den einzelnen Prüfschritten resultieren, in die Rollen error, warning und information übersetzt. Der Prüfbericht erhält den Konformitätstatus valid genau dann, wenn in der Konfiguration ein Prüfszenario für den Dokumenttyp des zu testenden Dokuments gefunden wurde und keine Meldung mit Status error oder warning vorliegt.
Die Erstellung dieser Bewertung ist nicht konfigurierbar.
In der Standardkonfiguration erhält der Prüfbericht genau dann die Empfehlung accept, wenn in der Konfiguration ein Prüfszenario für den Dokumenttyp des zu testenden Dokuments gefunden wurde und keine Meldung mit Status error vorliegt.
Die Erstellung dieser Empfehlung kann je Prüfszenario konfiguriert werden, in dem im jeweiligen Prüfszenario in
createReport ein customLevel aufgenommen wird:
<scenario>
<name>EN16931 CIUS XRechnung (UBL Invoice)</name>
...
<createReport>
<resource>
<name>Prüfbericht für XRechnung</name>
<location>resources/xrechnung/xrechnung-report.xsl</location>
</resource>
<customLevel level="warning">BR-15 BR-DE-3</customLevel>
</createReport>
</scenario>
In diesem Beispiel werden die Fehlercodes BR-15 (Teil der EN) und BR-DE-3 (Teil der CIUS XRechnung) für den
Bewertungsschritt von ihrer eigentlicher Rolle error auf warning geändert. Ein Dokument, welches eine oder
beide dieser Regeln verletzt (und ansonsten keine error-Meldungen erzeugt) erhielte damit abweichend vom
Standardverhalten die Bewertung accept.
Die Konfiguration XRechnung erstellt XML-Prüfberichte, welche für jede Bewertung (accept oder reject-Kindelement im Prüfbericht) genau eine HTML5-Darstellung enthalten.
Diese wird durch das XSLT-Skript xrechnung-report.xsl erstellt. Dieses Skript kann überschrieben werden um die
HTML-Ausgabe anzupassen. Dazu ist eine neue XSTL-Datei (z. B. my-xrechnung-report.xsl) zu erstellen, welche
xrechnung-report.xsl per xsl:import einbindet. Die neue XSLT-Datei ist anstelle von xrechnung-report.xsl in der
Konfigurationsdatei einzutragen. In der neuen XSLT-Datei kann nun das XSLT-Template html:html oder eines der von
diesem eingebundenen Unter-Templates html:* überschrieben werden.
Für weiterführende Erläuterungen wird auf die Dokumentation in der XSLT xrechung\resources\default-report.xsl
verwiesen.
- Die korrekte Funktionsweise des Prüftools wird durch mehr als 60 Unit-Test überprüft.
- Die Unit-Tests sind Teil des bereitgestellten Codes und werden durch den Maven-Build automatisch ausgeführt.
- Die Unit-Tests decken alle grundsätzlichen Funktionen des Prüftools ab. Daneben wird das korrekte Verhalten der Anwendung bei verschiedenen Fehleingaben überprüft und nachgewiesen.
- Die Testabdeckung (Coverage) liegt derzeit bei ca. 85% des Java-Codes.
Diese Abdeckung wird mittels der Bibliothek jacoco automatisch ermittelt und zeigt, dass alle wesentlichen Funktionen
durch Tests überprüft werden.
Die verbleibenden 15% lassen sich fast ausschließlich auf Fehlerbedingungen (Exceptions) zurückführen,
die in der Praxis auch bei Fehleingaben nicht auftreten können und entsprechend durch keine Unit-Tests durchlaufen werden.
- Der Quellcode wird dauerhaft und automatisch durch das weit verbreitete System Sonar zur statischen Code-Analyse geprüft.
- Das Prüftool wird von Sonar mit aktuell ca 1.800 Zeilen Quellcode als klein (S) eingestuft.
- Es existieren aktuelle 7 "Code Smells" und 3 "False Positives".
- Sämtliche „Code Smells“ sind auf nicht abgetestete Bedingungen (siehe oben) zurückzuführen.
- Ein Beispiel für ein "False Positive" ist "Illegale Ausgabe auf STDout", was jedoch eine konkrete Anforderung an das Prüftool ist.
- In den Aspekten "Reliability", "Security" und "Maintainability" wird der Quellcode jeweils mit dem bestmöglichen Rating "A" bewertet.
- Es wurden explizit Best Practices für die sichere XML-Verarbeitung mit Java (XML, XML Schema, XSLT) berücksichtigt, um beispielsweise XXE (XML eXternal Entity) Attacken und allgemein externe Referenzierungen (Entities, XIncludes) auzuschließen.
- Um die korrekte Funktion der Prüftool-Konfiguration XRechnung zu testen, wurde eine Suite aus 10 Testdokumenten und insgesamt 310 prüfbaren Aussagen (Assertions) über die resultierenden Prüfberichte erstellt.
- Durch diese Testsuite werden, ausgehend von dem Prüfbericht-Schemas alle möglichen Optionen und Auswahlmöglichkeiten mindestens je einmal positiv und einmal negativ getestet.
- Diese Zusicherungen können vom Prüftool selbst mittels des Schalter
--implemenation-assertionsautomatisch geprüft werden. - Zudem wird die Integrität aller erstellten Prüfberichte automatisch gegen das Schema (XML Schema und Schematron-Regeln) des Prüfberichts getestet.
- Für weitere Details siehe xrechnung/test/readme.txt.
Ein abschließendes Security Audit durch den Dienstleister läuft noch und wird voraussichtlich in der KW40 abgeschlossen sein.
Die Korrektheit der in der Prüftool-Konfiguration XRechnung enthaltenen Schematron-Dateien bzw. der aus ihnen erstellten XSLT-Kompilate wurde noch nicht systematisch geprüft, da weder die Schematron-Dateien der EN16931 noch die Schematron-Dateien des Standards XRechnung in finalen Fassungen vorlagen.