modules

type BaseCredentialSet ¶ added in v0.10.7

type BaseCredentialSet struct {
	Token string
	Host  string
}

BaseCredentialSet are the underlying credentials that CredentialsSource will use if no other credentials can be found for a given host.

type Cache ¶

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

Cache is a cache of modules that can be used to lookup modules to check if they've already been loaded.

This only works with modules that have the same identifier. It doesn't cache modules that are used multiple times with different identifiers. That is done separately by the PackageFetcher and only caches per-run of Infracost, so if you add the same module to your Terraform code it will redownload that module. We could optimize it by moving the package fetching cache logic into here, but it would be inconsistent with how terraform init works.

func NewCache(disco *Disco, logger zerolog.Logger) *Cache

type CredentialsSource ¶ added in v0.10.7

type CredentialsSource struct {
	BaseCredentialSet BaseCredentialSet
	FetchToken        FetchTokenFunc
}

CredentialsSource is an object that may be able to provide credentials for a given module source.

func NewTerraformCredentialsSource(creds BaseCredentialSet) (*CredentialsSource, error)

func (s *CredentialsSource) ForHost(host svchost.Hostname) (auth.HostCredentials, error)

func (s *CredentialsSource) ForgetForHost(host svchost.Hostname) error

func (s *CredentialsSource) StoreForHost(host svchost.Hostname, credentials auth.HostCredentialsWritable) error

type CustomGitGetter ¶ added in v0.10.32

type CustomGitGetter struct {
	*getter.GitGetter
}

CustomGitGetter extends the standard GitGetter transforming SSH sources to HTTPs first before attempting a Get. This means that we can attempt to use any Git credentials on the host machine to resolve the Get before falling back to SSH.

func (g *CustomGitGetter) Get(dst string, u *url.URL) error

type Disco ¶ added in v0.10.7

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

Disco allows discovery on given hostnames. It tries to resolve a module source based on a set of discovery rules. It caches the results by hostname to avoid repeated requests for the same information. Therefore, it is advisable to use Disco per project and pass it to all required clients.

func NewDisco(credentialsSource auth.CredentialsSource, logger zerolog.Logger) *Disco

func (d *Disco) DownloadLocation(moduleURL RegistryURL, version string) (string, error)

func (d *Disco) ModuleLocation(source string) (RegistryURL, bool, error)

type FetchTokenFunc ¶ added in v0.10.7

type FetchTokenFunc func(key string) string

FetchTokenFunc defines a function that returns a token for a given key. This can be an environment key, a header key, whatever the CredentialsSource requires.

type HostCredentials ¶ added in v0.10.7

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

func (c HostCredentials) PrepareRequest(req *http.Request)

func (c HostCredentials) Token() string

type Manifest ¶

type Manifest struct {
	Path    string            `json:"Path"`
	Version string            `json:"Version"`
	Modules []*ManifestModule `json:"Modules"`
	// contains filtered or unexported fields
}

Manifest is a struct that represents the JSON found in the manifest.json file in the .infracost dir It is used for caching the modules that have already been downloaded. It uses the same format as the .terraform/modules/modules.json file

func (m Manifest) Get(key string) ManifestModule

type ManifestModule ¶

type ManifestModule struct {
	Key         string `json:"Key"`
	Source      string `json:"Source"`
	Version     string `json:"Version,omitempty"`
	Dir         string `json:"Dir"`
	DownloadURL string
}

ManifestModule represents a single module in the manifest.json file

func (m ManifestModule) URL() string

type ModuleLoader ¶

type ModuleLoader struct {
	NewSpinner ui.SpinnerFunc
	// contains filtered or unexported fields
}

ModuleLoader handles the loading of Terraform modules. It supports local, registry and other remote modules.

The path should be the root directory of the Terraform project. We use a distinct module loader per Terraform project, because at the moment the cache is per project. The cache reads the manifest.json file from the path's .infracost/terraform_modules directory. We could implement a global cache in the future, but for now have decided to go with the same approach as Terraform.

func NewModuleLoader(cachePath string, hclParser *SharedHCLParser, credentialsSource *CredentialsSource, sourceMap config.TerraformSourceMap, logger zerolog.Logger, moduleSync *intSync.KeyMutex) *ModuleLoader

func (m *ModuleLoader) Load(path string) (man *Manifest, err error)

type PackageFetcher ¶

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

PackageFetcher downloads modules from a remote source to the given destination This supports all the non-local and non-Terraform registry sources listed here: https://www.terraform.io/language/modules/sources

func NewPackageFetcher(logger zerolog.Logger) *PackageFetcher

type RegistryLoader ¶

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

RegistryLoader is a loader that can lookup modules from a Terraform Registry and download them to the given destination

func NewRegistryLoader(packageFetcher *PackageFetcher, disco *Disco, logger zerolog.Logger) *RegistryLoader

func (r *RegistryLoader) DownloadLocation(moduleURL RegistryURL, version string) (string, error)

type RegistryLookupResult ¶

type RegistryLookupResult struct {
	OK        bool
	ModuleURL RegistryURL
	Version   string
}

RegistryLookupResult is returned when looking up the module to check if it exists in the registry and has a matching version

type RegistryURL ¶ added in v0.10.7

type RegistryURL struct {
	RawSource   string
	Host        string
	Location    string
	Credentials auth.HostCredentials
}

RegistryURL contains given URL information for a module source. This can be used to build http requests to download the module or check versions of the module.

type SharedHCLParser ¶ added in v0.10.31

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

func NewSharedHCLParser() *SharedHCLParser

func (p *SharedHCLParser) ParseHCLFile(filename string) (*hcl.File, hcl.Diagnostics)

func (p *SharedHCLParser) ParseJSONFile(filename string) (*hcl.File, hcl.Diagnostics)

type SourceMapResult ¶ added in v0.10.30

type SourceMapResult struct {
	Source   string
	Version  string
	RawQuery string
}