2020-11-03 13:02:13 +02:00
// Code generated by piper's step-generator. DO NOT EDIT.
package cmd
import (
"fmt"
"os"
"time"
"github.com/SAP/jenkins-library/pkg/config"
"github.com/SAP/jenkins-library/pkg/log"
2021-05-17 12:14:04 +02:00
"github.com/SAP/jenkins-library/pkg/splunk"
2020-11-03 13:02:13 +02:00
"github.com/SAP/jenkins-library/pkg/telemetry"
"github.com/spf13/cobra"
)
type abapEnvironmentCreateSystemOptions struct {
2020-11-03 14:41:39 +02:00
CfAPIEndpoint string ` json:"cfApiEndpoint,omitempty" `
Username string ` json:"username,omitempty" `
Password string ` json:"password,omitempty" `
CfOrg string ` json:"cfOrg,omitempty" `
CfSpace string ` json:"cfSpace,omitempty" `
CfService string ` json:"cfService,omitempty" `
CfServicePlan string ` json:"cfServicePlan,omitempty" `
CfServiceInstance string ` json:"cfServiceInstance,omitempty" `
ServiceManifest string ` json:"serviceManifest,omitempty" `
AbapSystemAdminEmail string ` json:"abapSystemAdminEmail,omitempty" `
AbapSystemDescription string ` json:"abapSystemDescription,omitempty" `
AbapSystemIsDevelopmentAllowed bool ` json:"abapSystemIsDevelopmentAllowed,omitempty" `
AbapSystemID string ` json:"abapSystemID,omitempty" `
AbapSystemSizeOfPersistence int ` json:"abapSystemSizeOfPersistence,omitempty" `
AbapSystemSizeOfRuntime int ` json:"abapSystemSizeOfRuntime,omitempty" `
AddonDescriptorFileName string ` json:"addonDescriptorFileName,omitempty" `
IncludeAddon bool ` json:"includeAddon,omitempty" `
2020-11-03 13:02:13 +02:00
}
// AbapEnvironmentCreateSystemCommand Creates a SAP Cloud Platform ABAP Environment system (aka Steampunk system)
func AbapEnvironmentCreateSystemCommand ( ) * cobra . Command {
const STEP_NAME = "abapEnvironmentCreateSystem"
metadata := abapEnvironmentCreateSystemMetadata ( )
var stepConfig abapEnvironmentCreateSystemOptions
var startTime time . Time
2021-05-17 12:14:04 +02:00
var logCollector * log . CollectorHook
2020-11-03 13:02:13 +02:00
var createAbapEnvironmentCreateSystemCmd = & cobra . Command {
Use : STEP_NAME ,
Short : "Creates a SAP Cloud Platform ABAP Environment system (aka Steampunk system)" ,
2020-11-11 18:08:24 +02:00
Long : ` This step creates a SAP Cloud Platform ABAP Environment system (aka Steampunk system) via the cloud foundry command line interface (cf CLI). This can be done by providing a service manifest as a configuration file (parameter ` + "`" + ` serviceManifest ` + "`" + ` ) or by passing the configuration values directly via the other parameters of this step. ` ,
2020-11-03 13:02:13 +02:00
PreRunE : func ( cmd * cobra . Command , _ [ ] string ) error {
startTime = time . Now ( )
log . SetStepName ( STEP_NAME )
log . SetVerbose ( GeneralConfig . Verbose )
2021-07-08 15:26:07 +02:00
GeneralConfig . GitHubAccessTokens = ResolveAccessTokens ( GeneralConfig . GitHubTokens )
2020-11-03 13:02:13 +02:00
path , _ := os . Getwd ( )
fatalHook := & log . FatalHook { CorrelationID : GeneralConfig . CorrelationID , Path : path }
log . RegisterHook ( fatalHook )
err := PrepareConfig ( cmd , & metadata , STEP_NAME , & stepConfig , config . OpenPiperFile )
if err != nil {
log . SetErrorCategory ( log . ErrorConfiguration )
return err
}
log . RegisterSecret ( stepConfig . Username )
log . RegisterSecret ( stepConfig . Password )
if len ( GeneralConfig . HookConfig . SentryConfig . Dsn ) > 0 {
sentryHook := log . NewSentryHook ( GeneralConfig . HookConfig . SentryConfig . Dsn , GeneralConfig . CorrelationID )
log . RegisterHook ( & sentryHook )
}
2021-05-17 12:14:04 +02:00
if len ( GeneralConfig . HookConfig . SplunkConfig . Dsn ) > 0 {
logCollector = & log . CollectorHook { CorrelationID : GeneralConfig . CorrelationID }
log . RegisterHook ( logCollector )
}
2020-11-03 13:02:13 +02:00
return nil
} ,
Run : func ( _ * cobra . Command , _ [ ] string ) {
telemetryData := telemetry . CustomData { }
telemetryData . ErrorCode = "1"
handler := func ( ) {
config . RemoveVaultSecretFiles ( )
telemetryData . Duration = fmt . Sprintf ( "%v" , time . Since ( startTime ) . Milliseconds ( ) )
telemetryData . ErrorCategory = log . GetErrorCategory ( ) . String ( )
telemetry . Send ( & telemetryData )
2021-05-17 12:14:04 +02:00
if len ( GeneralConfig . HookConfig . SplunkConfig . Dsn ) > 0 {
splunk . Send ( & telemetryData , logCollector )
}
2020-11-03 13:02:13 +02:00
}
log . DeferExitHandler ( handler )
defer handler ( )
telemetry . Initialize ( GeneralConfig . NoTelemetry , STEP_NAME )
2021-05-17 12:14:04 +02:00
if len ( GeneralConfig . HookConfig . SplunkConfig . Dsn ) > 0 {
splunk . Initialize ( GeneralConfig . CorrelationID ,
GeneralConfig . HookConfig . SplunkConfig . Dsn ,
GeneralConfig . HookConfig . SplunkConfig . Token ,
GeneralConfig . HookConfig . SplunkConfig . Index ,
GeneralConfig . HookConfig . SplunkConfig . SendLogs )
}
2020-11-03 13:02:13 +02:00
abapEnvironmentCreateSystem ( stepConfig , & telemetryData )
telemetryData . ErrorCode = "0"
log . Entry ( ) . Info ( "SUCCESS" )
} ,
}
addAbapEnvironmentCreateSystemFlags ( createAbapEnvironmentCreateSystemCmd , & stepConfig )
return createAbapEnvironmentCreateSystemCmd
}
func addAbapEnvironmentCreateSystemFlags ( cmd * cobra . Command , stepConfig * abapEnvironmentCreateSystemOptions ) {
cmd . Flags ( ) . StringVar ( & stepConfig . CfAPIEndpoint , "cfApiEndpoint" , ` https://api.cf.eu10.hana.ondemand.com ` , "Cloud Foundry API endpoint" )
cmd . Flags ( ) . StringVar ( & stepConfig . Username , "username" , os . Getenv ( "PIPER_username" ) , "User or E-Mail for CF" )
cmd . Flags ( ) . StringVar ( & stepConfig . Password , "password" , os . Getenv ( "PIPER_password" ) , "Password for Cloud Foundry User" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfOrg , "cfOrg" , os . Getenv ( "PIPER_cfOrg" ) , "Cloud Foundry org" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfSpace , "cfSpace" , os . Getenv ( "PIPER_cfSpace" ) , "Cloud Foundry Space" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfService , "cfService" , os . Getenv ( "PIPER_cfService" ) , "Parameter for Cloud Foundry Service to be used for creating Cloud Foundry Service" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfServicePlan , "cfServicePlan" , os . Getenv ( "PIPER_cfServicePlan" ) , "Parameter for Cloud Foundry Service Plan to be used when creating a Cloud Foundry Service" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfServiceInstance , "cfServiceInstance" , os . Getenv ( "PIPER_cfServiceInstance" ) , "Parameter for naming the Service Instance when creating a Cloud Foundry Service" )
cmd . Flags ( ) . StringVar ( & stepConfig . ServiceManifest , "serviceManifest" , os . Getenv ( "PIPER_serviceManifest" ) , "Path to Cloud Foundry Service Manifest in YAML format for multiple service creations that are being passed to a Create-Service-Push Cloud Foundry cli plugin" )
2020-11-03 14:41:39 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . AbapSystemAdminEmail , "abapSystemAdminEmail" , os . Getenv ( "PIPER_abapSystemAdminEmail" ) , "Admin E-Mail address for the initial administrator of the system" )
cmd . Flags ( ) . StringVar ( & stepConfig . AbapSystemDescription , "abapSystemDescription" , ` Test system created by an automated pipeline ` , "Description for the ABAP Environment system" )
cmd . Flags ( ) . BoolVar ( & stepConfig . AbapSystemIsDevelopmentAllowed , "abapSystemIsDevelopmentAllowed" , true , "This parameter determines, if development is allowed on the system" )
cmd . Flags ( ) . StringVar ( & stepConfig . AbapSystemID , "abapSystemID" , ` H02 ` , "The three character name of the system - maps to 'sapSystemName'" )
cmd . Flags ( ) . IntVar ( & stepConfig . AbapSystemSizeOfPersistence , "abapSystemSizeOfPersistence" , 0 , "The size of the persistence" )
cmd . Flags ( ) . IntVar ( & stepConfig . AbapSystemSizeOfRuntime , "abapSystemSizeOfRuntime" , 0 , "The size of the runtime" )
2020-11-03 13:02:13 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . AddonDescriptorFileName , "addonDescriptorFileName" , os . Getenv ( "PIPER_addonDescriptorFileName" ) , "The file name of the addonDescriptor" )
2020-11-03 14:41:39 +02:00
cmd . Flags ( ) . BoolVar ( & stepConfig . IncludeAddon , "includeAddon" , false , "Must be set to true to install the addon provided via 'addonDescriptorFileName'" )
2020-11-03 13:02:13 +02:00
cmd . MarkFlagRequired ( "cfApiEndpoint" )
cmd . MarkFlagRequired ( "username" )
cmd . MarkFlagRequired ( "password" )
cmd . MarkFlagRequired ( "cfOrg" )
cmd . MarkFlagRequired ( "cfSpace" )
}
// retrieve step metadata
func abapEnvironmentCreateSystemMetadata ( ) config . StepData {
var theMetaData = config . StepData {
Metadata : config . StepMetadata {
2020-11-20 09:13:59 +02:00
Name : "abapEnvironmentCreateSystem" ,
Aliases : [ ] config . Alias { } ,
Description : "Creates a SAP Cloud Platform ABAP Environment system (aka Steampunk system)" ,
2020-11-03 13:02:13 +02:00
} ,
Spec : config . StepSpec {
Inputs : config . StepInputs {
2021-06-16 08:43:30 +02:00
Secrets : [ ] config . StepSecrets {
{ Name : "cfCredentialsId" , Description : "Jenkins 'Username with password' credentials ID containing user and password to authenticate to the Cloud Foundry API." , Type : "jenkins" , Aliases : [ ] config . Alias { { Name : "cloudFoundry/credentialsId" , Deprecated : false } } } ,
} ,
2020-11-03 13:02:13 +02:00
Parameters : [ ] config . StepParameters {
{
Name : "cfApiEndpoint" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/apiEndpoint" } } ,
2021-06-16 08:43:30 +02:00
Default : ` https://api.cf.eu10.hana.ondemand.com ` ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "username" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "cfCredentialsId" ,
Param : "username" ,
Type : "secret" ,
} ,
{
2021-09-21 13:06:32 +02:00
Name : "cloudfoundryVaultSecretName" ,
Type : "vaultSecret" ,
Default : "cloudfoundry-$(org)-$(space)" ,
2020-11-03 13:02:13 +02:00
} ,
} ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_username" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "password" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "cfCredentialsId" ,
Param : "password" ,
Type : "secret" ,
} ,
{
2021-09-21 13:06:32 +02:00
Name : "cloudfoundryVaultSecretName" ,
Type : "vaultSecret" ,
Default : "cloudfoundry-$(org)-$(space)" ,
2020-11-03 13:02:13 +02:00
} ,
} ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_password" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "cfOrg" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/org" } } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_cfOrg" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "cfSpace" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/space" } } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_cfSpace" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "cfService" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/service" } } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_cfService" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "cfServicePlan" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/servicePlan" } } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_cfServicePlan" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "cfServiceInstance" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/serviceInstance" } } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_cfServiceInstance" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "serviceManifest" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/serviceManifest" } , { Name : "cfServiceManifest" } } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_serviceManifest" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
2020-11-03 14:41:39 +02:00
Name : "abapSystemAdminEmail" ,
2020-11-03 13:02:13 +02:00
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_abapSystemAdminEmail" ) ,
2020-11-03 13:02:13 +02:00
} ,
{
2020-11-03 14:41:39 +02:00
Name : "abapSystemDescription" ,
2020-11-03 13:02:13 +02:00
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : ` Test system created by an automated pipeline ` ,
2020-11-03 13:02:13 +02:00
} ,
{
2020-11-03 14:41:39 +02:00
Name : "abapSystemIsDevelopmentAllowed" ,
2020-11-03 13:02:13 +02:00
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "bool" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : true ,
2020-11-03 13:02:13 +02:00
} ,
{
2020-11-03 14:41:39 +02:00
Name : "abapSystemID" ,
2020-11-03 13:02:13 +02:00
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : ` H02 ` ,
2020-11-03 13:02:13 +02:00
} ,
{
2020-11-03 14:41:39 +02:00
Name : "abapSystemSizeOfPersistence" ,
2020-11-03 13:02:13 +02:00
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "int" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : 0 ,
2020-11-03 13:02:13 +02:00
} ,
{
2020-11-03 14:41:39 +02:00
Name : "abapSystemSizeOfRuntime" ,
2020-11-03 13:02:13 +02:00
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "int" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : 0 ,
2020-11-03 13:02:13 +02:00
} ,
{
Name : "addonDescriptorFileName" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_addonDescriptorFileName" ) ,
2020-11-03 13:02:13 +02:00
} ,
2020-11-03 14:41:39 +02:00
{
Name : "includeAddon" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" } ,
Type : "bool" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : false ,
2020-11-03 14:41:39 +02:00
} ,
2020-11-03 13:02:13 +02:00
} ,
} ,
2020-11-20 09:13:59 +02:00
Containers : [ ] config . Container {
2021-02-11 13:54:11 +02:00
{ Name : "cf" , Image : "ppiper/cf-cli:7" } ,
2020-11-20 09:13:59 +02:00
} ,
2020-11-03 13:02:13 +02:00
} ,
}
return theMetaData
}