mirror of
https://github.com/itplr-kosit/validator.git
synced 2026-05-25 16:55:39 +00:00
63 lines
3.1 KiB
Markdown
63 lines
3.1 KiB
Markdown
# Validator CLI
|
|
|
|
The validator comes with a commandline interface (CLI) which allows validating any number of input xml files.
|
|
|
|
The general way using the CLI is:
|
|
|
|
```shell
|
|
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> [OPTIONS] [FILE] [FILE] [FILE] ...
|
|
```
|
|
|
|
The validator can also read the xml file from the standard input
|
|
|
|
```shell script
|
|
# via redirection
|
|
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file> [OPTIONS] < my-input.xml
|
|
|
|
# read from pipe
|
|
cat my-input.xml | validationtool-<version>-standalone.jar -s <scenario-config-file> [OPTIONS]
|
|
```
|
|
|
|
The help option displays further CLI options to customize the process:
|
|
|
|
```shell
|
|
java -jar validationtool-<version>-standalone.jar --help
|
|
```
|
|
|
|
You can also use multiple scenario configurations and multiple repositories with resources for these. The validator either supports
|
|
supplying the parameters in order or using named configuration. Valid usages are
|
|
|
|
```shell
|
|
# multiple scenarios, implicit repository
|
|
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file1> -s <scenario-config-file2> [OPTIONS] [FILE]
|
|
|
|
# multiple scenarios, single defined repository
|
|
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file1> -s <scenario-config-file2> -r <path-to-repo> [OPTIONS] [FILE]
|
|
|
|
# multiple scenarios, multiple repositories ordered
|
|
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file1> -r <path-to-repo1> -s <scenario-config-file2> -r <path-to-repo2> [OPTIONS] [FILE]
|
|
java -jar validationtool-<version>-standalone.jar -s <scenario-config-file1> -s <scenario-config-file2> -r <path-to-repo1> -r <path-to-repo2> [OPTIONS] [FILE]
|
|
|
|
# multiple scenarios, multiple repositories (named)
|
|
java -jar validationtool-<version>-standalone.jar -s "NAME1=<scenario-config-file1>" -s "NAME2=<scenario-config-file2>" -r "NAME1=<path-to-repo1>" -r "NAME2=<path-to-repo2>" [OPTIONS] [FILE]
|
|
```
|
|
|
|
## Special features
|
|
|
|
Besides the obvious functionality of validating, the cli provides additional functionality to customize the processing:
|
|
|
|
|name | option | description | | - | - | - | | [Daemon mode](daemon.md) | `-D` | Starts the validator in daemon mode as an HTTP service | |
|
|
print mode | `-p` | Print the report to stdout | | extract html | `-h` | Extracts any html blocks within the report and saves the content to
|
|
the filesystem. Note: the file name is derived from the node name the html appears in | | print memory stats | `-m` | Prints some memory
|
|
usage information. Mainly for debugging purposes on processing huge xml files | | check assertions | `-c <file>` | Check assertions on the
|
|
generated reports. This is mainly useful for scenario developers. Ask KoSIT for documentation, if you want to use this feauture |
|
|
|
|
|
|
## Return codes
|
|
|
|
| code | description |
|
|
|-|-|
|
|
| 0 | All validated xml files are acceptable according to the scenario configurations |
|
|
| positive integer | Number of rejected (e.g. not acceptable) xml files according to the scenario configurations|
|
|
| -1 | Parsing error. The commandline arguments specified are incorrect |
|
|
| -2 | Configuration error. There is an error loading the configuration and/or validation targets |
|