Changes after review

Snowflake-Labs · Nov 13, 2023 · 7daba7a · 7daba7a
1 parent 8c0b058
commit 7daba7a
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 45 deletions.
diff --git a/pkg/sdk/poc/README.md b/pkg/sdk/poc/README.md
@@ -100,8 +100,12 @@ find a better solution to solve the issue (add more logic to the templates ?)
 - generate getters for requests, at least for identifier/name
 - generate integration tests in child package (because now we keep them in `testint` package)
 - struct_to_builder is not supporting templated-like values. See stages_def.go where in SQL there could be value, where 'n' can be replaced with any number
-  - SKIP_FILE_n - this looks more like keyword without a space between SQL prefix and int
-  - SKIP_FILE_n% (e.g. SKIP_FILE_123%) - this is more template-like behaviour, notice that 'n' is inside the value (we cannot reproduce that right now with struct_to_builder capabilities)
+  - `SKIP_FILE_n` - this looks more like keyword without a space between SQL prefix and int
+  - `SKIP_FILE_n%` (e.g. `SKIP_FILE_123%`) - this is more template-like behaviour, notice that 'n' is inside the value (we cannot reproduce that right now with struct_to_builder capabilities)
+- fix builder generation 
+  - we can add `flatten` option in cases where some sql structs had to be nested to create correct sql representation
+    - for example encryption options in `stages_def.go` (instead of calling `.WithEncryption(NewEncryptionRequest(encryption))` we could call `.WithEncryption(encryption)`)
+  - operation names (or their sql struct names) should dictate more how constructors are made
 
 ##### Known issues
 - generating two converts when Show and Desc use the same data structure

