sap-jenkins-library/vars/pipelineExecute.groovy

import com.sap.piper.GenerateDocumentation
import com.sap.piper.ConfigurationHelper

import groovy.transform.Field


@Field STEP_NAME = getClass().getName()

@Field Set GENERAL_CONFIG_KEYS = []

@Field Set STEP_CONFIG_KEYS = []

@Field Set PARAMETER_KEYS = [
    /** The url to the git repository of the pipeline to be loaded.*/
    'repoUrl',
    /** The branch of the git repository from which the pipeline should be checked out.*/
    'branch',
    /** The path to the Jenkinsfile, inside the repository, to be loaded.*/
    'path',
    /**
     * The Jenkins credentials containing user and password needed to access a private git repository.
     * In case access to the repository containing the pipeline script is restricted the credentialsId of the credentials used for
     * accessing the repository needs to be provided. The corresponding credentials needs to be configured in Jenkins accordingly.
     */
    'credentialsId'
]

/**
 * Loads and executes a pipeline from another git repository.
 * The idea is to set up a pipeline job in Jenkins that loads a minimal pipeline, which
 * in turn loads the shared library and then uses this step to load the actual pipeline.
 *
 * A centrally maintained pipeline script (Jenkinsfile) can be re-used by
 * several projects using `pipelineExecute` as outlined in the example below.
 */
@GenerateDocumentation
void call(Map parameters = [:]) {

    node() {

        Map config

        handlePipelineStepErrors (stepName: 'pipelineExecute', stepParameters: parameters, failOnError: true) {

            ConfigurationHelper configHelper = ConfigurationHelper.newInstance(this)
                .loadStepDefaults()
                .mixin(parameters, PARAMETER_KEYS)
                .withMandatoryProperty('repoUrl')
                .withMandatoryProperty('branch')
                .withMandatoryProperty('path')
                .withMandatoryProperty('credentialsId')

            config =  configHelper.use()

            deleteDir()

            checkout([
                $class: 'GitSCM',
                branches: [[name: config.branch]],
                doGenerateSubmoduleConfigurations: false,
                extensions: [[
                    $class: 'SparseCheckoutPaths',
                    sparseCheckoutPaths: [[path: config.path]]
                ]],
                submoduleCfg: [],
                userRemoteConfigs: [[
                    credentialsId: config.credentialsId,
                    url: config.repoUrl
                ]]
            ])

        }
        load config.path
    }
}