Skip to content

Commit

Permalink
Add section about license compliance and testing to external-sop/README
Browse files Browse the repository at this point in the history
  • Loading branch information
vanitasvitae committed Jan 22, 2023
1 parent 6c3e148 commit e18dfec
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions external-sop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)).

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.
For this purpose, additional environment variables can be passed in using a `Properties` object:

Expand Down Expand Up @@ -50,3 +52,9 @@ ExternalSOP.TempDirProvider provider = new ExternalSOP.TempDirProvider() {
};
SOP sop = new ExternalSOP("/usr/bin/example-sop", provider);
```

## Testing
The `external-sop` module comes with a growing test suite, which checks expectations of the SOP specification.
To configure different 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`.

0 comments on commit e18dfec

Please sign in to comment.