chore: migrate exec behavior for maru

exec/exec.go

@@ -0,0 +1,146 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Defense Unicorns
+
+// Package exec provides a wrapper around the os/exec package
+package exec
+
+import (
+	"bytes"
+	"context"
+	"errors"
+	"fmt"
+	"io"
+	"os"
+	"os/exec"
+	"runtime"
+	"strings"
+	"sync"
+)
+
+// Config is a struct for configuring the Cmd function.
+type Config struct {
+	Print          bool
+	Dir            string
+	Env            []string
+	CommandPrinter func(format string, a ...any)
+	Stdout         io.Writer
+	Stderr         io.Writer
+}
+
+// PrintCfg is a helper function for returning a Config struct with Print set to true.
+func PrintCfg() Config {
+	return Config{Print: true}
+}
+
+// Cmd executes a given command with given config.
+func Cmd(command string, args ...string) (string, string, error) {
+	return CmdWithContext(context.TODO(), Config{}, command, args...)
+}
+
+// CmdWithPrint executes a given command with given config and prints the command.
+func CmdWithPrint(command string, args ...string) error {
+	_, _, err := CmdWithContext(context.TODO(), PrintCfg(), command, args...)
+	return err
+}
+
+// CmdWithContext executes a given command with given config.
+func CmdWithContext(ctx context.Context, config Config, command string, args ...string) (string, string, error) {
+	if command == "" {
+		return "", "", errors.New("command is required")
+	}
+
+	// Set up the command.
+	cmd := exec.CommandContext(ctx, command, args...)
+	cmd.Dir = config.Dir
+	cmd.Env = append(os.Environ(), config.Env...)
+
+	// Capture the command outputs.
+	cmdStdout, _ := cmd.StdoutPipe()
+	cmdStderr, _ := cmd.StderrPipe()
+
+	var (
+		stdoutBuf, stderrBuf bytes.Buffer
+		errStdout, errStderr error
+		wg                   sync.WaitGroup
+	)
+
+	stdoutWriters := []io.Writer{
+		&stdoutBuf,
+	}
+
+	stdErrWriters := []io.Writer{
+		&stderrBuf,
+	}
+
+	// Add the writers if requested.
+	if config.Stdout != nil {
+		stdoutWriters = append(stdoutWriters, config.Stdout)
+	}
+
+	if config.Stderr != nil {
+		stdErrWriters = append(stdErrWriters, config.Stderr)
+	}
+
+	// Print to stdout if requested.
+	if config.Print {
+		stdoutWriters = append(stdoutWriters, os.Stdout)
+		stdErrWriters = append(stdErrWriters, os.Stderr)
+	}
+
+	// Bind all the writers.
+	stdout := io.MultiWriter(stdoutWriters...)
+	stderr := io.MultiWriter(stdErrWriters...)
+
+	// If we're printing, print the command.
+	if config.Print && config.CommandPrinter != nil {
+		config.CommandPrinter("%s %s", command, strings.Join(args, " "))
+	}
+
+	// Start the command.
+	if err := cmd.Start(); err != nil {
+		return "", "", err
+	}
+
+	// Add to waitgroup for each goroutine.
+	wg.Add(2)
+
+	// Run a goroutine to capture the command's stdout live.
+	go func() {
+		_, errStdout = io.Copy(stdout, cmdStdout)
+		wg.Done()
+	}()
+
+	// Run a goroutine to capture the command's stderr live.
+	go func() {
+		_, errStderr = io.Copy(stderr, cmdStderr)
+		wg.Done()
+	}()
+
+	// Wait for the goroutines to finish (if any).
+	wg.Wait()
+
+	// Abort if there was an error capturing the command's outputs.
+	if errStdout != nil {
+		return "", "", fmt.Errorf("failed to capture the stdout command output: %w", errStdout)
+	}
+	if errStderr != nil {
+		return "", "", fmt.Errorf("failed to capture the stderr command output: %w", errStderr)
+	}
+
+	// Wait for the command to finish and return the buffered outputs, regardless of whether we printed them.
+	return stdoutBuf.String(), stderrBuf.String(), cmd.Wait()
+}
+
+// LaunchURL opens a URL in the default browser.
+func LaunchURL(url string) error {
+	switch runtime.GOOS {
+	case "linux":
+		return exec.Command("xdg-open", url).Start()
+	case "windows":
+		return exec.Command("rundll32", "url.dll,FileProtocolHandler", url).Start()
+	case "darwin":
+		return exec.Command("open", url).Start()
+	}
+
+	return nil
+}

exec/go.mod

@@ -0,0 +1,12 @@
+module github.com/defenseunicorns/pkg/exec
+
+go 1.21.8
+
+require github.com/defenseunicorns/pkg/helpers v1.1.1
+
+require (
+	github.com/otiai10/copy v1.14.0 // indirect
+	golang.org/x/sync v0.6.0 // indirect
+	golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
+	oras.land/oras-go/v2 v2.5.0 // indirect
+)

exec/go.sum

