mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-12 10:55:20 +02:00
83 lines
2.7 KiB
Groovy
83 lines
2.7 KiB
Groovy
import static com.sap.piper.Prerequisites.checkScript
|
|
|
|
import com.sap.piper.GenerateDocumentation
|
|
import com.sap.piper.ConfigurationHelper
|
|
import com.sap.piper.Utils
|
|
import com.sap.piper.analytics.InfluxData
|
|
|
|
import groovy.transform.Field
|
|
|
|
@Field String STEP_NAME = getClass().getName()
|
|
|
|
@Field Set GENERAL_CONFIG_KEYS = [
|
|
/** */
|
|
'collectTelemetryData'
|
|
]
|
|
|
|
@Field Set STEP_CONFIG_KEYS = []
|
|
|
|
@Field Set PARAMETER_KEYS = [
|
|
/** Property file defining project specific settings.*/
|
|
'configFile'
|
|
]
|
|
|
|
/**
|
|
* Initializes the [`commonPipelineEnvironment`](commonPipelineEnvironment.md), which is used throughout the complete pipeline.
|
|
*
|
|
* !!! tip
|
|
* This step needs to run at the beginning of a pipeline right after the SCM checkout.
|
|
* Then subsequent pipeline steps consume the information from `commonPipelineEnvironment`; it does not need to be passed to pipeline steps explicitly.
|
|
*/
|
|
@GenerateDocumentation
|
|
void call(Map parameters = [:]) {
|
|
|
|
handlePipelineStepErrors (stepName: STEP_NAME, stepParameters: parameters) {
|
|
|
|
def script = checkScript(this, parameters)
|
|
|
|
prepareDefaultValues script: script, customDefaults: parameters.customDefaults
|
|
|
|
List customDefaults = ['default_pipeline_environment.yml'].plus(parameters.customDefaults?:[])
|
|
customDefaults.each {
|
|
cd ->
|
|
writeFile file: ".pipeline/${cd}", text: libraryResource(cd)
|
|
}
|
|
|
|
String configFile = parameters.get('configFile')
|
|
|
|
loadConfigurationFromFile(script, configFile)
|
|
|
|
Map config = ConfigurationHelper.newInstance(this)
|
|
.loadStepDefaults()
|
|
.mixinGeneralConfig(script.commonPipelineEnvironment, GENERAL_CONFIG_KEYS)
|
|
.use()
|
|
|
|
(parameters.utils ?: new Utils()).pushToSWA([
|
|
step: STEP_NAME,
|
|
stepParamKey4: 'customDefaults',
|
|
stepParam4: parameters.customDefaults?'true':'false'
|
|
], config)
|
|
|
|
InfluxData.addField('step_data', 'build_url', env.BUILD_URL)
|
|
InfluxData.addField('pipeline_data', 'build_url', env.BUILD_URL)
|
|
}
|
|
}
|
|
|
|
private loadConfigurationFromFile(script, String configFile) {
|
|
if (!configFile) {
|
|
String defaultYmlConfigFile = '.pipeline/config.yml'
|
|
String defaultYamlConfigFile = '.pipeline/config.yaml'
|
|
if (fileExists(defaultYmlConfigFile)) {
|
|
configFile = defaultYmlConfigFile
|
|
} else if (fileExists(defaultYamlConfigFile)) {
|
|
configFile = defaultYamlConfigFile
|
|
}
|
|
}
|
|
|
|
// A file passed to the function is not checked for existence in order to fail the pipeline.
|
|
if (configFile) {
|
|
script.commonPipelineEnvironment.configuration = readYaml(file: configFile)
|
|
script.commonPipelineEnvironment.configurationFile = configFile
|
|
}
|
|
}
|