sap-jenkins-library/documentation/docs/scenarios/CAP_Scenario.md

Build and Deploy SAP Cloud Application Programming Model Applications

In this scenario, we will setup a CI/CD Pipeline for a SAP Cloud Application Programming Model (CAP) project, which is based on the SAP Cloud Platform Business Application WebIDE Template.

Prerequisites

• You have an account on SAP Cloud Platform in the Cloud Foundry environment. See Accounts.
• You have setup a suitable Jenkins instance as described in Guided Tour

Context

The Application Programming Model for SAP Cloud Platform is an end-to-end best practice guide for developing applications on SAP Cloud Platform and provides a supportive set of APIs, languages, and libraries. For more information about the SAP Cloud Application Programming Model, see Working with the SAP Cloud Application Programming Model.

Getting started

To get started, generate a project in SAP Web IDE based on the SAP Cloud Platform Business Application template. Make sure to check the Include support for continuous delivery pipeline of SAP Cloud SDK checkbox, as in this screenshot:

This will generate a project which already includes a Jenkinsfile, and a pipeline_config.yml file.

!!! note "New location of pipeline configuration file" The SAP Cloud SDK Pipeline recently changed the default location for the configuration file from pipeline_config.yml to .config/pipeline to have a consistent user experience with other piper pipelines. For a limited amount of time starting with version v29 both locations can be used. In the following the configuration file is referenced by its new location.

In case you already created your project without this option, you'll need to copy and paste two files into the root directory of your project, and commit them to your git repository:

• Jenkinsfile
• .pipeline/config.yml
  • Note: The file must be named .pipeline/config.yml, despite the different name of the file template

!!! note "Using the right project structure" This only applies to projects created based on the SAP Cloud Platform Business Application template after September 6th 2019. They must comply with the structure which is described here.

If your project uses SAP HANA containers (HDI), you'll need to configure createHdiContainer and cloudFoundry in the backendIntegrationTests stage in your .pipeline/config.yml file as documented here

Now, you'll need to push the code to a git repository. This is required because the pipeline gets your code via git. This might be GitHub, or any other cloud or on-premise git solution you have in your company.

Be sure to configure the productionDeployment stage so your changes are deployed to SAP Cloud Platform automatically.

Legacy documentation

If your project is not based on the SAP Cloud Platform Business Application WebIDE template, you could either migrate your code to comply with the structure which is described here, or you can use a self built pipeline, as described in this section.

Prerequisites

• You have an account on SAP Cloud Platform in the Cloud Foundry environment. See Accounts.
• You have downloaded and installed the Cloud Foundry command line interface (CLI). See Download and Install the Cloud Foundry Command Line Interface.
• You have installed the multi-target application plug-in for the Cloud Foundry command line interface. See Install the Multi-Target Application Plug-in in the Cloud Foundry Environment.
• You have installed the Java Runtime Environment 8.
• You have installed Jenkins 2.60.3 or higher.
• You have set up Project “Piper”. See README.
• You have installed the Multi-Target Application (MTA) Archive Builder 1.0.6 or newer. See SAP Development Tools.
• You have installed Node.js including node and npm. See Node.js.

Context

The Application Programming Model for SAP Cloud Platform is an end-to-end best practice guide for developing applications on SAP Cloud Platform and provides a supportive set of APIs, languages, and libraries. For more information about the SAP Cloud Application Programming Model, see Working with the SAP Cloud Application Programming Model.

In this scenario, we want to show how to implement a basic continuous delivery process for developing applications according to this programming model with the help of project "Piper" on Jenkins. This basic scenario can be adapted and enriched according to your specific needs.

Example

Jenkinsfile

@Library('piper-lib-os') _

node(){
  stage('Prepare')   {
      deleteDir()
      checkout scm
      setupCommonPipelineEnvironment script:this
  }

  stage('Build')   {
      mtaBuild script:this
  }

  stage('Deploy')   {
      cloudFoundryDeploy script:this, deployTool:'mtaDeployPlugin'
  }
}

Configuration (.pipeline/config.yml)

steps:
  mtaBuild:
    buildTarget: 'CF'
  cloudFoundryDeploy:
    cloudFoundry:
      credentialsId: 'CF'
      apiEndpoint: '<CF Endpoint>'
      org: '<CF Organization>'
      space: '<CF Space>'

Parameters

For the detailed description of the relevant parameters, see:

• mtaBuild
• cloudFoundryDeploy