chore: Creates TF models & interfaces for mongodbatlas_encryption_at_rest_private_endpoints plural data source
#2502
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
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,56 @@ | ||
| //nolint:gocritic | ||
| package encryptionatrestprivateendpoint | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/datasource" | ||
|
|
||
| "github.com/mongodb/terraform-provider-mongodbatlas/internal/config" | ||
| ) | ||
|
|
||
| var _ datasource.DataSource = &encryptionAtRestPrivateEndpointsDS{} | ||
| var _ datasource.DataSourceWithConfigure = &encryptionAtRestPrivateEndpointsDS{} | ||
|
|
||
| func PluralDataSource() datasource.DataSource { | ||
| return &encryptionAtRestPrivateEndpointsDS{ | ||
| DSCommon: config.DSCommon{ | ||
| DataSourceName: fmt.Sprintf("%ss", encryptionAtRestPrivateEndpointName), | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| type encryptionAtRestPrivateEndpointsDS struct { | ||
| config.DSCommon | ||
| } | ||
|
|
||
| func (d *encryptionAtRestPrivateEndpointsDS) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) { | ||
| resp.Schema = PluralDataSourceSchema(ctx) | ||
| } | ||
|
|
||
| func (d *encryptionAtRestPrivateEndpointsDS) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) { | ||
| var encryptionAtRestPrivateEndpointsConfig TFEncryptionAtRestPrivateEndpointsDSModel | ||
| resp.Diagnostics.Append(req.Config.Get(ctx, &encryptionAtRestPrivateEndpointsConfig)...) | ||
| if resp.Diagnostics.HasError() { | ||
| return | ||
| } | ||
|
|
||
| // TODO: make get request to obtain list of results | ||
|
|
||
| // connV2 := d.Client.AtlasV2 | ||
| // TODO: GetEncryptionAtRestPrivateEndpointsForCloudProvider returns paginated results | ||
| // v, resp, err := connV2.EncryptionAtRestUsingCustomerKeyManagementApi.GetEncryptionAtRestPrivateEndpointsForCloudProvider(ctx, "", "").Execute() | ||
| // if err != nil { | ||
| // resp.Diagnostics.AddError("error fetching results", err.Error()) | ||
| // return | ||
| //} | ||
|
|
||
| // TODO: process response into new terraform state | ||
| // newEncryptionAtRestPrivateEndpointsModel := NewTFEarPrivateEndpoints("","",conversion.IntPtr(99), v.GetResults()) | ||
| // if diags.HasError() { | ||
| // resp.Diagnostics.Append(diags...) | ||
| // return | ||
| // } | ||
| // resp.Diagnostics.Append(resp.State.Set(ctx, NewTFEarPrivateEndpoints(ctx))...) | ||
| } |
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,107 @@ | ||
| package encryptionatrestprivateendpoint | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "go.mongodb.org/atlas-sdk/v20240805001/admin" | ||
|
|
||
| "github.com/hashicorp/terraform-plugin-framework/datasource/schema" | ||
| "github.com/hashicorp/terraform-plugin-framework/types" | ||
|
|
||
| "github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion" | ||
| ) | ||
|
|
||
| func PluralDataSourceSchema(ctx context.Context) schema.Schema { | ||
| return schema.Schema{ | ||
| Attributes: map[string]schema.Attribute{ | ||
| "cloud_provider": schema.StringAttribute{ | ||
| Required: true, | ||
| Description: "Human-readable label that identifies the cloud provider for the private endpoints to return.", | ||
| MarkdownDescription: "Human-readable label that identifies the cloud provider for the private endpoints to return.", | ||
| }, | ||
| "project_id": schema.StringAttribute{ | ||
| Required: true, | ||
| Description: "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", | ||
| MarkdownDescription: "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", | ||
| }, | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. Would double check in the mms implementation if effectively pageNum and itemsPerPage are not defined, or its a miss of not adding correct annotation for api spec. Seems strange since totalCount is being returned. There was a problem hiding this comment. Currently not supported in the API/MMS, double-checking with the API team if this is expected, awaiting a response from them There was a problem hiding this comment. checked with the team, they have updated the API and those attributes are now supported so I'll update the schema accordingly. Regarding use of If we have a strong opinion on wanting to use functions like PaginatedDSSchema, I think we should work on including it in our auto-generation workflow first. @AgustinBettati @EspenAlbert lmk if you guys disagree There was a problem hiding this comment. Will update this thread after the weekly meeting today There was a problem hiding this comment. updated PR to not support pagination as discussed today |
||
| "results": schema.ListNestedAttribute{ | ||
| NestedObject: schema.NestedAttributeObject{ | ||
| Attributes: map[string]schema.Attribute{ | ||
| "cloud_provider": schema.StringAttribute{ | ||
|
There was a problem hiding this comment. can we reuse the data_source schema similar to stream-connection DS or do we prefer to keep them independent? There was a problem hiding this comment. There's minor difference like presence of project_id in the singular DS model so they aren't exactly the same, I'd prefer to keep the autogenerated schema code close to the API implementation. |
||
| Computed: true, | ||
| Description: "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", | ||
| MarkdownDescription: "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", | ||
| }, | ||
| "error_message": schema.StringAttribute{ | ||
| Computed: true, | ||
| Description: "Error message for failures associated with the Encryption At Rest private endpoint.", | ||
| MarkdownDescription: "Error message for failures associated with the Encryption At Rest private endpoint.", | ||
| }, | ||
| "id": schema.StringAttribute{ | ||
| Computed: true, | ||
| Description: "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", | ||
| MarkdownDescription: "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", | ||
| }, | ||
| "private_endpoint_connection_name": schema.StringAttribute{ | ||
| Computed: true, | ||
| Description: "Connection name of the Azure Private Endpoint.", | ||
| MarkdownDescription: "Connection name of the Azure Private Endpoint.", | ||
| }, | ||
| "region_name": schema.StringAttribute{ | ||
| Computed: true, | ||
| Description: "Cloud provider region in which the Encryption At Rest private endpoint is located.", | ||
| MarkdownDescription: "Cloud provider region in which the Encryption At Rest private endpoint is located.", | ||
| }, | ||
| "status": schema.StringAttribute{ | ||
| Computed: true, | ||
| Description: "State of the Encryption At Rest private endpoint.", | ||
| MarkdownDescription: "State of the Encryption At Rest private endpoint.", | ||
| }, | ||
| }, | ||
| }, | ||
| Computed: true, | ||
| Description: "List of returned documents that MongoDB Cloud providers when completing this request.", | ||
| MarkdownDescription: "List of returned documents that MongoDB Cloud providers when completing this request.", | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| type TFEncryptionAtRestPrivateEndpointsDSModel struct { | ||
| CloudProvider types.String `tfsdk:"cloud_provider"` | ||
| ProjectID types.String `tfsdk:"project_id"` | ||
| Results []TFEarPrivateEndpointDSModel `tfsdk:"results"` | ||
| } | ||
|
|
||
| type TFEarPrivateEndpointDSModel struct { | ||
| CloudProvider types.String `tfsdk:"cloud_provider"` | ||
| ErrorMessage types.String `tfsdk:"error_message"` | ||
| ID types.String `tfsdk:"id"` | ||
| PrivateEndpointConnectionName types.String `tfsdk:"private_endpoint_connection_name"` | ||
| RegionName types.String `tfsdk:"region_name"` | ||
| Status types.String `tfsdk:"status"` | ||
| } | ||
|
|
||
| func NewTFEarPrivateEndpoints(projectID, cloudProvider string, results []admin.EARPrivateEndpoint) *TFEncryptionAtRestPrivateEndpointsDSModel { | ||
| return &TFEncryptionAtRestPrivateEndpointsDSModel{ | ||
| ProjectID: types.StringValue(projectID), | ||
| CloudProvider: types.StringValue(cloudProvider), | ||
| Results: NewTFEarPrivateEndpointsDS(results), | ||
| } | ||
| } | ||
|
|
||
| func NewTFEarPrivateEndpointsDS(endpoints []admin.EARPrivateEndpoint) []TFEarPrivateEndpointDSModel { | ||
| results := make([]TFEarPrivateEndpointDSModel, len(endpoints)) | ||
|
|
||
| for i, v := range endpoints { | ||
| results[i] = TFEarPrivateEndpointDSModel{ | ||
| CloudProvider: conversion.StringNullIfEmpty(v.GetCloudProvider()), | ||
| ErrorMessage: conversion.StringNullIfEmpty(v.GetErrorMessage()), | ||
| ID: conversion.StringNullIfEmpty(v.GetId()), | ||
| RegionName: conversion.StringNullIfEmpty(v.GetRegionName()), | ||
| Status: conversion.StringNullIfEmpty(v.GetStatus()), | ||
| PrivateEndpointConnectionName: conversion.StringNullIfEmpty(v.GetPrivateEndpointConnectionName()), | ||
| } | ||
| } | ||
| return results | ||
| } | ||
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
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.
not required, as an "id" attribute exists in the schema already