-
Notifications
You must be signed in to change notification settings - Fork 15
framework: Add unknown value refinement acceptance tests #296
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
austinvalle
wants to merge
12
commits into
main
Choose a base branch
from
av/refinements
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,006
−27
Draft
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
fa391ed
initial ruff resource implementation
austinvalle 2fc9836
add test for working refinement roundtrip
austinvalle 215bc51
add string prefix refinement
austinvalle f03a621
Merge branch 'main' into av/refinements
austinvalle dd5ddf1
go mod
austinvalle 7e045a5
go mod
austinvalle ef8a3b9
Merge branch 'main' into av/refinements
austinvalle c11826b
update go mod
austinvalle bc82d3c
remove temp plugin-go tests
austinvalle ca749c9
add refinement producer, consumer, and invalid tests
austinvalle 966b32d
more fine grained assertions
austinvalle 71e3ac9
comment
austinvalle File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
88 changes: 88 additions & 0 deletions
88
internal/framework5provider/invalid_refinement_resource.go
This file contains hidden or 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,88 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package framework | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "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" | ||
| ) | ||
|
|
||
| var _ resource.Resource = InvalidRefinementResource{} | ||
|
|
||
| func NewInvalidRefinement() resource.Resource { | ||
| return &InvalidRefinementResource{} | ||
| } | ||
|
|
||
| type InvalidRefinementResource struct{} | ||
|
|
||
| func (r InvalidRefinementResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) { | ||
| resp.TypeName = req.ProviderTypeName + "_invalid_refinement" | ||
| } | ||
|
|
||
| func (r InvalidRefinementResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { | ||
| resp.Schema = schema.Schema{ | ||
| Attributes: map[string]schema.Attribute{ | ||
| "string_with_prefix": schema.StringAttribute{ | ||
| Computed: true, | ||
| PlanModifiers: []planmodifier.String{ | ||
| stringplanmodifier.WillHavePrefix("prefix://"), | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (r InvalidRefinementResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) { | ||
| var data InvalidRefinementResourceModel | ||
|
|
||
| resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...) | ||
|
|
||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| data.StringWithPrefix = types.StringValue("not correct") | ||
|
|
||
| resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) | ||
| } | ||
|
|
||
| func (r InvalidRefinementResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) { | ||
| var data InvalidRefinementResourceModel | ||
|
|
||
| resp.Diagnostics.Append(req.State.Get(ctx, &data)...) | ||
|
|
||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| data.StringWithPrefix = types.StringValue("not correct") | ||
|
|
||
| resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) | ||
| } | ||
|
|
||
| func (r InvalidRefinementResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) { | ||
| var data InvalidRefinementResourceModel | ||
|
|
||
| resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...) | ||
|
|
||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| data.StringWithPrefix = types.StringValue("not correct") | ||
|
|
||
| resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) | ||
| } | ||
|
|
||
| func (r InvalidRefinementResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) { | ||
| } | ||
|
|
||
| type InvalidRefinementResourceModel struct { | ||
| StringWithPrefix types.String `tfsdk:"string_with_prefix"` | ||
| } |
48 changes: 48 additions & 0 deletions
48
internal/framework5provider/invalid_refinement_resource_test.go
This file contains hidden or 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,48 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package framework | ||
|
|
||
| import ( | ||
| "regexp" | ||
| "testing" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/providerserver" | ||
| "github.com/hashicorp/terraform-plugin-go/tfprotov5" | ||
| "github.com/hashicorp/terraform-plugin-testing/helper/resource" | ||
| "github.com/hashicorp/terraform-plugin-testing/plancheck" | ||
| "github.com/hashicorp/terraform-plugin-testing/tfjsonpath" | ||
| "github.com/hashicorp/terraform-plugin-testing/tfversion" | ||
| ) | ||
|
|
||
| // This resource tests Terraform's data consistency rules for refinements. It has an invalid | ||
| // promise (string must have prefix of "prefix://") in the plan, which will fail during apply. | ||
| func TestInvalidRefinementResource(t *testing.T) { | ||
| resource.UnitTest(t, resource.TestCase{ | ||
| TerraformVersionChecks: []tfversion.TerraformVersionCheck{ | ||
| // Unknown value refinements were introduced to Terraform v1.6.0 via go-cty | ||
| tfversion.SkipBelow(tfversion.Version1_6_0), | ||
| }, | ||
| ProtoV5ProviderFactories: map[string]func() (tfprotov5.ProviderServer, error){ | ||
| "framework": providerserver.NewProtocol5WithError(New()), | ||
| }, | ||
| Steps: []resource.TestStep{ | ||
| { | ||
| Config: ` | ||
| resource "framework_invalid_refinement" "test" {} | ||
|
|
||
| resource "terraform_data" "test_out" { | ||
| count = startswith(framework_invalid_refinement.test.string_with_prefix, "prefix://") ? 1 : 0 | ||
| } | ||
| `, | ||
| ConfigPlanChecks: resource.ConfigPlanChecks{ | ||
| PreApply: []plancheck.PlanCheck{ | ||
| plancheck.ExpectUnknownValue("framework_invalid_refinement.test", tfjsonpath.New("string_with_prefix")), | ||
| plancheck.ExpectResourceAction("terraform_data.test_out[0]", plancheck.ResourceActionCreate), | ||
| }, | ||
| }, | ||
| ExpectError: regexp.MustCompile(`Error: Provider produced inconsistent result after apply`), | ||
| }, | ||
| }, | ||
| }) | ||
| } |
This file contains hidden or 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
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 versions