feat: Upgrade tag SDK #3126

sfc-gh-jmichalak · 2024-10-10T13:53:29Z

add missing object types (snowflake_tag_association does not fully support objects #1496, Snowflake Tag Resource Should Support all Object Types #1862, Add support for tagging Snowflake Alert #2598)
adjust show options
add ifExists to tag queries
add missing masking policy note about v1 rc
add integration tests for setting, getting, and unsetting tags, except:
- failover group - business critical edition needed
- alert, password policy, network policy - missing tag handling in SDK
- git repo, iceberg table, budget, classification, replication group - objects not implemented in the sdk

Test Plan

integration tests

unit tests

References

https://docs.snowflake.com/en/sql-reference/sql/create-tag
https://docs.snowflake.com/en/user-guide/object-tagging
https://docs.snowflake.com/en/sql-reference/functions/system_get_tag

TODO

change GetTag to not fail on null values
move tag assignments integration tests to a common place
restrict the list of object types we want to support, instead of all of them
rework tag, tag_association resource
remove tag_masking_policy_association_resource (tag_association will be used instead)

github-actions · 2024-10-10T14:42:53Z

Integration tests failure for 424b47af067b90540fd2c61a1d0ae3c058ca4fea

github-actions · 2024-10-11T14:03:58Z

Integration tests cancelled for 651c4e36cd88317fcbd19030f713ef50522c4ad0

github-actions · 2024-10-11T14:03:59Z

Integration tests cancelled for acb0981ae15561392c73f553800c16f1a293794b

github-actions · 2024-10-11T16:16:17Z

Integration tests failure for 47b9ac5dec645cea701af0885eb5b790ea5a0117

pkg/resources/tag.go

sfc-gh-jcieslak · 2024-10-14T09:41:41Z

pkg/sdk/tag_association_validations.go

 		ObjectTypeAlert,
+		ObjectTypeBudget,
+		ObjectTypeClassification,
 		ObjectTypeExternalFunction,


We could create a test that would go through all the object types to see which ones are valid ones, I just checked that, e.g. dynamic tables can also be used (with table data type ofc).

+1 for such a test

It's related to #3126 (comment) - I can do this in the next PR.

pkg/sdk/object_types.go

sfc-gh-asawicki · 2024-10-14T10:13:42Z

pkg/sdk/system_functions.go

+// SQL compilation error: Invalid value VIEW for argument OBJECT_TYPE. Please use object type TABLE for all kinds of table-like objects.
+// TODO [SNOW-1022645]: discuss how we handle situation like this in the SDK
+func normalizeGetTagObjectType(objectType ObjectType) ObjectType {
+	if slices.Contains([]ObjectType{ObjectTypeView, ObjectTypeMaterializedView, ObjectTypeExternalTable}, objectType) {


what about dynamic table?

Initially, I missed dynamic tables because they are missing from https://docs.snowflake.com/en/user-guide/object-tagging. Managing dynamic tables is not implemented in the SDK. I just checked it manually, and it turns out you can use GetTag with dynamic table as an argument.

Thinking in reverse: here we can narrow the list of accepted object types, like we do in the grants, wdyt?

Good idea, next PR/follow-up issue?

pkg/sdk/testint/applications_integration_test.go

pkg/sdk/testint/databases_integration_test.go

sfc-gh-asawicki · 2024-10-14T10:20:39Z

pkg/sdk/testint/external_functions_integration_test.go

@@ -194,6 +195,33 @@ func TestInt_ExternalFunctions(t *testing.T) {
 		assertExternalFunction(t, externalFunction.ID(), true)
 	})

+	t.Run("alter external function: set and unset tags", func(t *testing.T) {


Maybe instead adding such a func to each object, we could extract one integration test with parametrized setup and run it for all objects instead? (I know that currently we had setting/unsetting tags in each object but with the rework, we can pick more centralized approach)

I can do it in the next PR.

Oky (keeping it open then)

sfc-gh-asawicki · 2024-10-14T10:21:23Z

pkg/sdk/testint/materialized_views_gen_integration_test.go

@@ -326,7 +326,7 @@ func TestInt_MaterializedViews(t *testing.T) {
 		err := client.Views.Alter(ctx, alterRequestSetTags)
 		require.NoError(t, err)

-		returnedTagValue, err := client.SystemFunctions.GetTag(ctx, tag.ID(), id, sdk.ObjectTypeTable)
+		returnedTagValue, err := client.SystemFunctions.GetTag(ctx, tag.ID(), id, sdk.ObjectTypeMaterializedView)


why in some tests we check for err nil and in some we also validate the tag's value?

That's because when a tag is not set, GetTag returns an error. I'd like to change this, so that nil is returned as a tag value in the next PR.

Oky (keeping it open then)

pkg/sdk/testint/schemas_integration_test.go

github-actions · 2024-10-17T16:16:33Z

Integration tests failure for 6be59db0f614df9aabfad26cf726cd8aaa12b114

github-actions · 2024-10-21T07:02:24Z

Integration tests cancelled for ca92d70faf456812972fca68a8e0029be707de8c

github-actions · 2024-10-21T08:44:55Z

Integration tests failure for bf2af836a4744222fb783b4191d1a1aaf6d56b23

## [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-jmichalak added 2 commits October 10, 2024 15:48

Tag sdk

41c3ab4

Improve tag sdk

424b47a

sfc-gh-jmichalak added 3 commits October 11, 2024 15:48

Cleanup

acb0981

Cleanup

651c4e3

Cleanup

47b9ac5

sfc-gh-jmichalak requested review from sfc-gh-asawicki and sfc-gh-jcieslak October 11, 2024 14:03

sfc-gh-jmichalak marked this pull request as ready for review October 11, 2024 14:11

sfc-gh-jcieslak reviewed Oct 14, 2024

View reviewed changes

sfc-gh-asawicki requested changes Oct 14, 2024

View reviewed changes

sfc-gh-jmichalak added 3 commits October 15, 2024 16:40

Merge remote-tracking branch 'origin/main' into tag-v1

28c2697

Merge remote-tracking branch 'origin/main' into tag-v1

7c9137e

Review suggestions

6be59db

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

View reviewed changes

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

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

View reviewed changes

Skip replica database test

ca92d70

sfc-gh-jmichalak dismissed stale reviews from sfc-gh-asawicki and sfc-gh-jcieslak via ca92d70 October 21, 2024 07:00

Merge remote-tracking branch 'origin/main' into tag-v1

bf2af83

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

View reviewed changes

sfc-gh-jmichalak merged commit 893b288 into main Oct 21, 2024
8 of 9 checks passed

sfc-gh-jmichalak deleted the tag-v1 branch October 21, 2024 08:51

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

chore(main): release 0.98.0 #3137

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Upgrade tag SDK #3126

feat: Upgrade tag SDK #3126

sfc-gh-jmichalak commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024

github-actions bot commented Oct 11, 2024

github-actions bot commented Oct 11, 2024

github-actions bot commented Oct 11, 2024

sfc-gh-jcieslak Oct 14, 2024

sfc-gh-asawicki Oct 14, 2024

sfc-gh-jmichalak Oct 15, 2024

sfc-gh-asawicki Oct 14, 2024

sfc-gh-jmichalak Oct 15, 2024 •

edited

Loading

sfc-gh-asawicki Oct 18, 2024

sfc-gh-asawicki Oct 14, 2024

sfc-gh-jmichalak Oct 15, 2024

sfc-gh-asawicki Oct 18, 2024

sfc-gh-asawicki Oct 14, 2024

sfc-gh-jmichalak Oct 15, 2024

sfc-gh-asawicki Oct 18, 2024

github-actions bot commented Oct 17, 2024

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

feat: Upgrade tag SDK #3126

feat: Upgrade tag SDK #3126

Conversation

sfc-gh-jmichalak commented Oct 10, 2024 • edited Loading

Test Plan

References

TODO

github-actions bot commented Oct 10, 2024

github-actions bot commented Oct 11, 2024

github-actions bot commented Oct 11, 2024

github-actions bot commented Oct 11, 2024

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

sfc-gh-jmichalak Oct 15, 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

Choose a reason for hiding this comment

github-actions bot commented Oct 17, 2024

github-actions bot commented Oct 21, 2024

github-actions bot commented Oct 21, 2024

sfc-gh-jmichalak commented Oct 10, 2024 •

edited

Loading

sfc-gh-jmichalak Oct 15, 2024 •

edited

Loading