util

func AsTerraformEnvVarJSONValue ¶

func AsTerraformEnvVarJSONValue(value any) (string, error)

AsTerraformEnvVarJSONValue converts the given value to a JSON value that can be passed to OpenTofu/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 OpenTofu/Terraform via env vars, we need to NOT wrap them in quotes, so this method adds special handling for that case. For complex types (maps, lists, objects), string values containing ${...} patterns are escaped to $${...} to prevent OpenTofu/Terraform's HCL parser from treating them as variable interpolations.

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. If the path is relative, basePath must be absolute or an error is returned.

func CanonicalResolvedPath ¶ added in v1.0.3

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

CanonicalResolvedPath returns the cleaned absolute path with symlinks resolved best-effort.

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 Copy ¶

func Copy(ctx context.Context, dst io.Writer, src io.Reader) (int64, error)

Copy is a io.Copy cancellable by context.

func CopyFile ¶

func CopyFile(source string, destination string) error

CopyFile copies a file from source to destination.

func CopyFolderContents ¶

func CopyFolderContents(l log.Logger, source, destination, manifestFile string, opts ...CopyOption) 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.

Optional behavior is configured through CopyOption values such as WithIncludeInCopy, WithExcludeFromCopy, and WithFastCopy.

func CopyFolderContentsWithFilter ¶

