fix: handle external change of secret type #3141

sfc-gh-fbudzynski · 2024-10-17T14:52:41Z

Changes

Added secret_type computed filed to secret resources
Added CustomDiff for handling external change of secret_type
Refactored show_and_describe_handlers for flat describe_output and show_output
Tested external change of secret type for each resource

Test Plan

acceptance tests

References

github-actions · 2024-10-17T16:51:41Z

Integration tests failure for 510df15a291f193bd9733d423af438b312e12ef9

github-actions · 2024-10-18T10:07:40Z

Integration tests failure for 7d90d7b0db639fdcbea2fdaf6f212aefd883b9f2

github-actions · 2024-10-18T13:49:46Z

Integration tests failure for dd38109b6b71fb199b4eb6cc0b03d03cb437c1a1

github-actions · 2024-10-21T08:23:33Z

Integration tests failure for 90721b42eaf1fb9604965548f225d113cca01334

sfc-gh-jcieslak · 2024-10-21T09:08:33Z

pkg/resources/secret_with_oauth_authorization_code_grant_acceptance_test.go

 							HasOauthRefreshTokenExpiryTimeString(refreshTokenExpiryDateTime),
 						assert.Check(resource.TestCheckResourceAttrSet(secretModel.ResourceReference(), "describe_output.0.oauth_refresh_token_expiry_time")),
 					),
 				),
 			},
