mirror of
https://github.com/itplr-kosit/validator.git
synced 2026-05-25 16:55:39 +00:00
Merge branch 'better-doc'
This commit is contained in:
Renzo Kottmann
commit
68da9049c7
6 changed files with 252 additions and 282 deletions
335
README.md
335
README.md
|
|
@ -1,321 +1,92 @@
|
||||||
# Inhaltsverzeichnis
|
# Validator
|
||||||
|
|
||||||
- [Über den Validator](#über-das-prüftool)
|
The validator is an XML validation-engine. It validates XML documents against XML Schema and Schematrons depending on self defined [scenarios](docs/configurations) which are used to fully configure the validation process.
|
||||||
- [Konfigurationen](#konfigurationen)
|
The validator always outputs a [validation report in XML](docs/configurations.md#validators-report) including all validation errors and data about the validation.
|
||||||
- [Grundsätzlicher Ablauf einer Prüfung](#grundsätzlicher-ablauf-einer-prüfung)
|
|
||||||
- [Verwendung](#verwendung)
|
|
||||||
- [Build-Anweisungen](#build-anweisungen)
|
|
||||||
- [Konfiguration des Prüftools](#konfiguration-des-prüftools)
|
|
||||||
- [Qualitätssicherung](#qualitätssicherung)
|
|
||||||
|
|
||||||
# Über das Prüftool
|
## Packages
|
||||||
|
|
||||||
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.
|
The validator distribution contains the following artifacts:
|
||||||
|
|
||||||
Das Prüftool ist ein Programm, welches XML-Dateien (Dokumente) in Abhängigkeit von ihren Dokumenttypen gegen verschiedene
|
1. **validator-`<version>`.jar**: Java library for embedded use within an application
|
||||||
Validierungsregeln (XML Schema und Schematron) prüft und das Ergebnis zu einem Konformitätsbericht (Konformitätsstatus
|
1. **validator-`<version`>-standalone**: Uber-JAR for standalone usage containing all dependencies in one jar file. This file comes with JAXB *embedded* and can be used with java 8 and java >=11)
|
||||||
*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.
|
1. **validator-`<version`>-java8-standalone**: Uber-JAR for standalone usage with java jdk 8 containing all dependencies in one jar file. This file file *does not* contain JAXB and depends on the bundled version of the JDK.
|
||||||
|
1. **libs/***: directory containing all (incl. optional) dependencies of the validator
|
||||||
|
|
||||||
Das Prüftool selbst ist fachunabhängig und kennt keine spezifischen Dokumentinhalte noch Validierungsregeln.
|
## Build
|
||||||
Diese werden im Rahmen einer [Prüftool-Konfiguration](#konfiguration-des-prüftools) definiert, welche zur Anwendung des Prüftools erforderlich ist.
|
|
||||||
|
|
||||||
# Konfigurationen
|
### Requirements
|
||||||
|
|
||||||
Fach- bzw. Standardspezifische Prüfkonfigurationen sind in eigene Module bzw. Repositories ausgelagert.
|
* Maven > 3.0.0
|
||||||
|
* Java > 8 update 111
|
||||||
|
|
||||||
## Prüfkonfiguration XRechnung
|
### Procedure
|
||||||
|
|
||||||
Eine eigenständige Konfiguration für den Standard [XRechnung](http://www.xoev.de/de/xrechnung) wird ebenfalls auf [GitHub bereitgestellt](https://github.com/itplr-kosit/validator-configuration-xrechnung) ([Releases](https://github.com/itplr-kosit/validator-configuration-xrechnung/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](https://github.com/itplr-kosit/xrechnung-schematron) in ihren aktuellen Versionen.
|
`mvn install` generates two different packages in the `dist` directory:
|
||||||
|
|
||||||
Der geregelte Betrieb dieser Konfiguration wird im Rahmen des Betriebs des Standards XRechnung erfolgen.
|
## Validation Configurations
|
||||||
|
|
||||||
## Prüfkonfiguration XGewerbeanzeige
|
The validator is just an engine and does not know anything about XML Documents and has no own validation rules.
|
||||||
|
|
||||||
Eine eigenständige Konfiguration für den Standard XGewerbeanzeige wird ebenfalls auf [GitHub bereitgestellt](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige) ([Releases](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige/releases)).
|
Validation rules and details are defined in [validation scenarios](docs/configurations) which are used to fully configure the validation process.
|
||||||
|
|
||||||
Der geregelte Betrieb dieser Konfiguration wird im Rahmen des Betriebs des Standards XGewerbeanzeige erfolgen.
|
All configurations are self-contained modules and deployed on their own.
|
||||||
|
|
||||||
|
### Third Party Validation Configurations
|
||||||
|
|
||||||
|
Currently, there are two public third party validation configurations available.
|
||||||
|
|
||||||
|
* Validation Configuration for [XRechnung](http://www.xoev.de/de/xrechnung) is available on
|
||||||
|
* Source code is available on [GitHub](https://github.com/itplr-kosit/validator-configuration-xrechnung)
|
||||||
|
* [Releases](https://github.com/itplr-kosit/validator-configuration-xrechnung/releases) can also be downloaded
|
||||||
|
* Validation Configuration for XGewerbeanzeige
|
||||||
|
* Source code is available on [GitHub](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige)
|
||||||
|
* [Releases](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige/releases) can also be downloaded
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
The validator is designed to be used in different 3 ways:
|
||||||
|
|
||||||
|
- as standalone application running from the cli
|
||||||
|
- as library embedded within a custom application
|
||||||
|
- as a daemon providing a http interface
|
||||||
|
|
||||||
|
|
||||||
# Grundsätzlicher Ablauf einer Prüfung
|
### Standalone Command-Line Interface
|
||||||
|
|
||||||
Eine zu prüfende Datei durchläuft die folgenden Schritte
|
The general way using the CLI is:
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
## Voraussetzungen
|
|
||||||
Zur Ausführung und zum Durchführen des Maven-Builds wird Java 8 Update 111 oder höher benötigt.
|
|
||||||
|
|
||||||
|
|
||||||
## Verwendung als Standalone-Anwendung
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> [OPTIONS] [FILE] [FILE] [FILE] ...
|
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.
|
You can more CLI options by
|
||||||
|
|
||||||
Aufruf, um die mitgelieferten Test-Dokumente zu validieren und dabei neben den XML-Prüfberichten auch die eingebetteten
|
```shell
|
||||||
HTML-Dokumente als eingeständige Dateien auszugeben:
|
java -jar validationtool-<version>-standalone.jar --help
|
||||||
|
|
||||||
```
|
|
||||||
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
|
A concrete example with a specific validator configuration can be found on [GitHub](https://github.com/itplr-kosit/validator-configuration-xrechnung
|
||||||
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).
|
|
||||||
|
|
||||||
## Verwendung als Bibliothek
|
### Daemon-Mode
|
||||||
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)).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* 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:
|
|
||||||
|
|
||||||
```java
|
|
||||||
//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:
|
|
||||||
|
|
||||||
```java
|
|
||||||
...
|
|
||||||
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
|
|
||||||
|
|
||||||
## 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
|
|
||||||
im _Daemon-Mode_ gestartet:
|
|
||||||
|
|
||||||
|
You can also start the validator as an HTTP-Server. Just start it in _Daemon-Mode_ with the `-D` option.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> -D
|
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> -D
|
||||||
```
|
```
|
||||||
|
|
||||||
In der Default-Konfiguration stellt dieser Aufruf einen HTTP-Server unter _localhost_ und Port 8080 bereit.
|
Per default the HTTP-Server listens on _localhost_ at Port 8080.
|
||||||
|
|
||||||
Host und Port lassen sich anpassen:
|
You can configure it with `-H` for IP Adress and `-P` for port number:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> -D -H 192.168.1.x -P 8081
|
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.
|
You can HTTP-POST to `/` and the response will return the report document as defined in your validator configuration.
|
||||||
Zur Integration in Monitoring-Systeme wird eine Health-Check angeboten. Dieser ist über einen GET-Request unter `/health` erreichbar.
|
|
||||||
|
|
||||||
# Build-Anweisungen
|
Additionally there is the GET `/health` endpoint which can be used by monitoring systems.
|
||||||
|
|
||||||
Das Projekt wird mit Apache Maven gebaut.
|
### Application User Interface (embedded usage)
|
||||||
|
|
||||||
Mittels `mvn install` werden im Unterverzeichnis `dist` zwei Pakete gebaut:
|
The validator can also be used in own Java Applications via the API. Details can be [found here](./docs/api.md).
|
||||||
|
|
||||||
* 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:
|
|
||||||
|
|
||||||
```
|
|
||||||
<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*.
|
|
||||||
|
|
||||||
## 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 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.
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
* 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](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.
|
|
||||||
|
|
||||||
### 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.
|
|
||||||
* 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).
|
|
||||||
|
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
||||||
### Fachlicher Test der Prüftool-Konfiguration XRechnung
|
|
||||||
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.
|
|
||||||
|
|
|
||||||
5
docs/about.md
Normal file
5
docs/about.md
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
# About
|
||||||
|
|
||||||
|
## German
|
||||||
|
|
||||||
|
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" (Engl. Validator) entwickelt und (vor-) konfiguriert.
|
||||||
74
docs/api.md
Normal file
74
docs/api.md
Normal file
|
|
@ -0,0 +1,74 @@
|
||||||
|
# Validator API
|
||||||
|
|
||||||
|
The Validator offers an API which allows you to integrate Validator in your own applications.
|
||||||
|
|
||||||
|
## Dependency Management
|
||||||
|
|
||||||
|
Currently, we *do not* deploy to Maven Central or similar. Hence you need to build and optionally deploy the Validator artifacts to your own shared repository (see for example [Maven Documentation](https://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html)).
|
||||||
|
|
||||||
|
### Maven
|
||||||
|
|
||||||
|
Then you can declare the dependency as follows:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<dependency>
|
||||||
|
<groupId>de.kosit</groupId>
|
||||||
|
<artifactId>validationtool</artifactId>
|
||||||
|
<version>${validator.version}</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Gradle
|
||||||
|
|
||||||
|
```js
|
||||||
|
dependencies {
|
||||||
|
compile group: 'de.kosit', name: 'validationtool', version: '1.0.0'
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Prerequisite for use is a valid [scenario definition](configurations.md) and the a folder with all necessary artifacts for validation (repository).
|
||||||
|
|
||||||
|
The following example demonstrates Der folgende Quellcode zeigt die Erzeugung einer neuen
|
||||||
|
Prüf-Instanz:
|
||||||
|
|
||||||
|
```java
|
||||||
|
//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:
|
||||||
|
|
||||||
|
```java
|
||||||
|
...
|
||||||
|
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);
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Initializing all XML artifacts and XSLT-executables is expensive. The `Check` instance is *threadsafe* and keeps all artifacts. Therefore, we recommend the re-use of an `Check` instance.
|
||||||
|
|
||||||
|
* Batch use is serial and *not parallel*
|
||||||
|
|
||||||
|
The only input `de.kosit.validationtool.api.Input` which can be created by various methods of `de.kosit.validationtool.api.InputFactory`.
|
||||||
|
The `InputFactory` calculates a hash sum for each Input which is also written to the Report. _SHA-256_ from the JDK is the default algorithm. It can be changed using the `read`-methods of `InputFactory`.
|
||||||
52
docs/architecture.md
Normal file
52
docs/architecture.md
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
# General Architecture
|
||||||
|
|
||||||
|
The validator itself is just an engine which executes validation according to a certain configuration (see [configuration documentation](docs/configurations.md)).
|
||||||
|
|
||||||
|
The validator takes a scenario.xml and the configured directory with all artifacts necessary for validation (scenario repository). Then it performs
|
||||||
|
the validation and generates a report in XML format. This report is then the input to an XSLT provided by the configuration.
|
||||||
|
|
||||||
|
## Separation of concerns
|
||||||
|
|
||||||
|
* The purpose of the validator is to only report if an XML instance is valid or not
|
||||||
|
* A configuration can provide an XSLT which takes the validator report and generates an own report
|
||||||
|
* This report may choose to conclude acceptance of the XML instance or not
|
||||||
|
|
||||||
|
The validator reports valid/invalid, a configuration reports acceptance/rejection!
|
||||||
|
|
||||||
|
## General process
|
||||||
|
|
||||||
|
The general process is like this:
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
|
||||||
|
sequenceDiagram
|
||||||
|
participant e as Validator
|
||||||
|
participant c as Configuration
|
||||||
|
e->>+c: create ScenarioRepository
|
||||||
|
c->>-e: is available
|
||||||
|
e->>e: parse XML
|
||||||
|
e->>e: select scenario
|
||||||
|
e->>e: validate XSD
|
||||||
|
e->>e: validate Schematron
|
||||||
|
e->>e: create Validator Report
|
||||||
|
e->>+c: execute configuration report generator
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
1. *parse XML*:
|
||||||
|
|
||||||
|
Is the XML instance valid in the basic sense. If not, validation is stopped and the validator report is returned with status *invalid*.
|
||||||
|
2. *select scenario*:
|
||||||
|
|
||||||
|
The configuration must have a defined scenario which matches the XML instance (it is an XPATH expression). If no scenario matches, validation is stopped and the validator report is returned with status *invalid*.
|
||||||
|
3. *validate XML-Schema*:
|
||||||
|
|
||||||
|
The XML instance must be valid according to the configured XSD. If not, validation is stopped and the validator report is returned with status *invalid*.
|
||||||
|
4. *validate Schematron*
|
||||||
|
5. *create Validator Report*:
|
||||||
|
|
||||||
|
All results are aggregated into the validation report:
|
||||||
|
* Depending on the configuration in the scenario, if there is a single *error* or *warning* the report will have status *invalid*, otherwise the status will be *valid*.
|
||||||
|
6. *execute configuration report generator*
|
||||||
|
|
||||||
|
The Validator will search for the XSLT as configured in scenario.xml and execute it with the Validator Report as input
|
||||||
54
docs/configurations.md
Normal file
54
docs/configurations.md
Normal file
|
|
@ -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 (`<scenario>` 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 each a name and define where to find the resources/artifacts for validation.
|
||||||
|
|
||||||
|
Lastly, you can define in an `<createReport>` 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 `<noScenarioReport>` 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 additional 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 scenario 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
|
||||||
|
<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</customLevel>
|
||||||
|
</createReport>
|
||||||
|
</scenario>
|
||||||
|
```
|
||||||
|
|
||||||
|
Here the errors reported by violating the schematron rule `BR-15` are translated from *error* to *warning*.
|
||||||
14
docs/qs.md
Normal file
14
docs/qs.md
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
# Quality Management
|
||||||
|
|
||||||
|
Some information on how we aim to ensure certain level of quality.
|
||||||
|
|
||||||
|
## Measures
|
||||||
|
|
||||||
|
* We perform unit tests (see [source code](src/test/java/de/kosit/validationtool) )
|
||||||
|
* We perform static code analysis using [Sonar](https://docs.sonarqube.org/display/SONAR/Metric+Definitions)
|
||||||
|
|
||||||
|
|
||||||
|
## XML-Security Best Practices
|
||||||
|
|
||||||
|
* We follow the [OWASP recommendations](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/XML_Security_Cheat_Sheet.md)
|
||||||
|
on best practices for JAVA XML to mitigate XML eXternal Entity (XXE) attacks and we do not allow external references on Entities and XIncludes per default.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue