util

package
v0.0.0-...-53190cb Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2024 License: MIT Imports: 29 Imported by: 0

Documentation

Overview

Package util provides utility functions for Terragrunt.

Index

Constants

View Source 
const (
	TerraformLockFile     = ".terraform.lock.hcl"
	TerragruntCacheDir    = ".terragrunt-cache"
	DefaultBoilerplateDir = ".boilerplate"
	TfFileExtension       = ".tf"
	ChecksumReadBlock     = 8192
)
View Source 
const Base62Chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
View Source 
const UniqueIDLength = 6 // Should be good for 62^6 = 56+ billion combinations

Variables

This section is empty.

Functions

func AsTerraformEnvVarJSONValue 

func AsTerraformEnvVarJSONValue(value interface{}) (string, error)

AsTerraformEnvVarJSONValue converts the given value to a JSON value that can be passed to Terraform as an environment variable. For the most part, this converts the value directly to JSON using Go's built-in json.Marshal. However, we have special handling for strings, which with normal JSON conversion would be wrapped in quotes, but when passing them to Terraform via env vars, we need to NOT wrap them in quotes, so this method adds special handling for that case.

func CanonicalPath 

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

CanonicalPath returns 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)

CanonicalPaths returns 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

CleanPath is a wrapper around filepath.Clean.

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

CloneStringList makes a copy of the given list of strings.

func CloneStringMap 

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

CloneStringMap makes 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 (because be is not a directory)

func CopyFile 

func CopyFile(source string, destination string) error

CopyFile copies a file from source to destination.

func CopyFolderContents 

func CopyFolderContents(logger log.Logger, source, destination, manifestFile string, includeInCopy []string) error

CopyFolderContents copies 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(logger log.Logger, source, destination, manifestFile string, filter func(absolutePath string) bool) error

CopyFolderContentsWithFilter copies the files and folders within the source folder into the destination folder.

func DoWithRetry 

