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/commonPipelineEnvironment.md
Christopher Fenner f757a0e1d4
fix Markdown issues (#365)
* fix Markdown issue 'Headers should be surrounded by blank lines'

* fix MD012

* fix MD022

* fix MD026

* fix MD007

* fix MD032

* fix MD038

* fix MD040

* fix MD031

* fix MD034

* fix MD004

* fix new findings

* fix MD036

* fix MD038

* fix MD032

* fix MD006
2018-11-06 13:50:09 +01:00

352 lines
4.9 KiB
Markdown

# commonPipelineEnvironment
## Description
Provides project specific settings.
## Prerequisites
none
## Method details
### getArtifactVersion()
#### Description
Returns the version of the artifact which is build in the pipeline.
#### Parameters
none
#### Return value
A `String` containing the version.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
def myVersion = commonPipelineEnvironment.getArtifactVersion()
```
### setArtifactVersion(version)
#### Description
Sets the version of the artifact which is build in the pipeline.
#### Parameters
none
#### Return value
none
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setArtifactVersion('1.2.3')
```
### getConfigProperties()
#### Description
Returns the map of project specific configuration properties. No defensive copy is created.
Write operations to the map are visible further down in the pipeline.
#### Parameters
none
#### Return value
A map containing project specific configuration properties.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.getConfigProperties()
```
### setConfigProperties(configuration)
#### Description
Sets the map of configuration properties. Any existing map is overwritten.
#### Parameters
* `configuration` - A map containing the new configuration
#### Return value
none
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setConfigProperties([DEPLOY_HOST: 'deploy-host.com', DEPLOY_ACCOUNT: 'deploy-account'])
```
### getConfigProperty(property)
#### Description
Gets a specific value from the configuration property.
#### Parameters
* `property` - The key of the property.
#### Return value
* The value associated with key `property`. `null` is returned in case the property does not exist.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.getConfigProperty('DEPLOY_HOST')
```
### setConfigProperty(property, value)
#### Description
Sets property `property` with value `value`. Any existing property with key `property` is overwritten.
#### Parameters
* `property` - The key of the property.
* `value` - The value of the property.
#### Return value
none
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setConfigProperty('DEPLOY_HOST', 'my-deploy-host.com')
```
### getInfluxCustomData()
#### Description
Returns the Influx custom data which can be collected during pipeline run.
#### Parameters
none
#### Return value
A `Map` containing the data collected.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
def myInfluxData = commonPipelineEnvironment.getInfluxCustomData()
```
### getInfluxCustomDataMap()
#### Description
Returns the Influx custom data map which can be collected during pipeline run.
It is used for example by step [`influxWriteData`](../steps/influxWriteData.md).
The data map is a map of maps, like `[pipeline_data: [:], my_measurement: [:]]`
Each map inside the map represents a dedicated measurement in the InfluxDB.
#### Parameters
none
#### Return value
A `Map` containing a `Map`s with data collected.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
def myInfluxDataMap = commonPipelineEnvironment.getInfluxCustomDataMap()
```
### getMtarFileName()
#### Description
Returns the path of the mtar archive file.
#### Parameters
none
#### Return value
The path of the mtar archive file.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.getMtarFileName()
```
### setMtarFileName(name)
#### Description
Sets the path of the mtar archive file. Any old value is discarded.
#### Parameters
* `mtarFilePath` - The path of the mtar archive file name.
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setMtarFileName('path/to/foo.mtar')
```
### getPipelineMeasurement(measurementName)
#### Description
Returns the value of a specific pipeline measurement.
The measurements are collected with step [`durationMeasure`](../steps/durationMeasure.md)
#### Parameters
Name of the measurement
#### Return value
Value of the measurement
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
def myMeasurementValue = commonPipelineEnvironment.getPipelineMeasurement('build_stage_duration')
```
### setPipelineMeasurement(measurementName, value)
#### Description
**This is an internal function!**
Sets the value of a specific pipeline measurement.
Please use the step [`durationMeasure`](../steps/durationMeasure.md) in a pipeline, instead.
#### Parameters
Name of the measurement and its value.
#### Return value
none
#### Side effects
none
#### Exceptions
none
#### Example
```groovy
commonPipelineEnvironment.setPipelineMeasurement('build_stage_duration', 2345)
```