util

Documentation

Index

• Constants
• Variables
• 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 ContainsPath(path, subpath string) bool
• func CopyFile(source string, destination string) error
• func CopyFolderContents(source, destination, manifestFile string) error
• func CopyFolderContentsWithFilter(source, destination, manifestFile string, filter func(path string) bool) error
• func CreateLogEntry(prefix string, level logrus.Level) *logrus.Entry
• func CreateLogEntryWithWriter(writer io.Writer, prefix string, level logrus.Level) *logrus.Entry
• func CreateLogger(lvl logrus.Level) *logrus.Logger
• func DoWithRetry(actionDescription string, maxRetries int, sleepBetweenRetries time.Duration, ...) error
• func EncodeBase64Sha1(str string) string
• func EnsureDirectory(path string) error
• func FileExists(path string) bool
• func FileNotExists(path string) bool
• func FirstArg(args []string) string
• func GetDiagnosticsWriter(parser *hclparse.Parser) hcl.DiagnosticWriter
• 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 HasPathPrefix(path, prefix string) bool
• func IsDir(path string) bool
• func IsFile(path string) bool
• func IsSymLink(path string) bool
• func JoinPath(elem ...string) string
• func JoinTerraformModulePath(modulesFolder string, path string) string
• func KeyValuePairStringListToMap(asList []string) (map[string]string, error)
• func KindOf(value interface{}) reflect.Kind
• func LastArg(args []string) string
• func ListContainsElement(list []string, element string) bool
• func ListContainsSublist(list, sublist []string) bool
• func ListEquals(a, b []string) bool
• func ListHasPrefix(list, prefix []string) bool
• func MatchesAny(regExps []string, s string) bool
• func Min(x, y int) int
• 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 SplitPath(path string) []string
• func StringListInsert(list []string, element string, index int) []string
• func TerragruntExcludes(path string) bool
• func UniqueId() string
• func WriteFileWithSamePermissions(source string, destination string, contents []byte) error
• type InvalidKeyValue
  • func (err InvalidKeyValue) Error() string
• type MaxRetriesExceeded
  • func (err MaxRetriesExceeded) Error() string
• type PathIsNotDirectory
  • func (err PathIsNotDirectory) Error() string

Constants

const BASE_62_CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

const DEFAULT_LOG_LEVEL = logrus.InfoLevel

const TerraformLockFile = ".terraform.lock.hcl"

const UNIQUE_ID_LENGTH = 6 // Should be good for 62^6 = 56+ billion combinations

Variables

var GlobalFallbackLogEntry *logrus.Entry

GlobalFallbackLogEntry is a global fallback logentry for the application Should be used in cases when more specific logger can't be created (like in the very beginning, when we have not yet parsed command line arguments).

