github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/cmd/apiProxyDownload_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 apiProxyDownloadOptions struct { 19 APIServiceKey string `json:"apiServiceKey,omitempty"` 20 APIProxyName string `json:"apiProxyName,omitempty"` 21 DownloadPath string `json:"downloadPath,omitempty"` 22 } 23 24 // ApiProxyDownloadCommand Download a specific API Proxy from the API Portal 25 func ApiProxyDownloadCommand() *cobra.Command { 26 const STEP_NAME = "apiProxyDownload" 27 28 metadata := apiProxyDownloadMetadata() 29 var stepConfig apiProxyDownloadOptions 30 var startTime time.Time 31 var logCollector *log.CollectorHook 32 var splunkClient *splunk.Splunk 33 telemetryClient := &telemetry.Telemetry{} 34 35 var createApiProxyDownloadCmd = &cobra.Command{ 36 Use: STEP_NAME, 37 Short: "Download a specific API Proxy from the API Portal", 38 Long: `With this step you can download a specific API Proxy from the API Portal, which returns a zip file with the api proxy contents in to current workspace using the OData API. Learn more about the SAP API Management API for downloading an api proxy artifact [here](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/e26b3320cd534ae4bc743af8013a8abb.html).`, 39 PreRunE: func(cmd *cobra.Command, _ []string) error { 40 startTime = time.Now() 41 log.SetStepName(STEP_NAME) 42 log.SetVerbose(GeneralConfig.Verbose) 43 44 GeneralConfig.GitHubAccessTokens = ResolveAccessTokens(GeneralConfig.GitHubTokens) 45 46 path, _ := os.Getwd() 47 fatalHook := &log.FatalHook{CorrelationID: GeneralConfig.CorrelationID, Path: path} 48 log.RegisterHook(fatalHook) 49 50 err := PrepareConfig(cmd, &metadata, STEP_NAME, &stepConfig, config.OpenPiperFile) 51 if err != nil { 52 log.SetErrorCategory(log.ErrorConfiguration) 53 return err 54 } 55 log.RegisterSecret(stepConfig.APIServiceKey) 56 57 if len(GeneralConfig.HookConfig.SentryConfig.Dsn) > 0 { 58 sentryHook := log.NewSentryHook(GeneralConfig.HookConfig.SentryConfig.Dsn, GeneralConfig.CorrelationID) 59 log.RegisterHook(&sentryHook) 60 } 61 62 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 63 splunkClient = &splunk.Splunk{} 64 logCollector = &log.CollectorHook{CorrelationID: GeneralConfig.CorrelationID} 65 log.RegisterHook(logCollector) 66 } 67 68 if err = log.RegisterANSHookIfConfigured(GeneralConfig.CorrelationID); err != nil { 69 log.Entry().WithError(err).Warn("failed to set up SAP Alert Notification Service log hook") 70 } 71 72 validation, err := validation.New(validation.WithJSONNamesForStructFields(), validation.WithPredefinedErrorMessages()) 73 if err != nil { 74 return err 75 } 76 if err = validation.ValidateStruct(stepConfig); err != nil { 77 log.SetErrorCategory(log.ErrorConfiguration) 78 return err 79 } 80 81 return nil 82 }, 83 Run: func(_ *cobra.Command, _ []string) { 84 stepTelemetryData := telemetry.CustomData{} 85 stepTelemetryData.ErrorCode = "1" 86 handler := func() { 87 config.RemoveVaultSecretFiles() 88 stepTelemetryData.Duration = fmt.Sprintf("%v", time.Since(startTime).Milliseconds()) 89 stepTelemetryData.ErrorCategory = log.GetErrorCategory().String() 90 stepTelemetryData.PiperCommitHash = GitCommit 91 telemetryClient.SetData(&stepTelemetryData) 92 telemetryClient.Send() 93 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 94 splunkClient.Initialize(GeneralConfig.CorrelationID, 95 GeneralConfig.HookConfig.SplunkConfig.Dsn, 96 GeneralConfig.HookConfig.SplunkConfig.Token, 97 GeneralConfig.HookConfig.SplunkConfig.Index, 98 GeneralConfig.HookConfig.SplunkConfig.SendLogs) 99 splunkClient.Send(telemetryClient.GetData(), logCollector) 100 } 101 if len(GeneralConfig.HookConfig.SplunkConfig.ProdCriblEndpoint) > 0 { 102 splunkClient.Initialize(GeneralConfig.CorrelationID, 103 GeneralConfig.HookConfig.SplunkConfig.ProdCriblEndpoint, 104 GeneralConfig.HookConfig.SplunkConfig.ProdCriblToken, 105 GeneralConfig.HookConfig.SplunkConfig.ProdCriblIndex, 106 GeneralConfig.HookConfig.SplunkConfig.SendLogs) 107 splunkClient.Send(telemetryClient.GetData(), logCollector) 108 } 109 } 110 log.DeferExitHandler(handler) 111 defer handler() 112 telemetryClient.Initialize(GeneralConfig.NoTelemetry, STEP_NAME) 113 apiProxyDownload(stepConfig, &stepTelemetryData) 114 stepTelemetryData.ErrorCode = "0" 115 log.Entry().Info("SUCCESS") 116 }, 117 } 118 119 addApiProxyDownloadFlags(createApiProxyDownloadCmd, &stepConfig) 120 return createApiProxyDownloadCmd 121 } 122 123 func addApiProxyDownloadFlags(cmd *cobra.Command, stepConfig *apiProxyDownloadOptions) { 124 cmd.Flags().StringVar(&stepConfig.APIServiceKey, "apiServiceKey", os.Getenv("PIPER_apiServiceKey"), "Service key JSON string to access the API Management Runtime service instance of plan 'api'") 125 cmd.Flags().StringVar(&stepConfig.APIProxyName, "apiProxyName", os.Getenv("PIPER_apiProxyName"), "Specifies the name of the API Proxy.") 126 cmd.Flags().StringVar(&stepConfig.DownloadPath, "downloadPath", os.Getenv("PIPER_downloadPath"), "Specifies api proxy download directory location. The file name should not be included in the path.") 127 128 cmd.MarkFlagRequired("apiServiceKey") 129 cmd.MarkFlagRequired("apiProxyName") 130 cmd.MarkFlagRequired("downloadPath") 131 } 132 133 // retrieve step metadata 134 func apiProxyDownloadMetadata() config.StepData { 135 var theMetaData = config.StepData{ 136 Metadata: config.StepMetadata{ 137 Name: "apiProxyDownload", 138 Aliases: []config.Alias{}, 139 Description: "Download a specific API Proxy from the API Portal", 140 }, 141 Spec: config.StepSpec{ 142 Inputs: config.StepInputs{ 143 Secrets: []config.StepSecrets{ 144 {Name: "apimApiServiceKeyCredentialsId", Description: "Jenkins secret text credential ID containing the service key to the API Management Runtime service instance of plan 'api'", Type: "jenkins"}, 145 }, 146 Parameters: []config.StepParameters{ 147 { 148 Name: "apiServiceKey", 149 ResourceRef: []config.ResourceReference{ 150 { 151 Name: "apimApiServiceKeyCredentialsId", 152 Param: "apiServiceKey", 153 Type: "secret", 154 }, 155 }, 156 Scope: []string{"PARAMETERS"}, 157 Type: "string", 158 Mandatory: true, 159 Aliases: []config.Alias{}, 160 Default: os.Getenv("PIPER_apiServiceKey"), 161 }, 162 { 163 Name: "apiProxyName", 164 ResourceRef: []config.ResourceReference{}, 165 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 166 Type: "string", 167 Mandatory: true, 168 Aliases: []config.Alias{}, 169 Default: os.Getenv("PIPER_apiProxyName"), 170 }, 171 { 172 Name: "downloadPath", 173 ResourceRef: []config.ResourceReference{}, 174 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 175 Type: "string", 176 Mandatory: true, 177 Aliases: []config.Alias{}, 178 Default: os.Getenv("PIPER_downloadPath"), 179 }, 180 }, 181 }, 182 }, 183 } 184 return theMetaData 185 }