github.com/xgoffin/jenkins-library@v1.154.0/cmd/jsonApplyPatch_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 jsonApplyPatchOptions struct { 19 Input string `json:"input,omitempty"` 20 Patch string `json:"patch,omitempty"` 21 Output string `json:"output,omitempty"` 22 } 23 24 // JsonApplyPatchCommand Patches a json with a patch file 25 func JsonApplyPatchCommand() *cobra.Command { 26 const STEP_NAME = "jsonApplyPatch" 27 28 metadata := jsonApplyPatchMetadata() 29 var stepConfig jsonApplyPatchOptions 30 var startTime time.Time 31 var logCollector *log.CollectorHook 32 var splunkClient *splunk.Splunk 33 telemetryClient := &telemetry.Telemetry{} 34 35 var createJsonApplyPatchCmd = &cobra.Command{ 36 Use: STEP_NAME, 37 Short: "Patches a json with a patch file", 38 Long: `This steps patches a json file with patch file using the json patch standard. 39 This step can, e.g., be used if there is a json schema which needs to be patched.`, 40 PreRunE: func(cmd *cobra.Command, _ []string) error { 41 startTime = time.Now() 42 log.SetStepName(STEP_NAME) 43 log.SetVerbose(GeneralConfig.Verbose) 44 45 GeneralConfig.GitHubAccessTokens = ResolveAccessTokens(GeneralConfig.GitHubTokens) 46 47 path, _ := os.Getwd() 48 fatalHook := &log.FatalHook{CorrelationID: GeneralConfig.CorrelationID, Path: path} 49 log.RegisterHook(fatalHook) 50 51 err := PrepareConfig(cmd, &metadata, STEP_NAME, &stepConfig, config.OpenPiperFile) 52 if err != nil { 53 log.SetErrorCategory(log.ErrorConfiguration) 54 return err 55 } 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 validation, err := validation.New(validation.WithJSONNamesForStructFields(), validation.WithPredefinedErrorMessages()) 69 if err != nil { 70 return err 71 } 72 if err = validation.ValidateStruct(stepConfig); err != nil { 73 log.SetErrorCategory(log.ErrorConfiguration) 74 return err 75 } 76 77 return nil 78 }, 79 Run: func(_ *cobra.Command, _ []string) { 80 stepTelemetryData := telemetry.CustomData{} 81 stepTelemetryData.ErrorCode = "1" 82 handler := func() { 83 config.RemoveVaultSecretFiles() 84 stepTelemetryData.Duration = fmt.Sprintf("%v", time.Since(startTime).Milliseconds()) 85 stepTelemetryData.ErrorCategory = log.GetErrorCategory().String() 86 stepTelemetryData.PiperCommitHash = GitCommit 87 telemetryClient.SetData(&stepTelemetryData) 88 telemetryClient.Send() 89 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 90 splunkClient.Send(telemetryClient.GetData(), logCollector) 91 } 92 } 93 log.DeferExitHandler(handler) 94 defer handler() 95 telemetryClient.Initialize(GeneralConfig.NoTelemetry, STEP_NAME) 96 if len(GeneralConfig.HookConfig.SplunkConfig.Dsn) > 0 { 97 splunkClient.Initialize(GeneralConfig.CorrelationID, 98 GeneralConfig.HookConfig.SplunkConfig.Dsn, 99 GeneralConfig.HookConfig.SplunkConfig.Token, 100 GeneralConfig.HookConfig.SplunkConfig.Index, 101 GeneralConfig.HookConfig.SplunkConfig.SendLogs) 102 } 103 jsonApplyPatch(stepConfig, &stepTelemetryData) 104 stepTelemetryData.ErrorCode = "0" 105 log.Entry().Info("SUCCESS") 106 }, 107 } 108 109 addJsonApplyPatchFlags(createJsonApplyPatchCmd, &stepConfig) 110 return createJsonApplyPatchCmd 111 } 112 113 func addJsonApplyPatchFlags(cmd *cobra.Command, stepConfig *jsonApplyPatchOptions) { 114 cmd.Flags().StringVar(&stepConfig.Input, "input", os.Getenv("PIPER_input"), "File path to the json file which schould be patched.") 115 cmd.Flags().StringVar(&stepConfig.Patch, "patch", os.Getenv("PIPER_patch"), "File path to the patch which should be applied to the json file.") 116 cmd.Flags().StringVar(&stepConfig.Output, "output", os.Getenv("PIPER_output"), "File path to destination of the patched json file.") 117 118 cmd.MarkFlagRequired("input") 119 cmd.MarkFlagRequired("patch") 120 cmd.MarkFlagRequired("output") 121 } 122 123 // retrieve step metadata 124 func jsonApplyPatchMetadata() config.StepData { 125 var theMetaData = config.StepData{ 126 Metadata: config.StepMetadata{ 127 Name: "jsonApplyPatch", 128 Aliases: []config.Alias{}, 129 Description: "Patches a json with a patch file", 130 }, 131 Spec: config.StepSpec{ 132 Inputs: config.StepInputs{ 133 Parameters: []config.StepParameters{ 134 { 135 Name: "input", 136 ResourceRef: []config.ResourceReference{}, 137 Scope: []string{"PARAMETERS"}, 138 Type: "string", 139 Mandatory: true, 140 Aliases: []config.Alias{}, 141 Default: os.Getenv("PIPER_input"), 142 }, 143 { 144 Name: "patch", 145 ResourceRef: []config.ResourceReference{}, 146 Scope: []string{"PARAMETERS"}, 147 Type: "string", 148 Mandatory: true, 149 Aliases: []config.Alias{}, 150 Default: os.Getenv("PIPER_patch"), 151 }, 152 { 153 Name: "output", 154 ResourceRef: []config.ResourceReference{}, 155 Scope: []string{"PARAMETERS"}, 156 Type: "string", 157 Mandatory: true, 158 Aliases: []config.Alias{}, 159 Default: os.Getenv("PIPER_output"), 160 }, 161 }, 162 }, 163 }, 164 } 165 return theMetaData 166 }