1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/vars/piperPipelineStageAcceptance.groovy
2022-09-16 13:12:29 +02:00

143 lines
6.3 KiB
Groovy

import com.sap.piper.ConfigurationHelper
import com.sap.piper.GenerateStageDocumentation
import com.sap.piper.StageNameProvider
import com.sap.piper.Utils
import groovy.transform.Field
import static com.sap.piper.Prerequisites.checkScript
@Field String STEP_NAME = getClass().getName()
@Field String TECHNICAL_STAGE_NAME = 'endToEndTests'
@Field Set GENERAL_CONFIG_KEYS = []
@Field STAGE_STEP_KEYS = [
/** Can perform both deployments to cloud foundry and neo targets. Preferred over cloudFoundryDeploy and neoDeploy, if configured. */
'multicloudDeploy',
/** For Cloud Foundry use-cases: Performs deployment to Cloud Foundry space/org. */
'cloudFoundryDeploy',
/** Performs behavior-driven tests using Gauge test framework against the deployed application/service. */
'gaugeExecuteTests',
/** For Kubernetes use-cases: Performs deployment to Kubernetes landscape. */
'kubernetesDeploy',
/**
* Performs health check in order to prove one aspect of operational readiness.
* In order to be able to respond to health checks from infrastructure components (like load balancers) it is important to provide one unprotected application endpoint which allows a judgement about the health of your application.
*/
'healthExecuteCheck',
/** For Neo use-cases: Performs deployment to Neo landscape. */
'neoDeploy',
/** Performs API testing using Newman against the deployed application/service. */
'newmanExecute',
/** Publishes test results to Jenkins. It will automatically be active in cases tests are executed. */
'testsPublishResults',
/** Performs end-to-end UI testing using UIVeri5 test framework against the deployed application/service. */
'uiVeri5ExecuteTests',
/** Executes end to end tests by running the npm script 'ci-e2e' defined in the project's package.json file. */
'npmExecuteEndToEndTests'
]
@Field Set STEP_CONFIG_KEYS = GENERAL_CONFIG_KEYS.plus(STAGE_STEP_KEYS)
@Field Set PARAMETER_KEYS = STEP_CONFIG_KEYS
/**
* In this stage the application/service is typically deployed and automated acceptance tests are executed.<br />
* This is to make sure that
*
* * new functionality is tested end-to-end
* * there is no end-to-end regression in existing functionality
*
*/
@GenerateStageDocumentation(defaultStageName = "Acceptance")
void call(Map parameters = [:]) {
def script = checkScript(this, parameters) ?: this
def utils = parameters.juStabUtils ?: new Utils()
def stageName = StageNameProvider.instance.getStageName(script, parameters, this)
Map config = ConfigurationHelper.newInstance(this)
.loadStepDefaults()
.mixinGeneralConfig(script.commonPipelineEnvironment, GENERAL_CONFIG_KEYS)
.mixinStageConfig(script.commonPipelineEnvironment, stageName, STEP_CONFIG_KEYS)
.mixin(parameters, PARAMETER_KEYS)
.addIfEmpty('multicloudDeploy', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.multicloudDeploy)
.addIfEmpty('cloudFoundryDeploy', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.cloudFoundryDeploy)
.addIfEmpty('kubernetesDeploy', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.kubernetesDeploy)
.addIfEmpty('gaugeExecuteTests', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.gaugeExecuteTests)
.addIfEmpty('healthExecuteCheck', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.healthExecuteCheck)
.addIfEmpty('neoDeploy', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.neoDeploy)
.addIfEmpty('newmanExecute', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.newmanExecute)
.addIfEmpty('uiVeri5ExecuteTests', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.uiVeri5ExecuteTests)
.addIfEmpty('npmExecuteEndToEndTests', script.commonPipelineEnvironment.configuration.runStep?.get(stageName)?.npmExecuteEndToEndTests)
.use()
piperStageWrapper (script: script, stageName: stageName) {
// telemetry reporting
utils.pushToSWA([step: STEP_NAME], config)
// Prefer the newer multicloudDeploy step if it is configured as it is more capable
if (config.multicloudDeploy) {
durationMeasure(script: script, measurementName: 'deploy_test_multicloud_duration') {
multicloudDeploy(script: script, stage: stageName)
}
} else {
if (config.cloudFoundryDeploy) {
durationMeasure(script: script, measurementName: 'deploy_test_cf_duration') {
cloudFoundryDeploy script: script
}
}
if (config.neoDeploy) {
durationMeasure(script: script, measurementName: 'deploy_test_neo_duration') {
neoDeploy script: script
}
}
if (config.kubernetesDeploy){
durationMeasure(script: script, measurementName: 'deploy_release_kubernetes_duration') {
kubernetesDeploy script: script
}
}
}
if (config.healthExecuteCheck) {
healthExecuteCheck script: script
}
def publishMap = [script: script]
def publishResults = false
if (config.gaugeExecuteTests) {
durationMeasure(script: script, measurementName: 'gauge_duration') {
publishResults = true
gaugeExecuteTests script: script
publishMap += [gauge: [archive: true]]
}
}
if (config.newmanExecute) {
durationMeasure(script: script, measurementName: 'newman_duration') {
publishResults = true
newmanExecute script: script
}
}
if (config.uiVeri5ExecuteTests) {
durationMeasure(script: script, measurementName: 'uiveri5_duration') {
publishResults = true
uiVeri5ExecuteTests script: script
}
}
if (config.npmExecuteEndToEndTests) {
durationMeasure(script: script, measurementName: 'npmExecuteEndToEndTests_duration') {
npmExecuteEndToEndTests script: script, stageName: stageName
}
}
if (publishResults) {
testsPublishResults publishMap
}
}
}