datadir

Documentation

Index

• Constants
• func ModuleManifestFilePath(fs filesystem.Filesystem, modulePath string) (string, bool)
• func ModulePath(filePath string) (string, bool)
• func PluginLockFilePath(fs filesystem.Filesystem, modPath string) (string, bool)
• type DataDir
  • func WalkDataDirOfModule(fs filesystem.Filesystem, modPath string) *DataDir
• 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) GetModuleType() ModuleType
  • func (r *ModuleRecord) IsExternal() bool
  • func (r *ModuleRecord) IsRoot() bool
  • func (r *ModuleRecord) UnmarshalJSON(b []byte) error
• type ModuleType
• type WatchablePaths
  • func WatchableModulePaths(modPath string) *WatchablePaths

Constants

const DataDirName = ".terraform"

Functions

func ModuleManifestFilePath

func ModuleManifestFilePath(fs filesystem.Filesystem, 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 PluginLockFilePath

func PluginLockFilePath(fs filesystem.Filesystem, modPath string) (string, bool)

Types

type DataDir

type DataDir struct {
	ModuleManifestPath string
	PluginLockFilePath string
}

func WalkDataDirOfModule

func WalkDataDirOfModule(fs filesystem.Filesystem, modPath string) *DataDir

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 given for this module in configuration.
	// This is used only to detect if the source was changed in configuration
	// since the module was last installed, which means that the installer
	// must re-install it.
	SourceAddr 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) GetModuleType

func (r *ModuleRecord) GetModuleType() ModuleType

GetModuleType parses source addresses to determine what kind of source the Terraform module comes from. It currently supports detecting Terraform Registry modules, GitHub modules, Git modules, and local file paths

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 ModuleType

type ModuleType string

const (
	UNKNOWN    ModuleType = "unknown"
	TFREGISTRY ModuleType = "tfregistry"
	LOCAL      ModuleType = "local"
	GITHUB     ModuleType = "github"
	GIT        ModuleType = "git"
)

type WatchablePaths

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

func WatchableModulePaths

func WatchableModulePaths(modPath string) *WatchablePaths