upstream/terraform
1
0
Fork 0
mirror of https://github.com/hashicorp/terraform.git synced 2026-06-09 08:58:34 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Merge pull request #36269 from hashicorp/std-client-capabilities

Browse source 
refactoring: standardize client capabilities
This commit is contained in:
Daniel Schmidt 2025-01-07 10:44:02 +01:00 committed by GitHub
commit 044e4d56c9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 81 additions and 81 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
internal/grpcwrap/provider.go
View file

@ -122,6 +122,7 @@ func (p *provider) ValidateResourceTypeConfig(_ context.Context, req *tfplugin5.
TypeName: req.TypeName,
Config: configVal,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: true,
WriteOnlyAttributesAllowed: true,
},
})

15
internal/stacks/stackruntime/internal/stackeval/client_capabilities.go Normal file
View file

@ -0,0 +1,15 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1
package stackeval
import "github.com/hashicorp/terraform/internal/providers"
// ClientCapabilities returns the client capabilities sent to the providers
// for each request. They define what this terraform instance is capable of.
func ClientCapabilities() providers.ClientCapabilities {
return providers.ClientCapabilities{
DeferralAllowed: true,
WriteOnlyAttributesAllowed: true,
}
}

9
internal/stacks/stackruntime/internal/stackeval/provider_instance.go
View file

@ -256,12 +256,9 @@ func (p *ProviderInstance) CheckClient(ctx context.Context, phase EvalPhase) (pr
}
resp := client.ConfigureProvider(providers.ConfigureProviderRequest{
TerraformVersion: version.SemVer.String(),
Config: unmarkedArgs,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: true,
WriteOnlyAttributesAllowed: true,
},
TerraformVersion: version.SemVer.String(),
Config: unmarkedArgs,
ClientCapabilities: ClientCapabilities(),
})
diags = diags.Append(resp.Diagnostics)
if resp.Diagnostics.HasErrors() {

10
internal/stacks/stackruntime/internal/stackeval/provider_instance_test.go
View file

@ -383,10 +383,7 @@ func TestProviderInstanceCheckClient(t *testing.T) {
Config: cty.ObjectVal(map[string]cty.Value{
"test": cty.StringVal("yep"),
}),
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: true,
WriteOnlyAttributesAllowed: true,
},
ClientCapabilities: ClientCapabilities(),
}
if diff := cmp.Diff(want, got, ctydebug.CmpOptions); diff != "" {
t.Errorf("wrong request\n%s", diff)
@ -426,10 +423,7 @@ func TestProviderInstanceCheckClient(t *testing.T) {
Config: cty.ObjectVal(map[string]cty.Value{
"test": cty.StringVal("yep"),
}),
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: true,
WriteOnlyAttributesAllowed: true,
},
ClientCapabilities: ClientCapabilities(),
}
if diff := cmp.Diff(want, got, ctydebug.CmpOptions); diff != "" {
t.Errorf("wrong request\n%s", diff)

4
internal/terraform/eval_context.go
View file

@ -191,6 +191,10 @@ type EvalContext interface {
// perform a planned action due to an upstream dependency being deferred.
Deferrals() *deferring.Deferred
// ClientCapabilities returns the client capabilities sent to the providers
// for each request. They define what this terraform instance is capable of.
ClientCapabilities() providers.ClientCapabilities
// MoveResults returns a map describing the results of handling any
// resource instance move statements prior to the graph walk, so that
// the graph walk can then record that information appropriately in other

7
internal/terraform/eval_context_builtin.go
View file

@ -613,3 +613,10 @@ func (ctx *BuiltinEvalContext) Forget() bool {
func (ctx *BuiltinEvalContext) EphemeralResources() *ephemeral.Resources {
return ctx.EphemeralResourcesValue
}
func (ctx *BuiltinEvalContext) ClientCapabilities() providers.ClientCapabilities {
return providers.ClientCapabilities{
DeferralAllowed: ctx.Deferrals().DeferralAllowed(),
WriteOnlyAttributesAllowed: true,
}
}

7
internal/terraform/eval_context_mock.go
View file

@ -424,3 +424,10 @@ func (c *MockEvalContext) Forget() bool {
c.ForgetCalled = true
return c.ForgetValues
}
func (ctx *MockEvalContext) ClientCapabilities() providers.ClientCapabilities {
return providers.ClientCapabilities{
DeferralAllowed: ctx.Deferrals().DeferralAllowed(),
WriteOnlyAttributesAllowed: true,
}
}

83
internal/terraform/node_resource_abstract_instance.go
View file

@ -432,16 +432,13 @@ func (n *NodeAbstractResourceInstance) planDestroy(ctx EvalContext, currentState
// Allow the provider to check the destroy plan, and insert any
// necessary private data.
resp = provider.PlanResourceChange(providers.PlanResourceChangeRequest{
TypeName: n.Addr.Resource.Resource.Type,
Config: nullVal,
PriorState: unmarkedPriorVal,
ProposedNewState: nullVal,
PriorPrivate: currentState.Private,
ProviderMeta: metaConfigVal,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: deferralAllowed,
WriteOnlyAttributesAllowed: true,
},
TypeName: n.Addr.Resource.Resource.Type,
Config: nullVal,
PriorState: unmarkedPriorVal,
ProposedNewState: nullVal,
PriorPrivate: currentState.Private,
ProviderMeta: metaConfigVal,
ClientCapabilities: ctx.ClientCapabilities(),
})
deferred = resp.Deferred
@ -635,14 +632,11 @@ func (n *NodeAbstractResourceInstance) refresh(ctx EvalContext, deposedKey state
}
} else {
resp = provider.ReadResource(providers.ReadResourceRequest{
TypeName: n.Addr.Resource.Resource.Type,
PriorState: priorVal,
Private: state.Private,
ProviderMeta: metaConfigVal,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: deferralAllowed,
WriteOnlyAttributesAllowed: true,
},
TypeName: n.Addr.Resource.Resource.Type,
PriorState: priorVal,
Private: state.Private,
ProviderMeta: metaConfigVal,
ClientCapabilities: ctx.ClientCapabilities(),
})
// If we don't support deferrals, but the provider reports a deferral and does not
@ -863,11 +857,9 @@ func (n *NodeAbstractResourceInstance) plan(
unmarkedConfigVal, _ := origConfigVal.UnmarkDeep()
validateResp := provider.ValidateResourceConfig(
providers.ValidateResourceConfigRequest{
TypeName: n.Addr.Resource.Resource.Type,
Config: unmarkedConfigVal,
ClientCapabilities: providers.ClientCapabilities{
WriteOnlyAttributesAllowed: true,
},
TypeName: n.Addr.Resource.Resource.Type,
Config: unmarkedConfigVal,
ClientCapabilities: ctx.ClientCapabilities(),
},
)
diags = diags.Append(validateResp.Diagnostics.InConfigBody(config.Config, n.Addr.String()))
@ -926,16 +918,13 @@ func (n *NodeAbstractResourceInstance) plan(
}
} else {
resp = provider.PlanResourceChange(providers.PlanResourceChangeRequest{
TypeName: n.Addr.Resource.Resource.Type,
Config: unmarkedConfigVal,
PriorState: unmarkedPriorVal,
ProposedNewState: proposedNewVal,
PriorPrivate: priorPrivate,
ProviderMeta: metaConfigVal,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: deferralAllowed,
WriteOnlyAttributesAllowed: true,
},
TypeName: n.Addr.Resource.Resource.Type,
Config: unmarkedConfigVal,
PriorState: unmarkedPriorVal,
ProposedNewState: proposedNewVal,
PriorPrivate: priorPrivate,
ProviderMeta: metaConfigVal,
ClientCapabilities: ctx.ClientCapabilities(),
})
// If we don't support deferrals, but the provider reports a deferral and does not
// emit any error level diagnostics, we should emit an error.
@ -1100,16 +1089,13 @@ func (n *NodeAbstractResourceInstance) plan(
}
} else {
resp = provider.PlanResourceChange(providers.PlanResourceChangeRequest{
TypeName: n.Addr.Resource.Resource.Type,
Config: unmarkedConfigVal,
PriorState: nullPriorVal,
ProposedNewState: proposedNewVal,
PriorPrivate: plannedPrivate,
ProviderMeta: metaConfigVal,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: deferralAllowed,
WriteOnlyAttributesAllowed: true,
},
TypeName: n.Addr.Resource.Resource.Type,
Config: unmarkedConfigVal,
PriorState: nullPriorVal,
ProposedNewState: proposedNewVal,
PriorPrivate: plannedPrivate,
ProviderMeta: metaConfigVal,
ClientCapabilities: ctx.ClientCapabilities(),
})
// If we don't support deferrals, but the provider reports a deferral and does not
@ -1567,13 +1553,10 @@ func (n *NodeAbstractResourceInstance) readDataSource(ctx EvalContext, configVal
}
} else {
resp = provider.ReadDataSource(providers.ReadDataSourceRequest{
TypeName: n.Addr.ContainingResource().Resource.Type,
Config: configVal,
ProviderMeta: metaConfigVal,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: deferralAllowed,
WriteOnlyAttributesAllowed: true,
},
TypeName: n.Addr.ContainingResource().Resource.Type,
Config: configVal,
ProviderMeta: metaConfigVal,
ClientCapabilities: ctx.ClientCapabilities(),
})
// If we don't support deferrals, but the provider reports a deferral and does not