func CopyFolderContentsWithFilter(l 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 CopyFolderToTemp ¶ added in v1.0.0

func CopyFolderToTemp(source string, tempPrefix string, filter func(path string) bool) (string, error)

CopyFolderToTemp creates a temp directory with the given prefix, copies the contents of the source folder into it using the provided filter, and returns the path to the temp directory.

func DefaultWorkingAndDownloadDirs ¶ added in v1.0.0

func DefaultWorkingAndDownloadDirs(terragruntConfigPath string) (string, string)

DefaultWorkingAndDownloadDirs gets the default working and download directories for the given Terragrunt config path.

func DirContainsTFFiles ¶

func DirContainsTFFiles(dirPath string) (bool, error)

DirContainsTFFiles checks if the given directory contains any Terraform/OpenTofu files (.tf, .tofu, .tf.json, .tofu.json)

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 EnsureCacheDir ¶ added in v1.0.4

func EnsureCacheDir() (string, error)

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

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 EnsureTempDir ¶ added in v1.0.4

func EnsureTempDir() (string, error)

EnsureTempDir returns the global terragrunt temp directory.

func EscapeInterpolationInString ¶ added in v1.0.0

func EscapeInterpolationInString(s string) string

EscapeInterpolationInString escapes HCL interpolation patterns (${...}) in a string by doubling the dollar sign (${ → $${). This is idempotent: already-escaped $${...} patterns are not double-escaped.

func ExcludeFiltersFromFile ¶

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

ExcludeFiltersFromFile returns a list of filters from the given filename, where each filter starts on a new line.

Note that this is a backwards compatibility implementation for the `--queue-excludes-file` flag, so it's going to append the ! prefix to each filter to negate it.

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 FindTFFiles ¶

func FindTFFiles(rootPath string) ([]string, error)

FindTFFiles walks through the directory and returns all OpenTofu/Terraform files (.tf, .tofu, .tf.json, .tofu.json)

func FirstNonEmpty ¶

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

FirstNonEmpty returns the first non-empty/non-zero element from the slice, or the zero value if none found.

func GenerateRandomSha256 ¶

func GenerateRandomSha256() (string, error)

func GetExitCode ¶

func GetExitCode(err error) (int, error)

GetExitCode returns the exit code of a command. If the error does not implement errorCode or is not an exec.ExitError or *errors.MultiError type, the error is returned.

func GetFiltersFromFile ¶

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

GetFiltersFromFile returns a list of filter queries from the given filename, where each filter query starts on a new line.

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 GrepFilesWithSuffix ¶ added in v1.0.3

func GrepFilesWithSuffix(fsys vfs.FS, regex *regexp.Regexp, rootDir, suffix string) (bool, error)

GrepFilesWithSuffix returns true if regex matches the contents of any file under rootDir whose name ends with suffix. The walk stops as soon as a match is found. A missing rootDir is not an error; the function returns false.

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(e vexec.Exec, ctx context.Context, command string, args ...string) bool

IsCommandExecutable returns true if the command can be run to completion without error via the given vexec.Exec.

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 ¶

func IsSymLink(path string) bool

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

func IsTFFile ¶

func IsTFFile(path string) bool

IsTFFile checks if a given file is a Terraform/OpenTofu file (.tf, .tofu, .tf.json, .tofu.json)

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 any) reflect.Kind

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

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 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, walkWithSymlinks bool) ([]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 MergeSlices ¶

func MergeSlices[S ~[]E, E cmp.Ordered](slicesToMerge ...S) S

MergeSlices combines multiple slices and removes duplicates. Note: This function sorts the result, so original order is not preserved.

func MoveFile ¶

func MoveFile(source string, destination string) error

MoveFile attempts to rename a file from source to destination, if this fails due to invalid cross-device link it falls back to copying the file contents and deleting the original file.

func MustWalkTerraformOutput ¶

func MustWalkTerraformOutput(value any, path ...string) any

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(manifestFolder string, manifestFile string) *fileManifest

func NotifyIfSlow ¶ added in v1.0.1

func NotifyIfSlow(ctx context.Context, l log.Logger, spinnerW io.Writer, timeout time.Duration, msgs SlowNotifyMsg, fn func() error) error

NotifyIfSlow runs fn and, if it takes longer than timeout, shows a spinner on spinnerW. When fn completes successfully, the spinner is replaced by an INFO log with the done message and elapsed time. When fn returns an error, the spinner is cleared but no success message is logged.

func ParseTimestamp ¶

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

func ReadFileAsString ¶

func ReadFileAsString(path string) (string, error)

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

func RegexFoundInTFFiles ¶

func RegexFoundInTFFiles(workingDir string, pattern *regexp.Regexp) (bool, error)

RegexFoundInTFFiles walks through the directory and checks if any OpenTofu/Terraform files (.tf, .tofu, .tf.json, .tofu.json) contain the given regex pattern

func RelPathForLog ¶ added in v0.99.4

func RelPathForLog(basePath, targetPath string, showAbsPath bool) string

RelPathForLog returns a relative path suitable for logging. If the path cannot be made relative, it returns the original path. Paths that don't start with ".." get a "./" prefix for clarity. If showAbsPath is true, the original targetPath is returned unchanged.

func RemoveDuplicates ¶

func RemoveDuplicates[S ~[]E, E cmp.Ordered](list S) S

RemoveDuplicates returns a new slice with duplicates removed. Note: This function sorts the result, so original order is not preserved.

func RemoveDuplicatesKeepLast ¶

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

RemoveDuplicatesKeepLast returns a new slice with duplicates removed, keeping the last occurrence. Unlike RemoveDuplicates, this preserves the relative order of elements.

func ResolvePath ¶ added in v0.99.4

func ResolvePath(path string) string

ResolvePath resolves symlinks in a path for consistent comparison across platforms. On macOS, /var is a symlink to /private/var, so paths must be resolved. Returns the original path if symlink resolution fails.

func SanitizePath ¶

func SanitizePath(baseDir string, file string) (sanitized string, err error)

SanitizePath resolves a file path within a base directory, returning the sanitized path or an error if it attempts to access anything outside the base directory.

func SkipDirIfIgnorable ¶ added in v1.0.0

func SkipDirIfIgnorable(dir string) error

SkipDirIfIgnorable checks if an entire directory should be skipped based on the fact that it's in a directory that should never have components discovered in it.

func SpinnerWriter ¶ added in v1.0.1

func SpinnerWriter() io.Writer

SpinnerWriter returns os.Stderr if it is an interactive terminal, nil otherwise. Use the returned writer as the spinnerW argument to NotifyIfSlow.

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 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 WalkDirWithSymlinks ¶

func WalkDirWithSymlinks(root string, externalWalkFn fs.WalkDirFunc) error

WalkDirWithSymlinks traverses a directory tree using filepath.WalkDir, following symbolic links and calling the provided function for each file or directory encountered. It handles both regular symlinks and circular symlinks without getting into infinite loops.

func WriteFileWithSamePermissions ¶

func WriteFileWithSamePermissions(source string, destination string, contents io.Reader) 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`.