util

Documentation

Index

• Variables
• func EnsureDirectory(dir string) error
• func FindInInterface(iface interface{}, mapKeys ...string) (interface{}, error)
• func GetShell() (string, error)
• func HostCommandExists(cmd string) (bool, error)
• func InterfaceToJSON(mapVar interface{}) ([]byte, error)
• func IsInRange(target, since, until time.Time) bool
• func JSONToFile(JSON []byte, outFile string) error
• func SplitFilepath(path string) (dir string, file string)
• func TarGz(sourceDir string, destFileName string, baseName string) error
• func WriteJSON(iface interface{}, filePath string) error
• type CommandNotFoundError
  • func (e CommandNotFoundError) Error() string
  • func (e CommandNotFoundError) Unwrap() error

Variables

var ErrNoShellOnWindows = errors.New("shell{} is not supported on Windows. please use command{}")

ErrNoShellOnWindows occurs when GetShell() is run on a Windows machine.

var ErrUnknownShell = errors.New("unable to determine shell from environment. please set the $SHELL environment variable")

ErrUnknownShell occurs when the $SHELL environment variable is empty or not set.

Functions

func EnsureDirectory

func EnsureDirectory(dir string) error

EnsureDirectory will ensure that the full path to the destination directory exists. If the full path exists, this is a no-op and will return nil. Otherwise, it will create any directories that do not exist in the destination path. Any directories created will be given file permissions 0755.

func FindInInterface

func FindInInterface(iface interface{}, mapKeys ...string) (interface{}, error)

FindInInterface treats an interface{} like a (nested) map, and searches through its contents for a given list of mapKeys. For example, given an interface{} containing a map like iface ~ interface{}{"top": {"mid": {"bottom": "desired_value"}}} one could fetch an interface{} of "desired_value" with FindInInterface(iface, "top", "mid", "bottom") then afterwards cast it to a string, or whatever type you're expecting.

func GetShell

func GetShell() (string, error)

GetShell returns the value of the $SHELL environment variable, or an error if on Windows or the variable is not set.

func HostCommandExists

func HostCommandExists(cmd string) (bool, error)

HostCommandExists takes a single OS-level command name, returning true if it exists in $PATH; false/CommandNotFoundError otherwise

func InterfaceToJSON

func InterfaceToJSON(mapVar interface{}) ([]byte, error)

InterfaceToJSON converts an interface{} to JSON.

func IsInRange

func IsInRange(target, since, until time.Time) bool

func JSONToFile

func JSONToFile(JSON []byte, outFile string) error

JSONToFile accepts JSON and an output file path to create a JSON file.

func SplitFilepath

func SplitFilepath(path string) (dir string, file string)

SplitFilepath takes a full path string and turns it into directory and file parts. In particular, it's useful for passing into runner.NewCopy()

func TarGz

func TarGz(sourceDir string, destFileName string, baseName string) error

TarGz is a utility function for archiving and compressing files. Its arguments include the source directory that you wish to archive; a destination filename, which is the .tar.gz file you want to create; and a baseName, which is the name of the directory that should be created when the resulting .tar.gz file is later extracted.

func WriteJSON

func WriteJSON(iface interface{}, filePath string) error

WriteJSON converts an interface{} to JSON then writes to filePath.

Types

type CommandNotFoundError

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

func (CommandNotFoundError) Error

func (e CommandNotFoundError) Error() string

func (CommandNotFoundError) Unwrap

func (e CommandNotFoundError) Unwrap() error