chore: Creates TF models & interfaces for `mongodbatlas_encryption_at_rest_private_endpoints` plural data source #2502

maastha · 2024-08-13T16:27:41Z

Description

Creates TF models & interfaces for new mongodbatlas_encryption_at_rest_private_endpoints plural data source:

Adds:
TF model
TF schema
Read skeleton handler
Minor updates to other resource models

Link to any related issue(s): CLOUDP-266929

Type of change:

Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
This change requires a documentation update
Documentation fix/enhancement

Required Checklist:

I have signed the MongoDB CLA
I have read the contributing guides
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.
If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

…aces-pluralDS

maastha · 2024-08-14T10:42:53Z

internal/service/encryptionatrestprivateendpoint/data_source_schema.go

@@ -14,11 +14,6 @@ func DataSourceSchema(ctx context.Context) schema.Schema {
 				Description:         "Human-readable label that identifies the cloud provider of the private endpoint.",
 				MarkdownDescription: "Human-readable label that identifies the cloud provider of the private endpoint.",
 			},
-			"endpoint_id": schema.StringAttribute{


not required, as an "id" attribute exists in the schema already

maastha · 2024-08-14T10:43:52Z

internal/service/encryptionatrestprivateendpoint/resource_schema.go

@@ -15,11 +15,6 @@ func ResourceSchema(ctx context.Context) schema.Schema {
 				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.",
 			},
-			"endpoint_id": schema.StringAttribute{


not required, as an "id" attribute exists in the schema already

EspenAlbert · 2024-08-14T12:27:38Z

internal/service/encryptionatrestprivateendpoint/pural_data_source_schema.go

+				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.",
+			},


~~Have you seen the PaginatedDSSchema ? I think that could apply for this resource~~
*UPDATE: I was taking an extra look. It looks like pagination is not supported on that endpoint

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.

Currently not supported in the API/MMS, double-checking with the API team if this is expected, awaiting a response from them

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 PaginatedDSSchema I understand it may make the code a bit modular but since these schemas are being generated using scaffolding, but I don't see much value in making such changes to the generated schema and I'd like to keep the generated schema as close to what is auto-generated as possible.

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

Will update this thread after the weekly meeting today

updated PR to not support pagination as discussed today
cc @AgustinBettati

EspenAlbert · 2024-08-14T12:34:18Z

internal/service/encryptionatrestprivateendpoint/pural_data_source_schema.go

+			"results": schema.ListNestedAttribute{
+				NestedObject: schema.NestedAttributeObject{
+					Attributes: map[string]schema.Attribute{
+						"cloud_provider": schema.StringAttribute{


can we reuse the data_source schema similar to stream-connection DS or do we prefer to keep them independent?

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.

EspenAlbert · 2024-08-14T12:36:31Z

internal/service/encryptionatrestprivateendpoint/model_test.go

+	testCases := map[string]sdkToTFModelPluralDSTestCase{
+		"Complete SDK response": {
+			SDKResp: []admin.EARPrivateEndpoint{
+				{


can we refactor the admin examples to helper functions. They seemed to be used in both TestEncryptionAtRestPrivateEndpointPluralDSSDKToTFModel and TestEncryptionAtRestPrivateEndpointTFModelToSDK?

EspenAlbert

LGTM. Some nit and ideas 👍

AgustinBettati

LGTM, only doubt I have is why API/SDK does not support pageNum and itemsPerPage.

…o master (#2569) * update sdk dev (#2490) * chore: Creates TF models & interfaces for new `mongodbatlas_encryption_at_rest_private_endpoint` resource (#2493) * chore: Creates TF models & interfaces for new `mongodbatlas_encryption_at_rest_private_endpoint` data source (#2500) * feat: Updates `mongodbatlas_encryption_at_rest` resource to use new `azure_key_vault_config.require_private_networking` field (#2509) * chore: Creates TF models & interfaces for `mongodbatlas_encryption_at_rest_private_endpoints` plural data source (#2502) * feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` resource (#2512) * wip - implementing CRUD * include changelog entry * small adjustments * supporting state transition logic * implement acceptance test * add unit testing for state transitions * handle return error message if failed status is present * add acceptance test transitioning for public to private network * improve messaging for failed status * fix prechecks * use global const for resource name * avoid hardcoded value * adjust state transition logic for delete * adjusting target version in migration test to 1.19.0 * adjust default refresh to 30 seconds for quicker response * feat: Implements `mongodbatlas_encryption_at_rest_private_endpoint` singular data source (#2527) * implement singular data source * including changelog entry * doc: Updates existing documentation for `mongodbatlas_encryption_at_rest` resource to be auto-generated (#2529) * doc: Include example for new `mongodbatlas_encryption_at_rest_private_endpoint` resource (#2540) * Include example for ear with private endpoint * fix example * adjust readme * Update examples/mongodbatlas_encryption_at_rest_private_endpoint/azure/README.md Co-authored-by: maastha <[email protected]> * Update examples/mongodbatlas_encryption_at_rest_private_endpoint/azure/README.md Co-authored-by: maastha <[email protected]> * add example cli command * make use of variables to make value of resource id more compact --------- Co-authored-by: maastha <[email protected]> * feat: Implements new `mongodbatlas_encryption_at_rest_private_endpoints` data source (#2536) * temporary change to cloud provider access and getting latest sdk * implements plural data source * adapted cloud provider access with latest changes from dev preview * fix unit test * adding changelog entry * add changes to verify plural data source in basic test case * doc adjust to cloud_provider attribute * feat: Implements new `mongodbatlas_encryption_at_rest` singular data source & adds `valid` attribute for cloud provider configs in the resource (#2538) * fix: Adds error message handling to `mongodbatlas_encryption_at_rest_private_endpoint` resource (#2544) * doc: Adds documentation for new `encryption_at_rest_private_endpoint` resource and data sources (#2547) * adding documentation for encryption_at_rest_private_endpoint resource and data sources * align generated docs * minor typo fix * Adjust description of project_id to make it more concise * align note stating feature is available by request as defined in general docs * chore: Adopt latest changes from master into ear private endpoint dev branch to adopt latest SDK (#2549) * test: Reduce instance size and use of provisioned disk iops for test that verifies transition for symmetric to asymmetric configuration (#2503) * doc: Include changelog entries to mention 2 new guides (#2506) * add entry for 2 new guides * add link * chore: Updates examples link in index.md for v1.18.0 release * chore: Updates CHANGELOG.md header for v1.18.0 release * doc: Update Atlas SP db_role_to_execute info. (#2508) * (DOCSP-41590) Updating Atlas SP db_role_to_execute info. * Update docs/resources/stream_connection.md Co-authored-by: kanchana-mongodb <[email protected]> --------- Co-authored-by: kanchana-mongodb <[email protected]> * doc: Contributing Guidelines Updates (#2494) * Contributing Guidelines Updates * Update README.md * Update README.md * Update contributing/README.md Co-authored-by: kyuan-mongodb <[email protected]> --------- Co-authored-by: kyuan-mongodb <[email protected]> * test: Simply migration test checks after 1.18.0 release and adjust version constraint in advanced_cluster examples uing new schema (#2510) * doc: Add references to the terraform modules in the resources documentations (#2513) * add references to the modules in the resources documentations * fix pr comments * chore: Bump hashicorp/setup-terraform from 3.1.1 to 3.1.2 (#2515) Bumps [hashicorp/setup-terraform](https://github.com/hashicorp/setup-terraform) from 3.1.1 to 3.1.2. - [Release notes](https://github.com/hashicorp/setup-terraform/releases) - [Changelog](https://github.com/hashicorp/setup-terraform/blob/main/CHANGELOG.md) - [Commits](hashicorp/setup-terraform@651471c...b9cd54a) --- updated-dependencies: - dependency-name: hashicorp/setup-terraform dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore: Add mention of support ticket when opening a pull request (#2507) * Add mention of creating support ticket when opening PR * rephrasing to avoid mention of priority * including suggestion * doc: Updates`mongodbatlas_advanced_cluster` ISS migration guide & resource doc with expected 500 error on update (#2525) * chore: Updates mongodbatlas_advanced_cluster tests to expect temporary SERVICE_UNAVAILABLE error when migrating from old to new schema (#2523) * doc: Fixes wordings in the new advanced_cluster sharding guide. (#2524) * chore: Updates examples link in index.md for v1.18.1 release * chore: Updates CHANGELOG.md header for v1.18.1 release * chore: upgrades go SDK from `v20240805001` to `v20240805002` (#2534) * chore: Updates to Go 1.23 (#2535) * update asdf TF version * update to Go 1.23 * update linter * update golang-ci linter * disable Go telemetry * revert TF change * chore: Bump go.mongodb.org/atlas from 0.36.0 to 0.37.0 (#2532) Bumps [go.mongodb.org/atlas](https://github.com/mongodb/go-client-mongodb-atlas) from 0.36.0 to 0.37.0. - [Release notes](https://github.com/mongodb/go-client-mongodb-atlas/releases) - [Changelog](https://github.com/mongodb/go-client-mongodb-atlas/blob/master/CHANGELOG.md) - [Commits](mongodb/go-client-mongodb-atlas@v0.36.0...v0.37.0) --- updated-dependencies: - dependency-name: go.mongodb.org/atlas dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore: Bump github.com/hashicorp/hcl/v2 from 2.21.0 to 2.22.0 (#2530) Bumps [github.com/hashicorp/hcl/v2](https://github.com/hashicorp/hcl) from 2.21.0 to 2.22.0. - [Release notes](https://github.com/hashicorp/hcl/releases) - [Changelog](https://github.com/hashicorp/hcl/blob/main/CHANGELOG.md) - [Commits](hashicorp/hcl@v2.21.0...v2.22.0) --- updated-dependencies: - dependency-name: github.com/hashicorp/hcl/v2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * update asdf TF version to 1.9.5 (#2537) * chore: Changes deprecation message for labels attribute (#2542) * chore: Upgrades go SDK from `v20240805002` to `v20240805003` (#2545) * major version update calling gomajor tool * manual change to reincorporate v20240530005 * reverts temp changes in cloud provider resources, fixes sdk versions in new implementations --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: svc-apix-bot <[email protected]> Co-authored-by: lmkerbey-mdb <[email protected]> Co-authored-by: kanchana-mongodb <[email protected]> Co-authored-by: Zuhair Ahmed <[email protected]> Co-authored-by: kyuan-mongodb <[email protected]> Co-authored-by: rubenVB01 <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: maastha <[email protected]> Co-authored-by: Marco Suma <[email protected]> Co-authored-by: Espen Albert <[email protected]> Co-authored-by: Leo Antoli <[email protected]> Co-authored-by: Oriol <[email protected]> * doc: Adds documentation & examples for `mongodbatlas_encryption_at_rest` singular data source (#2543) * chore: Enables `mongodbatlas_encryption_at_rest` (Azure) tests to run in CI (#2551) * chore: Adds `mongodbatlas_encryption_at_rest_private_endpoint` acceptance test using azapi to approve private endpoint & check ACTIVE status (#2558) * doc: Add user journey considerations in current resource and example documentation (#2559) * minor typo fix * improve initial description in ear * adjust ear docs with mention of azure private link * private link doc adjustments * improve example * improve example * add mention in ear examples about policies * add note on update operation * link adjustments and add header for handling existing clusters * add note on private endpoint * add note in data sources * Update docs/resources/encryption_at_rest_private_endpoint.md Co-authored-by: maastha <[email protected]> * add clarification of preview flag for data sources --------- Co-authored-by: maastha <[email protected]> * update project_ip_addresses action * address doc comment --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Agustin Bettati <[email protected]> Co-authored-by: svc-apix-bot <[email protected]> Co-authored-by: lmkerbey-mdb <[email protected]> Co-authored-by: kanchana-mongodb <[email protected]> Co-authored-by: Zuhair Ahmed <[email protected]> Co-authored-by: kyuan-mongodb <[email protected]> Co-authored-by: rubenVB01 <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Marco Suma <[email protected]> Co-authored-by: Espen Albert <[email protected]> Co-authored-by: Leo Antoli <[email protected]> Co-authored-by: Oriol <[email protected]>

maastha added 3 commits August 13, 2024 15:55

add singular data source schema

cc4a760

update provider

f950c48

add initial schema

851d723

Base automatically changed from CLOUDP-266928-tf-interfaces-datasource to CLOUDP-246459-ear-kms-dev August 13, 2024 16:30

maastha added 2 commits August 13, 2024 17:32

Merge branch 'CLOUDP-246459-ear-kms-dev' into CLOUDP-266929-tf-interf…

809ac75

…aces-pluralDS

update models, add unit tests

40ec9d1

maastha changed the title ~~chore: Adds initial schema for plural DS~~ chore: Creates TF models & interfaces for mongodbatlas_encryption_at_rest_private_endpoints plural data source Aug 14, 2024

maastha commented Aug 14, 2024

View reviewed changes

maastha marked this pull request as ready for review August 14, 2024 10:50

maastha requested a review from a team as a code owner August 14, 2024 10:50

EspenAlbert reviewed Aug 14, 2024

View reviewed changes

EspenAlbert approved these changes Aug 14, 2024

View reviewed changes

AgustinBettati approved these changes Aug 14, 2024

View reviewed changes

remove totalCount

4e1b5f4

maastha merged commit 8226718 into CLOUDP-246459-ear-kms-dev Aug 19, 2024
35 checks passed

maastha deleted the CLOUDP-266929-tf-interfaces-pluralDS branch August 19, 2024 14:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Creates TF models & interfaces for `mongodbatlas_encryption_at_rest_private_endpoints` plural data source #2502

chore: Creates TF models & interfaces for `mongodbatlas_encryption_at_rest_private_endpoints` plural data source #2502

maastha commented Aug 13, 2024 •

edited

Loading

maastha Aug 14, 2024

maastha Aug 14, 2024

EspenAlbert Aug 14, 2024 •

edited

Loading

AgustinBettati Aug 14, 2024

maastha Aug 14, 2024 •

edited

Loading

maastha Aug 16, 2024

maastha Aug 19, 2024

maastha Aug 19, 2024

EspenAlbert Aug 14, 2024

maastha Aug 14, 2024

EspenAlbert Aug 14, 2024

EspenAlbert left a comment

AgustinBettati left a comment

chore: Creates TF models & interfaces for mongodbatlas_encryption_at_rest_private_endpoints plural data source #2502

chore: Creates TF models & interfaces for mongodbatlas_encryption_at_rest_private_endpoints plural data source #2502

Conversation

maastha commented Aug 13, 2024 • edited Loading

Description

Type of change:

Required Checklist:

Further comments

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EspenAlbert Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maastha Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EspenAlbert left a comment

Choose a reason for hiding this comment

AgustinBettati left a comment

Choose a reason for hiding this comment

chore: Creates TF models & interfaces for `mongodbatlas_encryption_at_rest_private_endpoints` plural data source #2502

chore: Creates TF models & interfaces for `mongodbatlas_encryption_at_rest_private_endpoints` plural data source #2502

maastha commented Aug 13, 2024 •

edited

Loading

EspenAlbert Aug 14, 2024 •

edited

Loading

maastha Aug 14, 2024 •

edited

Loading