utils

Documentation

Index

• func CleanPath(path string) string
• func CloseExecFrom(minFd int) error
• func ExitStatus(status syscall.WaitStatus) int
• func GenerateRandomName(prefix string, size int) (string, error)
• func ResolveRootfs(uncleanRootfs string) (string, error)
• func SearchLabels(labels []string, query string) string
• func WriteJSON(w io.Writer, v interface{}) error

Functions

func CleanPath

func CleanPath(path string) string

CleanPath makes a path safe for use with filepath.Join. This is done by not only cleaning the path, but also (if the path is relative) adding a leading '/' and cleaning it (then removing the leading '/'). This ensures that a path resulting from prepending another path will always resolve to lexically be a subdirectory of the prefixed path. This is all done lexically, so paths that include symlinks won't be safe as a result of using CleanPath.

func CloseExecFrom

func CloseExecFrom(minFd int) error

func ExitStatus

func ExitStatus(status syscall.WaitStatus) int

ExitStatus returns the correct exit status for a process based on if it was signaled or exited cleanly

func GenerateRandomName

func GenerateRandomName(prefix string, size int) (string, error)

GenerateRandomName returns a new name joined with a prefix. This size specified is used to truncate the randomly generated value

func ResolveRootfs

func ResolveRootfs(uncleanRootfs string) (string, error)

ResolveRootfs ensures that the current working directory is not a symlink and returns the absolute path to the rootfs

func SearchLabels

func SearchLabels(labels []string, query string) string

SearchLabels searches a list of key-value pairs for the provided key and returns the corresponding value. The pairs must be separated with '='.

func WriteJSON

func WriteJSON(w io.Writer, v interface{}) error

WriteJSON writes the provided struct v to w using standard json marshaling