You've already forked sap-jenkins-library
mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-06-15 00:05:11 +02:00
34 lines
1002 B
Markdown
34 lines
1002 B
Markdown
|
# toolValidate
|
||
|
|
|
||
|
|
## Description
|
||
|
|
|
||
|
|
Checks the existence and compatibility of a tool, necessary for a successful pipeline execution.
|
||
|
|
In case a violation is found, an exception is raised.
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| parameter | mandatory | default | possible values |
|
||
|
|
| -----------------|-----------|-----------------------------------|----------------------------|
|
||
|
|
| `tool` | yes | | 'java', 'mta', 'neo' |
|
||
|
|
| `home` | yes | | |
|
||
|
|
|
||
|
|
* `tool` The tool that is checked for existence and compatible version.
|
||
|
|
* `home` The location in the file system where Jenkins can access the tool.
|
||
|
|
|
||
|
|
## Exceptions
|
||
|
|
|
||
|
|
* `IllegalArgumentException`
|
||
|
|
* If at least one of the parameters `tool`, `home` is not provided.
|
||
|
|
* `AbortException`
|
||
|
|
* If `tool` is not supported.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
```groovy
|
||
|
|
toolValidate tool: 'neo', home:'/path/to/neo-java-web-sdk'
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|