funcs

README

This package contains code from github.com/hashicorp/terraform/internal/lang/funcs that has been modified to use afero.Fs for filesystem access rather than using the OS packages directly.

Documentation

Index

• Variables
• func Basename(path cty.Value) (cty.Value, error)
• func Dirname(path cty.Value) (cty.Value, error)
• func File(fsys afero.Fs, baseDir string, path cty.Value) (cty.Value, error)
• func FileBase64(fsys afero.Fs, baseDir string, path cty.Value) (cty.Value, error)
• func FileExists(fsys afero.Fs, baseDir string, path cty.Value) (cty.Value, error)
• func FileSet(fsys afero.Fs, baseDir string, path, pattern cty.Value) (cty.Value, error)
• func MakeAbsPathFunc(fsys afero.Fs, baseDir string) function.Function
• func MakeFileBase64Sha256Func(fsys afero.Fs, baseDir string) function.Function
• func MakeFileBase64Sha512Func(fsys afero.Fs, baseDir string) function.Function
• func MakeFileExistsFunc(fsys afero.Fs, baseDir string) function.Function
• func MakeFileFunc(fsys afero.Fs, baseDir string, encBase64 bool) function.Function
• func MakeFileMd5Func(fsys afero.Fs, baseDir string) function.Function
• func MakeFileSetFunc(fsys afero.Fs, baseDir string) function.Function
• func MakeFileSha1Func(fsys afero.Fs, baseDir string) function.Function
• func MakeFileSha256Func(fsys afero.Fs, baseDir string) function.Function
• func MakeFileSha512Func(fsys afero.Fs, baseDir string) function.Function
• func MakePathExpandFunc(fsys afero.Fs) function.Function
• func MakeTemplateFileFunc(fsys afero.Fs, baseDir string, funcsCb func() map[string]function.Function) function.Function
• func Override(fsys afero.Fs, scope lang.Scope) map[string]function.Function
• func Pathexpand(fsys afero.Fs, path cty.Value) (cty.Value, error)

Variables

var BasenameFunc = function.New(&function.Spec{
	Params: []function.Parameter{
		{
			Name: "path",
			Type: cty.String,
		},
	},
	Type: function.StaticReturnType(cty.String),
	Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) {
		return cty.StringVal(filepath.Base(args[0].AsString())), nil
	},
})

BasenameFunc constructs a function that takes a string containing a filesystem path and removes all except the last portion from it.

var DirnameFunc = function.New(&function.Spec{
	Params: []function.Parameter{
		{
			Name: "path",
			Type: cty.String,
		},
	},
	Type: function.StaticReturnType(cty.String),
	Impl: func(args []cty.Value, retType cty.Type) (cty.Value, error) {
		return cty.StringVal(filepath.Dir(args[0].AsString())), nil
	},
})

DirnameFunc constructs a function that takes a string containing a filesystem path and removes the last portion from it.

Functions

func Basename

func Basename(path cty.Value) (cty.Value, error)

Basename takes a string containing a filesystem path and removes all except the last portion from it.

The underlying function implementation works only with the path string and does not access the filesystem itself. It is therefore unable to take into account filesystem features such as symlinks.

If the path is empty then the result is ".", representing the current working directory.

func Dirname

func Dirname(path cty.Value) (cty.Value, error)

Dirname takes a string containing a filesystem path and removes the last portion from it.

The underlying function implementation works only with the path string and does not access the filesystem itself. It is therefore unable to take into account filesystem features such as symlinks.

If the path is empty then the result is ".", representing the current working directory.

func File

func File(fsys afero.Fs, baseDir string, path cty.Value) (cty.Value, error)

File reads the contents of the file at the given path.

The file must contain valid UTF-8 bytes, or this function will return an error.

The underlying function implementation works relative to a particular base directory, so this wrapper takes a base directory string and uses it to construct the underlying function before calling it.

func FileBase64

func FileBase64(fsys afero.Fs, baseDir string, path cty.Value) (cty.Value, error)

FileBase64 reads the contents of the file at the given path.

The bytes from the file are encoded as base64 before returning.

The underlying function implementation works relative to a particular base directory, so this wrapper takes a base directory string and uses it to construct the underlying function before calling it.

