diff --git a/README.md b/README.md index 39e927c..c26ab1c 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ In seiner 23. Sitzung hat der [IT-Planungsrat](https://www.it-planungsrat.de) mit [Beschluss 2017/22 (6a)](https://www.it-planungsrat.de/SharedDocs/Sitzungen/DE/2017/Sitzung_23.html?pos=3) die [Koordinierungsstelle für IT-Standards (KoSIT)](https://www.xoev.de/) 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 +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. +*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](#konfiguration-des-prüftools) definiert, welche zur Anwendung des Prüftools erforderlich ist. +Das Prüftool selbst ist fachunabhängig und kennt keine spezifischen Dokumentinhalte noch Validierungsregeln. +Diese werden im Rahmen einer [Prüftool-Konfiguration](#konfiguration-des-prüftools) definiert, welche zur Anwendung des Prüftools erforderlich ist. # Konfigurationen @@ -36,39 +36,12 @@ Eine eigenständige Konfiguration für den Standard XGewerbeanzeige wird ebenfal Der geregelte Betrieb dieser Konfiguration wird im Rahmen des Betriebs des Standards XGewerbeanzeige erfolgen. -# Grundsätzlicher Ablauf einer Prüfung -Eine zu prüfende Datei durchläuft die folgenden Schritte - -1. *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. -2. *Identifikation des anzuwendenden Prüfszenarios*: Für den Dokumenttyp der zu prüfenden XML-Datei muss in der - [Konfigurationsdatei](#konfiguration-des-prüftools) 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. -3. *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. -4. *Prüfung gegen die Schematron-Regeln des identifizierten Dokumenttyps* -5. *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](#konfiguration-des-prüftools) kann für einzelne Prüfregeln festgelegt werden, dass - sie für die Bewertung einer [anderen Meldungsart](#anpassung-der-fehlergrade-für-die-bewertung) 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](#anpassung-der-html-ausgabe) werden. - # Verwendung Das Prüftool steht in zwei Varianten zur Verfügung: -- als [Standalone-Version](#verwendung-als-standalone-anwendung), die von der Kommandozeile aus aufgerufen werden kann -- als [Bibliothek](#verwendung-als-bibliothek), die in eigene Anwendungen integriert werden kann +- als [Standalone-Version](#verwendung-als-standalone-anwendung), die von der Kommandozeile aus aufgerufen werden kann +- als [Bibliothek](#verwendung-als-bibliothek), die in eigene Anwendungen integriert werden kann ## Voraussetzungen Zur Ausführung und zum Durchführen des Maven-Builds wird Java 8 Update 111 oder höher benötigt. @@ -92,20 +65,20 @@ java -jar validationtool--standalone.jar -s scenarios.xml -o test/repor ``` Der Aufruf erzeugt im Verzeichnis test/reports für jede validierte Eingabedatei -einen gleichnamige [Prüfbericht]-Datei. +einen gleichnamige [Prüfbericht]-Datei. Eine Übersicht über die Eigenschaften der Testdateien in [/validator-configuration-xrechnung/src/test/instances](/validator-configuration-xrechnung/src/test/instances) findet sich in -[/validator-configuration-xrechnung/src/test/instances/assertions.xlsx](/validator-configuration-xrechnung/src/test/assertions.xlsx). +[/validator-configuration-xrechnung/src/test/instances/assertions.xlsx](/validator-configuration-xrechnung/src/test/assertions.xlsx). ## Verwendung als Bibliothek -Daneben kann das Prüftool auch in eigene Anwendungen integriert werden. +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](https://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html)). +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](https://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html)). - -* Maven + +* Maven ``` de.kosit @@ -120,9 +93,9 @@ dependencies { } ``` -Voraussetzung für die Verwendung ist eine valide Prüfszenarien-Definition (xml-Datei) und das dazugehörige Repository +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: +Prüf-Instanz: ```java //Vorbereitung der Konfiguration @@ -137,8 +110,8 @@ 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 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: @@ -158,18 +131,18 @@ List 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 +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 +verwendete Algorithmus ist über die `read`-Methoden der `InputFactory` definierbar. Standardmäßig wird _SHA-256_ des JDK verwendet ## Verwendung des Daemon-Mode -Das Prüftool stellt auch eine HTTP-Schnittstelle bereit, über die die Funktionalität angesprochen werden kann. Dazu wird die Anwendung +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: @@ -177,143 +150,79 @@ im _Daemon-Mode_ gestartet: java -jar validationtool--standalone.jar -s -D ``` -In der Default-Konfiguration stellt dieser Aufruf einen HTTP-Server unter _localhost_ und Port 8080 bereit. +In der Default-Konfiguration stellt dieser Aufruf einen HTTP-Server unter _localhost_ und Port 8080 bereit. Host und Port lassen sich anpassen: ```shell -java -jar validationtool--standalone.jar -s -D -H 192.168.1.x -P 8081 +java -jar validationtool--standalone.jar -s -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. +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. # Build-Anweisungen -Das Projekt wird mit Apache Maven gebaut. +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, +* 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 `validationtools` sowie die benötigten Abhängigkeiten. -# Konfiguration des Prüftools - -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](validationtool/src/main/model/xsd/scenarios.xsd) erläutert. - -## Prüfbericht -Der Aufbau des Prüfberichts ist im entsprechenden Schema [report.xsd](configurations/xrechnung/resources/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. - - -## Anpassung der Fehlergrade für die Bewertung -Grundsätzlich werden für die Verarbeitungen alle Meldungen, welche aus den einzelnen -[Prüfschritten](#grundsätzlicher-ablauf-der-prüfung) 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: - -``` - - EN16931 CIUS XRechnung (UBL Invoice) - ... - - - Prüfbericht für XRechnung - resources/xrechnung/xrechnung-report.xsl - - BR-15 BR-DE-3 - - -``` - -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*. - -## Anpassung der HTML-Ausgabe - -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. # Qualitätssicherung ## Umgesetzte QS-Maßnahmen ### Automatische Unit-Tests (Java-Code) -* 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 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. + 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, + 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. + werden. ### Automatische Code-Analyse (Java-Code) * Der Quellcode wird dauerhaft und automatisch durch das weit verbreitete System [Sonar](https://www.sonarqube.org/) 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. + 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. + Prüftool ist. * In den Aspekten "Reliability", "Security" und "Maintainability" wird der Quellcode jeweils mit dem bestmöglichen - [Rating](https://docs.sonarqube.org/display/SONAR/Metric+Definitions) "A" bewertet. + [Rating](https://docs.sonarqube.org/display/SONAR/Metric+Definitions) "A" bewertet. ### Berücksichtigung von Best Practices für XML-Security * 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. - + auzuschließen. + ### End-to-End-Testsuite für die Prüftool-Konfiguration XRechnung * 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. + mindestens je einmal positiv und einmal negativ getestet. * Diese Zusicherungen können vom Prüftool selbst mittels des Schalter `--implemenation-assertions` automatisch 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](configurations/xrechnung/test/readme.txt). + Schematron-Regeln) des Prüfberichts getestet. +* Für weitere Details siehe [xrechnung/test/readme.txt](configurations/xrechnung/test/readme.txt). ## Noch nicht umgesetzte QS-Maßnahmen ### Internes Security-Audit (Java-Code) -Ein abschließendes Security Audit durch den Dienstleister läuft noch und wird voraussichtlich in der KW40 abgeschlossen sein. +Ein abschließendes Security Audit durch den Dienstleister läuft noch und wird voraussichtlich in der KW40 abgeschlossen sein. ### Fachlicher Test der Prüftool-Konfiguration XRechnung Die Korrektheit der in der Prüftool-Konfiguration XRechnung enthaltenen Schematron-Dateien bzw. der aus ihnen erstellten diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..8f39b3f --- /dev/null +++ b/docs/api.md @@ -0,0 +1,2 @@ +# Validator API + diff --git a/docs/configurations.md b/docs/configurations.md new file mode 100644 index 0000000..de8d601 --- /dev/null +++ b/docs/configurations.md @@ -0,0 +1,54 @@ +# Validation Configuration + +## Scenarios + +The core of each validation configuration is the scenarios.xml file. The scenarios.xml itself must be valid according to the [Scenarios XML Schema](/src/main/model/xsd/scenarios.xsd) with the following namespace `http://www.xoev.de/de/validator/framework/1/scenarios`. + +Several validation scenarios (`` XML Elements can be described for each configuration. + +Each scenario allows to define the matching criterion. It is an XPATH expression which must evaluate to true matched against the test xml candidate. Only then this scenario will apply to the test candidate. + +Within a scenario you can define the XML Schema and several Schematrons against which a test xml candidate has to be validated. You can give these a name and define where to find the resources/artifacts for validation. + +Lastly, you can define in an `` element a XSLT transformation which takes the validator's report in order to create an own styled report. + +If no scenario matches you can also define a XSLT transformation in `` element. + +## Validators Report + +The validator's report is defined in [createReportInput.xsd](src/main/model/xsd/createReportInput.xsd) and contains all errors from all validation steps and some addional information on time of validation, engine used, the scenario which applied and a document identification. + +In general all errors will be classified in the following levels: + +* *warning*, +* *error*, or +* *fatal error* + +### Customization of error levels + +In each single sceanrio each error level can be configured to the following error types + +* error +* warning +* information + +This can be done by adding `customLevel` elements in +`createReport`. + +Here is an example: + +```xml + + EN16931 CIUS XRechnung (UBL Invoice) + ... + + + Prüfbericht für XRechnung + resources/xrechnung/xrechnung-report.xsl + + BR-15 + + +``` + +Here the errors reported by violating the schematron rule `BR/15` are translated from *error* to *warning*.