shell

type BashRenderer struct {
	// contains filtered or unexported fields
}

type CommandRenderer interface {
	// Chown returns a shell command for changing the ownership of
	// a file or directory. The copies the behavior of os.Chown,
	// though it also supports names in addition to ints.
	Chown(name, user, group string) []string

	// Chmod returns a shell command that sets the given file's
	// permissions. The result is equivalent to os.Chmod.
	Chmod(path string, perm os.FileMode) []string

	// WriteFile returns a shell command that writes the provided
	// content to a file. The command is functionally equivalent to
	// ioutil.WriteFile with permissions from the current umask.
	WriteFile(filename string, data []byte) []string

	// Mkdir returns a shell command for creating a directory. The
	// command is functionally equivalent to os.MkDir using permissions
	// appropriate for a directory.
	Mkdir(dirname string) []string

	// MkdirAll returns a shell command for creating a directory and
	// all missing parent directories. The command is functionally
	// equivalent to os.MkDirAll using permissions appropriate for
	// a directory.
	MkdirAll(dirname string) []string

	// Touch returns a shell command that updates the atime and ctime
	// of the named file. If the provided timestamp is nil then the
	// current time is used. If the file does not exist then it is
	// created. If UTC is desired then Time.UTC() should be called
	// before calling Touch.
	Touch(filename string, timestamp *time.Time) []string
}

type OutputRenderer interface {
	// RedirectFD returns a shell command that redirects the src
	// file descriptor to the dst one.
	RedirectFD(dst, src string) []string

	// RedirectOutput will cause all subsequent output from the shell
	// (or script) to go be appended to the given file. Only stdout is
	// redirected (use RedirectFD to redirect stderr or other FDs).
	//
	// The file should already exist (so a call to Touch may be
	// necessary before calling RedirectOutput). If the file should have
	// specific permissions or a specific owner then Chmod and Chown
	// should be called before calling RedirectOutput.
	RedirectOutput(filename string) []string

	// RedirectOutputReset will cause all subsequent output from the
	// shell (or script) to go be written to the given file. The file
	// will be reset (truncated to 0) before anything is written. Only
	// stdout is redirected (use RedirectFD to redirect stderr or
	// other FDs).
	//
	// The file should already exist (so a call to Touch may be
	// necessary before calling RedirectOutputReset). If the file should
	// have specific permissions or a specific owner then Chmod and
	// Chown should be called before calling RedirectOutputReset.
	RedirectOutputReset(filename string) []string
}

type PathRenderer interface {
	filepath.Renderer

	// Quote generates a new string with quotation marks and relevant
	// escape/control characters properly escaped. The resulting string
	// is wrapped in quotation marks such that it will be treated as a
	// single string by the shell.
	Quote(str string) string

	// ExeSuffix returns the filename suffix for executable files.
	ExeSuffix() string
}

type PowershellRenderer struct {
	// contains filtered or unexported fields
}

type Renderer interface {
	PathRenderer
	CommandRenderer
	OutputRenderer
}

type ScriptRenderer interface {
	// RenderScript generates the content of a shell script for the
	// provided shell commands.
	RenderScript(commands []string) []byte
}

type ScriptWriter interface {
	ScriptRenderer

	// Chmod returns a shell command that sets the given file's
	// permissions. The result is equivalent to os.Chmod.
	Chmod(path string, perm os.FileMode) []string

	// WriteFile returns a shell command that writes the provided
	// content to a file. The command is functionally equivalent to
	// ioutil.WriteFile with permissions from the current umask.
	WriteFile(filename string, data []byte) []string

	// ScriptFilename generates a filename appropriate for a script
	// from the provided file and directory names.
	ScriptFilename(name, dirname string) string

	// ScriptPermissions returns the permissions appropriate for a script.
	ScriptPermissions() os.FileMode
}

type WinCmdRenderer struct {
	// contains filtered or unexported fields
}