@@ -0,0 +1,20 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/defenseunicorns/pkg/helpers v1.1.1 h1:p3pKeK5SeFaoZUJZIX9sEsJqX1CGGMS8OpQMPgJtSqM=
+github.com/defenseunicorns/pkg/helpers v1.1.1/go.mod h1:F4S5VZLDrlNWQKklzv4v9tFWjjZNhxJ1gT79j4XiLwk=
+github.com/otiai10/copy v1.14.0 h1:dCI/t1iTdYGtkvCuBG2BgR6KZa83PTclw4U5n2wAllU=
+github.com/otiai10/copy v1.14.0/go.mod h1:ECfuL02W+/FkTWZWgQqXPWZgW9oeKCSQ5qVfSc4qc4w=
+github.com/otiai10/mint v1.5.1 h1:XaPLeE+9vGbuyEHem1JNk3bYc7KKqyI/na0/mLd/Kks=
+github.com/otiai10/mint v1.5.1/go.mod h1:MJm72SBthJjz8qhefc4z1PYEieWmy8Bku7CjcAqyUSM=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+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/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+oras.land/oras-go/v2 v2.5.0 h1:o8Me9kLY74Vp5uw07QXPiitjsw7qNXi8Twd+19Zf02c=
+oras.land/oras-go/v2 v2.5.0/go.mod h1:z4eisnLP530vwIOUOJeBIj0aGI0L1C3d53atvCBqZHg=

exec/shell.go

@@ -0,0 +1,71 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Defense Unicorns
+
+// Package exec provides a wrapper around the os/exec package
+package exec
+
+import "runtime"
+
+// Shell represents the desired shell to use for a given command
+type Shell struct {
+	Windows string `json:"windows,omitempty" jsonschema:"description=(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item),example=powershell,example=cmd,example=pwsh,example=sh,example=bash,example=gsh"`
+	Linux   string `json:"linux,omitempty" jsonschema:"description=(default 'sh') Indicates a preference for the shell to use on Linux systems,example=sh,example=bash,example=fish,example=zsh,example=pwsh"`
+	Darwin  string `json:"darwin,omitempty" jsonschema:"description=(default 'sh') Indicates a preference for the shell to use on macOS systems,example=sh,example=bash,example=fish,example=zsh,example=pwsh"`
+}
+
+// GetOSShell returns the shell and shellArgs based on the current OS
+func GetOSShell(shellPref Shell) (string, []string) {
+	var shell string
+	var shellArgs []string
+	powershellShellArgs := []string{"-Command", "$ErrorActionPreference = 'Stop';"}
+	shShellArgs := []string{"-e", "-c"}
+
+	switch runtime.GOOS {
+	case "windows":
+		shell = "powershell"
+		if shellPref.Windows != "" {
+			shell = shellPref.Windows
+		}
+
+		shellArgs = powershellShellArgs
+		if shell == "cmd" {
+			// Change shellArgs to /c if cmd is chosen
+			shellArgs = []string{"/c"}
+		} else if !IsPowershell(shell) {
+			// Change shellArgs to -c if a real shell is chosen
+			shellArgs = shShellArgs
+		}
+	case "darwin":
+		shell = "sh"
+		if shellPref.Darwin != "" {
+			shell = shellPref.Darwin
+		}
+
+		shellArgs = shShellArgs
+		if IsPowershell(shell) {
+			// Change shellArgs to -Command if pwsh is chosen
+			shellArgs = powershellShellArgs
+		}
+	case "linux":
+		shell = "sh"
+		if shellPref.Linux != "" {
+			shell = shellPref.Linux
+		}
+
+		shellArgs = shShellArgs
+		if IsPowershell(shell) {
+			// Change shellArgs to -Command if pwsh is chosen
+			shellArgs = powershellShellArgs
+		}
+	default:
+		shell = "sh"
+		shellArgs = shShellArgs
+	}
+
+	return shell, shellArgs
+}
+
+// IsPowershell returns whether a shell name is powershell
+func IsPowershell(shellName string) bool {
+	return shellName == "powershell" || shellName == "pwsh"
+}

exec/utils.go

