github.com/jaylevin/jenkins-library@v1.230.4/cmd/cloudFoundryDeleteService_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 cloudFoundryDeleteServiceOptions struct { 19 CfAPIEndpoint string `json:"cfApiEndpoint,omitempty"` 20 Username string `json:"username,omitempty"` 21 Password string `json:"password,omitempty"` 22 CfOrg string `json:"cfOrg,omitempty"` 23 CfSpace string `json:"cfSpace,omitempty"` 24 CfServiceInstance string `json:"cfServiceInstance,omitempty"` 25 CfDeleteServiceKeys bool `json:"cfDeleteServiceKeys,omitempty"` 26 } 27 28 // CloudFoundryDeleteServiceCommand DeleteCloudFoundryService 29 func CloudFoundryDeleteServiceCommand() *cobra.Command { 30 const STEP_NAME = "cloudFoundryDeleteService" 31 32 metadata := cloudFoundryDeleteServiceMetadata() 33 var stepConfig cloudFoundryDeleteServiceOptions 34 var startTime time.Time 35 var logCollector *log.CollectorHook 36 var splunkClient *splunk.Splunk 37 telemetryClient := &telemetry.Telemetry{} 38 39 var createCloudFoundryDeleteServiceCmd = &cobra.Command{ 40 Use: STEP_NAME, 41 Short: "DeleteCloudFoundryService", 42 Long: `Delete CloudFoundryService`, 43 PreRunE: func(cmd *cobra.Command, _ []string) error { 44 startTime = time.Now() 45 log.SetStepName(STEP_NAME) 46 log.SetVerbose(GeneralConfig.Verbose) 47 48 GeneralConfig.GitHubAccessTokens = ResolveAccessTokens(GeneralConfig.GitHubTokens) 49 50 path, _ := os.Getwd() 51 fatalHook := &log.FatalHook{CorrelationID: GeneralConfig.CorrelationID, Path: path} 52 log.RegisterHook(fatalHook) 53 54 err := PrepareConfig(cmd, &metadata, STEP_NAME, &stepConfig, config.OpenPiperFile) 55 if err != nil { 56 log.SetErrorCategory(log.ErrorConfiguration) 57 return err 58 } 59 log.RegisterSecret(stepConfig.Username) 60 log.RegisterSecret(stepConfig.Password) 61 62 if len(GeneralConfig.HookConfig.SentryConfig.Dsn) > 0 { 63 sentryHook := log.NewSentryHook(GeneralConfig.HookConfig.SentryConfig.Dsn, GeneralConfig.CorrelationID) 64 log.RegisterHook(&sentryHook) 65 } 66 67 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 68 splunkClient = &splunk.Splunk{} 69 logCollector = &log.CollectorHook{CorrelationID: GeneralConfig.CorrelationID} 70 log.RegisterHook(logCollector) 71 } 72 73 validation, err := validation.New(validation.WithJSONNamesForStructFields(), validation.WithPredefinedErrorMessages()) 74 if err != nil { 75 return err 76 } 77 if err = validation.ValidateStruct(stepConfig); err != nil { 78 log.SetErrorCategory(log.ErrorConfiguration) 79 return err 80 } 81 82 return nil 83 }, 84 Run: func(_ *cobra.Command, _ []string) { 85 stepTelemetryData := telemetry.CustomData{} 86 stepTelemetryData.ErrorCode = "1" 87 handler := func() { 88 config.RemoveVaultSecretFiles() 89 stepTelemetryData.Duration = fmt.Sprintf("%v", time.Since(startTime).Milliseconds()) 90 stepTelemetryData.ErrorCategory = log.GetErrorCategory().String() 91 stepTelemetryData.PiperCommitHash = GitCommit 92 telemetryClient.SetData(&stepTelemetryData) 93 telemetryClient.Send() 94 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 95 splunkClient.Send(telemetryClient.GetData(), logCollector) 96 } 97 } 98 log.DeferExitHandler(handler) 99 defer handler() 100 telemetryClient.Initialize(GeneralConfig.NoTelemetry, STEP_NAME) 101 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 102 splunkClient.Initialize(GeneralConfig.CorrelationID, 103 GeneralConfig.HookConfig.SplunkConfig.Dsn, 104 GeneralConfig.HookConfig.SplunkConfig.Token, 105 GeneralConfig.HookConfig.SplunkConfig.Index, 106 GeneralConfig.HookConfig.SplunkConfig.SendLogs) 107 } 108 cloudFoundryDeleteService(stepConfig, &stepTelemetryData) 109 stepTelemetryData.ErrorCode = "0" 110 log.Entry().Info("SUCCESS") 111 }, 112 } 113 114 addCloudFoundryDeleteServiceFlags(createCloudFoundryDeleteServiceCmd, &stepConfig) 115 return createCloudFoundryDeleteServiceCmd 116 } 117 118 func addCloudFoundryDeleteServiceFlags(cmd *cobra.Command, stepConfig *cloudFoundryDeleteServiceOptions) { 119 cmd.Flags().StringVar(&stepConfig.CfAPIEndpoint, "cfApiEndpoint", os.Getenv("PIPER_cfApiEndpoint"), "Cloud Foundry API endpoint") 120 cmd.Flags().StringVar(&stepConfig.Username, "username", os.Getenv("PIPER_username"), "User or E-Mail for CF") 121 cmd.Flags().StringVar(&stepConfig.Password, "password", os.Getenv("PIPER_password"), "User Password for CF User") 122 cmd.Flags().StringVar(&stepConfig.CfOrg, "cfOrg", os.Getenv("PIPER_cfOrg"), "CF org") 123 cmd.Flags().StringVar(&stepConfig.CfSpace, "cfSpace", os.Getenv("PIPER_cfSpace"), "CF Space") 124 cmd.Flags().StringVar(&stepConfig.CfServiceInstance, "cfServiceInstance", os.Getenv("PIPER_cfServiceInstance"), "Parameter of ServiceInstance Name to delete CloudFoundry Service") 125 cmd.Flags().BoolVar(&stepConfig.CfDeleteServiceKeys, "cfDeleteServiceKeys", false, "Parameter to force deletion of Cloud Foundry Service Keys") 126 127 cmd.MarkFlagRequired("cfApiEndpoint") 128 cmd.MarkFlagRequired("username") 129 cmd.MarkFlagRequired("password") 130 cmd.MarkFlagRequired("cfOrg") 131 cmd.MarkFlagRequired("cfSpace") 132 cmd.MarkFlagRequired("cfServiceInstance") 133 } 134 135 // retrieve step metadata 136 func cloudFoundryDeleteServiceMetadata() config.StepData { 137 var theMetaData = config.StepData{ 138 Metadata: config.StepMetadata{ 139 Name: "cloudFoundryDeleteService", 140 Aliases: []config.Alias{}, 141 Description: "DeleteCloudFoundryService", 142 }, 143 Spec: config.StepSpec{ 144 Inputs: config.StepInputs{ 145 Secrets: []config.StepSecrets{ 146 {Name: "cfCredentialsId", Description: "Jenkins 'Username with password' credentials ID containing user and password to authenticate to the Cloud Foundry API.", Type: "jenkins"}, 147 }, 148 Parameters: []config.StepParameters{ 149 { 150 Name: "cfApiEndpoint", 151 ResourceRef: []config.ResourceReference{}, 152 Scope: []string{"PARAMETERS", "STAGES", "STEPS", "GENERAL"}, 153 Type: "string", 154 Mandatory: true, 155 Aliases: []config.Alias{{Name: "cloudFoundry/apiEndpoint"}}, 156 Default: os.Getenv("PIPER_cfApiEndpoint"), 157 }, 158 { 159 Name: "username", 160 ResourceRef: []config.ResourceReference{ 161 { 162 Name: "cfCredentialsId", 163 Param: "username", 164 Type: "secret", 165 }, 166 167 { 168 Name: "cloudfoundryVaultSecretName", 169 Type: "vaultSecret", 170 Default: "cloudfoundry-$(org)-$(space)", 171 }, 172 }, 173 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 174 Type: "string", 175 Mandatory: true, 176 Aliases: []config.Alias{}, 177 Default: os.Getenv("PIPER_username"), 178 }, 179 { 180 Name: "password", 181 ResourceRef: []config.ResourceReference{ 182 { 183 Name: "cfCredentialsId", 184 Param: "password", 185 Type: "secret", 186 }, 187 188 { 189 Name: "cloudfoundryVaultSecretName", 190 Type: "vaultSecret", 191 Default: "cloudfoundry-$(org)-$(space)", 192 }, 193 }, 194 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 195 Type: "string", 196 Mandatory: true, 197 Aliases: []config.Alias{}, 198 Default: os.Getenv("PIPER_password"), 199 }, 200 { 201 Name: "cfOrg", 202 ResourceRef: []config.ResourceReference{}, 203 Scope: []string{"PARAMETERS", "STAGES", "STEPS", "GENERAL"}, 204 Type: "string", 205 Mandatory: true, 206 Aliases: []config.Alias{{Name: "cloudFoundry/org"}}, 207 Default: os.Getenv("PIPER_cfOrg"), 208 }, 209 { 210 Name: "cfSpace", 211 ResourceRef: []config.ResourceReference{}, 212 Scope: []string{"PARAMETERS", "STAGES", "STEPS", "GENERAL"}, 213 Type: "string", 214 Mandatory: true, 215 Aliases: []config.Alias{{Name: "cloudFoundry/space"}}, 216 Default: os.Getenv("PIPER_cfSpace"), 217 }, 218 { 219 Name: "cfServiceInstance", 220 ResourceRef: []config.ResourceReference{}, 221 Scope: []string{"PARAMETERS", "STAGES", "STEPS", "GENERAL"}, 222 Type: "string", 223 Mandatory: true, 224 Aliases: []config.Alias{{Name: "cloudFoundry/serviceInstance"}}, 225 Default: os.Getenv("PIPER_cfServiceInstance"), 226 }, 227 { 228 Name: "cfDeleteServiceKeys", 229 ResourceRef: []config.ResourceReference{}, 230 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 231 Type: "bool", 232 Mandatory: false, 233 Aliases: []config.Alias{{Name: "cloudFoundry/cfDeleteServiceKeys"}}, 234 Default: false, 235 }, 236 }, 237 }, 238 Containers: []config.Container{ 239 {Name: "cf", Image: "ppiper/cf-cli:latest", WorkingDir: "/home/piper"}, 240 }, 241 }, 242 } 243 return theMetaData 244 }