Documentation
¶
Index ¶
- func CanonicalPath(path string, basePath string) (string, error)
- func CanonicalPaths(paths []string, basePath string) ([]string, error)
- func CleanPath(path string) string
- func CloneStringList(listToClone []string) []string
- func CloneStringMap(mapToClone map[string]string) map[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 FirstArg(args []string) string
- 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 IsDir(path string) bool
- func IsFile(path string) bool
- func JoinPath(elem ...string) string
- func JoinTerraformModulePath(modulesFolder string, path string) string
- func KindOf(value interface{}) reflect.Kind
- func LastArg(args []string) string
- func ListContainsElement(list []string, element string) bool
- func MatchesAny(regExps []string, s string) bool
- func Min(x, y int) int
- 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 SecondArg(args []string) string
- func WriteFileWithSamePermissions(source string, destination string, contents []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CanonicalPath ¶ added in v0.6.0
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 ¶ added in v0.6.0
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 ¶ added in v0.9.0
Use this function when cleaning paths to ensure the returned path uses / as the path separator to improve cross-platform compatibility
func CloneStringList ¶ added in v0.13.19
Make a copy of the given list of strings
func CloneStringMap ¶ added in v0.13.19
Make a copy of the given map of strings
func CommaSeparatedStrings ¶ added in v0.12.17
CommaSeparatedStrings returns an HCL compliant formatted list of strings (each string within double quote)
func CopyFolderContents ¶ added in v0.9.4
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 ¶ added in v0.6.0
Create a logger with the given prefix
func CreateLoggerWithWriter ¶ added in v0.13.3
CreateLoggerWithWriter Create a lgogger around the given output stream and prefix
func DeleteFiles ¶ added in v0.9.7
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 ¶ added in v0.9.7
Returns the base 64 encoded sha1 hash of the given string
func FirstArg ¶ added in v0.16.7
A convenience method that returns the first item (0th index) in the given list or an empty string if this is an empty list
func GetPathRelativeTo ¶ added in v0.4.0
Return the relative path you would have to take to get from basePath to path
func GetRandomTime ¶ added in v0.6.4
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 ¶
Returns true if the given regex can be found in any of the files matched by the given glob
func JoinPath ¶ added in v0.9.0
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 JoinTerraformModulePath ¶ added in v0.13.13
Join two paths together with a double-slash between them, as this is what Terraform uses to identify where a "repo" ends and a path within the repo begins. Note: The Terraform docs only mention two forward-slashes, so it's not clear if on Windows those should be two back-slashes? https://www.terraform.io/docs/modules/sources.html
func LastArg ¶ added in v0.16.14
A convenience method that returns the last item in the given list or an empty string if this is an empty list
func ListContainsElement ¶ added in v0.6.0
Return true if the given list contains the given element
func MatchesAny ¶ added in v0.17.0
func PathContainsHiddenFileOrFolder ¶ added in v0.12.22
func ReadFileAsString ¶ added in v0.4.0
Return the contents of the file at the given path as a string
func RemoveDuplicatesFromList ¶ added in v0.12.11
Returns a copy of the given list with all duplicates removed (keeping the first encountereds)
func RemoveDuplicatesFromListKeepLast ¶ added in v0.12.11
Returns a copy of the given list with all duplicates removed (keeping the last encountereds)
func RemoveElementFromList ¶ added in v0.6.0
Return a copy of the given list with all instances of the given element removed
Types ¶
This section is empty.
Source Files