56fda0f8c6
The GH_DEBUG environment variable is a new gh-specific verbosity control. For backwards-compatibility, DEBUG will still be respected if it has values "1", "true", "yes", and "api", but any other values will be ignored. Finally, support for "oauth" debug value has been dropped in favor of "api". The "oauth" value only had limited, internal use. Co-authored-by: Mislav Marohnić <mislav@github.com>
86 lines
1.8 KiB
Go
86 lines
1.8 KiB
Go
package run
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/cli/cli/v2/utils"
|
|
)
|
|
|
|
// Runnable is typically an exec.Cmd or its stub in tests
|
|
type Runnable interface {
|
|
Output() ([]byte, error)
|
|
Run() error
|
|
}
|
|
|
|
// PrepareCmd extends exec.Cmd with extra error reporting features and provides a
|
|
// hook to stub command execution in tests
|
|
var PrepareCmd = func(cmd *exec.Cmd) Runnable {
|
|
return &cmdWithStderr{cmd}
|
|
}
|
|
|
|
// cmdWithStderr augments exec.Cmd by adding stderr to the error message
|
|
type cmdWithStderr struct {
|
|
*exec.Cmd
|
|
}
|
|
|
|
func (c cmdWithStderr) Output() ([]byte, error) {
|
|
if isVerbose, _ := utils.IsDebugEnabled(); isVerbose {
|
|
_ = printArgs(os.Stderr, c.Cmd.Args)
|
|
}
|
|
if c.Cmd.Stderr != nil {
|
|
return c.Cmd.Output()
|
|
}
|
|
errStream := &bytes.Buffer{}
|
|
c.Cmd.Stderr = errStream
|
|
out, err := c.Cmd.Output()
|
|
if err != nil {
|
|
err = &CmdError{errStream, c.Cmd.Args, err}
|
|
}
|
|
return out, err
|
|
}
|
|
|
|
func (c cmdWithStderr) Run() error {
|
|
if isVerbose, _ := utils.IsDebugEnabled(); isVerbose {
|
|
_ = printArgs(os.Stderr, c.Cmd.Args)
|
|
}
|
|
if c.Cmd.Stderr != nil {
|
|
return c.Cmd.Run()
|
|
}
|
|
errStream := &bytes.Buffer{}
|
|
c.Cmd.Stderr = errStream
|
|
err := c.Cmd.Run()
|
|
if err != nil {
|
|
err = &CmdError{errStream, c.Cmd.Args, err}
|
|
}
|
|
return err
|
|
}
|
|
|
|
// CmdError provides more visibility into why an exec.Cmd had failed
|
|
type CmdError struct {
|
|
Stderr *bytes.Buffer
|
|
Args []string
|
|
Err error
|
|
}
|
|
|
|
func (e CmdError) Error() string {
|
|
msg := e.Stderr.String()
|
|
if msg != "" && !strings.HasSuffix(msg, "\n") {
|
|
msg += "\n"
|
|
}
|
|
return fmt.Sprintf("%s%s: %s", msg, e.Args[0], e.Err)
|
|
}
|
|
|
|
func printArgs(w io.Writer, args []string) error {
|
|
if len(args) > 0 {
|
|
// print commands, but omit the full path to an executable
|
|
args = append([]string{filepath.Base(args[0])}, args[1:]...)
|
|
}
|
|
_, err := fmt.Fprintf(w, "%v\n", args)
|
|
return err
|
|
}
|