diff --git a/pkg/sdk/stages_dto_builders_gen.go b/pkg/sdk/stages_dto_builders_gen.go
diff --git a/pkg/sdk/stages_dto_gen.go b/pkg/sdk/stages_dto_gen.go
@@ -85,10 +85,10 @@ type ExternalS3StageParamsRequest struct {
 }
 
 type ExternalStageS3CredentialsRequest struct {
-	AwsKeyId     *string
-	AwsSecretKey *string
-	AwsToken     *string
-	AwsRole      *string
+	AWSKeyId     *string
+	AWSSecretKey *string
+	AWSToken     *string
+	AWSRole      *string
 }
 
 type ExternalStageS3EncryptionRequest struct {
@@ -186,8 +186,8 @@ type CreateOnS3CompatibleStageRequest struct {
 }
 
 type ExternalStageS3CompatibleCredentialsRequest struct {
-	AwsKeyId     *string // required
-	AwsSecretKey *string // required
+	AWSKeyId     *string // required
+	AWSSecretKey *string // required
 }
 
 type AlterStageRequest struct {

diff --git a/pkg/sdk/stages_gen.go b/pkg/sdk/stages_gen.go
@@ -96,10 +96,10 @@ type ExternalS3StageParams struct {
 }
 
 type ExternalStageS3Credentials struct {
-	AwsKeyId     *string `ddl:"parameter,single_quotes" sql:"AWS_KEY_ID"`
-	AwsSecretKey *string `ddl:"parameter,single_quotes" sql:"AWS_SECRET_KEY"`
-	AwsToken     *string `ddl:"parameter,single_quotes" sql:"AWS_TOKEN"`
-	AwsRole      *string `ddl:"parameter,single_quotes" sql:"AWS_ROLE"`
+	AWSKeyId     *string `ddl:"parameter,single_quotes" sql:"AWS_KEY_ID"`
+	AWSSecretKey *string `ddl:"parameter,single_quotes" sql:"AWS_SECRET_KEY"`
+	AWSToken     *string `ddl:"parameter,single_quotes" sql:"AWS_TOKEN"`
+	AWSRole      *string `ddl:"parameter,single_quotes" sql:"AWS_ROLE"`
 }
 
 type ExternalStageS3Encryption struct {
@@ -206,8 +206,8 @@ type CreateOnS3CompatibleStageOptions struct {
 }
 
 type ExternalStageS3CompatibleCredentials struct {
-	AwsKeyId     *string `ddl:"parameter,single_quotes" sql:"AWS_KEY_ID"`
-	AwsSecretKey *string `ddl:"parameter,single_quotes" sql:"AWS_SECRET_KEY"`
+	AWSKeyId     *string `ddl:"parameter,single_quotes" sql:"AWS_KEY_ID"`
+	AWSSecretKey *string `ddl:"parameter,single_quotes" sql:"AWS_SECRET_KEY"`
 }
 
 // AlterStageOptions is based on https://docs.snowflake.com/en/sql-reference/sql/alter-stage.

diff --git a/pkg/sdk/stages_gen_test.go b/pkg/sdk/stages_gen_test.go
@@ -100,7 +100,7 @@ func TestStages_CreateOnS3(t *testing.T) {
 		opts.ExternalStageParams = &ExternalS3StageParams{
 			StorageIntegration: &integrationId,
 			Credentials: &ExternalStageS3Credentials{
-				AwsRole: String("aws-role"),
+				AWSRole: String("aws-role"),
 			},
 		}
 		assertOptsInvalidJoinedErrors(t, opts, errOneOf(".ExternalStageParams", "StorageIntegration", "Credentials"))
@@ -110,8 +110,8 @@ func TestStages_CreateOnS3(t *testing.T) {
 		opts := defaultOpts()
 		opts.ExternalStageParams = &ExternalS3StageParams{
 			Credentials: &ExternalStageS3Credentials{
-				AwsKeyId: String("aws-key-id"),
-				AwsRole:  String("aws-role"),
+				AWSKeyId: String("aws-key-id"),
+				AWSRole:  String("aws-role"),
 			},
 		}
 		assertOptsInvalidJoinedErrors(t, opts, errOneOf(".ExternalStageParams.Credentials", "AwsKeyId", "AwsRole"))
@@ -144,9 +144,9 @@ func TestStages_CreateOnS3(t *testing.T) {
 		opts.ExternalStageParams = &ExternalS3StageParams{
 			Url: "some url",
 			Credentials: &ExternalStageS3Credentials{
-				AwsKeyId:     String("aws-key-id"),
-				AwsSecretKey: String("aws-secret-key"),
-				AwsToken:     String("aws-token"),
+				AWSKeyId:     String("aws-key-id"),
+				AWSSecretKey: String("aws-secret-key"),
+				AWSToken:     String("aws-token"),
 			},
 		}
 		opts.DirectoryTableOptions = &ExternalS3DirectoryTableOptions{
@@ -313,8 +313,8 @@ func TestStages_CreateOnS3Compatible(t *testing.T) {
 		opts.Url = "some url"
 		opts.Endpoint = "some endpoint"
 		opts.Credentials = &ExternalStageS3CompatibleCredentials{
-			AwsKeyId:     String("aws-key-id"),
-			AwsSecretKey: String("aws-secret-key"),
+			AWSKeyId:     String("aws-key-id"),
+			AWSSecretKey: String("aws-secret-key"),
 		}
 		opts.FileFormat = &StageFileFormat{
 			Type: &FileFormatTypeCSV,
@@ -471,7 +471,7 @@ func TestStages_AlterExternalS3Stage(t *testing.T) {
 		opts.ExternalStageParams = &ExternalS3StageParams{
 			StorageIntegration: &integrationId,
 			Credentials: &ExternalStageS3Credentials{
-				AwsRole: String("aws-role"),
+				AWSRole: String("aws-role"),
 			},
 		}
 		assertOptsInvalidJoinedErrors(t, opts, errOneOf(".ExternalStageParams", "StorageIntegration", "Credentials"))
@@ -481,8 +481,8 @@ func TestStages_AlterExternalS3Stage(t *testing.T) {
 		opts := defaultOpts()
 		opts.ExternalStageParams = &ExternalS3StageParams{
 			Credentials: &ExternalStageS3Credentials{
-				AwsKeyId: String("aws-key-id"),
-				AwsRole:  String("aws-role"),
+				AWSKeyId: String("aws-key-id"),
+				AWSRole:  String("aws-role"),
 			},
 		}
 		assertOptsInvalidJoinedErrors(t, opts, errOneOf(".ExternalStageParams.Credentials", "AwsKeyId", "AwsRole"))

diff --git a/pkg/sdk/stages_impl_gen.go b/pkg/sdk/stages_impl_gen.go
@@ -173,10 +173,10 @@ func (r *CreateOnS3StageRequest) toOpts() *CreateOnS3StageOptions {
 		}
 		if r.ExternalStageParams.Credentials != nil {
 			opts.ExternalStageParams.Credentials = &ExternalStageS3Credentials{
-				AwsKeyId:     r.ExternalStageParams.Credentials.AwsKeyId,
-				AwsSecretKey: r.ExternalStageParams.Credentials.AwsSecretKey,
-				AwsToken:     r.ExternalStageParams.Credentials.AwsToken,
-				AwsRole:      r.ExternalStageParams.Credentials.AwsRole,
+				AWSKeyId:     r.ExternalStageParams.Credentials.AWSKeyId,
+				AWSSecretKey: r.ExternalStageParams.Credentials.AWSSecretKey,
+				AWSToken:     r.ExternalStageParams.Credentials.AWSToken,
+				AWSRole:      r.ExternalStageParams.Credentials.AWSRole,
 			}
 		}
 		if r.ExternalStageParams.Encryption != nil {
@@ -357,8 +357,8 @@ func (r *CreateOnS3CompatibleStageRequest) toOpts() *CreateOnS3CompatibleStageOp
 	}
 	if r.Credentials != nil {
 		opts.Credentials = &ExternalStageS3CompatibleCredentials{
-			AwsKeyId:     r.Credentials.AwsKeyId,
-			AwsSecretKey: r.Credentials.AwsSecretKey,
+			AWSKeyId:     r.Credentials.AWSKeyId,
+			AWSSecretKey: r.Credentials.AWSSecretKey,
 		}
 	}
 	if r.DirectoryTableOptions != nil {
@@ -456,10 +456,10 @@ func (r *AlterExternalS3StageStageRequest) toOpts() *AlterExternalS3StageStageOp
 		}
 		if r.ExternalStageParams.Credentials != nil {
 			opts.ExternalStageParams.Credentials = &ExternalStageS3Credentials{
-				AwsKeyId:     r.ExternalStageParams.Credentials.AwsKeyId,
-				AwsSecretKey: r.ExternalStageParams.Credentials.AwsSecretKey,
-				AwsToken:     r.ExternalStageParams.Credentials.AwsToken,
-				AwsRole:      r.ExternalStageParams.Credentials.AwsRole,
+				AWSKeyId:     r.ExternalStageParams.Credentials.AWSKeyId,
+				AWSSecretKey: r.ExternalStageParams.Credentials.AWSSecretKey,
+				AWSToken:     r.ExternalStageParams.Credentials.AWSToken,
+				AWSRole:      r.ExternalStageParams.Credentials.AWSRole,
 			}
 		}
 		if r.ExternalStageParams.Encryption != nil {

diff --git a/pkg/sdk/stages_validations_gen.go b/pkg/sdk/stages_validations_gen.go
@@ -41,8 +41,8 @@ func (opts *CreateOnS3StageOptions) validate() error {
 			errs = append(errs, errOneOf("CreateOnS3StageOptions.ExternalStageParams", "StorageIntegration", "Credentials"))
 		}
 		if valueSet(opts.ExternalStageParams.Credentials) {
-			if everyValueSet(opts.ExternalStageParams.Credentials.AwsKeyId, opts.ExternalStageParams.Credentials.AwsRole) {
-				errs = append(errs, errOneOf("AlterExternalS3StageStageOptions.ExternalStageParams.Credentials", "AwsKeyId", "AwsRole"))
+			if everyValueSet(opts.ExternalStageParams.Credentials.AWSKeyId, opts.ExternalStageParams.Credentials.AWSRole) {
+				errs = append(errs, errOneOf("AlterExternalS3StageStageOptions.ExternalStageParams.Credentials", "AWSKeyId", "AWSRole"))
 			}
 		}
 	}
@@ -131,8 +131,8 @@ func (opts *AlterExternalS3StageStageOptions) validate() error {
 			errs = append(errs, errOneOf("AlterExternalS3StageStageOptions.ExternalStageParams", "StorageIntegration", "Credentials"))
 		}
 		if valueSet(opts.ExternalStageParams.Credentials) {
-			if everyValueSet(opts.ExternalStageParams.Credentials.AwsKeyId, opts.ExternalStageParams.Credentials.AwsRole) {
-				errs = append(errs, errOneOf("AlterExternalS3StageStageOptions.ExternalStageParams.Credentials", "AwsKeyId", "AwsRole"))
+			if everyValueSet(opts.ExternalStageParams.Credentials.AWSKeyId, opts.ExternalStageParams.Credentials.AWSRole) {
+				errs = append(errs, errOneOf("AlterExternalS3StageStageOptions.ExternalStageParams.Credentials", "AWSKeyId", "AWSRole"))
 			}
 		}
 	}