93 lines
3.0 KiB
Go
93 lines
3.0 KiB
Go
package configload
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/hashicorp/terraform/configs"
|
|
"github.com/hashicorp/terraform/registry"
|
|
"github.com/hashicorp/terraform/svchost/auth"
|
|
"github.com/hashicorp/terraform/svchost/disco"
|
|
"github.com/spf13/afero"
|
|
)
|
|
|
|
// A Loader instance is the main entry-point for loading configurations via
|
|
// this package.
|
|
//
|
|
// It extends the general config-loading functionality in the parent package
|
|
// "configs" to support installation of modules from remote sources and
|
|
// loading full configurations using modules that were previously installed.
|
|
type Loader struct {
|
|
// parser is used to read configuration
|
|
parser *configs.Parser
|
|
|
|
// modules is used to install and locate descendent modules that are
|
|
// referenced (directly or indirectly) from the root module.
|
|
modules moduleMgr
|
|
}
|
|
|
|
// Config is used with NewLoader to specify configuration arguments for the
|
|
// loader.
|
|
type Config struct {
|
|
// ModulesDir is a path to a directory where descendent modules are
|
|
// (or should be) installed. (This is usually the
|
|
// .terraform/modules directory, in the common case where this package
|
|
// is being loaded from the main Terraform CLI package.)
|
|
ModulesDir string
|
|
|
|
// Services is the service discovery client to use when locating remote
|
|
// module registry endpoints. If this is nil then registry sources are
|
|
// not supported, which should be true only in specialized circumstances
|
|
// such as in tests.
|
|
Services *disco.Disco
|
|
|
|
// Creds is a credentials store for communicating with remote module
|
|
// registry endpoints. If this is nil then no credentials will be used.
|
|
Creds auth.CredentialsSource
|
|
}
|
|
|
|
// NewLoader creates and returns a loader that reads configuration from the
|
|
// real OS filesystem.
|
|
//
|
|
// The loader has some internal state about the modules that are currently
|
|
// installed, which is read from disk as part of this function. If that
|
|
// manifest cannot be read then an error will be returned.
|
|
func NewLoader(config *Config) (*Loader, error) {
|
|
fs := afero.NewOsFs()
|
|
parser := configs.NewParser(fs)
|
|
reg := registry.NewClient(config.Services, config.Creds, nil)
|
|
|
|
ret := &Loader{
|
|
parser: parser,
|
|
modules: moduleMgr{
|
|
FS: afero.Afero{Fs: fs},
|
|
CanInstall: true,
|
|
Dir: config.ModulesDir,
|
|
Services: config.Services,
|
|
Creds: config.Creds,
|
|
Registry: reg,
|
|
},
|
|
}
|
|
|
|
err := ret.modules.readModuleManifestSnapshot()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to read module manifest: %s", err)
|
|
}
|
|
|
|
return ret, nil
|
|
}
|
|
|
|
// Parser returns the underlying parser for this loader.
|
|
//
|
|
// This is useful for loading other sorts of files than the module directories
|
|
// that a loader deals with, since then they will share the source code cache
|
|
// for this loader and can thus be shown as snippets in diagnostic messages.
|
|
func (l *Loader) Parser() *configs.Parser {
|
|
return l.parser
|
|
}
|
|
|
|
// Sources returns the source code cache for the underlying parser of this
|
|
// loader. This is a shorthand for l.Parser().Sources().
|
|
func (l *Loader) Sources() map[string][]byte {
|
|
return l.parser.Sources()
|
|
}
|