2017-07-11 15:12:03 +02:00
|
|
|
# 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.
|
|
|
|
|
2017-11-24 16:59:34 +02:00
|
|
|
## Prerequisites
|
|
|
|
none
|
2017-07-11 15:12:03 +02:00
|
|
|
|
2017-11-24 16:59:34 +02:00
|
|
|
## Parameters
|
2017-07-11 15:12:03 +02:00
|
|
|
| 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.
|
|
|
|
|
2018-03-06 14:43:53 +02:00
|
|
|
## Step configuration
|
|
|
|
none
|
|
|
|
|
2017-11-24 16:59:34 +02:00
|
|
|
## Return value
|
|
|
|
none
|
2017-07-11 15:12:03 +02:00
|
|
|
|
2017-11-24 16:59:34 +02:00
|
|
|
## Side effects
|
|
|
|
none
|
|
|
|
|
|
|
|
## Exceptions
|
|
|
|
* `IllegalArgumentException`:
|
2017-07-11 15:12:03 +02:00
|
|
|
* If at least one of the parameters `tool`, `home` is not provided.
|
2017-11-24 16:59:34 +02:00
|
|
|
* `AbortException`:
|
2017-07-11 15:12:03 +02:00
|
|
|
* If `tool` is not supported.
|
|
|
|
|
|
|
|
## Example
|
|
|
|
```groovy
|
|
|
|
toolValidate tool: 'neo', home:'/path/to/neo-java-web-sdk'
|
|
|
|
```
|
|
|
|
|