@@ -0,0 +1,61 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Defense Unicorns
+
+// Package exec provides a wrapper around the os/exec package
+package exec
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"regexp"
+	"runtime"
+	"strings"
+
+	"github.com/defenseunicorns/pkg/helpers"
+)
+
+var registeredCmdMutations = map[string]string{}
+
+// GetFinalExecutablePath returns the absolute path to the current executable, following any symlinks along the way.
+func GetFinalExecutablePath() (string, error) {
+	binaryPath, err := os.Executable()
+	if err != nil {
+		return "", err
+	}
+
+	// In case the binary is symlinked somewhere else, get the final destination
+	linkedPath, err := filepath.EvalSymlinks(binaryPath)
+	return linkedPath, err
+}
+
+// RegisterCmdMutation registers local ./ commands that should change to the specified cmdLocation
+func RegisterCmdMutation(cmdKey string, cmdLocation string) {
+	registeredCmdMutations[fmt.Sprintf("./%s ", cmdKey)] = fmt.Sprintf("%s ", cmdLocation)
+}
+
+// MutateCommand performs some basic string mutations to make commands more useful.
+func MutateCommand(cmd string, shellPref Shell) string {
+	for cmdKey, cmdLocation := range registeredCmdMutations {
+		cmd = strings.ReplaceAll(cmd, cmdKey, cmdLocation)
+	}
+
+	// Make commands 'more' compatible with Windows OS PowerShell
+	if runtime.GOOS == "windows" && (IsPowershell(shellPref.Windows) || shellPref.Windows == "") {
+		// Replace "touch" with "New-Item" on Windows as it's a common command, but not POSIX so not aliased by M$.
+		// See https://mathieubuisson.github.io/powershell-linux-bash/ &
+		// http://web.cs.ucla.edu/~miryung/teaching/EE461L-Spring2012/labs/posix.html for more details.
+		cmd = regexp.MustCompile(`^touch `).ReplaceAllString(cmd, `New-Item `)
+
+		// Convert any ${ENV_*} or $ENV_* to ${Env:ENV_*} or $Env:ENV_* respectively.
+		// https://regex101.com/r/bBDfW2/1
+		envVarRegex := regexp.MustCompile(`(?P<envIndicator>\${?(?P<varName>([^E{]|E[^n]|En[^v]|Env[^:\s])([a-zA-Z0-9_-])+)}?)`)
+		get, err := helpers.MatchRegex(envVarRegex, cmd)
+		if err == nil {
+			newCmd := strings.ReplaceAll(cmd, get("envIndicator"), fmt.Sprintf("$Env:%s", get("varName")))
+			cmd = newCmd
+		}
+	}
+
+	return cmd
+}

variables/common.go

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-FileCopyrightText: 2024-Present Defense Unicorns
+
+// Package variables contains functions for interacting with variables
+package variables
+
+import (
+	"log/slog"
+)
+
+// VariableConfig represents a value to be templated into a text file.
+type VariableConfig struct {
+	templatePrefix string
+	deprecatedKeys map[string]string
+
+	applicationTemplates map[string]*TextTemplate
+	setVariableMap       SetVariableMap
+	constants            []Constant
+
+	prompt func(variable InteractiveVariable) (value string, err error)
+	logger *slog.Logger
+}
+
+// New creates a new VariableConfig
+func New(templatePrefix string, deprecatedKeys map[string]string, prompt func(variable InteractiveVariable) (value string, err error), logger *slog.Logger) *VariableConfig {
+	return &VariableConfig{
+		templatePrefix:       templatePrefix,
+		deprecatedKeys:       deprecatedKeys,
+		applicationTemplates: make(map[string]*TextTemplate),
+		setVariableMap:       make(SetVariableMap),
+		prompt:               prompt,
+		logger:               logger,
+	}
+}
+
+// SetApplicationTemplates sets the application-specific templates for the variable config (i.e. ZARF_REGISTRY for Zarf)
+func (vc *VariableConfig) SetApplicationTemplates(applicationTemplates map[string]*TextTemplate) {
+	vc.applicationTemplates = applicationTemplates
+}
+
+// SetConstants sets the constants for a variable config (templated as PREFIX_CONST_NAME)
+func (vc *VariableConfig) SetConstants(constants []Constant) {
+	vc.constants = constants
+}

variables/go.mod

@@ -0,0 +1,12 @@
+module github.com/defenseunicorns/pkg/variables
+
+go 1.21.8
+
+require github.com/defenseunicorns/pkg/helpers v1.1.1
+
+require (
+	github.com/otiai10/copy v1.14.0 // indirect
+	golang.org/x/sync v0.6.0 // indirect
+	golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
+	oras.land/oras-go/v2 v2.5.0 // indirect
+)

variables/go.sum

@@ -0,0 +1,20 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/defenseunicorns/pkg/helpers v1.1.1 h1:p3pKeK5SeFaoZUJZIX9sEsJqX1CGGMS8OpQMPgJtSqM=
+github.com/defenseunicorns/pkg/helpers v1.1.1/go.mod h1:F4S5VZLDrlNWQKklzv4v9tFWjjZNhxJ1gT79j4XiLwk=
+github.com/otiai10/copy v1.14.0 h1:dCI/t1iTdYGtkvCuBG2BgR6KZa83PTclw4U5n2wAllU=
+github.com/otiai10/copy v1.14.0/go.mod h1:ECfuL02W+/FkTWZWgQqXPWZgW9oeKCSQ5qVfSc4qc4w=
+github.com/otiai10/mint v1.5.1 h1:XaPLeE+9vGbuyEHem1JNk3bYc7KKqyI/na0/mLd/Kks=
+github.com/otiai10/mint v1.5.1/go.mod h1:MJm72SBthJjz8qhefc4z1PYEieWmy8Bku7CjcAqyUSM=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+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/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+oras.land/oras-go/v2 v2.5.0 h1:o8Me9kLY74Vp5uw07QXPiitjsw7qNXi8Twd+19Zf02c=
+oras.land/oras-go/v2 v2.5.0/go.mod h1:z4eisnLP530vwIOUOJeBIj0aGI0L1C3d53atvCBqZHg=