mirror of https://github.com/hashicorp/terraform
Implement the core nodes for ephemeral resources. This constitutes what's needed for execution, but does not yet include all the necessary graph transformations.pull/35764/head
James Bardin
2 years ago
parent
dfdf27c7bc
commit
0d3530c815
@ -0,0 +1,205 @@
|
||||
// Copyright (c) HashiCorp, Inc.
|
||||
// SPDX-License-Identifier: BUSL-1.1
|
||||
|
||||
package terraform
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log"
|
||||
|
||||
"github.com/zclconf/go-cty/cty"
|
||||
|
||||
"github.com/hashicorp/terraform/internal/addrs"
|
||||
"github.com/hashicorp/terraform/internal/configs"
|
||||
"github.com/hashicorp/terraform/internal/lang/marks"
|
||||
"github.com/hashicorp/terraform/internal/plans/objchange"
|
||||
"github.com/hashicorp/terraform/internal/providers"
|
||||
"github.com/hashicorp/terraform/internal/resources/ephemeral"
|
||||
"github.com/hashicorp/terraform/internal/tfdiags"
|
||||
)
|
||||
|
||||
type ephemeralResourceInput struct {
|
||||
addr addrs.AbsResourceInstance
|
||||
config *configs.Resource
|
||||
providerConfig addrs.AbsProviderConfig
|
||||
}
|
||||
|
||||
// ephemeralResourceOpen implements the "open" step of the ephemeral resource
|
||||
// instance lifecycle, which behaves the same way in both the plan and apply
|
||||
// walks.
|
||||
func ephemeralResourceOpen(ctx EvalContext, inp ephemeralResourceInput) tfdiags.Diagnostics {
|
||||
log.Printf("[TRACE] ephemeralResourceOpen: opening %s", inp.addr)
|
||||
var diags tfdiags.Diagnostics
|
||||
|
||||
provider, providerSchema, err := getProvider(ctx, inp.providerConfig)
|
||||
if err != nil {
|
||||
diags = diags.Append(err)
|
||||
return diags
|
||||
}
|
||||
|
||||
config := inp.config
|
||||
schema, _ := providerSchema.SchemaForResourceAddr(inp.addr.ContainingResource().Resource)
|
||||
if schema == nil {
|
||||
// Should be caught during validation, so we don't bother with a pretty error here
|
||||
diags = diags.Append(
|
||||
fmt.Errorf("provider %q does not support ephemeral resource %q",
|
||||
inp.providerConfig, inp.addr.ContainingResource().Resource.Type,
|
||||
),
|
||||
)
|
||||
return diags
|
||||
}
|
||||
|
||||
resources := ctx.EphemeralResources()
|
||||
allInsts := ctx.InstanceExpander()
|
||||
keyData := allInsts.GetResourceInstanceRepetitionData(inp.addr)
|
||||
|
||||
checkDiags := evalCheckRules(
|
||||
addrs.ResourcePrecondition,
|
||||
config.Preconditions,
|
||||
ctx, inp.addr, keyData,
|
||||
tfdiags.Error,
|
||||
)
|
||||
diags = diags.Append(checkDiags)
|
||||
if diags.HasErrors() {
|
||||
return diags // failed preconditions prevent further evaluation
|
||||
}
|
||||
|
||||
configVal, _, configDiags := ctx.EvaluateBlock(config.Config, schema, nil, keyData)
|
||||
diags = diags.Append(configDiags)
|
||||
if diags.HasErrors() {
|
||||
return diags
|
||||
}
|
||||
unmarkedConfigVal, configMarks := configVal.UnmarkDeepWithPaths()
|
||||
|
||||
diags = diags.Append(provider.ValidateEphemeralResourceConfig(providers.ValidateEphemeralResourceConfigRequest{
|
||||
TypeName: inp.addr.Resource.Resource.Type,
|
||||
Config: unmarkedConfigVal,
|
||||
}))
|
||||
|
||||
if diags.HasErrors() {
|
||||
return diags
|
||||
}
|
||||
|
||||
resp := provider.OpenEphemeralResource(providers.OpenEphemeralResourceRequest{
|
||||
TypeName: inp.addr.ContainingResource().Resource.Type,
|
||||
Config: unmarkedConfigVal,
|
||||
})
|
||||
if resp.Deferred != nil {
|
||||
// FIXME: Actually implement this.
|
||||
diags = diags.Append(fmt.Errorf("we don't support deferral of ephemeral resource instances yet"))
|
||||
}
|
||||
diags = diags.Append(resp.Diagnostics.InConfigBody(config.Config, inp.addr.String()))
|
||||
if diags.HasErrors() {
|
||||
return diags
|
||||
}
|
||||
resultVal := resp.Result.MarkWithPaths(configMarks)
|
||||
|
||||
errs := objchange.AssertPlanValid(schema, cty.NullVal(schema.ImpliedType()), configVal, resultVal)
|
||||
for _, err := range errs {
|
||||
diags = diags.Append(tfdiags.AttributeValue(
|
||||
tfdiags.Error,
|
||||
"Provider produced invalid ephemeral resource instance",
|
||||
fmt.Sprintf(
|
||||
"The provider for %s produced an inconsistent result: %s.",
|
||||
inp.addr.Resource.Resource.Type,
|
||||
tfdiags.FormatError(err),
|
||||
),
|
||||
nil,
|
||||
)).InConfigBody(config.Config, inp.addr.String())
|
||||
}
|
||||
if diags.HasErrors() {
|
||||
return diags
|
||||
}
|
||||
|
||||
// We are going to wholesale mark the entire resource as ephemeral. This
|
||||
// simplifies the model as any references to ephemeral resources can be
|
||||
// considered as such. Any input values that don't need to be ephemeral can
|
||||
// be referenced directly.
|
||||
resultVal = resultVal.Mark(marks.Ephemeral)
|
||||
|
||||
impl := &ephemeralResourceInstImpl{
|
||||
addr: inp.addr,
|
||||
provider: provider,
|
||||
internal: resp.InternalContext,
|
||||
}
|
||||
// TODO: What can we use as a signal to cancel the context we're passing in
|
||||
// here, so that the object will stop renewing things when we start shutting
|
||||
// down?
|
||||
// TODO: The context Stopped channel should probably be updated
|
||||
// finally to a Context
|
||||
resources.RegisterInstance(context.TODO(), inp.addr, ephemeral.ResourceInstanceRegistration{
|
||||
Value: resultVal,
|
||||
ConfigBody: config.Config,
|
||||
Impl: impl,
|
||||
FirstRenewal: resp.Renew,
|
||||
})
|
||||
|
||||
return diags
|
||||
}
|
||||
|
||||
// nodeEphemeralResourceClose is the node type for closing the previously-opened
|
||||
// instances of a particular ephemeral resource.
|
||||
//
|
||||
// Although ephemeral resource instances will always all get closed once a
|
||||
// graph walk has completed anyway, the inclusion of explicit nodes for this
|
||||
// allows closing ephemeral resource instances more promptly after all work
|
||||
// that uses them has been completed, rather than always just waiting until
|
||||
// the end of the graph walk.
|
||||
//
|
||||
// This is scoped to config-level resources rather than dynamic resource
|
||||
// instances as a concession to allow using the same node type in both the plan
|
||||
// and apply graphs, where the former only deals in whole resources while the
|
||||
// latter contains individual instances.
|
||||
type nodeEphemeralResourceClose struct {
|
||||
addr addrs.ConfigResource
|
||||
}
|
||||
|
||||
var _ GraphNodeExecutable = (*nodeEphemeralResourceClose)(nil)
|
||||
var _ GraphNodeModulePath = (*nodeEphemeralResourceClose)(nil)
|
||||
|
||||
func (n *nodeEphemeralResourceClose) Name() string {
|
||||
return n.addr.String() + " (close)"
|
||||
}
|
||||
|
||||
// ModulePath implements GraphNodeModulePath.
|
||||
func (n *nodeEphemeralResourceClose) ModulePath() addrs.Module {
|
||||
return n.addr.Module
|
||||
}
|
||||
|
||||
// Execute implements GraphNodeExecutable.
|
||||
func (n *nodeEphemeralResourceClose) Execute(ctx EvalContext, op walkOperation) tfdiags.Diagnostics {
|
||||
log.Printf("[TRACE] nodeEphemeralResourceClose: closing all instances of %s", n.addr)
|
||||
resources := ctx.EphemeralResources()
|
||||
return resources.CloseInstances(context.TODO(), n.addr)
|
||||
}
|
||||
|
||||
// ephemeralResourceInstImpl implements ephemeral.ResourceInstance as an
|
||||
// adapter to the relevant provider API calls.
|
||||
type ephemeralResourceInstImpl struct {
|
||||
addr addrs.AbsResourceInstance
|
||||
provider providers.Interface
|
||||
internal []byte
|
||||
}
|
||||
|
||||
var _ ephemeral.ResourceInstance = (*ephemeralResourceInstImpl)(nil)
|
||||
|
||||
// Close implements ephemeral.ResourceInstance.
|
||||
func (impl *ephemeralResourceInstImpl) Close(ctx context.Context) tfdiags.Diagnostics {
|
||||
log.Printf("[TRACE] ephemeralResourceInstImpl: closing %s", impl.addr)
|
||||
resp := impl.provider.CloseEphemeralResource(providers.CloseEphemeralResourceRequest{
|
||||
TypeName: impl.addr.Resource.Resource.Type,
|
||||
InternalContext: impl.internal,
|
||||
})
|
||||
return resp.Diagnostics
|
||||
}
|
||||
|
||||
// Renew implements ephemeral.ResourceInstance.
|
||||
func (impl *ephemeralResourceInstImpl) Renew(ctx context.Context, req providers.EphemeralRenew) (nextRenew *providers.EphemeralRenew, diags tfdiags.Diagnostics) {
|
||||
log.Printf("[TRACE] ephemeralResourceInstImpl: renewing %s", impl.addr)
|
||||
resp := impl.provider.RenewEphemeralResource(providers.RenewEphemeralResourceRequest{
|
||||
TypeName: impl.addr.Resource.Resource.Type,
|
||||
InternalContext: req.InternalContext,
|
||||
})
|
||||
return resp.RenewAgain, resp.Diagnostics
|
||||
}
|
||||
Loading…
Reference in new issue