9
internal/terraform/node_resource_import.go
View file

@ -103,12 +103,9 @@ func (n *graphNodeImportState) Execute(ctx EvalContext, op walkOperation) (diags
}
resp := provider.ImportResourceState(providers.ImportResourceStateRequest{
TypeName: n.Addr.Resource.Resource.Type,
ID: n.ID,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: false,
WriteOnlyAttributesAllowed: true,
},
TypeName: n.Addr.Resource.Resource.Type,
ID: n.ID,
ClientCapabilities: ctx.ClientCapabilities(),
})
diags = diags.Append(resp.Diagnostics)
if diags.HasErrors() {

9
internal/terraform/node_resource_plan_instance.go
View file

@ -649,12 +649,9 @@ func (n *NodePlannableResourceInstance) importState(ctx EvalContext, addr addrs.
}
} else {
resp = provider.ImportResourceState(providers.ImportResourceStateRequest{
TypeName: addr.Resource.Resource.Type,
ID: importId,
ClientCapabilities: providers.ClientCapabilities{
DeferralAllowed: deferralAllowed,
WriteOnlyAttributesAllowed: true,
},
TypeName: addr.Resource.Resource.Type,
ID: importId,
ClientCapabilities: ctx.ClientCapabilities(),
})
}
// If we don't support deferrals, but the provider reports a deferral and does not

8
internal/terraform/node_resource_validate.go
View file

@ -390,11 +390,9 @@ func (n *NodeValidatableResource) validateResource(ctx EvalContext) tfdiags.Diag
// Use unmarked value for validate request
unmarkedConfigVal, _ := configVal.UnmarkDeep()
req := providers.ValidateResourceConfigRequest{
TypeName: n.Config.Type,
Config: unmarkedConfigVal,
ClientCapabilities: providers.ClientCapabilities{
WriteOnlyAttributesAllowed: true,
},
TypeName: n.Config.Type,
Config: unmarkedConfigVal,
ClientCapabilities: ctx.ClientCapabilities(),
}
resp := provider.ValidateResourceConfig(req)