util

package
v0.23.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 28, 2020 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source
const BASE_62_CHARS = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
View Source
const UNIQUE_ID_LENGTH = 6 // Should be good for 62^6 = 56+ billion combinations

Variables

This section is empty.

Functions

func CanonicalPath added in v0.6.0

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 added in v0.6.0

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 added in v0.9.0

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 added in v0.13.19

func CloneStringList(listToClone []string) []string

Make a copy of the given list of strings

func CloneStringMap added in v0.13.19

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

Make a copy of the given map of strings

func ColorLogf added in v0.19.23

func ColorLogf(logger *log.Logger, colorCode *color.Color, fmtString string, fmtArgs ...interface{})

ColorLogf

func CommaSeparatedStrings added in v0.12.17

func CommaSeparatedStrings(list []string) string

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

func CopyFile added in v0.9.4

func CopyFile(source string, destination string) error

Copy a file from source to destination

func CopyFolderContents added in v0.9.4

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 added in v0.19.0

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 CreateLogger added in v0.6.0

func CreateLogger(prefix string) *log.Logger

Create a logger with the given prefix

func CreateLoggerWithWriter added in v0.13.3

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

CreateLoggerWithWriter Create a logger around the given output stream and prefix

func Debugf added in v0.19.14

func Debugf(logger *log.Logger, fmtString string, fmtArgs ...interface{})

MAINTAINER'S NOTE: This is a temporary solution for logging levels in terragrunt. This is not a permanent debug logging solution. Debugf will only print out terragrunt logs if the TG_LOG environment variable is set to DEBUG.

func DoWithRetry added in v0.19.0

func DoWithRetry(actionDescription string, maxRetries int, sleepBetweenRetries time.Duration, logger *log.Logger, 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 added in v0.9.7

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 FileNotExists added in v0.21.6

func FileNotExists(path string) bool

Return true if the given file does not exist

func FirstArg added in v0.16.7

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 added in v0.19.14

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

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

func GetPathRelativeTo added in v0.4.0

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 added in v0.6.4

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 IsDir added in v0.13.5

func IsDir(path string) bool

Return true if the path points to a directory

func IsFile added in v0.16.13

func IsFile(path string) bool

Return true if the path points to a file

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 added in v0.9.0

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 added in v0.13.13

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 KindOf added in v0.12.9

func KindOf(value interface{}) reflect.Kind

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

func LastArg added in v0.16.14

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 added in v0.6.0

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

Return true if the given list contains the given element

func MatchesAny added in v0.17.0

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

func Min added in v0.14.1

func Min(x, y int) int

func PathContainsHiddenFileOrFolder added in v0.12.22

func PathContainsHiddenFileOrFolder(path string) bool

func ReadFileAsString added in v0.4.0

func ReadFileAsString(path string) (string, error)

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

func RemoveDuplicatesFromList added in v0.12.11

func RemoveDuplicatesFromList(list []string) []string

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

func RemoveDuplicatesFromListKeepLast added in v0.12.11

func RemoveDuplicatesFromListKeepLast(list []string) []string

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

func RemoveElementFromList added in v0.6.0

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

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

func SecondArg added in v0.16.7

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 UniqueId added in v0.19.0

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 added in v0.9.4

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 MaxRetriesExceeded added in v0.19.0

type MaxRetriesExceeded struct {
	Description string
	MaxRetries  int
}

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

func (MaxRetriesExceeded) Error added in v0.19.0

func (err MaxRetriesExceeded) Error() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL