util

Documentation

Index

• func CanonicalPath(path string, basePath string) (string, error)
• func CanonicalPaths(paths []string, basePath string) ([]string, error)
• func CleanPath(path string) string
• func CommaSeparatedStrings(list []string) string
• func CopyFile(source string, destination string) error
• func CopyFolderContents(source string, destination string) error
• func CreateLogger(prefix string) *log.Logger
• func CreateLoggerWithWriter(writer io.Writer, prefix string) *log.Logger
• func DeleteFiles(files []string) error
• func EncodeBase64Sha1(str string) string
• func FileExists(path string) bool
• func GetPathRelativeTo(path string, basePath string) (string, error)
• func GetRandomTime(lowerBound, upperBound time.Duration) time.Duration
• func Grep(regex *regexp.Regexp, glob string) (bool, error)
• func JoinPath(elem ...string) string
• func KindOf(value interface{}) reflect.Kind
• func ListContainsElement(list []string, element string) bool
• func PathContainsHiddenFileOrFolder(path string) bool
• func ReadFileAsString(path string) (string, error)
• func RemoveDuplicatesFromList(list []string) []string
• func RemoveDuplicatesFromListKeepLast(list []string) []string
• func RemoveElementFromList(list []string, element string) []string
• func WriteFileWithSamePermissions(source string, destination string, contents []byte) error

Functions

func CanonicalPath

func CanonicalPath(path string, basePath string) (string, error)

Return the canonical version of the given path, relative to the given base path. That is, if the given path is a relative path, assume it is relative to the given base path. A canonical path is an absolute path with all relative components (e.g. "../") fully resolved, which makes it safe to compare paths as strings.

func CanonicalPaths

func CanonicalPaths(paths []string, basePath string) ([]string, error)

Return the canonical version of the given paths, relative to the given base path. That is, if a given path is a relative path, assume it is relative to the given base path. A canonical path is an absolute path with all relative components (e.g. "../") fully resolved, which makes it safe to compare paths as strings.

func CleanPath

func CleanPath(path string) string

Use this function when cleaning paths to ensure the returned path uses / as the path separator to improve cross-platform compatibility

func CommaSeparatedStrings

func CommaSeparatedStrings(list []string) string

CommaSeparatedStrings returns an HCL compliant formated list of strings (each string within double quote)

func CopyFile

func CopyFile(source string, destination string) error

Copy a file from source to destination

func CopyFolderContents

func CopyFolderContents(source string, destination string) error

Copy the files and folders within the source folder into the destination folder. Note that hidden files and folders (those starting with a dot) will be skipped.

func CreateLogger

func CreateLogger(prefix string) *log.Logger

Create a logger with the given prefix

func CreateLoggerWithWriter

func CreateLoggerWithWriter(writer io.Writer, prefix string) *log.Logger

CreateLoggerWithWriter Create a lgogger around the given output stream and prefix

func DeleteFiles

func DeleteFiles(files []string) error

Delete the given list of files. Note: this function ONLY deletes files and will return an error if you pass in a folder path.

func EncodeBase64Sha1

func EncodeBase64Sha1(str string) string

Returns the base 64 encoded sha1 hash of the given string

func FileExists

func FileExists(path string) bool

Return true if the given file exists

func GetPathRelativeTo

func GetPathRelativeTo(path string, basePath string) (string, error)

Return the relative path you would have to take to get from basePath to path

func GetRandomTime

func GetRandomTime(lowerBound, upperBound time.Duration) time.Duration

Get a random time duration between the lower bound and upper bound. This is useful because some of our automated tests wound up flooding the AWS API all at once, leading to a "Subscriber limit exceeded" error. TODO: Some of the more exotic test cases fail, but it's not worth catching them given the intended use of this function.

func Grep

func Grep(regex *regexp.Regexp, glob string) (bool, error)

Returns true if the given regex can be found in any of the files matched by the given glob

func JoinPath

func JoinPath(elem ...string) string

Windows systems use \ as the path separator *nix uses / Use this function when joining paths to force the returned path to use / as the path separator This will improve cross-platform compatibility

func KindOf

func KindOf(value interface{}) reflect.Kind

Return the kind of the type or Invalid if value is nil

func ListContainsElement

func ListContainsElement(list []string, element string) bool

Return true if the given list contains the given element

func PathContainsHiddenFileOrFolder

func PathContainsHiddenFileOrFolder(path string) bool

func ReadFileAsString

func ReadFileAsString(path string) (string, error)

Return the contents of the file at the given path as a string

func RemoveDuplicatesFromList

func RemoveDuplicatesFromList(list []string) []string

Returns a copy of the given list with all duplicates removed (keeping the first encountereds)

func RemoveDuplicatesFromListKeepLast

func RemoveDuplicatesFromListKeepLast(list []string) []string

Returns a copy of the given list with all duplicates removed (keeping the last encountereds)

func RemoveElementFromList

func RemoveElementFromList(list []string, element string) []string

Return a copy of the given list with all instances of the given element removed

func WriteFileWithSamePermissions

func WriteFileWithSamePermissions(source string, destination string, contents []byte) error

Write a file to the given destination with the given contents using the same permissions as the file at source