// Copyright (c) The OpenTofu Authors // SPDX-License-Identifier: MPL-2.0 // Copyright (c) 2023 HashiCorp, Inc. // SPDX-License-Identifier: MPL-2.0 package tofu import ( "context" "fmt" "log" "sync" "github.com/opentofu/opentofu/internal/addrs" "github.com/opentofu/opentofu/internal/configs/configschema" "github.com/opentofu/opentofu/internal/providers" "github.com/opentofu/opentofu/internal/provisioners" ) // contextPlugins represents a library of available plugins (providers and // provisioners) which we assume will all be used with the same // tofu.Context, and thus it'll be safe to cache certain information // about the providers for performance reasons. type contextPlugins struct { providerFactories map[addrs.Provider]providers.Factory provisionerFactories map[string]provisioners.Factory providerSchemasLock sync.Mutex providerSchemas map[addrs.Provider]providerSchemaEntry provisionerSchemasLock sync.Mutex provisionerSchemas map[string]provisionerSchemaEntry } type providerSchemaEntry func() (providers.ProviderSchema, error) type provisionerSchemaEntry func() (*configschema.Block, error) func newContextPlugins(providerFactories map[addrs.Provider]providers.Factory, provisionerFactories map[string]provisioners.Factory) *contextPlugins { return &contextPlugins{ providerFactories: providerFactories, provisionerFactories: provisionerFactories, providerSchemas: map[addrs.Provider]providerSchemaEntry{}, provisionerSchemas: map[string]provisionerSchemaEntry{}, } } func (cp *contextPlugins) HasProvider(addr addrs.Provider) bool { _, ok := cp.providerFactories[addr] return ok } func (cp *contextPlugins) NewProviderInstance(addr addrs.Provider) (providers.Interface, error) { f, ok := cp.providerFactories[addr] if !ok { return nil, fmt.Errorf("unavailable provider %q", addr.String()) } return f() } func (cp *contextPlugins) HasProvisioner(typ string) bool { _, ok := cp.provisionerFactories[typ] return ok } func (cp *contextPlugins) NewProvisionerInstance(typ string) (provisioners.Interface, error) { f, ok := cp.provisionerFactories[typ] if !ok { return nil, fmt.Errorf("unavailable provisioner %q", typ) } return f() } // ProviderSchema uses a temporary instance of the provider with the given // address to obtain the full schema for all aspects of that provider. // // ProviderSchema memoizes results by unique provider address, so it's fine // to repeatedly call this method with the same address if various different // parts of OpenTofu all need the same schema information. func (cp *contextPlugins) ProviderSchema(ctx context.Context, addr addrs.Provider) (providers.ProviderSchema, error) { // Coarse lock only for ensuring that a valid entry exists cp.providerSchemasLock.Lock() entry, ok := cp.providerSchemas[addr] if !ok { entry = sync.OnceValues(func() (providers.ProviderSchema, error) { log.Printf("[TRACE] tofu.contextPlugins: Initializing provider %q to read its schema", addr) provider, err := cp.NewProviderInstance(addr) if err != nil { return providers.ProviderSchema{}, fmt.Errorf("failed to instantiate provider %q to obtain schema: %w", addr, err) } defer provider.Close(ctx) schema := provider.GetProviderSchema(ctx) return schema, schema.Validate(addr) }) cp.providerSchemas[addr] = entry } // This lock is only for access to the map. We don't need to hold the lock when calling // "entry" because [sync.OnceValues] handles synchronization itself. // We don't defer unlock as the majority of the work of this function happens in calling "entry" // and we want to release as soon as possible for multiple concurrent callers of different providers cp.providerSchemasLock.Unlock() return entry() } // ProviderConfigSchema is a helper wrapper around ProviderSchema which first // reads the full schema of the given provider and then extracts just the // provider's configuration schema, which defines what's expected in a // "provider" block in the configuration when configuring this provider. func (cp *contextPlugins) ProviderConfigSchema(ctx context.Context, providerAddr addrs.Provider) (*configschema.Block, error) { providerSchema, err := cp.ProviderSchema(ctx, providerAddr) if err != nil { return nil, err } return providerSchema.Provider.Block, nil } // ResourceTypeSchema is a helper wrapper around ProviderSchema which first // reads the schema of the given provider and then tries to find the schema // for the resource type of the given resource mode in that provider. // // ResourceTypeSchema will return an error if the provider schema lookup // fails, but will return nil if the provider schema lookup succeeds but then // the provider doesn't have a resource of the requested type. // // Managed resource types have versioned schemas, so the second return value // is the current schema version number for the requested resource. The version // is irrelevant for other resource modes. func (cp *contextPlugins) ResourceTypeSchema(ctx context.Context, providerAddr addrs.Provider, resourceMode addrs.ResourceMode, resourceType string) (*configschema.Block, uint64, error) { providerSchema, err := cp.ProviderSchema(ctx, providerAddr) if err != nil { return nil, 0, err } schema, version := providerSchema.SchemaForResourceType(resourceMode, resourceType) return schema, version, nil } // ProvisionerSchema uses a temporary instance of the provisioner with the // given type name to obtain the schema for that provisioner's configuration. // // ProvisionerSchema memoizes results by provisioner type name, so it's fine // to repeatedly call this method with the same name if various different // parts of OpenTofu all need the same schema information. func (cp *contextPlugins) ProvisionerSchema(addr string) (*configschema.Block, error) { // Coarse lock only for ensuring that a valid entry exists cp.provisionerSchemasLock.Lock() entry, ok := cp.provisionerSchemas[addr] if !ok { entry = sync.OnceValues(func() (*configschema.Block, error) { log.Printf("[TRACE] tofu.contextPlugins: Initializing provisioner %q to read its schema", addr) provisioner, err := cp.NewProvisionerInstance(addr) if err != nil { return nil, fmt.Errorf("failed to instantiate provisioner %q to obtain schema: %w", addr, err) } defer provisioner.Close() resp := provisioner.GetSchema() if resp.Diagnostics.HasErrors() { return nil, fmt.Errorf("failed to retrieve schema from provisioner %q: %w", addr, resp.Diagnostics.Err()) } return resp.Provisioner, nil }) cp.provisionerSchemas[addr] = entry } // This lock is only for access to the map. We don't need to hold the lock when calling // "entry" because [sync.OnceValues] handles synchronization itself. // We don't defer unlock as the majority of the work of this function happens in calling "entry" // and we want to release as soon as possible for multiple concurrent callers of different provisioners cp.provisionerSchemasLock.Unlock() return entry() }