diff --git a/README.md b/README.md index d63ac68d..2dd451c2 100644 --- a/README.md +++ b/README.md @@ -521,6 +521,24 @@ The path to a directory where the local OpenTofu versions, Terraform versions, T +
GITHUB_ACTIONS
+ +String (Default: false) + +If set to true **tenv** proxies exposes proxied output `stdout`, `stderr`, and `exitcode` by writing them into GITHUB_OUTPUT in [multiline format](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#multiline-strings). GitHub Actions set it (see [default environment variables](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables)). + +
+ + +
GITHUB_OUTPUT
+ +String (Default: "") + +Needed when GITHUB_ACTIONS is set to true, path to a file to write proxied output. + +
+ + ### OpenTofu environment variables diff --git a/config/config.go b/config/config.go index aa52dbaf..c66deca8 100644 --- a/config/config.go +++ b/config/config.go @@ -233,8 +233,8 @@ func (conf *Config) InitRemoteConf() error { } func getenvBoolFallback(defaultValue bool, keys ...string) (bool, error) { - if verboseStr := getenvFallback(keys...); verboseStr != "" { - return strconv.ParseBool(verboseStr) + if valueStr := getenvFallback(keys...); valueStr != "" { + return strconv.ParseBool(valueStr) } return defaultValue, nil diff --git a/go.mod b/go.mod index 750f6fec..ec22fda0 100644 --- a/go.mod +++ b/go.mod @@ -32,10 +32,11 @@ require ( github.com/pkg/errors v0.9.1 // indirect github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect github.com/stretchr/testify v1.8.4 // indirect - golang.org/x/crypto v0.21.0 // indirect - golang.org/x/mod v0.16.0 // indirect - golang.org/x/net v0.23.0 // indirect - golang.org/x/sys v0.18.0 // indirect + golang.org/x/crypto v0.22.0 // indirect + golang.org/x/mod v0.17.0 // indirect + golang.org/x/net v0.24.0 // indirect + golang.org/x/sync v0.7.0 // indirect + golang.org/x/sys v0.19.0 // indirect golang.org/x/text v0.14.0 // indirect - golang.org/x/tools v0.19.0 // indirect + golang.org/x/tools v0.20.0 // indirect ) diff --git a/go.sum b/go.sum index 499d99f3..8abd04be 100644 --- a/go.sum +++ b/go.sum @@ -74,12 +74,12 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.3.1-0.20221117191849-2c476679df9a/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= golang.org/x/crypto v0.7.0/go.mod h1:pYwdfH91IfpZVANVyUOhSIPZaFoJGxTFbZhFTx+dXZU= -golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA= -golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs= +golang.org/x/crypto v0.22.0 h1:g1v0xeRhjcugydODzvb3mEM9SQ0HGp9s/nh3COQ/C30= +golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic= -golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= @@ -87,13 +87,13 @@ golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc= golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns= -golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs= -golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg= +golang.org/x/net v0.24.0 h1:1PcaxkF854Fu3+lvBIx5SYn9wRlBzzcnHZSiaFFAb0w= +golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ= -golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M= +golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -110,8 +110,8 @@ golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4= -golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o= +golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= @@ -131,8 +131,8 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= -golang.org/x/tools v0.19.0 h1:tfGCXNR1OsFG+sVdLAitlpjAvD/I6dHDKnYrpEZUHkw= -golang.org/x/tools v0.19.0/go.mod h1:qoJWxmGSIBmAeriMx19ogtrEPrGtDbPK634QFIcLAhc= +golang.org/x/tools v0.20.0 h1:hz/CVckiOxybQvFw6h7b/q80NTr9IUQb4s1IIzW7KNY= +golang.org/x/tools v0.20.0/go.mod h1:WvitBU7JJf6A4jOdg4S1tviW9bhUxkgeCui/0JHctQg= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= diff --git a/versionmanager/proxy/proxy.go b/versionmanager/proxy/proxy.go index 0c695a89..15ce99e6 100644 --- a/versionmanager/proxy/proxy.go +++ b/versionmanager/proxy/proxy.go @@ -19,16 +19,22 @@ package proxy import ( + "errors" "fmt" + "math/rand" "os" "os/exec" "path/filepath" + "strconv" + "strings" "github.com/tofuutils/tenv/config" "github.com/tofuutils/tenv/versionmanager" terragruntparser "github.com/tofuutils/tenv/versionmanager/semantic/parser/terragrunt" ) +var errDelimiter = errors.New("key and value should not contains delimiter") + func Exec(builderFunc func(*config.Config, terragruntparser.TerragruntParser) versionmanager.VersionManager, execName string) { conf, err := config.InitConfigFromEnv() if err != nil { @@ -48,17 +54,121 @@ func Exec(builderFunc func(*config.Config, terragruntparser.TerragruntParser) ve } func RunCmd(installPath string, detectedVersion string, execName string) { + exitCode := 0 + defer func() { + os.Exit(exitCode) + }() + cmdArgs := os.Args[1:] // proxy to selected version cmd := exec.Command(filepath.Join(installPath, detectedVersion, execName), cmdArgs...) - cmd.Stderr = os.Stderr - cmd.Stdin = os.Stdin - cmd.Stdout = os.Stdout - if err := cmd.Run(); err != nil { + done, err := initIO(cmd, execName, &exitCode) + if err != nil { + exitWithErrorMsg(execName, err, &exitCode) + + return + } + + calledExitCode := 0 + defer func() { + done(calledExitCode) + }() + + if err = cmd.Run(); err != nil { if exitError, ok := err.(*exec.ExitError); ok { - os.Exit(exitError.ExitCode()) + calledExitCode = exitError.ExitCode() + + return } - fmt.Println("Failure during", execName, "call :", err) //nolint - os.Exit(1) + exitWithErrorMsg(execName, err, &exitCode) + } +} + +func exitWithErrorMsg(execName string, err error, pExitCode *int) { + fmt.Println("Failure during", execName, "call :", err) //nolint + *pExitCode = 1 +} + +func getenvBool(defaultValue bool, key string) (bool, error) { + if valueStr := os.Getenv(key); valueStr != "" { + return strconv.ParseBool(valueStr) } + + return defaultValue, nil +} + +func initIO(cmd *exec.Cmd, execName string, pExitCode *int) (func(int), error) { + gha, err := getenvBool(false, "GITHUB_ACTIONS") + if err != nil { + return nil, err + } + + cmd.Stdin = os.Stdin + if !gha { + cmd.Stderr = os.Stderr + cmd.Stdout = os.Stdout + + return func(calledExitCode int) { + if calledExitCode != 0 { + *pExitCode = calledExitCode + } + }, nil + } + + outputPath := os.Getenv("GITHUB_OUTPUT") + + outputFile, err := os.OpenFile(outputPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) + if err != nil { + return nil, err + } + + var errBuffer, outBuffer strings.Builder + cmd.Stderr = &errBuffer + cmd.Stdout = &outBuffer + + return func(calledExitCode int) { + var err error + defer func() { + if err != nil { + exitWithErrorMsg(execName, err, pExitCode) + } + }() + defer outputFile.Close() + + if err = writeMultiline(outputFile, "stderr", errBuffer.String()); err != nil { + return + } + + if err = writeMultiline(outputFile, "stdout", outBuffer.String()); err != nil { + return + } + + if err = writeMultiline(outputFile, "exitcode", strconv.Itoa(calledExitCode)); err != nil { + return + } + + if calledExitCode != 0 && calledExitCode != 2 { + err = fmt.Errorf("exited with code %d", calledExitCode) + } + }, nil +} + +func writeMultiline(file *os.File, key string, value string) error { + delimiter := "ghadelimeter_" + strconv.Itoa(rand.Int()) + if strings.Contains(key, delimiter) || strings.Contains(value, delimiter) { + return errDelimiter + } + + var builder strings.Builder + builder.WriteString(key) + builder.WriteString("<<") + builder.WriteString(delimiter) + builder.WriteRune('\n') + builder.WriteString(value) + builder.WriteRune('\n') + builder.WriteString(delimiter) + builder.WriteRune('\n') + _, err := file.WriteString(builder.String()) + + return err }