func FileExists

func FileExists(fsys afero.Fs, baseDir string, path cty.Value) (cty.Value, error)

FileExists determines whether a file exists at the given path.

The underlying function implementation works relative to a particular base directory, so this wrapper takes a base directory string and uses it to construct the underlying function before calling it.

func FileSet

func FileSet(fsys afero.Fs, baseDir string, path, pattern cty.Value) (cty.Value, error)

FileSet enumerates a set of files given a glob pattern

The underlying function implementation works relative to a particular base directory, so this wrapper takes a base directory string and uses it to construct the underlying function before calling it.

func MakeAbsPathFunc

func MakeAbsPathFunc(fsys afero.Fs, baseDir string) function.Function

MakeAbsPathFunc constructs a function that converts a filesystem path to an absolute path

func MakeFileBase64Sha256Func

func MakeFileBase64Sha256Func(fsys afero.Fs, baseDir string) function.Function

MakeFileBase64Sha256Func constructs a function that is like Base64Sha256Func but reads the contents of a file rather than hashing a given literal string.

func MakeFileBase64Sha512Func

func MakeFileBase64Sha512Func(fsys afero.Fs, baseDir string) function.Function

func MakeFileExistsFunc

func MakeFileExistsFunc(fsys afero.Fs, baseDir string) function.Function

MakeFileExistsFunc constructs a function that takes a path and determines whether a file exists at that path

func MakeFileFunc

func MakeFileFunc(fsys afero.Fs, baseDir string, encBase64 bool) function.Function

MakeFileFunc constructs a function that takes a file path and returns the contents of that file, either directly as a string (where valid UTF-8 is required) or as a string containing base64 bytes.

func MakeFileMd5Func

func MakeFileMd5Func(fsys afero.Fs, baseDir string) function.Function

MakeFileMd5Func constructs a function that is like Md5Func but reads the contents of a file rather than hashing a given literal string.

func MakeFileSetFunc

func MakeFileSetFunc(fsys afero.Fs, baseDir string) function.Function

MakeFileSetFunc constructs a function that takes a glob pattern and enumerates a file set from that pattern

func MakeFileSha1Func

func MakeFileSha1Func(fsys afero.Fs, baseDir string) function.Function

MakeFileSha1Func constructs a function that is like Sha1Func but reads the contents of a file rather than hashing a given literal string.

func MakeFileSha256Func

func MakeFileSha256Func(fsys afero.Fs, baseDir string) function.Function

MakeFileSha256Func constructs a function that is like Sha256Func but reads the contents of a file rather than hashing a given literal string.

func MakeFileSha512Func

func MakeFileSha512Func(fsys afero.Fs, baseDir string) function.Function

MakeFileSha512Func constructs a function that is like Sha512Func but reads the contents of a file rather than hashing a given literal string.

func MakePathExpandFunc

func MakePathExpandFunc(fsys afero.Fs) function.Function

PathExpandFunc constructs a function that expands a leading ~ character to the current user's home directory.

func MakeTemplateFileFunc

func MakeTemplateFileFunc(fsys afero.Fs, baseDir string, funcsCb func() map[string]function.Function) function.Function

MakeTemplateFileFunc constructs a function that takes a file path and an arbitrary object of named values and attempts to render the referenced file as a template using HCL template syntax.

The template itself may recursively call other functions so a callback must be provided to get access to those functions. The template cannot, however, access any variables defined in the scope: it is restricted only to those variables provided in the second function argument, to ensure that all dependencies on other graph nodes can be seen before executing this function.

As a special exception, a referenced template file may not recursively call the templatefile function, since that would risk the same file being included into itself indefinitely.

func Override

func Override(fsys afero.Fs, scope lang.Scope) map[string]function.Function

func Pathexpand

func Pathexpand(fsys afero.Fs, path cty.Value) (cty.Value, error)

Pathexpand takes a string that might begin with a `~` segment, and if so it replaces that segment with the current user's home directory path.

The underlying function implementation works only with the path string and does not access the filesystem itself. It is therefore unable to take into account filesystem features such as symlinks.

If the leading segment in the path is not `~` then the given path is returned unmodified.