util

Documentation

Index

• Variables
• func BoolPtr(b bool) *bool
• func CreateTar(w io.Writer, root string, paths []string) error
• func CreateTarGz(w io.Writer, root string, paths []string) error
• func ExecuteEnvTemplate(envTemplate *template.Template, customMap map[string]string) (string, error)
• func ExpandPathsGlob(workingDir string, paths []string) ([]string, error)
• func IsSupportedKubernetesFormat(n string) bool
• func ParseEnvTemplate(t string) (*template.Template, error)
• func RandomID() string
• func ReadConfiguration(filename string) ([]byte, error)
• func RemoveFromSlice(s []string, target string) []string
• func RunCmd(cmd *exec.Cmd) error
• func RunCmdOut(cmd *exec.Cmd) ([]byte, error)
• func StrSliceContains(sl []string, s string) bool
• func StringPtr(s string) *string
• func VerifyOrCreateFile(path string) error
• type Command
• type Commander
  • func (*Commander) RunCmd(cmd *exec.Cmd) error
  • func (*Commander) RunCmdOut(cmd *exec.Cmd) ([]byte, error)

Variables

var OSEnviron = os.Environ

Functions

func BoolPtr

func BoolPtr(b bool) *bool

BoolPtr returns a pointer to a bool

func CreateTar

func CreateTar(w io.Writer, root string, paths []string) error

func CreateTarGz

func CreateTarGz(w io.Writer, root string, paths []string) error

func ExecuteEnvTemplate

func ExecuteEnvTemplate(envTemplate *template.Template, customMap map[string]string) (string, error)

ExecuteEnvTemplate executes an envTemplate based on OS environment variables and a custom map

func ExpandPathsGlob

func ExpandPathsGlob(workingDir string, paths []string) ([]string, error)

ExpandPathsGlob expands paths according to filepath.Glob patterns Returns a list of unique files that match the glob patterns passed in.

func IsSupportedKubernetesFormat

func IsSupportedKubernetesFormat(n string) bool

IsSupportedKubernetesFormat is for determining if a file under a glob pattern is deployable file format. It makes no attempt to check whether or not the file is actually deployable or has the correct contents.

func ParseEnvTemplate

func ParseEnvTemplate(t string) (*template.Template, error)

ParseEnvTemplate is a simple wrapper to parse an env template

func RandomID

func RandomID() string

func ReadConfiguration

func ReadConfiguration(filename string) ([]byte, error)

func RemoveFromSlice

func RemoveFromSlice(s []string, target string) []string

RemoveFromSlice removes a string from a slice of strings

func RunCmd

func RunCmd(cmd *exec.Cmd) error

func RunCmdOut

func RunCmdOut(cmd *exec.Cmd) ([]byte, error)

func StrSliceContains

func StrSliceContains(sl []string, s string) bool

func StringPtr

func StringPtr(s string) *string

StringPtr returns a pointer to a string

func VerifyOrCreateFile

func VerifyOrCreateFile(path string) error

VerifyOrCreateFile checks if a file exists at the given path, and if not, creates all parent directories and creates the file.

Types

type Command

type Command interface {
	RunCmdOut(cmd *exec.Cmd) ([]byte, error)
	RunCmd(cmd *exec.Cmd) error
}

Command is an interface used to run commands. All packages should use this interface instead of calling exec.Cmd directly.

var DefaultExecCommand Command = &Commander{}

DefaultExecCommand runs commands using exec.Cmd

type Commander

type Commander struct{}

Commander is the exec.Cmd implementation of the Command interface

func (*Commander) RunCmd

func (*Commander) RunCmd(cmd *exec.Cmd) error

RunCmd runs an exec.Command.

func (*Commander) RunCmdOut

func (*Commander) RunCmdOut(cmd *exec.Cmd) ([]byte, error)

RunCmdOut runs an exec.Command and returns the stdout and error.