Skip to content
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.

Sign up for GitHub

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

Jump to bottom

chore: migrate encryption_at_rest resource to new SDK #1725

Merged
merged 6 commits into from
Dec 13, 2023
Merged

chore: migrate encryption_at_rest resource to new SDK #1725

merged 6 commits into from
Dec 13, 2023

Conversation

oarbusi
Copy link
Collaborator

@oarbusi oarbusi commented Dec 7, 2023

Description

Migrate encryption_at_rest resource to new SDK

Link to any related issue(s): https://jira.mongodb.org/browse/CLOUDP-216420

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.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contribution guidelines
  • 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.

Further comments

oarbusi
oarbusi commented Dec 7, 2023
View reviewed changes
internal/service/encryptionatrest/resource_encryption_at_rest.go
}

atlasEncryptionAtRest.GroupID = projectID

encryptionResp, _, err := conn.EncryptionsAtRest.Create(ctx, atlasEncryptionAtRest)
Copy link
Collaborator Author

@oarbusi oarbusi Dec 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create operation was actually a PATCH operation, that's why it's now an Update in the new SDK (api docs), see also CFN

oarbusi
oarbusi commented Dec 7, 2023
View reviewed changes
internal/service/encryptionatrest/resource_encryption_at_rest.go
projectID := encryptionAtRestState.ProjectID.ValueString()
_, err := conn.EncryptionsAtRest.Delete(ctx, projectID)
Copy link
Collaborator Author

@oarbusi oarbusi Dec 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete operation was actually a PATCH operation doing a soft delete, that's why it's now an Update in the new SDK where we set everything as disabled (enabled: false) api docs, see also CFN

@oarbusi oarbusi marked this pull request as ready for review December 7, 2023 15:37
@oarbusi oarbusi requested a review from a team as a code owner December 7, 2023 15:37
@lantoli
Copy link
Member

lantoli commented Dec 7, 2023

ok for me once it's tested manually

@github-actions GitHub Actions
Copy link
Contributor

Code Coverage

Package Line Rate Health
github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion 31% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/common/dsschema 100% ✔
github.com/mongodb/terraform-provider-mongodbatlas/internal/common/validate 68% ➖
github.com/mongodb/terraform-provider-mongodbatlas/internal/provider 7% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/accesslistapikey 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/advancedcluster 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/alertconfiguration 33% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/apikey 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/atlasuser 0% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/auditing 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/backupcompliancepolicy 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/cloudbackupschedule 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/cloudbackupsnapshot 5% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/cloudbackupsnapshotexportbucket 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/cloudbackupsnapshotexportjob 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/cloudbackupsnapshotrestorejob 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/cloudprovideraccess 4% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/cluster 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/clusteroutagesimulation 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/customdbrole 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/customdnsconfigurationclusteraws 5% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/databaseuser 0% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/datalakepipeline 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/encryptionatrest 0% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/eventtrigger 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/federateddatabaseinstance 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/federatedquerylimit 4% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/federatedsettingsidentityprovider 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/federatedsettingsorgconfig 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/federatedsettingsorgrolemapping 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/globalclusterconfig 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/ldapconfiguration 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/ldapverify 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/maintenancewindow 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/networkcontainer 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/networkpeering 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/onlinearchive 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/organization 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/orginvitation 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/privateendpointregionalmode 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/privatelinkendpoint 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/privatelinkendpointserverless 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/privatelinkendpointservice 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/privatelinkendpointservicedatafederationonlinearchive 3% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/privatelinkendpointserviceserverless 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/project 28% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/projectapikey 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/projectinvitation 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/projectipaccesslist 0% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/rolesorgid 7% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/searchdeployment 23% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/searchindex 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/serverlessinstance 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/streaminstance 14% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/teams 1% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/thirdpartyintegration 4% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/service/x509authenticationdatabaseuser 2% ❌
github.com/mongodb/terraform-provider-mongodbatlas/internal/testutil/acc 4% ❌
Summary 5% (579 / 10847) ❌

AgustinBettati
AgustinBettati approved these changes Dec 11, 2023
View reviewed changes
Copy link
Member

@AgustinBettati AgustinBettati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just one doubt

internal/service/encryptionatrest/resource_encryption_at_rest.go
projectID := encryptionAtRestState.ProjectID.ValueString()
_, err := conn.EncryptionsAtRest.Delete(ctx, projectID)

_, _, err := connV2.EncryptionAtRestUsingCustomerKeyManagementApi.GetEncryptionAtRest(context.Background(), projectID).Execute()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a reason we need to do this get request? comparing to previous logic it would seem it does the update directly

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did this to match the implementation in CFN which was already migrated to the new SDK

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, it would seem in CFN it does the get to provide a more detailed error. When looking into terraform delete functions we go for the delete operation directly, in case the resource has already been deleted the API error would be returned.

@oarbusi oarbusi merged commit 42f0f37 into master Dec 13, 2023
30 checks passed
@oarbusi oarbusi deleted the CLOUDP-216420 branch December 13, 2023 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AgustinBettati AgustinBettati AgustinBettati approved these changes

@lantoli lantoli lantoli approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@oarbusi @lantoli @AgustinBettati