1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/cmd/shellExecute.go
Oliver Nocon 5da174aeb0
feat(kubernetesDeploy): add infrastructure extensibility (#3853)
* feat(kubernetesDeploy): add infrastructure extensibility

* update comment

* update error handling

* remove trailing spaces

* chore: refactor to use reuse capabilities

* chore: add tests

* fix: use proper download function

* fix: expose credentials via groovy step

* fix: test

* chore: remove comment

* chore: address CodeClimate findings
2022-06-29 12:00:37 +02:00

106 lines
2.9 KiB
Go

package cmd
import (
"fmt"
"os/exec"
"strings"
"github.com/pkg/errors"
"github.com/SAP/jenkins-library/pkg/command"
piperhttp "github.com/SAP/jenkins-library/pkg/http"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/piperutils"
"github.com/SAP/jenkins-library/pkg/telemetry"
)
type shellExecuteUtils interface {
command.ExecRunner
piperutils.FileUtils
piperhttp.Downloader
}
type shellExecuteUtilsBundle struct {
*command.Command
*piperutils.Files
*piperhttp.Client
}
func newShellExecuteUtils() shellExecuteUtils {
utils := shellExecuteUtilsBundle{
Command: &command.Command{},
Files: &piperutils.Files{},
Client: &piperhttp.Client{},
}
utils.Stdout(log.Writer())
utils.Stderr(log.Writer())
return &utils
}
func shellExecute(config shellExecuteOptions, telemetryData *telemetry.CustomData) {
utils := newShellExecuteUtils()
err := runShellExecute(&config, telemetryData, utils)
if err != nil {
log.Entry().WithError(err).Fatal("step execution failed")
}
}
func runShellExecute(config *shellExecuteOptions, telemetryData *telemetry.CustomData, utils shellExecuteUtils) error {
// check input data
// example for script: sources: ["./script.sh"]
for position, source := range config.Sources {
if strings.Contains(source, "https") {
scriptLocation, err := piperhttp.DownloadExecutable(config.GithubToken, utils, utils, source)
if err != nil {
return errors.Wrapf(err, "script download error")
}
source = scriptLocation
}
// check if the script is physically present
exists, err := utils.FileExists(source)
if err != nil {
log.Entry().WithError(err).Error("failed to check for defined script")
return fmt.Errorf("failed to check for defined script: %w", err)
}
if !exists {
log.Entry().WithError(err).Errorf("the script '%v' could not be found: %v", source, err)
return fmt.Errorf("the script '%v' could not be found", source)
}
args := []string{}
if len(config.ScriptArguments) > 0 && isArgumentAtPosition(config.ScriptArguments, position) {
args = strings.Split(config.ScriptArguments[position], " ")
}
log.Entry().Info("starting running script:", source)
err = utils.RunExecutable(source, args...)
if err != nil {
log.Entry().Errorln("starting running script:", source)
}
// handle exit code
if ee, ok := err.(*exec.ExitError); ok {
switch ee.ExitCode() {
case 0:
// success
return nil
case 1:
return errors.Wrap(err, "an error occurred while executing the script")
default:
// exit code 2 or >2 - unstable
return errors.Wrap(err, "script execution unstable or something went wrong")
}
} else if err != nil {
return errors.Wrap(err, "script execution error occurred")
}
}
return nil
}
func isArgumentAtPosition(scriptArguments []string, index int) bool {
return ((len(scriptArguments) > index) && scriptArguments[index] != "")
}