+			{
+				RefreshState: true,


I see this kind of test case for the first time, could you briefly describe what it does/tests ?

When discussing the refresh_token_expiry_time field with @sfc-gh-jmichalak we wanted to check if there will be a perma diff or not when invoking Read on that resource in order to be sure if we needed a diff suppress.

There was no perma diff because this filed is not being overwritten by value in describe, it is handled by using setStateToValuesFromConfig

withExternalChangesMarking and handleExternalValueChangesToObjectInDescribe is being used only to detect the external change on that field.

Diffs after read are usually implicitly caught by the testing framework, but If we want to check that explicitly let's make a comment above this test case to know what are we actually asserting.

pkg/resources/secret_with_oauth_client_credentials_acceptance_test.go

pkg/sdk/testint/secrets_gen_integration_test.go

…e_grant_flow

…bs/terraform-provider-snowflake into secret-type-external-change

github-actions · 2024-10-21T15:41:49Z

Integration tests failure for 49dc3b8dfa8ac335618d359bb46d2f65826d2d5f

github-actions · 2024-10-21T15:43:43Z

Integration tests failure for b05ad4d69cf3c449cd2a7000983b83087a4b8ff3

github-actions · 2024-10-21T15:49:20Z

Integration tests failure for 36c16a0ac744681341ae838981058762cbaefba7

github-actions · 2024-10-21T15:55:08Z

Integration tests failure for 97e7aae5717601a8e91cea9934daa667b5b599b0

pkg/sdk/secrets_def.go

pkg/resources/secret_with_basic_authentication.go

pkg/resources/custom_diffs.go

pkg/resources/secret_with_oauth_authorization_code_grant.go

pkg/resources/secret_common.go

pkg/resources/show_and_describe_handlers.go

pkg/resources/custom_diffs.go

github-actions · 2024-10-22T16:00:14Z

Integration tests success for cf8b7e43e3f574144028de9cd2a40f079ce012a3

sfc-gh-asawicki · 2024-10-23T08:50:19Z

pkg/sdk/secrets_def.go

-	SecretTypeGenericString                          = "GENERIC_STRING"
-	OAuth2ClientCredentialsFlow      OauthSecretType = "CLIENT_CREDENTIALS"       // #nosec G101
-	OAuth2AuthorizationCodeGrantFlow OauthSecretType = "AUTHORIZATION_CODE_GRANT" // #nosec G101
+	SecretTypePassword                     SecretType = "PASSWORD"


nit: I don't like that this is one enum here. Two different use cases are mixed here: SQL TYPE value and creation variants. I'm okay with merging this but let's talk later how we can improve this.

github-actions · 2024-10-23T11:57:34Z

Integration tests failure for 9cbbca0fd625f337d71b7c3e86ff5df60937bf25

github-actions · 2024-10-23T12:27:29Z

Integration tests failure for 55ee85b119f16006ad0b625fa9f22f5086870a0d

## [0.98.0](v0.97.0...v0.98.0) (2024-11-08) Feature scope readiness for V1: [link](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/v1-preparations/ESSENTIAL_GA_OBJECTS.MD) ([Roadmap reference](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/ROADMAP.md#wrap-up-the-functional-scope)). :exclamation: Migration guide: [v0.97.0 -> v0.98.0](https://github.com/Snowflake-Labs/terraform-provider-snowflake/blob/main/MIGRATION_GUIDE.md#v0970--v0980) ### 🎉 What's new - New resources: - authentication_policy ([#3098](#3098)), references [#2880](#2880) - external_volume ([#3106](#3106)), partially references [#2980](#2980) - stream_on_directory_table ([#3129](#3129)) - stream_on_view ([#3150](#3150)) - primary_connection, secondary_connection ([#3162](#3162)) - secret_with_basic_authentication, secret_with_generic_string, secret_with_oauth_authorization_code_grant, secret_with_oauth_client_credentials ([#3110](#3110)), ([#3141](#3141)) - New data sources: - connections ([#3155](#3155)), ([#3173](#3173)) - secrets ([#3131](#3131)) - Reworked: - provider configuration hierarchy ([#3166](#3166)), references [#1881](#1881), [#2145](#2145), [#2925](#2925), [#2983](#2983), [#3104](#3104) - provider configuration fields ([#3152](#3152)) streams data source ([#3151](#3151)) - SDK upgrades: - Upgrade tag SDK ([#3126](#3126)) - Recreate streams when they are stale ([#3129](#3129)) ### 🔧 Misc - Add object renaming research summary ([#3172](#3172)) - Test support for object renaming ([#3130](#3130)), ([#3147](#3147)), ([#3154](#3154)) - Add tests to issue [#3117](#3117) ([#3133](#3133)) - New roadmap entry ([#3158](#3158)) - Test more authentication methods ([#3178](#3178)) - Minor fixes ([#3174](#3174)) ### 🐛 Bug fixes - Apply various fixes ([#3176](#3176)), this addresses BCR 2024_08, references [#2717](#2717), [#3005](#3005), [#3125](#3125), [#3127](#3127), [#3153](#3153) - Connection and secret data sources tests ([#3177](#3177)) - Fix grant import docs ([#3183](#3183)), resolves [#3179](https://github.com/Snowflake-Labs/terraform-provider-snowflake/discussions/3179) - Fix user resource import ([#3181](#3181)) - Handle external type changes in stream resources ([#3164](#3164)) - Do not use OR REPLACE on initial creation in resources with copy_grants ([#3129](#3129)) - Address issue [#2201](#2201) by introducing new stream resources Co-authored-by: snowflake-release-please[bot] <105954990+snowflake-release-please[bot]@users.noreply.github.com>

sfc-gh-fbudzynski added 5 commits October 17, 2024 09:25

Proper handling of externally change atribute secret_type

57f2dde

add tests for external type changes

9a2e33d

Fix for proper handling of externally changed secret_type

e82413b

Change of show_and_describe_handlers to get rid of code duplication

309a39c

self-review small fixes

510df15

resource models re-generated

7d90d7b

fix secret with authorization code grant parameters order

dd38109

sfc-gh-fbudzynski marked this pull request as ready for review October 18, 2024 14:37

sfc-gh-fbudzynski changed the title ~~fix: handle secret type external change~~ fix: handle external change of secret type Oct 18, 2024

sfc-gh-asawicki self-requested a review October 18, 2024 15:14

Merge branch 'main' into secret-type-external-change

90721b4

sfc-gh-jcieslak reviewed Oct 21, 2024

View reviewed changes

sfc-gh-fbudzynski added 6 commits October 21, 2024 15:27

add detect secret type change for client_credentials_flow to auth_cod…

887507f

…e_grant_flow

Merge branch 'secret-type-external-change' of github.com:Snowflake-La…

b05ad4d

…bs/terraform-provider-snowflake into secret-type-external-change

proper comments to tests and assertions before external change

36c16a0

Merge branch 'main' into secret-type-external-change

97e7aae

docs check fix

83317e8

Merge branch 'secret-type-external-change' of github.com:Snowflake-La…

49dc3b8

…bs/terraform-provider-snowflake into secret-type-external-change

sfc-gh-jmichalak requested changes Oct 22, 2024

View reviewed changes

sfc-gh-asawicki requested changes Oct 22, 2024

View reviewed changes

pkg/resources/custom_diffs.go Outdated Show resolved Hide resolved

resolved comments for review

cf8b7e4

sfc-gh-asawicki self-requested a review October 23, 2024 08:45

sfc-gh-asawicki previously approved these changes Oct 23, 2024

View reviewed changes

sfc-gh-jcieslak previously approved these changes Oct 23, 2024

View reviewed changes

sfc-gh-jmichalak previously approved these changes Oct 23, 2024

View reviewed changes

Merge branch 'main' into secret-type-external-change

9cbbca0

sfc-gh-fbudzynski dismissed stale reviews from sfc-gh-jmichalak, sfc-gh-jcieslak, and sfc-gh-asawicki via 9cbbca0 October 23, 2024 09:33

conflicts resolved

55ee85b

sfc-gh-jmichalak approved these changes Oct 24, 2024

View reviewed changes

sfc-gh-jcieslak approved these changes Oct 24, 2024

View reviewed changes

sfc-gh-fbudzynski merged commit 649b839 into main Oct 24, 2024
8 of 9 checks passed

sfc-gh-fbudzynski deleted the secret-type-external-change branch October 24, 2024 08:31

snowflake-release-please bot mentioned this pull request Oct 22, 2024

chore(main): release 0.98.0 #3137

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: handle external change of secret type #3141

fix: handle external change of secret type #3141

sfc-gh-fbudzynski commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 21, 2024

sfc-gh-jcieslak Oct 21, 2024

sfc-gh-fbudzynski Oct 21, 2024

sfc-gh-jcieslak Oct 23, 2024 •

edited

Loading

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 22, 2024

sfc-gh-asawicki Oct 23, 2024

github-actions bot commented Oct 23, 2024

github-actions bot commented Oct 23, 2024

fix: handle external change of secret type #3141

fix: handle external change of secret type #3141

Conversation

sfc-gh-fbudzynski commented Oct 17, 2024 • edited Loading

Changes

Test Plan

References

github-actions bot commented Oct 17, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 18, 2024

github-actions bot commented Oct 21, 2024

sfc-gh-jcieslak Oct 21, 2024

Choose a reason for hiding this comment

sfc-gh-fbudzynski Oct 21, 2024

Choose a reason for hiding this comment

sfc-gh-jcieslak Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 22, 2024

sfc-gh-asawicki Oct 23, 2024

Choose a reason for hiding this comment

github-actions bot commented Oct 23, 2024

github-actions bot commented Oct 23, 2024

sfc-gh-fbudzynski commented Oct 17, 2024 •

edited

Loading

sfc-gh-jcieslak Oct 23, 2024 •

edited

Loading