squadron/internal/util/cmd.go

package util

import (
	"bytes"
	"context"
	"io"
	"os"
	"os/exec"

	ptermx "github.com/foomo/squadron/internal/pterm"
	"github.com/pkg/errors"
	"github.com/pterm/pterm"
)

type Cmd struct {
	command       []string
	templateData  any
	cwd           string
	env           []string
	stdin         io.Reader
	stdoutWriters []io.Writer
	stderrWriters []io.Writer
}

// ------------------------------------------------------------------------------------------------
// ~ Constructor
// ------------------------------------------------------------------------------------------------

func NewCommand(name string) *Cmd {
	return &Cmd{
		command: []string{name},
		env:     os.Environ(),
	}
}

// ------------------------------------------------------------------------------------------------
// ~ Public methods
// ------------------------------------------------------------------------------------------------

func (c *Cmd) Args(args ...string) *Cmd {
	for _, arg := range args {
		if arg == "" {
			continue
		}

		c.append(arg)
	}

	return c
}

func (c *Cmd) TemplateData(v any) *Cmd {
	c.templateData = v
	return c
}

func (c *Cmd) Arg(name, v string) *Cmd {
	if name == "" || v == "" {
		return c
	}

	c.append(name, v)

	return c
}

func (c *Cmd) BoolArg(name string, v bool) *Cmd {
	if name == "" || !v {
		return c
	}

	c.append(name)

	return c
}

func (c *Cmd) ListArg(name string, vs []string) *Cmd {
	if name == "" {
		return c
	}

	for _, v := range vs {
		if v == "" {
			continue
		}

		c.append(name, v)
	}

	return c
}

func (c *Cmd) Cwd(path string) *Cmd {
	c.cwd = path
	return c
}

func (c *Cmd) Env(env ...string) *Cmd {
	c.env = append(c.env, env...)
	return c
}

func (c *Cmd) Stdin(r io.Reader) *Cmd {
	c.stdin = r
	return c
}

func (c *Cmd) Stdout(w io.Writer) *Cmd {
	if w == nil {
		w, _ = os.Open(os.DevNull)
	}

	c.stdoutWriters = append(c.stdoutWriters, w)

	return c
}

func (c *Cmd) Stderr(w io.Writer) *Cmd {
	if w == nil {
		w, _ = os.Open(os.DevNull)
	}

	c.stderrWriters = append(c.stderrWriters, w)

	return c
}

func (c *Cmd) String() string {
	cmd := exec.Command(c.command[0], c.command[1:]...) //nolint:noctx,gosec

	cmd.Env = append(os.Environ(), c.env...)
	if c.cwd != "" {
		cmd.Dir = c.cwd
	}

	return cmd.String()
}

func (c *Cmd) Run(ctx context.Context) (string, error) {
	cmd := exec.CommandContext(ctx, c.command[0], c.command[1:]...) //nolint:gosec

	cmd.Env = append(os.Environ(), c.env...)
	if c.cwd != "" {
		cmd.Dir = c.cwd
	}

	var (
		stdout bytes.Buffer
		stderr bytes.Buffer
	)

	if c.stdin != nil {
		cmd.Stdin = c.stdin
	}

	if value, ok := ptermx.SpinnerFromContext(ctx); ok {
		c.stdoutWriters = append(c.stdoutWriters, value)
		c.stderrWriters = append(c.stderrWriters, value)
	}

	cmd.Stdout = io.MultiWriter(append(c.stdoutWriters, &stdout)...)
	cmd.Stderr = io.MultiWriter(append(c.stderrWriters, &stderr)...)

	pterm.Debug.Println("❯ " + cmd.String())

	err := cmd.Run()
	if err != nil {
		err = errors.Wrap(err, "failed to execute: "+cmd.String())
	}

	return stdout.String() + stderr.String(), err
}

// ------------------------------------------------------------------------------------------------
// ~ Private methods
// ------------------------------------------------------------------------------------------------

func (c *Cmd) append(v ...string) {
	if c.templateData != nil {
		for i, s := range v {
			if value, err := RenderTemplateString(s, c.templateData); err != nil {
				pterm.Fatal.Println("failed to render template", err)
			} else {
				v[i] = value
			}
		}
	}

	c.command = append(c.command, v...)
}