all: Add acceptance tests for write-only attributes #293
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package cornertesting | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/attr" | ||
| "github.com/hashicorp/terraform-plugin-framework/diag" | ||
| "github.com/hashicorp/terraform-plugin-framework/path" | ||
| "github.com/hashicorp/terraform-plugin-framework/resource" | ||
| ) | ||
|
|
||
| func PreferWriteOnlyAttribute(oldAttribute, newAttribute path.Expression) resource.ConfigValidator { | ||
| return preferWriteOnlyAttributeValidator{ | ||
| oldAttribute: oldAttribute, | ||
| newAttribute: newAttribute, | ||
| } | ||
| } | ||
|
|
||
| var _ resource.ConfigValidator = &preferWriteOnlyAttributeValidator{} | ||
|
|
||
| type preferWriteOnlyAttributeValidator struct { | ||
| oldAttribute path.Expression | ||
| newAttribute path.Expression | ||
| } | ||
|
|
||
| func (v preferWriteOnlyAttributeValidator) Description(ctx context.Context) string { | ||
| return v.MarkdownDescription(ctx) | ||
| } | ||
|
|
||
| func (v preferWriteOnlyAttributeValidator) MarkdownDescription(_ context.Context) string { | ||
| return fmt.Sprintf("If the client supports write-only attributes (Terraform v1.11+), attribute %s should be used in-place of %s", v.newAttribute, v.oldAttribute) | ||
| } | ||
|
|
||
| func (v preferWriteOnlyAttributeValidator) ValidateResource(ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse) { | ||
| // Write-only attributes are not supported in the client, so no warning should be raised. | ||
| if !req.ClientCapabilities.WriteOnlyAttributesAllowed { | ||
| return | ||
| } | ||
|
|
||
| matchedOldPaths, matchedOldPathsDiags := req.Config.PathMatches(ctx, v.oldAttribute) | ||
| resp.Diagnostics.Append(matchedOldPathsDiags...) | ||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| var diags diag.Diagnostics | ||
| for _, matchedOldPath := range matchedOldPaths { | ||
| var value attr.Value | ||
| getAttributeDiags := req.Config.GetAttribute(ctx, matchedOldPath, &value) | ||
|
|
||
| diags.Append(getAttributeDiags...) | ||
|
|
||
| // Collect all errors | ||
| if getAttributeDiags.HasError() { | ||
| continue | ||
| } | ||
|
|
||
| // Value must not be null or unknown to trigger validation error | ||
| if value.IsNull() || value.IsUnknown() { | ||
| continue | ||
| } | ||
|
|
||
| diags.AddAttributeWarning( | ||
| matchedOldPath, | ||
| "Available Write-Only Attribute Alternative", | ||
| fmt.Sprintf("The attribute %s has a WriteOnly version %s available. "+ | ||
| "Use the WriteOnly version of the attribute when possible.", matchedOldPath, v.newAttribute), | ||
| ) | ||
| } | ||
|
|
||
| resp.Diagnostics = diags | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
| package cornertesting | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" | ||
| ) | ||
|
|
||
| func RequiredOnCreate() planmodifier.String { | ||
| return requiredOnCreateModifier{} | ||
| } | ||
|
|
||
| type requiredOnCreateModifier struct{} | ||
|
|
||
| func (m requiredOnCreateModifier) Description(_ context.Context) string { | ||
| return "This attribute is required only when creating the resource." | ||
| } | ||
|
|
||
| func (m requiredOnCreateModifier) MarkdownDescription(_ context.Context) string { | ||
| return "This attribute is required only when creating the resource." | ||
| } | ||
|
|
||
| func (m requiredOnCreateModifier) PlanModifyString(ctx context.Context, req planmodifier.StringRequest, resp *planmodifier.StringResponse) { | ||
| // If there is a non-null state, we are destroying or updating so no validation is needed | ||
| if !req.State.Raw.IsNull() { | ||
| return | ||
| } | ||
|
|
||
| // We are creating, but the attribute value is not present in config, return an error. | ||
| if req.ConfigValue.IsNull() { | ||
| resp.Diagnostics.AddAttributeError( | ||
| req.Path, | ||
| "Attribute Required when Creating", | ||
| fmt.Sprintf("Must set a configuration value for the %s attribute when creating.", req.Path.String()), | ||
| ) | ||
| return | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package framework | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/path" | ||
| "github.com/hashicorp/terraform-plugin-framework/resource" | ||
| "github.com/hashicorp/terraform-plugin-framework/resource/schema" | ||
| "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" | ||
| "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" | ||
| "github.com/hashicorp/terraform-plugin-framework/types" | ||
| "github.com/hashicorp/terraform-provider-corner/internal/cornertesting" | ||
| ) | ||
|
|
||
| var _ resource.Resource = WriteOnceResource{} | ||
|
|
||
| func NewWriteOnceResource() resource.Resource { | ||
| return &WriteOnceResource{} | ||
| } | ||
|
|
||
| type WriteOnceResource struct{} | ||
|
|
||
| func (r WriteOnceResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) { | ||
| resp.TypeName = req.ProviderTypeName + "_writeonce" | ||
| } | ||
|
|
||
| func (r WriteOnceResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { | ||
| resp.Schema = schema.Schema{ | ||
| Attributes: map[string]schema.Attribute{ | ||
| "trigger_attr": schema.StringAttribute{ | ||
| Required: true, | ||
| PlanModifiers: []planmodifier.String{ | ||
| stringplanmodifier.RequiresReplace(), | ||
| }, | ||
| }, | ||
| // The only place that validation can reference prior state (which is required to determine if the planned action is | ||
| // a create, i.e, prior state is null) is during plan modification. So the plan modifier implementation is responsible | ||
| // for applying the "write-once" validation | ||
| "writeonce_string": schema.StringAttribute{ | ||
| Optional: true, | ||
| WriteOnly: true, | ||
| PlanModifiers: []planmodifier.String{ | ||
| cornertesting.RequiredOnCreate(), | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (r WriteOnceResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) { | ||
| var config WriteOnceResourceModel | ||
| resp.Diagnostics.Append(req.Config.Get(ctx, &config)...) | ||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| resp.Diagnostics.Append(assertWriteOnlyVal(ctx, req.Config, path.Root("writeonce_string"), types.StringValue("fakepassword"))...) | ||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| // Since all attributes are in configuration, we write it back directly to test that the write-only attributes | ||
| // are nulled out before sending back to TF Core. | ||
| resp.Diagnostics.Append(resp.State.Set(ctx, &config)...) | ||
| } | ||
|
|
||
| func (r WriteOnceResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) { | ||
| var data WriteOnceResourceModel | ||
|
|
||
| resp.Diagnostics.Append(req.State.Get(ctx, &data)...) | ||
|
|
||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) | ||
| } | ||
|
|
||
| func (r WriteOnceResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) { | ||
| // Once created, the only operation that can occur is replacement (delete/create) | ||
| } | ||
|
|
||
| func (r WriteOnceResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) { | ||
| } | ||
|
|
||
| type WriteOnceResourceModel struct { | ||
| TriggerAttr types.String `tfsdk:"trigger_attr"` | ||
| WriteOnlyString types.String `tfsdk:"writeonce_string"` | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: Update with released version once available