func DoWithRetry(ctx context.Context, actionDescription string, maxRetries int, sleepBetweenRetries time.Duration, logger log.Logger, logLevel log.Level, action func(ctx context.Context) 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

EncodeBase64Sha1 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

FileExists returns true if the given file exists.

func FileNotExists 

func FileNotExists(path string) bool

FileNotExists returns true if the given file does not exist.

func FileOrData 

func FileOrData(maybePath string) (string, error)

FileOrData will read the contents of the data of the given arg if it is a file, and otherwise return the contents by itself. This will return an error if the given path is a directory.

func FileSHA256 

func FileSHA256(filePath string) ([]byte, error)

FileSHA256 calculates the SHA256 hash of the file at the given path.

func FirstArg 

func FirstArg[S ~[]E, E comparable](args S) E

FirstArg is 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 GenerateRandomSha256 

func GenerateRandomSha256() (string, error)

func GetCacheDir 

func GetCacheDir() (string, error)

GetCacheDir returns the global terragrunt cache directory for the current user.

func GetExcludeDirsFromFile 

func GetExcludeDirsFromFile(baseDir, filename string) ([]string, error)

GetExcludeDirsFromFile returns a list of directories from the given filename, where each directory path starts on a new line.

func GetExitCode 

func GetExitCode(err error) (int, error)

GetExitCode returns the exit code of a command. If the error does not implement iErrorCode or is not an exec.ExitError or *multierror.Error type, the error is returned.

func GetPathRelativeTo 

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

GetPathRelativeTo returns the relative path you would have to take to get from basePath to path.

func GetRandomTime 

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

GetRandomTime gets 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 GetTempDir 

func GetTempDir() (string, error)

GetTempDir returns the global terragrunt temp directory.

func GlobCanonicalPath 

func GlobCanonicalPath(basePath string, globPaths ...string) ([]string, error)

GlobCanonicalPath returns the canonical versions of the given glob paths, relative to the given base path.

func Grep 

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

Grep 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 IsCommandExecutable 

func IsCommandExecutable(command string, args ...string) bool

IsCommandExecutable - returns true if a command can be executed without errors.

func IsDir 

func IsDir(path string) bool

IsDir returns true if the path points to a directory.

func IsDirectoryEmpty 

func IsDirectoryEmpty(dirPath string) (bool, error)

IsDirectoryEmpty - returns true if the given path exists and is a empty directory.

func IsFile 

func IsFile(path string) bool

IsFile returns 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 

func JoinPath(elem ...string) string

JoinPath is a wrapper around filepath.Join

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

JoinTerraformModulePath joins 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 

func KindOf(value interface{}) reflect.Kind

KindOf returns the kind of the type or Invalid if value is nil.

func LastArg 

func LastArg[S ~[]E, E comparable](args S) E

LastArg is 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[S ~[]E, E comparable](list S, element any) bool

ListContainsElement returns true if the given list contains the given element

func ListContainsSublist 

func ListContainsSublist[S ~[]E, E comparable](list, sublist S) bool

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

func ListEquals 

func ListEquals[S ~[]E, E comparable](a, b S) bool

ListEquals returns true if the two lists are equal

func ListHasPrefix 

func ListHasPrefix[S ~[]E, E comparable](list, prefix S) bool

ListHasPrefix returns true if list starts with the given prefix list

func ListTfFiles 

func ListTfFiles(directoryPath string) ([]string, error)

ListTfFiles returns a list of all TF files in the specified directory.

func MatchSha256Checksum 

func MatchSha256Checksum(file, filename []byte) []byte

MatchSha256Checksum returns the SHA256 checksum for the given file and filename.

func MatchesAny 

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

func Min 

func Min(x, y int) int

func MustWalkTerraformOutput 

func MustWalkTerraformOutput(value interface{}, path ...string) interface{}

MustWalkTerraformOutput is a helper utility to deeply return a value from a terraform output. 

nil will be returned if the path is invalid

Using an example terraform output:
  a = {
    b = {
      c = "foo"
    }
    "d" = [
      1,
      2
    ]
  }

path ["a", "b", "c"] will return "foo"
path ["a", "d", "1"] will return 2
path ["a", "foo"] will return nil

func NewFileManifest 

func NewFileManifest(logger log.Logger, manifestFolder string, manifestFile string) *fileManifest

func ParseTimestamp 

func ParseTimestamp(ts string) (time.Time, error)

func PrefixedWriter 

func PrefixedWriter(writer io.Writer, prefix string) io.Writer

func ReadFileAsString 

func ReadFileAsString(path string) (string, error)

ReadFileAsString returns the contents of the file at the given path as a string.

func RemoveDuplicatesFromList 

func RemoveDuplicatesFromList[S ~[]E, E comparable](list S) S

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

func RemoveDuplicatesFromListKeepLast 

func RemoveDuplicatesFromListKeepLast[S ~[]E, E comparable](list S) S

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

func RemoveElementFromList 

func RemoveElementFromList[S ~[]E, E comparable](list S, element E) S

RemoveElementFromList returns a copy of the given list with all instances of the given element removed.

func RemoveSublistFromList 

func RemoveSublistFromList[S ~[]E, E comparable](list, sublist S) S

RemoveSublistFromList returns a copy of the given list with all instances of the given sublist removed

func SecondArg 

func SecondArg[S ~[]E, E comparable](args S) E

SecondArg is 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 SplitUrls 

func SplitUrls(s, sep string) []string

SplitUrls slices s into all substrings separated by sep and returns a slice of the substrings between those separators. Taking into account that the `=` sign can also be used as a git tag, e.g. `git@github.com/test.git?ref=feature`

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

UniqueID 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 Unwrap 

func Unwrap[V error](err error) *V

func WriteFileWithSamePermissions 

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

WriteFileWithSamePermissions writes a file to the given destination with the given contents using the same permissions as the file at source.

func WriterNotifier 

func WriterNotifier(writer io.Writer, notifyFn func(p []byte)) io.Writer

WriterNotifier fires `notifyFn` once when the first data comes at `Writer(p []byte)` and forwards data further to the specified `writer`.

Types

type CmdOutput 

type CmdOutput struct {
	Stdout string
	Stderr string
}

type FatalError 

type FatalError struct {
	Underlying error
}

FatalError is error interface for cases that should not be retried.

func (FatalError) Error 

func (err FatalError) Error() string

type KeyLocks 

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

KeyLocks manages a map of locks, each associated with a string key.

func NewKeyLocks 

func NewKeyLocks() *KeyLocks

NewKeyLocks creates a new instance of KeyLocks.

func (*KeyLocks) Lock 

func (kl *KeyLocks) Lock(key string)

Lock acquires the lock for the given key.

func (*KeyLocks) Unlock 

func (kl *KeyLocks) Unlock(key string)

Unlock releases the lock for the given key.

type Lockfile 

type Lockfile struct {
	*flock.Flock
}

func NewLockfile 

func NewLockfile(filename string) *Lockfile

func (*Lockfile) TryLock 

func (lockfile *Lockfile) TryLock() error

func (*Lockfile) Unlock 

func (lockfile *Lockfile) Unlock() error

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

type PathIsNotFile 

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

PathIsNotFile is returned when the given path is unexpectedly not a file.

func (PathIsNotFile) Error 

func (err PathIsNotFile) Error() string

type ProcessExecutionError 

type ProcessExecutionError struct {
	Err        error
	Stdout     string
	Stderr     string
	WorkingDir string
}

ProcessExecutionError - error returned when a command fails, contains StdOut and StdErr

func (ProcessExecutionError) Error 

func (err ProcessExecutionError) Error() string

func (ProcessExecutionError) ExitStatus 

func (err ProcessExecutionError) ExitStatus() (int, error)

type TrapWriter 

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

TrapWriter intercepts any messages matching `reg` received from the `writer` output, but passes all others. Used when necessary to filter logs from terraform.

func NewTrapWriter 

func NewTrapWriter(writer io.Writer, reg *regexp.Regexp) *TrapWriter

NewTrapWriter returns a new TrapWriter instance.

func (*TrapWriter) Clear 

func (trap *TrapWriter) Clear()

Clear clears all intercepted messages.

func (*TrapWriter) Msgs 

func (trap *TrapWriter) Msgs() []string

Msgs returns the intercepted messages.

func (*TrapWriter) Write 

func (trap *TrapWriter) Write(msg []byte) (int, error)

Write implements `io.Writer` interface.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.