2020-09-18 11:18:51 +02:00
// Code generated by piper's step-generator. DO NOT EDIT.
package cmd
import (
"fmt"
"os"
"path/filepath"
"time"
"github.com/SAP/jenkins-library/pkg/config"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/piperenv"
2021-05-17 12:14:04 +02:00
"github.com/SAP/jenkins-library/pkg/splunk"
2020-09-18 11:18:51 +02:00
"github.com/SAP/jenkins-library/pkg/telemetry"
"github.com/spf13/cobra"
)
type abapAddonAssemblyKitCreateTargetVectorOptions struct {
AbapAddonAssemblyKitEndpoint string ` json:"abapAddonAssemblyKitEndpoint,omitempty" `
Username string ` json:"username,omitempty" `
Password string ` json:"password,omitempty" `
AddonDescriptor string ` json:"addonDescriptor,omitempty" `
}
type abapAddonAssemblyKitCreateTargetVectorCommonPipelineEnvironment struct {
abap struct {
addonDescriptor string
}
}
func ( p * abapAddonAssemblyKitCreateTargetVectorCommonPipelineEnvironment ) persist ( path , resourceName string ) {
content := [ ] struct {
category string
name string
2020-10-05 15:33:28 +02:00
value interface { }
2020-09-18 11:18:51 +02:00
} {
{ category : "abap" , name : "addonDescriptor" , value : p . abap . addonDescriptor } ,
}
errCount := 0
for _ , param := range content {
err := piperenv . SetResourceParameter ( path , resourceName , filepath . Join ( param . category , param . name ) , param . value )
if err != nil {
log . Entry ( ) . WithError ( err ) . Error ( "Error persisting piper environment." )
errCount ++
}
}
if errCount > 0 {
log . Entry ( ) . Fatal ( "failed to persist Piper environment" )
}
}
2020-09-23 14:57:45 +02:00
// AbapAddonAssemblyKitCreateTargetVectorCommand This step creates a Target Vector for software lifecycle operations
2020-09-18 11:18:51 +02:00
func AbapAddonAssemblyKitCreateTargetVectorCommand ( ) * cobra . Command {
const STEP_NAME = "abapAddonAssemblyKitCreateTargetVector"
metadata := abapAddonAssemblyKitCreateTargetVectorMetadata ( )
var stepConfig abapAddonAssemblyKitCreateTargetVectorOptions
var startTime time . Time
var commonPipelineEnvironment abapAddonAssemblyKitCreateTargetVectorCommonPipelineEnvironment
2021-05-17 12:14:04 +02:00
var logCollector * log . CollectorHook
2020-09-18 11:18:51 +02:00
var createAbapAddonAssemblyKitCreateTargetVectorCmd = & cobra . Command {
Use : STEP_NAME ,
2020-09-23 14:57:45 +02:00
Short : "This step creates a Target Vector for software lifecycle operations" ,
2020-09-18 11:18:51 +02:00
Long : ` This step takes the Product Version and the corresponding list of Software Component Versions from the addonDescriptor in the commonPipelineEnvironment .
2020-09-23 14:57:45 +02:00
With these it creates a Target Vector , which is necessary for executing software lifecylce operations in ABAP Cloud Platform systems .
2021-06-17 21:28:15 +02:00
The Target Vector describes the software state , which shall be reached in the managed ABAP Cloud Platform system .
< br / >
For Terminology refer to the [ Scenario Description ] ( https : //www.project-piper.io/scenarios/abapEnvironmentAddons/).`,
2020-09-18 11:18:51 +02:00
PreRunE : func ( cmd * cobra . Command , _ [ ] string ) error {
startTime = time . Now ( )
log . SetStepName ( STEP_NAME )
log . SetVerbose ( GeneralConfig . Verbose )
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-09-18 11:18:51 +02:00
return nil
} ,
Run : func ( _ * cobra . Command , _ [ ] string ) {
telemetryData := telemetry . CustomData { }
telemetryData . ErrorCode = "1"
handler := func ( ) {
2020-10-26 15:20:04 +02:00
config . RemoveVaultSecretFiles ( )
2020-09-18 11:18:51 +02:00
commonPipelineEnvironment . persist ( GeneralConfig . EnvRootPath , "commonPipelineEnvironment" )
telemetryData . Duration = fmt . Sprintf ( "%v" , time . Since ( startTime ) . Milliseconds ( ) )
2020-09-29 13:49:40 +02:00
telemetryData . ErrorCategory = log . GetErrorCategory ( ) . String ( )
2020-09-18 11:18:51 +02:00
telemetry . Send ( & telemetryData )
2021-05-17 12:14:04 +02:00
if len ( GeneralConfig . HookConfig . SplunkConfig . Dsn ) > 0 {
splunk . Send ( & telemetryData , logCollector )
}
2020-09-18 11:18:51 +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-09-18 11:18:51 +02:00
abapAddonAssemblyKitCreateTargetVector ( stepConfig , & telemetryData , & commonPipelineEnvironment )
telemetryData . ErrorCode = "0"
log . Entry ( ) . Info ( "SUCCESS" )
} ,
}
addAbapAddonAssemblyKitCreateTargetVectorFlags ( createAbapAddonAssemblyKitCreateTargetVectorCmd , & stepConfig )
return createAbapAddonAssemblyKitCreateTargetVectorCmd
}
func addAbapAddonAssemblyKitCreateTargetVectorFlags ( cmd * cobra . Command , stepConfig * abapAddonAssemblyKitCreateTargetVectorOptions ) {
2020-11-16 14:40:57 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . AbapAddonAssemblyKitEndpoint , "abapAddonAssemblyKitEndpoint" , ` https://apps.support.sap.com ` , "Base URL to the Addon Assembly Kit as a Service (AAKaaS) system" )
2020-09-18 11:18:51 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . Username , "username" , os . Getenv ( "PIPER_username" ) , "User for the Addon Assembly Kit as a Service (AAKaaS) system" )
cmd . Flags ( ) . StringVar ( & stepConfig . Password , "password" , os . Getenv ( "PIPER_password" ) , "Password for the Addon Assembly Kit as a Service (AAKaaS) system" )
cmd . Flags ( ) . StringVar ( & stepConfig . AddonDescriptor , "addonDescriptor" , os . Getenv ( "PIPER_addonDescriptor" ) , "Structure in the commonPipelineEnvironment containing information about the Product Version and corresponding Software Component Versions" )
cmd . MarkFlagRequired ( "abapAddonAssemblyKitEndpoint" )
cmd . MarkFlagRequired ( "username" )
cmd . MarkFlagRequired ( "password" )
cmd . MarkFlagRequired ( "addonDescriptor" )
}
// retrieve step metadata
func abapAddonAssemblyKitCreateTargetVectorMetadata ( ) config . StepData {
var theMetaData = config . StepData {
Metadata : config . StepMetadata {
2020-11-20 09:13:59 +02:00
Name : "abapAddonAssemblyKitCreateTargetVector" ,
Aliases : [ ] config . Alias { } ,
Description : "This step creates a Target Vector for software lifecycle operations" ,
2020-09-18 11:18:51 +02:00
} ,
Spec : config . StepSpec {
Inputs : config . StepInputs {
2021-06-16 08:43:30 +02:00
Secrets : [ ] config . StepSecrets {
{ Name : "abapAddonAssemblyKitCredentialsId" , Description : "Credential stored in Jenkins for the Addon Assembly Kit as a Service (AAKaaS) system" , Type : "jenkins" } ,
} ,
2020-09-18 11:18:51 +02:00
Parameters : [ ] config . StepParameters {
{
Name : "abapAddonAssemblyKitEndpoint" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : ` https://apps.support.sap.com ` ,
2020-09-18 11:18:51 +02:00
} ,
{
Name : "username" ,
ResourceRef : [ ] config . ResourceReference { } ,
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-09-18 11:18:51 +02:00
} ,
{
Name : "password" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_password" ) ,
2020-09-18 11:18:51 +02:00
} ,
{
Name : "addonDescriptor" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "commonPipelineEnvironment" ,
Param : "abap/addonDescriptor" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_addonDescriptor" ) ,
2020-09-18 11:18:51 +02:00
} ,
} ,
} ,
2020-11-20 09:13:59 +02:00
Outputs : config . StepOutputs {
Resources : [ ] config . StepResources {
{
Name : "commonPipelineEnvironment" ,
Type : "piperEnvironment" ,
Parameters : [ ] map [ string ] interface { } {
{ "Name" : "abap/addonDescriptor" } ,
} ,
} ,
} ,
} ,
2020-09-18 11:18:51 +02:00
} ,
}
return theMetaData
}