2021-01-29 10:46:47 +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"
2021-01-29 10:46:47 +02:00
"github.com/SAP/jenkins-library/pkg/telemetry"
"github.com/spf13/cobra"
)
type integrationArtifactUpdateConfigurationOptions struct {
2021-06-28 10:50:33 +02:00
APIServiceKey string ` json:"apiServiceKey,omitempty" `
2021-01-29 10:46:47 +02:00
IntegrationFlowID string ` json:"integrationFlowId,omitempty" `
IntegrationFlowVersion string ` json:"integrationFlowVersion,omitempty" `
Platform string ` json:"platform,omitempty" `
ParameterKey string ` json:"parameterKey,omitempty" `
ParameterValue string ` json:"parameterValue,omitempty" `
}
// IntegrationArtifactUpdateConfigurationCommand Update integration flow Configuration parameter
func IntegrationArtifactUpdateConfigurationCommand ( ) * cobra . Command {
const STEP_NAME = "integrationArtifactUpdateConfiguration"
metadata := integrationArtifactUpdateConfigurationMetadata ( )
var stepConfig integrationArtifactUpdateConfigurationOptions
var startTime time . Time
2021-05-17 12:14:04 +02:00
var logCollector * log . CollectorHook
2021-01-29 10:46:47 +02:00
var createIntegrationArtifactUpdateConfigurationCmd = & cobra . Command {
Use : STEP_NAME ,
Short : "Update integration flow Configuration parameter" ,
2021-04-30 09:43:25 +02:00
Long : ` With this step you can update the value for a configuration parameters of a designtime integration flow using the OData API. Learn more about the SAP Cloud Integration remote API for configuration update of the integration flow parameter [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html). ` ,
2021-01-29 10:46:47 +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
}
2021-06-28 10:50:33 +02:00
log . RegisterSecret ( stepConfig . APIServiceKey )
2021-01-29 10:46:47 +02:00
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 )
}
2021-01-29 10:46:47 +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 )
}
2021-01-29 10:46:47 +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 )
}
2021-01-29 10:46:47 +02:00
integrationArtifactUpdateConfiguration ( stepConfig , & telemetryData )
telemetryData . ErrorCode = "0"
log . Entry ( ) . Info ( "SUCCESS" )
} ,
}
addIntegrationArtifactUpdateConfigurationFlags ( createIntegrationArtifactUpdateConfigurationCmd , & stepConfig )
return createIntegrationArtifactUpdateConfigurationCmd
}
func addIntegrationArtifactUpdateConfigurationFlags ( cmd * cobra . Command , stepConfig * integrationArtifactUpdateConfigurationOptions ) {
2021-06-28 10:50:33 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . APIServiceKey , "apiServiceKey" , os . Getenv ( "PIPER_apiServiceKey" ) , "Service key JSON string to access the Cloud Integration API" )
2021-01-29 10:46:47 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . IntegrationFlowID , "integrationFlowId" , os . Getenv ( "PIPER_integrationFlowId" ) , "Specifies the ID of the Integration Flow artifact" )
cmd . Flags ( ) . StringVar ( & stepConfig . IntegrationFlowVersion , "integrationFlowVersion" , os . Getenv ( "PIPER_integrationFlowVersion" ) , "Specifies the version of the Integration Flow artifact" )
cmd . Flags ( ) . StringVar ( & stepConfig . Platform , "platform" , os . Getenv ( "PIPER_platform" ) , "Specifies the running platform of the SAP Cloud platform integraion service" )
cmd . Flags ( ) . StringVar ( & stepConfig . ParameterKey , "parameterKey" , os . Getenv ( "PIPER_parameterKey" ) , "Specifies the externalized parameter name." )
cmd . Flags ( ) . StringVar ( & stepConfig . ParameterValue , "parameterValue" , os . Getenv ( "PIPER_parameterValue" ) , "Specifies the externalized parameter value." )
2021-06-28 10:50:33 +02:00
cmd . MarkFlagRequired ( "apiServiceKey" )
2021-01-29 10:46:47 +02:00
cmd . MarkFlagRequired ( "integrationFlowId" )
cmd . MarkFlagRequired ( "integrationFlowVersion" )
cmd . MarkFlagRequired ( "parameterKey" )
cmd . MarkFlagRequired ( "parameterValue" )
}
// retrieve step metadata
func integrationArtifactUpdateConfigurationMetadata ( ) config . StepData {
var theMetaData = config . StepData {
Metadata : config . StepMetadata {
Name : "integrationArtifactUpdateConfiguration" ,
Aliases : [ ] config . Alias { } ,
Description : "Update integration flow Configuration parameter" ,
} ,
Spec : config . StepSpec {
Inputs : config . StepInputs {
2021-06-16 08:43:30 +02:00
Secrets : [ ] config . StepSecrets {
2021-06-28 14:54:03 +02:00
{ Name : "cpiApiServiceKeyCredentialsId" , Description : "Jenkins credential ID for secret text containing the service key to the SAP Cloud Integration API" , Type : "jenkins" } ,
2021-06-16 08:43:30 +02:00
} ,
2021-01-29 10:46:47 +02:00
Parameters : [ ] config . StepParameters {
{
2021-06-28 10:50:33 +02:00
Name : "apiServiceKey" ,
2021-01-29 10:46:47 +02:00
ResourceRef : [ ] config . ResourceReference {
{
2021-06-28 16:57:37 +02:00
Name : "cpiApiServiceKeyCredentialsId" ,
Param : "apiServiceKey" ,
2021-01-29 10:46:47 +02:00
Type : "secret" ,
} ,
} ,
2021-06-28 10:50:33 +02:00
Scope : [ ] string { "PARAMETERS" } ,
2021-01-29 10:46:47 +02:00
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
2021-06-28 10:50:33 +02:00
Default : os . Getenv ( "PIPER_apiServiceKey" ) ,
2021-01-29 10:46:47 +02:00
} ,
{
Name : "integrationFlowId" ,
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_integrationFlowId" ) ,
2021-01-29 10:46:47 +02:00
} ,
{
Name : "integrationFlowVersion" ,
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_integrationFlowVersion" ) ,
2021-01-29 10:46:47 +02:00
} ,
{
Name : "platform" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-06-16 08:43:30 +02:00
Default : os . Getenv ( "PIPER_platform" ) ,
2021-01-29 10:46:47 +02:00
} ,
{
Name : "parameterKey" ,
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_parameterKey" ) ,
2021-01-29 10:46:47 +02:00
} ,
{
Name : "parameterValue" ,
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_parameterValue" ) ,
2021-01-29 10:46:47 +02:00
} ,
} ,
} ,
} ,
}
return theMetaData
}