2018-09-21 16:55:31 +02:00
|
|
|
import static com.sap.piper.Prerequisites.checkScript
|
|
|
|
|
2018-06-26 13:00:48 +02:00
|
|
|
import com.sap.piper.GitUtils
|
2018-08-09 11:35:33 +02:00
|
|
|
import com.sap.piper.Utils
|
2018-06-26 13:00:48 +02:00
|
|
|
import groovy.transform.Field
|
|
|
|
import hudson.AbortException
|
|
|
|
|
2018-07-06 09:05:26 +02:00
|
|
|
import com.sap.piper.ConfigurationHelper
|
2018-06-26 13:00:48 +02:00
|
|
|
import com.sap.piper.ConfigurationMerger
|
2018-09-28 13:45:26 +02:00
|
|
|
import com.sap.piper.cm.BackendType
|
2018-06-26 13:00:48 +02:00
|
|
|
import com.sap.piper.cm.ChangeManagement
|
|
|
|
import com.sap.piper.cm.ChangeManagementException
|
|
|
|
|
2018-09-28 15:54:20 +02:00
|
|
|
import static com.sap.piper.cm.StepHelpers.getChangeDocumentId
|
2018-09-28 14:43:51 +02:00
|
|
|
import static com.sap.piper.cm.StepHelpers.getBackendTypeAndLogInfoIfCMIntegrationDisabled
|
2018-09-28 15:54:20 +02:00
|
|
|
|
2018-06-26 13:00:48 +02:00
|
|
|
@Field def STEP_NAME = 'checkChangeInDevelopment'
|
|
|
|
|
2018-10-16 13:07:57 +02:00
|
|
|
@Field Set GENERAL_CONFIG_KEYS = STEP_CONFIG_KEYS
|
|
|
|
|
2018-10-16 13:07:57 +02:00
|
|
|
@Field Set STEP_CONFIG_KEYS = [
|
2018-07-17 09:21:56 +02:00
|
|
|
'changeManagement',
|
2018-10-26 12:14:03 +02:00
|
|
|
/**
|
|
|
|
* When set to `false` the step will not fail in case the step is not in status 'in development'.
|
|
|
|
* @possibleValues `true`, `false`
|
|
|
|
*/
|
2018-07-17 09:21:56 +02:00
|
|
|
'failIfStatusIsNotInDevelopment'
|
2018-06-26 13:00:48 +02:00
|
|
|
]
|
|
|
|
|
2018-10-16 13:07:57 +02:00
|
|
|
@Field Set PARAMETER_KEYS = STEP_CONFIG_KEYS.plus('changeDocumentId')
|
2018-07-06 09:05:26 +02:00
|
|
|
|
2018-10-26 12:32:25 +02:00
|
|
|
/**
|
2018-10-29 08:48:21 +02:00
|
|
|
* Checks if a Change Document in SAP Solution Manager is in status 'in development'. The change document id is retrieved from the git commit history. The change document id
|
|
|
|
* can also be provided via parameter `changeDocumentId`. Any value provided as parameter has a higher precedence than a value from the commit history.
|
|
|
|
*
|
|
|
|
* By default the git commit messages between `origin/master` and `HEAD` are scanned for a line like `ChangeDocument : <changeDocumentId>`. The commit
|
|
|
|
* range and the pattern can be configured. For details see 'parameters' table.
|
|
|
|
*
|
2018-11-05 11:19:57 +02:00
|
|
|
*/
|
2018-08-30 16:33:07 +02:00
|
|
|
void call(parameters = [:]) {
|
2018-06-26 13:00:48 +02:00
|
|
|
|
|
|
|
handlePipelineStepErrors (stepName: STEP_NAME, stepParameters: parameters) {
|
|
|
|
|
2018-10-31 09:40:12 +02:00
|
|
|
def script = checkScript(this, parameters) ?: this
|
2018-07-06 09:04:04 +02:00
|
|
|
|
2018-06-26 13:00:48 +02:00
|
|
|
GitUtils gitUtils = parameters?.gitUtils ?: new GitUtils()
|
|
|
|
|
2018-07-06 09:04:04 +02:00
|
|
|
ChangeManagement cm = parameters?.cmUtils ?: new ChangeManagement(script, gitUtils)
|
2018-06-26 13:00:48 +02:00
|
|
|
|
2018-10-17 11:05:20 +02:00
|
|
|
ConfigurationHelper configHelper = ConfigurationHelper.newInstance(this)
|
2018-09-07 10:08:16 +02:00
|
|
|
.loadStepDefaults()
|
2018-10-16 13:07:57 +02:00
|
|
|
.mixinGeneralConfig(script.commonPipelineEnvironment, GENERAL_CONFIG_KEYS)
|
|
|
|
.mixinStepConfig(script.commonPipelineEnvironment, STEP_CONFIG_KEYS)
|
|
|
|
.mixinStageConfig(script.commonPipelineEnvironment, parameters.stageName?:env.STAGE_NAME, STEP_CONFIG_KEYS)
|
|
|
|
.mixin(parameters, PARAMETER_KEYS)
|
2018-09-28 13:45:26 +02:00
|
|
|
|
|
|
|
Map configuration = configHelper.use()
|
|
|
|
|
2018-09-28 14:43:51 +02:00
|
|
|
BackendType backendType = getBackendTypeAndLogInfoIfCMIntegrationDisabled(this, configuration)
|
|
|
|
if(backendType == BackendType.NONE) return
|
2018-09-28 13:45:26 +02:00
|
|
|
|
|
|
|
configHelper
|
2018-08-15 10:37:34 +02:00
|
|
|
// for the following parameters we expect defaults
|
2018-11-05 11:19:57 +02:00
|
|
|
/**
|
|
|
|
* A pattern used for identifying lines holding the change document id.
|
|
|
|
* @possibleValues regex pattern
|
|
|
|
*/
|
2018-08-15 10:37:34 +02:00
|
|
|
.withMandatoryProperty('changeManagement/changeDocumentLabel')
|
2018-11-05 11:19:57 +02:00
|
|
|
/**
|
|
|
|
* Additional options for cm command line client, e.g. like JAVA_OPTS.
|
|
|
|
*/
|
2018-08-15 10:37:34 +02:00
|
|
|
.withMandatoryProperty('changeManagement/clientOpts')
|
2018-11-05 11:19:57 +02:00
|
|
|
/**
|
|
|
|
* The id of the credentials to connect to the Solution Manager. The credentials needs to be maintained on Jenkins.
|
|
|
|
*/
|
2018-08-15 10:37:34 +02:00
|
|
|
.withMandatoryProperty('changeManagement/credentialsId')
|
2018-11-05 11:19:57 +02:00
|
|
|
/**
|
|
|
|
* The starting point for retrieving the change document id
|
|
|
|
*/
|
2018-08-15 10:37:34 +02:00
|
|
|
.withMandatoryProperty('changeManagement/git/from')
|
2018-11-05 11:19:57 +02:00
|
|
|
/**
|
|
|
|
* The end point for retrieving the change document id
|
|
|
|
*/
|
2018-08-15 10:37:34 +02:00
|
|
|
.withMandatoryProperty('changeManagement/git/to')
|
2018-11-05 11:19:57 +02:00
|
|
|
/**
|
|
|
|
* Specifies what part of the commit is scanned. By default the body of the commit message is scanned.
|
|
|
|
* @possibleValues see `git log --help`
|
|
|
|
*/
|
2018-08-15 10:37:34 +02:00
|
|
|
.withMandatoryProperty('changeManagement/git/format')
|
|
|
|
.withMandatoryProperty('failIfStatusIsNotInDevelopment')
|
|
|
|
// for the following parameters we expect a value provided from outside
|
2018-10-16 13:07:57 +02:00
|
|
|
/**
|
|
|
|
* The address of the Solution Manager.
|
|
|
|
*/
|
2018-08-15 10:37:34 +02:00
|
|
|
.withMandatoryProperty('changeManagement/endpoint')
|
2018-07-17 09:21:56 +02:00
|
|
|
|
2018-10-30 17:22:42 +02:00
|
|
|
new Utils().pushToSWA([step: STEP_NAME,
|
2018-11-05 13:26:48 +02:00
|
|
|
stepParam1: parameters?.script == null], configuration)
|
2018-08-09 11:35:33 +02:00
|
|
|
|
2018-09-28 15:54:20 +02:00
|
|
|
def changeId = getChangeDocumentId(cm, this, configuration)
|
2018-06-26 13:00:48 +02:00
|
|
|
|
2018-07-12 08:54:04 +02:00
|
|
|
configuration = configHelper.mixin([changeDocumentId: changeId?.trim() ?: null], ['changeDocumentId'] as Set)
|
2018-10-16 13:07:57 +02:00
|
|
|
|
2018-11-05 11:22:44 +02:00
|
|
|
/**
|
|
|
|
* The id of the change document to transport. If not provided, it is retrieved from the git commit history.
|
|
|
|
*/
|
2018-07-12 08:54:04 +02:00
|
|
|
.withMandatoryProperty('changeDocumentId',
|
|
|
|
"No changeDocumentId provided. Neither via parameter 'changeDocumentId' " +
|
2018-07-17 09:21:56 +02:00
|
|
|
"nor via label '${configuration.changeManagement.changeDocumentLabel}' in commit range " +
|
|
|
|
"[from: ${configuration.changeManagement.git.from}, to: ${configuration.changeManagement.git.to}].")
|
2018-07-12 08:54:04 +02:00
|
|
|
.use()
|
|
|
|
|
2018-06-26 13:00:48 +02:00
|
|
|
boolean isInDevelopment
|
|
|
|
|
2018-07-12 08:54:04 +02:00
|
|
|
echo "[INFO] Checking if change document '${configuration.changeDocumentId}' is in development."
|
2018-06-26 13:00:48 +02:00
|
|
|
|
2018-07-16 15:41:46 +02:00
|
|
|
try {
|
2018-06-26 13:00:48 +02:00
|
|
|
|
2018-07-16 15:41:46 +02:00
|
|
|
isInDevelopment = cm.isChangeInDevelopment(configuration.changeDocumentId,
|
|
|
|
configuration.changeManagement.endpoint,
|
|
|
|
configuration.changeManagement.credentialsId,
|
|
|
|
configuration.changeManagement.clientOpts)
|
|
|
|
|
|
|
|
} catch(ChangeManagementException ex) {
|
|
|
|
throw new AbortException(ex.getMessage())
|
2018-06-26 13:00:48 +02:00
|
|
|
}
|
|
|
|
|
2018-07-16 15:41:46 +02:00
|
|
|
|
2018-06-26 13:00:48 +02:00
|
|
|
if(isInDevelopment) {
|
|
|
|
echo "[INFO] Change '${changeId}' is in status 'in development'."
|
|
|
|
} else {
|
|
|
|
if(configuration.failIfStatusIsNotInDevelopment.toBoolean()) {
|
|
|
|
throw new AbortException("Change '${changeId}' is not in status 'in development'.")
|
|
|
|
|
|
|
|
} else {
|
|
|
|
echo "[WARNING] Change '${changeId}' is not in status 'in development'. Failing the pipeline has been explicitly disabled."
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|