1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/documentation/docs/steps/toolValidate.md

39 lines
1.1 KiB
Markdown
Raw Normal View History

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.
## Prerequisites
none
2017-07-11 15:12:03 +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
## Return value
none
2017-07-11 15:12:03 +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.
* `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'
```