github.com/jaylevin/jenkins-library@v1.230.4/cmd/integrationArtifactUpdateConfiguration_generated.go (about) 1 // Code generated by piper's step-generator. DO NOT EDIT. 2 3 package cmd 4 5 import ( 6 "fmt" 7 "os" 8 "time" 9 10 "github.com/SAP/jenkins-library/pkg/config" 11 "github.com/SAP/jenkins-library/pkg/log" 12 "github.com/SAP/jenkins-library/pkg/splunk" 13 "github.com/SAP/jenkins-library/pkg/telemetry" 14 "github.com/SAP/jenkins-library/pkg/validation" 15 "github.com/spf13/cobra" 16 ) 17 18 type integrationArtifactUpdateConfigurationOptions struct { 19 APIServiceKey string `json:"apiServiceKey,omitempty"` 20 IntegrationFlowID string `json:"integrationFlowId,omitempty"` 21 IntegrationFlowVersion string `json:"integrationFlowVersion,omitempty"` 22 ParameterKey string `json:"parameterKey,omitempty"` 23 ParameterValue string `json:"parameterValue,omitempty"` 24 } 25 26 // IntegrationArtifactUpdateConfigurationCommand Update integration flow Configuration parameter 27 func IntegrationArtifactUpdateConfigurationCommand() *cobra.Command { 28 const STEP_NAME = "integrationArtifactUpdateConfiguration" 29 30 metadata := integrationArtifactUpdateConfigurationMetadata() 31 var stepConfig integrationArtifactUpdateConfigurationOptions 32 var startTime time.Time 33 var logCollector *log.CollectorHook 34 var splunkClient *splunk.Splunk 35 telemetryClient := &telemetry.Telemetry{} 36 37 var createIntegrationArtifactUpdateConfigurationCmd = &cobra.Command{ 38 Use: STEP_NAME, 39 Short: "Update integration flow Configuration parameter", 40 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).`, 41 PreRunE: func(cmd *cobra.Command, _ []string) error { 42 startTime = time.Now() 43 log.SetStepName(STEP_NAME) 44 log.SetVerbose(GeneralConfig.Verbose) 45 46 GeneralConfig.GitHubAccessTokens = ResolveAccessTokens(GeneralConfig.GitHubTokens) 47 48 path, _ := os.Getwd() 49 fatalHook := &log.FatalHook{CorrelationID: GeneralConfig.CorrelationID, Path: path} 50 log.RegisterHook(fatalHook) 51 52 err := PrepareConfig(cmd, &metadata, STEP_NAME, &stepConfig, config.OpenPiperFile) 53 if err != nil { 54 log.SetErrorCategory(log.ErrorConfiguration) 55 return err 56 } 57 log.RegisterSecret(stepConfig.APIServiceKey) 58 59 if len(GeneralConfig.HookConfig.SentryConfig.Dsn) > 0 { 60 sentryHook := log.NewSentryHook(GeneralConfig.HookConfig.SentryConfig.Dsn, GeneralConfig.CorrelationID) 61 log.RegisterHook(&sentryHook) 62 } 63 64 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 65 splunkClient = &splunk.Splunk{} 66 logCollector = &log.CollectorHook{CorrelationID: GeneralConfig.CorrelationID} 67 log.RegisterHook(logCollector) 68 } 69 70 validation, err := validation.New(validation.WithJSONNamesForStructFields(), validation.WithPredefinedErrorMessages()) 71 if err != nil { 72 return err 73 } 74 if err = validation.ValidateStruct(stepConfig); err != nil { 75 log.SetErrorCategory(log.ErrorConfiguration) 76 return err 77 } 78 79 return nil 80 }, 81 Run: func(_ *cobra.Command, _ []string) { 82 stepTelemetryData := telemetry.CustomData{} 83 stepTelemetryData.ErrorCode = "1" 84 handler := func() { 85 config.RemoveVaultSecretFiles() 86 stepTelemetryData.Duration = fmt.Sprintf("%v", time.Since(startTime).Milliseconds()) 87 stepTelemetryData.ErrorCategory = log.GetErrorCategory().String() 88 stepTelemetryData.PiperCommitHash = GitCommit 89 telemetryClient.SetData(&stepTelemetryData) 90 telemetryClient.Send() 91 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 92 splunkClient.Send(telemetryClient.GetData(), logCollector) 93 } 94 } 95 log.DeferExitHandler(handler) 96 defer handler() 97 telemetryClient.Initialize(GeneralConfig.NoTelemetry, STEP_NAME) 98 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 99 splunkClient.Initialize(GeneralConfig.CorrelationID, 100 GeneralConfig.HookConfig.SplunkConfig.Dsn, 101 GeneralConfig.HookConfig.SplunkConfig.Token, 102 GeneralConfig.HookConfig.SplunkConfig.Index, 103 GeneralConfig.HookConfig.SplunkConfig.SendLogs) 104 } 105 integrationArtifactUpdateConfiguration(stepConfig, &stepTelemetryData) 106 stepTelemetryData.ErrorCode = "0" 107 log.Entry().Info("SUCCESS") 108 }, 109 } 110 111 addIntegrationArtifactUpdateConfigurationFlags(createIntegrationArtifactUpdateConfigurationCmd, &stepConfig) 112 return createIntegrationArtifactUpdateConfigurationCmd 113 } 114 115 func addIntegrationArtifactUpdateConfigurationFlags(cmd *cobra.Command, stepConfig *integrationArtifactUpdateConfigurationOptions) { 116 cmd.Flags().StringVar(&stepConfig.APIServiceKey, "apiServiceKey", os.Getenv("PIPER_apiServiceKey"), "Service key JSON string to access the Process Integration Runtime service instance of plan 'api'") 117 cmd.Flags().StringVar(&stepConfig.IntegrationFlowID, "integrationFlowId", os.Getenv("PIPER_integrationFlowId"), "Specifies the ID of the Integration Flow artifact") 118 cmd.Flags().StringVar(&stepConfig.IntegrationFlowVersion, "integrationFlowVersion", os.Getenv("PIPER_integrationFlowVersion"), "Specifies the version of the Integration Flow artifact") 119 cmd.Flags().StringVar(&stepConfig.ParameterKey, "parameterKey", os.Getenv("PIPER_parameterKey"), "Specifies the externalized parameter name.") 120 cmd.Flags().StringVar(&stepConfig.ParameterValue, "parameterValue", os.Getenv("PIPER_parameterValue"), "Specifies the externalized parameter value.") 121 122 cmd.MarkFlagRequired("apiServiceKey") 123 cmd.MarkFlagRequired("integrationFlowId") 124 cmd.MarkFlagRequired("integrationFlowVersion") 125 cmd.MarkFlagRequired("parameterKey") 126 cmd.MarkFlagRequired("parameterValue") 127 } 128 129 // retrieve step metadata 130 func integrationArtifactUpdateConfigurationMetadata() config.StepData { 131 var theMetaData = config.StepData{ 132 Metadata: config.StepMetadata{ 133 Name: "integrationArtifactUpdateConfiguration", 134 Aliases: []config.Alias{}, 135 Description: "Update integration flow Configuration parameter", 136 }, 137 Spec: config.StepSpec{ 138 Inputs: config.StepInputs{ 139 Secrets: []config.StepSecrets{ 140 {Name: "cpiApiServiceKeyCredentialsId", Description: "Jenkins secret text credential ID containing the service key to the Process Integration Runtime service instance of plan 'api'", Type: "jenkins"}, 141 }, 142 Parameters: []config.StepParameters{ 143 { 144 Name: "apiServiceKey", 145 ResourceRef: []config.ResourceReference{ 146 { 147 Name: "cpiApiServiceKeyCredentialsId", 148 Param: "apiServiceKey", 149 Type: "secret", 150 }, 151 }, 152 Scope: []string{"PARAMETERS"}, 153 Type: "string", 154 Mandatory: true, 155 Aliases: []config.Alias{}, 156 Default: os.Getenv("PIPER_apiServiceKey"), 157 }, 158 { 159 Name: "integrationFlowId", 160 ResourceRef: []config.ResourceReference{}, 161 Scope: []string{"PARAMETERS", "GENERAL", "STAGES", "STEPS"}, 162 Type: "string", 163 Mandatory: true, 164 Aliases: []config.Alias{}, 165 Default: os.Getenv("PIPER_integrationFlowId"), 166 }, 167 { 168 Name: "integrationFlowVersion", 169 ResourceRef: []config.ResourceReference{}, 170 Scope: []string{"PARAMETERS", "GENERAL", "STAGES", "STEPS"}, 171 Type: "string", 172 Mandatory: true, 173 Aliases: []config.Alias{}, 174 Default: os.Getenv("PIPER_integrationFlowVersion"), 175 }, 176 { 177 Name: "parameterKey", 178 ResourceRef: []config.ResourceReference{}, 179 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 180 Type: "string", 181 Mandatory: true, 182 Aliases: []config.Alias{}, 183 Default: os.Getenv("PIPER_parameterKey"), 184 }, 185 { 186 Name: "parameterValue", 187 ResourceRef: []config.ResourceReference{}, 188 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 189 Type: "string", 190 Mandatory: true, 191 Aliases: []config.Alias{}, 192 Default: os.Getenv("PIPER_parameterValue"), 193 }, 194 }, 195 }, 196 }, 197 } 198 return theMetaData 199 }