github.com/jaylevin/jenkins-library@v1.230.4/cmd/shellExecute_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 shellExecuteOptions struct { 19 Sources []string `json:"sources,omitempty"` 20 GithubToken string `json:"githubToken,omitempty"` 21 ScriptArguments []string `json:"scriptArguments,omitempty"` 22 } 23 24 // ShellExecuteCommand Step executes defined script 25 func ShellExecuteCommand() *cobra.Command { 26 const STEP_NAME = "shellExecute" 27 28 metadata := shellExecuteMetadata() 29 var stepConfig shellExecuteOptions 30 var startTime time.Time 31 var logCollector *log.CollectorHook 32 var splunkClient *splunk.Splunk 33 telemetryClient := &telemetry.Telemetry{} 34 35 var createShellExecuteCmd = &cobra.Command{ 36 Use: STEP_NAME, 37 Short: "Step executes defined script", 38 Long: `Step executes defined script provided in the 'sources' parameter`, 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.GithubToken) 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 shellExecute(stepConfig, &stepTelemetryData) 104 stepTelemetryData.ErrorCode = "0" 105 log.Entry().Info("SUCCESS") 106 }, 107 } 108 109 addShellExecuteFlags(createShellExecuteCmd, &stepConfig) 110 return createShellExecuteCmd 111 } 112 113 func addShellExecuteFlags(cmd *cobra.Command, stepConfig *shellExecuteOptions) { 114 cmd.Flags().StringSliceVar(&stepConfig.Sources, "sources", []string{}, "Scripts paths that must be present in the current workspace or https links to scripts. Only https urls from github are allowed and must be in the format :https://{githubBaseurl}/api/v3/repos/{owner}/{repository}/contents/{path to script} Authentication for the download is only supported via the 'githubToken' param. Make sure the script has the necessary execute permissions.") 115 cmd.Flags().StringVar(&stepConfig.GithubToken, "githubToken", os.Getenv("PIPER_githubToken"), "GitHub personal access token as per https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line") 116 cmd.Flags().StringSliceVar(&stepConfig.ScriptArguments, "scriptArguments", []string{}, "scriptArguments that are needed to be passed to scripts. the scriptArguments list is a flat list and has a positional relationship to the `sources` param. For e.g. The scriptArguments string at position 1 will be considered as the argument(s) for script at position 1 in `sources` list") 117 118 } 119 120 // retrieve step metadata 121 func shellExecuteMetadata() config.StepData { 122 var theMetaData = config.StepData{ 123 Metadata: config.StepMetadata{ 124 Name: "shellExecute", 125 Aliases: []config.Alias{}, 126 Description: "Step executes defined script", 127 }, 128 Spec: config.StepSpec{ 129 Inputs: config.StepInputs{ 130 Secrets: []config.StepSecrets{ 131 {Name: "githubTokenCredentialsId", Description: "Jenkins credentials ID containing the github token.", Type: "jenkins"}, 132 }, 133 Parameters: []config.StepParameters{ 134 { 135 Name: "sources", 136 ResourceRef: []config.ResourceReference{}, 137 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 138 Type: "[]string", 139 Mandatory: false, 140 Aliases: []config.Alias{}, 141 Default: []string{}, 142 }, 143 { 144 Name: "githubToken", 145 ResourceRef: []config.ResourceReference{ 146 { 147 Name: "githubTokenCredentialsId", 148 Type: "secret", 149 }, 150 151 { 152 Name: "githubVaultSecretName", 153 Type: "vaultSecret", 154 Default: "github", 155 }, 156 }, 157 Scope: []string{"GENERAL", "PARAMETERS", "STAGES", "STEPS"}, 158 Type: "string", 159 Mandatory: false, 160 Aliases: []config.Alias{{Name: "access_token"}}, 161 Default: os.Getenv("PIPER_githubToken"), 162 }, 163 { 164 Name: "scriptArguments", 165 ResourceRef: []config.ResourceReference{}, 166 Scope: []string{"PARAMETERS", "STAGES", "STEPS"}, 167 Type: "[]string", 168 Mandatory: false, 169 Aliases: []config.Alias{}, 170 Default: []string{}, 171 }, 172 }, 173 }, 174 Containers: []config.Container{ 175 {Name: "shell", Image: "node:lts-stretch", WorkingDir: "/home/node"}, 176 }, 177 }, 178 } 179 return theMetaData 180 }