PGPainless/sop-java
1
0
Fork 0
mirror of https://codeberg.org/PGPainless/sop-java.git synced 2024-12-21 20:47:58 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add section about license compliance and testing to external-sop/README

Browse source
This commit is contained in:
Paul Schaub 2023-01-22 17:37:47 +01:00
parent 6c3e148bcd
commit 88e3ba0095
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
external-sop/README.md
View file

@ -23,6 +23,8 @@ SOP sop = new ExternalSOP("/usr/bin/example-sop");
This SOP object can now be used as usual (see [here](../sop-java/README.md)). This SOP object can now be used as usual (see [here](../sop-java/README.md)).
Keep in mind the license of the external SOP binary when integrating one with your project!
Some SOP binaries might require additional configuration, e.g. a Java based SOP might need to know which JAVA_HOME to use. Some SOP binaries might require additional configuration, e.g. a Java based SOP might need to know which JAVA_HOME to use.
For this purpose, additional environment variables can be passed in using a `Properties` object: For this purpose, additional environment variables can be passed in using a `Properties` object:
@ -50,3 +52,8 @@ ExternalSOP.TempDirProvider provider = new ExternalSOP.TempDirProvider() {
}; };
SOP sop = new ExternalSOP("/usr/bin/example-sop", provider); SOP sop = new ExternalSOP("/usr/bin/example-sop", provider);
``` ```
## Testing
The `external-sop` module comes with a growing test suite, which tests SOP binaries against the expectations of the SOP specification.
To configure one or multiple backends for use with the test suite, just provide a custom `config.json` file in `src/main/resources/sop/external`.
An example configuration file with the required file format is available as `config.json.example`.