listresourcevalidator: add new package with common validators for list resource configurations #298
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package listresourcevalidator | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/list" | ||
| ) | ||
|
|
||
| // All returns a validator which ensures that any configured attribute value | ||
| // validates against all the given validators. | ||
| // | ||
| // Use of All is only necessary when used in conjunction with Any or AnyWithAllWarnings | ||
| // as the Validators field automatically applies a logical AND. | ||
| func All(validators ...list.ConfigValidator) list.ConfigValidator { | ||
| return allValidator{ | ||
| validators: validators, | ||
| } | ||
| } | ||
|
|
||
| var _ list.ConfigValidator = allValidator{} | ||
|
|
||
| // allValidator implements the validator. | ||
| type allValidator struct { | ||
| validators []list.ConfigValidator | ||
| } | ||
|
|
||
| // Description describes the validation in plain text formatting. | ||
| func (v allValidator) Description(ctx context.Context) string { | ||
| var descriptions []string | ||
|
|
||
| for _, subValidator := range v.validators { | ||
| descriptions = append(descriptions, subValidator.Description(ctx)) | ||
| } | ||
|
|
||
| return fmt.Sprintf("Value must satisfy all of the validations: %s", strings.Join(descriptions, " + ")) | ||
| } | ||
|
|
||
| // MarkdownDescription describes the validation in Markdown formatting. | ||
| func (v allValidator) MarkdownDescription(ctx context.Context) string { | ||
| return v.Description(ctx) | ||
| } | ||
|
|
||
| // ValidateListResourceConfig performs the validation. | ||
| func (v allValidator) ValidateListResourceConfig(ctx context.Context, req list.ValidateConfigRequest, resp *list.ValidateConfigResponse) { | ||
| for _, subValidator := range v.validators { | ||
| validateResp := &list.ValidateConfigResponse{} | ||
|
|
||
| subValidator.ValidateListResourceConfig(ctx, req, validateResp) | ||
|
|
||
| resp.Diagnostics.Append(validateResp.Diagnostics...) | ||
| } | ||
| } |
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,20 @@ | ||
| // Copyright (c) HashiCorp, Inc. | ||
| // SPDX-License-Identifier: MPL-2.0 | ||
|
|
||
| package listresourcevalidator_test | ||
|
|
||
| import ( | ||
| "github.com/hashicorp/terraform-plugin-framework-validators/listresourcevalidator" | ||
| "github.com/hashicorp/terraform-plugin-framework/list" | ||
| ) | ||
|
|
||
| func ExampleAll() { | ||
| // Used inside a list.ListResource type ConfigValidators method | ||
| _ = []list.ConfigValidator{ | ||
| // The configuration must satisfy either All validator. | ||
| listresourcevalidator.Any( | ||
| listresourcevalidator.All( /* ... */ ), | ||
| listresourcevalidator.All( /* ... */ ), | ||
| ), | ||
| } | ||
| } |
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.
Performed some alphabetical reordering in several files similar to this..