os

Documentation

Index

• func CopyFileContents(src string, dst string, permission os.FileMode) error
• func FileContentMatches(path string, expectedContent []byte) error
• func FileExists(path string) bool
• func RemoveFileAsRoot(reason, filepath string) error
• func RemoveFileIfExists(path string) error
• func ReplaceOrAddEnv(variables []string, varName string, value string) []string
• func RunPrivileged(reason string, cmdAndArgs ...string) (string, string, error)
• func RunWithDefaultLocale(command string, args ...string) (string, string, error)
• func RunWithDefaultLocalePrivate(command string, args ...string) (string, string, error)
• func RunningInTerminal() bool
• func WriteFileIfContentChanged(path string, newContent []byte, perm os.FileMode) (bool, error)
• func WriteToFileAsRoot(reason, content, filepath string, mode os.FileMode) error
• type CommandRunner
  • func NewLocalCommandRunner() CommandRunner

Functions

func CopyFileContents

func CopyFileContents(src string, dst string, permission os.FileMode) error

func FileContentMatches

func FileContentMatches(path string, expectedContent []byte) error

func FileExists

func FileExists(path string) bool

FileExists returns true if the file at path exists. It returns false if it does not exist, or if there was an error when checking for its existence. This means there can be false negatives if Lstat fails because of permission issues (file exists, but is not reachable by the current user)

func RemoveFileAsRoot

func RemoveFileAsRoot(reason, filepath string) error

func RemoveFileIfExists

func RemoveFileIfExists(path string) error

func ReplaceOrAddEnv

func ReplaceOrAddEnv(variables []string, varName string, value string) []string

ReplaceOrAddEnv changes the value of an environment variable if it exists otherwise add the new variable It drops the existing value and appends the new value in-place

func RunPrivileged

func RunPrivileged(reason string, cmdAndArgs ...string) (string, string, error)

RunPrivileged executes a command using sudo provide a reason why root is needed as the first argument

func RunWithDefaultLocale

func RunWithDefaultLocale(command string, args ...string) (string, string, error)

func RunWithDefaultLocalePrivate

func RunWithDefaultLocalePrivate(command string, args ...string) (string, string, error)

func RunningInTerminal

func RunningInTerminal() bool

func WriteFileIfContentChanged

func WriteFileIfContentChanged(path string, newContent []byte, perm os.FileMode) (bool, error)

func WriteToFileAsRoot

func WriteToFileAsRoot(reason, content, filepath string, mode os.FileMode) error

Types

type CommandRunner

type CommandRunner interface {
	Run(command string, args ...string) (string, string, error)
	RunPrivate(command string, args ...string) (string, string, error)
	RunPrivileged(reason string, cmdAndArgs ...string) (string, string, error)
}

func NewLocalCommandRunner

func NewLocalCommandRunner() CommandRunner