This might go away once we migrate toproper cli library (see https://github.com/gruntwork-io/terragrunt/blob/master/cli/args.go#L29)

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 CloneStringList

func CloneStringList(listToClone []string) []string

Make a copy of the given list of strings

func CloneStringMap

func CloneStringMap(mapToClone map[string]string) map[string]string

Make a copy of the given map of strings

func CommaSeparatedStrings

func CommaSeparatedStrings(list []string) string

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

func ContainsPath

func ContainsPath(path, subpath string) bool

ContainsPath returns true if path contains the given subpath E.g. path="foo/bar/bee", subpath="bar/bee" -> true E.g. path="foo/bar/bee", subpath="bar/be" -> false (becuase be is not a directory)

func CopyFile

func CopyFile(source string, destination string) error

Copy a file from source to destination

func CopyFolderContents

func CopyFolderContents(source, destination, manifestFile 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. Will create a specified manifest file that contains paths of all copied files.

func CopyFolderContentsWithFilter

func CopyFolderContentsWithFilter(source, destination, manifestFile string, filter func(path string) bool) error

Copy the files and folders within the source folder into the destination folder. Pass each file and folder through the given filter function and only copy it if the filter returns true. Will create a specified manifest file that contains paths of all copied files.

func CreateLogEntry

func CreateLogEntry(prefix string, level logrus.Level) *logrus.Entry

CreateLogEntry creates a logger entry with the given prefix field

func CreateLogEntryWithWriter

func CreateLogEntryWithWriter(writer io.Writer, prefix string, level logrus.Level) *logrus.Entry

CreateLoggerWithWriter Create a logger around the given output stream and prefix

func CreateLogger

func CreateLogger(lvl logrus.Level) *logrus.Logger

CreateLogger creates a logger. If debug is set, we use ErrorLevel to enable verbose output, otherwise - only errors are shown

func DoWithRetry

func DoWithRetry(actionDescription string, maxRetries int, sleepBetweenRetries time.Duration, logger *logrus.Entry, logLevel logrus.Level, action func() error) error

DoWithRetry runs the specified action. If it returns a value, return that value. If it returns an error, sleep for sleepBetweenRetries and try again, up to a maximum of maxRetries retries. If maxRetries is exceeded, return a MaxRetriesExceeded error.

func EncodeBase64Sha1

func EncodeBase64Sha1(str string) string

Returns the base 64 encoded sha1 hash of the given string

func EnsureDirectory

func EnsureDirectory(path string) error

EnsureDirectory creates a directory at this path if it does not exist, or error if the path exists and is a file.

func FileExists

func FileExists(path string) bool

Return true if the given file exists

func FileNotExists

func FileNotExists(path string) bool

Return true if the given file does not exist

func FirstArg

func FirstArg(args []string) string

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 GetDiagnosticsWriter

func GetDiagnosticsWriter(parser *hclparse.Parser) hcl.DiagnosticWriter

GetDiagnosticsWriter returns a hcl2 parsing diagnostics emitter for the current terminal.

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 HasPathPrefix

func HasPathPrefix(path, prefix string) bool

HasPathPrefix returns true if path starts with the given path prefix E.g. path="/foo/bar/biz", prefix="/foo/bar" -> true E.g. path="/foo/bar/biz", prefix="/foo/ba" -> false (because ba is not a directory path)

func IsDir

func IsDir(path string) bool

Return true if the path points to a directory

func IsFile

func IsFile(path string) bool

Return true if the path points to a file

func IsSymLink

func IsSymLink(path string) bool

IsSymLink returns true if the given file is a symbolic link Per https://stackoverflow.com/a/18062079/2308858

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 JoinTerraformModulePath

func JoinTerraformModulePath(modulesFolder string, path string) string

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 KeyValuePairStringListToMap

func KeyValuePairStringListToMap(asList []string) (map[string]string, error)

KeyValuePairListToMap converts a list of key value pair encoded as `key=value` strings into a map.

func KindOf

func KindOf(value interface{}) reflect.Kind

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

func LastArg

func LastArg(args []string) string

A convenience method that returns the last item in the given list or an empty string if this is an empty list

func ListContainsElement

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

Return true if the given list contains the given element

func ListContainsSublist

func ListContainsSublist(list, sublist []string) bool

ListContainsSublist returns true if an instance of the sublist can be found in the given list

func ListEquals

func ListEquals(a, b []string) bool

ListEquals returns true if the two lists are equal

func ListHasPrefix

func ListHasPrefix(list, prefix []string) bool

ListHasPrefix returns true if list starts with the given prefix list

func MatchesAny

func MatchesAny(regExps []string, s string) bool

func Min

func Min(x, y int) int

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 SecondArg

func SecondArg(args []string) string

A convenience method that returns the second item (1st index) in the given list or an empty string if this is a list that has less than 2 items in it

func SplitPath

func SplitPath(path string) []string

SplitPath splits the given path into a list. E.g. "foo/bar/boo.txt" -> ["foo", "bar", "boo.txt"] E.g. "/foo/bar/boo.txt" -> ["", "foo", "bar", "boo.txt"] Notice that if path is absolute the resulting list will begin with an empty string.

func StringListInsert

func StringListInsert(list []string, element string, index int) []string

StringListInsert will insert the given string in to the provided string list at the specified index and return the new list of strings. To insert the element, we append the item to the tail of the string and then prepend the existing items.

func TerragruntExcludes

func TerragruntExcludes(path string) bool

func UniqueId

func UniqueId() string

Returns a unique (ish) id we can use to name resources so they don't conflict with each other. Uses base 62 to generate a 6 character string that's unlikely to collide with the handful of tests we run in parallel. Based on code here: http://stackoverflow.com/a/9543797/483528

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

Types

type InvalidKeyValue

type InvalidKeyValue string

func (InvalidKeyValue) Error

func (err InvalidKeyValue) Error() string

type MaxRetriesExceeded

type MaxRetriesExceeded struct {
	Description string
	MaxRetries  int
}

MaxRetriesExceeded is an error that occurs when the maximum amount of retries is exceeded.

func (MaxRetriesExceeded) Error

func (err MaxRetriesExceeded) Error() string

type PathIsNotDirectory

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

PathIsNotDirectory is returned when the given path is unexpectedly not a directory.

func (PathIsNotDirectory) Error

func (err PathIsNotDirectory) Error() string