datadir

Documentation

Index

• Constants
• func ModuleManifestFilePath(fs fs.StatFS, modulePath string) (string, bool)
• func ModulePath(filePath string) (string, bool)
• func ModuleUriFromDataDir(rawUri string) (string, bool)
• func ModuleUriFromModuleLockFile(rawUri string) (string, bool)
• func ModuleUriFromPluginLockFile(rawUri string) (string, bool)
• func ModuleUriFromTerraformSourcesFile(rawUri string) (string, bool)
• func PluginLockFilePath(fs fs.StatFS, modPath string) (string, bool)
• type DataDir
  • func WalkDataDirOfModule(fs fs.StatFS, modPath string) *DataDir
• type EventType
• type FS
• type ModuleManifest
  • func NewModuleManifest(rootDir string, records []ModuleRecord) *ModuleManifest
  • func ParseModuleManifestFromFile(path string) (*ModuleManifest, error)
  • func (mm *ModuleManifest) ContainsLocalModule(path string) bool
  • func (mm *ModuleManifest) Copy() *ModuleManifest
  • func (mm *ModuleManifest) RootDir() string
• type ModuleRecord
  • func (r *ModuleRecord) IsExternal() bool
  • func (r *ModuleRecord) IsRoot() bool
  • func (r *ModuleRecord) UnmarshalJSON(b []byte) error
• type PluginVersionMap
  • func ParsePluginVersions(filesystem FS, modPath string) (PluginVersionMap, error)
• type TerraformSources
  • func ParseTerraformSourcesFromFile(modulePath string) (*TerraformSources, error)
  • func (mm *TerraformSources) Copy() *TerraformSources
  • func (tfs *TerraformSources) RootDir() string
• type WatchPattern
  • func PathGlobPatternsForWatching() []WatchPattern
• type WatchablePaths
  • func WatchableModulePaths(modPath string) *WatchablePaths

Constants

const DataDirName = ".terraform"

Functions

func ModuleManifestFilePath

func ModuleManifestFilePath(fs fs.StatFS, modulePath string) (string, bool)

func ModulePath

func ModulePath(filePath string) (string, bool)

ModulePath strips known lock file paths to get the path to the (closest) module these files belong to

func ModuleUriFromDataDir

func ModuleUriFromDataDir(rawUri string) (string, bool)

func ModuleUriFromModuleLockFile

func ModuleUriFromModuleLockFile(rawUri string) (string, bool)

func ModuleUriFromPluginLockFile

func ModuleUriFromPluginLockFile(rawUri string) (string, bool)

func ModuleUriFromTerraformSourcesFile

func ModuleUriFromTerraformSourcesFile(rawUri string) (string, bool)

func PluginLockFilePath

func PluginLockFilePath(fs fs.StatFS, modPath string) (string, bool)

Types

type DataDir

type DataDir struct {
	ModuleManifestPath string
	PluginLockFilePath string
}

func WalkDataDirOfModule

func WalkDataDirOfModule(fs fs.StatFS, modPath string) *DataDir

type EventType

type EventType rune

const (
	AnyEventType    EventType = '*'
	CreateEventType EventType = 'c'
	ModifyEventType EventType = 'm'
	DeleteEventType EventType = 'd'
)

type FS

type FS interface {
	ReadFile(name string) ([]byte, error)
	ReadDir(name string) ([]fs.DirEntry, error)
}

type ModuleManifest

type ModuleManifest struct {
	Records []ModuleRecord `json:"Modules"`
	// contains filtered or unexported fields
}

func NewModuleManifest

func NewModuleManifest(rootDir string, records []ModuleRecord) *ModuleManifest

func ParseModuleManifestFromFile

func ParseModuleManifestFromFile(path string) (*ModuleManifest, error)

func (*ModuleManifest) ContainsLocalModule

func (mm *ModuleManifest) ContainsLocalModule(path string) bool

func (*ModuleManifest) Copy

func (mm *ModuleManifest) Copy() *ModuleManifest

func (*ModuleManifest) RootDir

func (mm *ModuleManifest) RootDir() string

type ModuleRecord

type ModuleRecord struct {
	// Key is a unique identifier for this particular module, based on its
	// position within the static module tree.
	Key string `json:"Key"`

	// SourceAddr is the source address for the module.
	SourceAddr tfmod.ModuleSourceAddr `json:"-"`

	// RawSourceAddr is the raw source address for the module
	// as it appears in the manifest.
	RawSourceAddr string `json:"Source"`

	// Version is the exact version of the module, which results from parsing
	// VersionStr. nil for un-versioned modules.
	Version *version.Version `json:"-"`

	// VersionStr is the version specifier string. This is used only for
	// serialization in snapshots and should not be accessed or updated
	// by any other codepaths; use "Version" instead.
	VersionStr string `json:"Version,omitempty"`

	// Dir is the path to the local directory where the module is installed.
	Dir string `json:"Dir"`
}

ModuleRecord represents some metadata about an installed module, as part of a ModuleManifest.

func (*ModuleRecord) IsExternal

func (r *ModuleRecord) IsExternal() bool

func (*ModuleRecord) IsRoot

func (r *ModuleRecord) IsRoot() bool

func (*ModuleRecord) UnmarshalJSON

func (r *ModuleRecord) UnmarshalJSON(b []byte) error

type PluginVersionMap

type PluginVersionMap map[tfaddr.Provider]*version.Version

func ParsePluginVersions

func ParsePluginVersions(filesystem FS, modPath string) (PluginVersionMap, error)

type TerraformSources

type TerraformSources struct {
	sourcebundle.Bundle
	// contains filtered or unexported fields
}

func ParseTerraformSourcesFromFile

func ParseTerraformSourcesFromFile(modulePath string) (*TerraformSources, error)

func (*TerraformSources) Copy

func (mm *TerraformSources) Copy() *TerraformSources

func (*TerraformSources) RootDir

func (tfs *TerraformSources) RootDir() string

type WatchPattern

type WatchPattern struct {
	Pattern   string
	EventType EventType
}

func PathGlobPatternsForWatching

func PathGlobPatternsForWatching() []WatchPattern

type WatchablePaths

type WatchablePaths struct {
	Dirs            []string
	ModuleManifests []string
	PluginLockFiles []string
}

func WatchableModulePaths

func WatchableModulePaths(modPath string) *WatchablePaths