feat: Add secret to sdk #3091

sfc-gh-fbudzynski · 2024-09-19T09:02:16Z

Changes

Changed name of Secret struct in common_types.go due to naming clash
Added Secret Object to SDK
Unit and integration tests

References

CREATE SECRET

github-actions · 2024-09-19T10:42:02Z

Integration tests failure for 01a70062a3b2aed8351229d43d94e520ec3c1e05

github-actions · 2024-09-19T11:16:54Z

Integration tests failure for 929c810a42e5eade5724b107bb10432ed35e376b

github-actions · 2024-09-19T13:31:10Z

Integration tests failure for 8c5dcfb3ad8ad5d7394d32c8c8f6896697c5e498

pkg/acceptance/helpers/secret_client.go

pkg/sdk/secrets_def.go

pkg/sdk/testint/secrets_gen_integration_test.go

sfc-gh-jmichalak

Overall a good first PR 👍

sfc-gh-jmichalak · 2024-09-19T12:18:12Z

pkg/acceptance/helpers/secret_client.go

+	return secret, c.CleanupSecretFunc(t, id)
+}
+
+func (c *SecretClient) CleanupSecretFunc(t *testing.T, id sdk.SchemaObjectIdentifier) func() {


Nit: In general, we name these functions like DropFunc. Also, Secret should be not present in function names.

sfc-gh-jmichalak · 2024-09-19T12:19:07Z

pkg/acceptance/helpers/secret_client.go

+	return func() {
+		_, err := c.client().ShowByID(ctx, id)
+		if errors.Is(err, sdk.ErrObjectNotExistOrAuthorized) {
+			return


Cool that you thought about checking an object here, but when we use IF EXISTS, this is not needed.

sfc-gh-jmichalak · 2024-09-19T12:25:33Z

pkg/sdk/secrets_def.go

+	Field("Owner", "string").
+	Field("Comment", "string").
+	Field("SecretType", "string").
+	Field("OauthScopes", "sql.NullString").


In general, we try to parse fields containing lists/objects in convert, so that they are available as slices in the object struct. So, this should be "[]string". The same applies to OauthScopes in SecretDetails.

sfc-gh-jmichalak · 2024-09-19T12:50:03Z

pkg/sdk/secrets_def.go

+	Field("OwnerRoleType", "string")
+
+var secretDetailsDbRow = g.DbStruct("secretDetailsDBRow").
+	Field("created_on", "string").


Why no Time()?

Have changed it to use Time() instead of string

sfc-gh-jmichalak · 2024-09-19T12:55:10Z

pkg/sdk/secrets_def.go

+		SQL("SECRET").
+		IfNotExists().
+		Name().
+		PredefinedQueryStructField("Type", "string", g.StaticOptions().SQL("TYPE = PASSWORD")).


Nit: rather than having this field exported, you could use a name like secretType. In other places as well.

sfc-gh-jmichalak · 2024-09-20T09:31:25Z

pkg/sdk/testint/secrets_gen_integration_test.go

+		assert.NotEmpty(t, s.DatabaseName)
+		assert.NotEmpty(t, s.SchemaName)
+		assert.NotEmpty(t, s.OwnerRoleType)
+		assert.NotEmpty(t, s.Owner)


Now we use generated asserts - check views integration tests.

Have generated them and used after the first review

sfc-gh-jmichalak · 2024-09-20T09:36:59Z

pkg/sdk/secrets_gen.go

+	SchemaName                  string
+	DatabaseName                string
+	Owner                       string
+	Comment                     sql.NullString


These sql.* types should be present only in dbRows - we want to separate things returned from Snowflake from things returned by the SDK. You can use *string here.

sfc-gh-jmichalak · 2024-09-20T09:41:49Z

pkg/sdk/testint/secrets_gen_integration_test.go

+			Name:                        id.Name(),
+			SecretType:                  "OAUTH2",
+			Comment:                     "a",
+			OauthRefreshTokenExpiryTime: stringDateToSnowflakeTimeFormat(time.DateOnly, refreshTokenExpiryTime),


@sfc-gh-jcieslak Do we have a helper function for comparing time? If not, this could be moved to helpers somewhere.

I don't think so, time is more complicated topic, that's why for a long time we avoided parsing time from SHOW and just saved it as strings (I'm not sure if we should keep doing that instead of having time.Time). Mostly, because in some cases Snowflake outputs strange time formats that are non-standard and hard to parse. It means this function will only apply to secrets and maybe other objects and it's not generic for all objects. For example, resource monitor's time format is totally different as far as I remember (you can check start or end time in SHOW for resource monitor). I'm wondering what should we do with this function, let's leave the thread open for now and I'll take a closer look at it in the 2nd round of review.

Let's leave it as it is right now, as a helper function just for secrets.

sfc-gh-jmichalak · 2024-09-20T09:45:40Z

pkg/sdk/testint/secrets_gen_integration_test.go

+					),
+			)
+		err := client.Secrets.Alter(ctx, setRequest)
+		require.NoError(t, err)


You're missing assert here.

sfc-gh-jmichalak · 2024-09-20T09:47:28Z

pkg/sdk/testint/secrets_gen_integration_test.go

+		require.Contains(t, returnedSecrets, *secretGenericString)
+	})
+
+	t.Run("Show: SecretWithOAuthClientCredentialsFlow with Like", func(t *testing.T) {


It's cool you've provided all of these cases, but I think that one case for each filtering option is enough (with an arbitrary type).

…aming clash

github-actions · 2024-09-24T09:56:07Z

Integration tests failure for 4ccc4e7c6e391151251af148c4f0d03d559d2344

pkg/sdk/secrets_gen_integration_test.go

pkg/sdk/secrets_validations_gen.go

pkg/sdk/testint/secrets_gen_integration_test.go

…validationType

github-actions · 2024-09-24T14:22:46Z

Integration tests failure for bdf2585574da6c6a5f77546015d0d107907aae1b

github-actions · 2024-09-25T10:09:12Z

Integration tests failure for 7791f33dae8de262967283156065ac9cee49972e

sfc-gh-fbudzynski force-pushed the add-secret-to-sdk branch from 929c810 to 8c5dcfb Compare September 19, 2024 11:43

sfc-gh-fbudzynski requested review from sfc-gh-jcieslak and sfc-gh-jmichalak September 19, 2024 12:05

sfc-gh-fbudzynski marked this pull request as ready for review September 19, 2024 12:12

sfc-gh-jcieslak reviewed Sep 20, 2024

View reviewed changes

sfc-gh-jmichalak requested changes Sep 20, 2024

View reviewed changes

sfc-gh-fbudzynski added 21 commits September 24, 2024 10:14

initial secret_def file for sdk

58d5794

naming changes to secret create options

f1488ca

create secrets and alter with two basic tests

752f924

unit tests for alter

d7ae12f

add tests for all four create types

57ca19a

rename previous secret to secretReference in common_types.go due to n…

8d55a63

…aming clash

secrets gen with drop, show and desc

9894799

all unit tests

e4a0827

init for integration tests

3bb8c85

added secret to client.go and created secret_client

4130618

added like and in to showByID for secret

fc85c66

init for integration tests

aa64511

secret_def changes

ab8bee1

tests for two methods of creating secret

3541c70

changed refresh token expiry time from string to time.Time

180a7ce

added remaining integration tests

7a9ad92

linter

0e9cf94

linting

deadc65

removing comment

235fbe5

mid review commit before generating assertions

73eeb63

rebase conflict resolved

bd0b64f

sfc-gh-fbudzynski added 6 commits September 24, 2024 10:15

tests pass after changing to []string for oauthScopes

2050b85

readded unit tests

59c7b14

added CreateApiAuthenticationWithRequest to security integration client

df7a8ff

changes to secret after review, all tests pass

eed310a

added assert for details

af2e030

linter hints applied

4ccc4e7

sfc-gh-fbudzynski force-pushed the add-secret-to-sdk branch from c8564af to 4ccc4e7 Compare September 24, 2024 08:18

sfc-gh-jcieslak reviewed Sep 24, 2024

View reviewed changes

sfc-gh-fbudzynski added 2 commits September 24, 2024 14:40

updated generator README with validation issue for ConflictingFields …

34983af

…validationType

updated after re-review

bdf2585

sfc-gh-jcieslak previously approved these changes Sep 25, 2024

View reviewed changes

test changed to use errMoreThanOneOf

7791f33

sfc-gh-fbudzynski dismissed sfc-gh-jcieslak’s stale review via 7791f33 September 25, 2024 08:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add secret to sdk #3091

feat: Add secret to sdk #3091

sfc-gh-fbudzynski commented Sep 19, 2024 •

edited

Loading

github-actions bot commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

sfc-gh-jmichalak left a comment

sfc-gh-jmichalak Sep 19, 2024

sfc-gh-jmichalak Sep 19, 2024

sfc-gh-jmichalak Sep 19, 2024

sfc-gh-jmichalak Sep 19, 2024

sfc-gh-fbudzynski Sep 26, 2024

sfc-gh-jmichalak Sep 19, 2024

sfc-gh-jmichalak Sep 20, 2024

sfc-gh-fbudzynski Sep 26, 2024

sfc-gh-jmichalak Sep 20, 2024

sfc-gh-jmichalak Sep 20, 2024

sfc-gh-jcieslak Sep 23, 2024 •

edited

Loading

sfc-gh-jcieslak Sep 24, 2024

sfc-gh-jmichalak Sep 20, 2024

sfc-gh-jmichalak Sep 20, 2024

github-actions bot commented Sep 24, 2024

github-actions bot commented Sep 24, 2024

github-actions bot commented Sep 25, 2024

feat: Add secret to sdk #3091

Are you sure you want to change the base?

feat: Add secret to sdk #3091

Conversation

sfc-gh-fbudzynski commented Sep 19, 2024 • edited Loading

Changes

References

github-actions bot commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

github-actions bot commented Sep 19, 2024

sfc-gh-jmichalak left a 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

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-jcieslak Sep 23, 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

github-actions bot commented Sep 24, 2024

github-actions bot commented Sep 24, 2024

github-actions bot commented Sep 25, 2024

sfc-gh-fbudzynski commented Sep 19, 2024 •

edited

Loading

sfc-gh-jcieslak Sep 23, 2024 •

edited

Loading