chore: Generate ID and ObjectType Show Object Methods

pkg/sdk/api_integrations_def.go

@@ -170,4 +170,4 @@ var ApiIntegrationsDef = g.NewInterface(
 			SQL("API INTEGRATION").
 			Name().
 			WithValidation(g.ValidIdentifier, "name"),
-	)
+	).HelperMethodID()

pkg/sdk/api_integrations_gen.go

@@ -130,10 +130,6 @@ type ApiIntegration struct {
 	CreatedOn time.Time
 }
 
-func (v *ApiIntegration) ID() AccountObjectIdentifier {
-	return NewAccountObjectIdentifier(v.Name)
-}
-
 // DescribeApiIntegrationOptions is based on https://docs.snowflake.com/en/sql-reference/sql/desc-integration.
 type DescribeApiIntegrationOptions struct {
 	describe       bool                    `ddl:"static" sql:"DESCRIBE"`
@@ -154,3 +150,7 @@ type ApiIntegrationProperty struct {
 	Value   string
 	Default string
 }
+
+func (v *ApiIntegration) ID() AccountObjectIdentifier {
+	return NewAccountObjectIdentifier(v.Name)
+}

pkg/sdk/notification_integrations_def.go

@@ -200,4 +200,4 @@ var NotificationIntegrationsDef = g.NewInterface(
 			SQL("NOTIFICATION INTEGRATION").
 			Name().
 			WithValidation(g.ValidIdentifier, "name"),
-	)
+	).HelperMethodID()

pkg/sdk/notification_integrations_gen.go

@@ -161,10 +161,6 @@ type NotificationIntegration struct {
 	CreatedOn        time.Time
 }
 
-func (v *NotificationIntegration) ID() AccountObjectIdentifier {
-	return NewAccountObjectIdentifier(v.Name)
-}
-
 // DescribeNotificationIntegrationOptions is based on https://docs.snowflake.com/en/sql-reference/sql/desc-integration.
 type DescribeNotificationIntegrationOptions struct {
 	describe                bool                    `ddl:"static" sql:"DESCRIBE"`
@@ -185,3 +181,7 @@ type NotificationIntegrationProperty struct {
 	Value   string
 	Default string
 }
+
+func (v *NotificationIntegration) ID() AccountObjectIdentifier {
+	return NewAccountObjectIdentifier(v.Name)
+}

pkg/sdk/poc/generator/helper_methods.go

@@ -0,0 +1,115 @@
+package generator
+
+import (
+	"fmt"
+	"log"
+)
+
+type objectIdentifier string
+
+const (
+	AccountObjectIdentifier             objectIdentifier = "AccountObjectIdentifier"
+	DatabaseObjectIdentifier            objectIdentifier = "DatabaseObjectIdentifier"
+	SchemaObjectIdentifier              objectIdentifier = "SchemaObjectIdentifier"
+	SchemaObjectIdentifierWithArguments objectIdentifier = "SchemaObjectIdentifierWithArguments"
+)
+
+func identifierStringToObjectIdentifier(s string) objectIdentifier {
+	switch s {
+	case "AccountObjectIdentifier":
+		return AccountObjectIdentifier
+	case "DatabaseObjectIdentifier":
+		return DatabaseObjectIdentifier
+	case "SchemaObjectIdentifier":
+		return SchemaObjectIdentifier
+	case "SchemaObjectIdentifierWithArguments":
+		return SchemaObjectIdentifierWithArguments
+	default:
+		return ""
+	}
+}
+
+type HelperMethod struct {
+	Name        string
+	StructName  string
+	ReturnValue string
+	ReturnType  string
+}
+
+func newHelperMethod(name, structName, returnValue string, returnType string) *HelperMethod {
+	return &HelperMethod{
+		Name:        name,
+		StructName:  structName,
+		ReturnValue: returnValue,
+		ReturnType:  returnType,
+	}
+}
+
+var requiredFieldsForIDMethodMapping map[objectIdentifier][]string = map[objectIdentifier][]string{
+	AccountObjectIdentifier:  {"Name"},
+	DatabaseObjectIdentifier: {"Name", "DatabaseName"},
+	SchemaObjectIdentifier:   {"Name", "DatabaseName", "SchemaName"},
+}
+
+func newIDHelperMethod(structName string, objectIdentifier objectIdentifier) *HelperMethod {
+	var args string
+	fields := requiredFieldsForIDMethodMapping[objectIdentifier]
+	for _, field := range fields {
+		args += fmt.Sprintf("v.%v, ", field)
+	}
+	returnValue := fmt.Sprintf("New%v(%v)", objectIdentifier, args)
+	return newHelperMethod("ID", structName, returnValue, string(objectIdentifier))
+}
+
+func newObjectTypeHelperMethod(structName string) *HelperMethod {
+	returnValue := fmt.Sprintf("ObjectType%v", structName)
+	return newHelperMethod("ObjectType", structName, returnValue, "ObjectType")
+}
+
+func containsFieldNames(fields []*Field, names ...string) bool {
+	fieldNames := map[string]any{}
+	for _, field := range fields {
+		fieldNames[field.Name] = nil
+	}
+
+	for _, name := range names {
+		if _, ok := fieldNames[name]; !ok {
+			return false
+		}
+	}
+	return true
+}
+
+func hasRequiredFieldsForIDMethod(operations []*Operation, structName string, requiredFields ...string) bool {
+	for _, op := range operations {
+		if op.Name != string(OperationKindShow) {
+			continue
+		}
+		for _, field := range op.HelperStructs {
+			if field.Name == structName {
+				return containsFieldNames(field.Fields, requiredFields...)
+			}
+		}
+		log.Printf("WARNING: Struct: '%s' not found in '%s' operation. Couldn't generate ID() helper method.", structName, OperationKindShow)
+	}
+	log.Printf("WARNING: Operation: '%s' not found. Couldn't generate ID() helper method.", OperationKindShow)
+	return false
+}
+
+// HelperMethodID adds a helper method "ID()" to the interface file that returns the ObjectIdentifier of the object
+func (i *Interface) HelperMethodID() *Interface {
+	identifierKind := identifierStringToObjectIdentifier(i.IdentifierKind)
+	requiredFields := requiredFieldsForIDMethodMapping[identifierKind]
+	if !hasRequiredFieldsForIDMethod(i.Operations, i.NameSingular, requiredFields...) {
+		log.Printf("WARNING: Struct '%s' does not contain needed fields to build ID() helper method. Create the method manually in _ext file or add missing one of required fields: %v.\n", i.NameSingular, requiredFields)
+		return i
+	}
+	i.HelperMethods = append(i.HelperMethods, newIDHelperMethod(i.NameSingular, identifierKind))
+	return i
+}
+
+// HelperMethodObjectType adds a helper method "ObjectType()" to the interface file that returns the ObjectType for the struct
+func (i *Interface) HelperMethodObjectType() *Interface {
+	i.HelperMethods = append(i.HelperMethods, newObjectTypeHelperMethod(i.NameSingular))
+	return i
+}

pkg/sdk/poc/generator/interface.go

@@ -10,6 +10,8 @@ type Interface struct {
 	Operations []*Operation
 	// IdentifierKind keeps identifier of the underlying object (e.g. DatabaseObjectIdentifier)
 	IdentifierKind string
+	// HelperMethods contains helper methods for the Interface file (i.e. ID(), ObjectType())
+	HelperMethods []*HelperMethod
 }
 
 func NewInterface(name string, nameSingular string, identifierKind string, operations ...*Operation) *Interface {

pkg/sdk/poc/generator/template_executors.go

@@ -22,6 +22,15 @@ func GenerateInterface(writer io.Writer, def *Interface) {
 			generateOptionsStruct(writer, o)
 		}
 	}
+	for _, m := range def.HelperMethods {
+		if m != nil {
+			generateHelperMethods(writer, m)
+		}
+	}
+}
+
+func generateHelperMethods(writer io.Writer, hm *HelperMethod) {
+	printTo(writer, HelperMethodTemplate, hm)
 }
 
 func generateOptionsStruct(writer io.Writer, operation *Operation) {

pkg/sdk/poc/generator/templates.go

@@ -24,6 +24,10 @@ var (
 	structTemplateContent string
 	StructTemplate, _     = template.New("structTemplate").Parse(structTemplateContent)
 
+	//go:embed templates/helper_method.tmpl
+	helperMethodTemplateContent string
+	HelperMethodTemplate, _     = template.New("helperMethodTemplate").Parse(helperMethodTemplateContent)
+
 	//go:embed templates/dto_declarations.tmpl
 	dtoDeclarationsTemplateContent string
 	DtoTemplate, _                 = template.New("dtoTemplate").Parse(dtoDeclarationsTemplateContent)

pkg/sdk/poc/generator/templates/helper_method.tmpl

@@ -0,0 +1,5 @@
+{{- /*gotype: github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk/poc/generator.HelperMethod*/ -}}
+
+func (v *{{ .StructName }}) {{ .Name }}() {{ .ReturnType }} {
+    return {{ .ReturnValue }}
+}

pkg/sdk/secrets_def.go

@@ -254,4 +254,5 @@ var SecretsDef = g.NewInterface(
 		SQL("SECRET").
 		Name().
 		WithValidation(g.ValidIdentifier, "name"),
-)
+).HelperMethodID().
+	HelperMethodObjectType()

pkg/sdk/secrets_gen.go

@@ -30,9 +30,11 @@ type CreateWithOAuthClientCredentialsFlowSecretOptions struct {
 	OauthScopes    *OauthScopesList        `ddl:"parameter,parentheses" sql:"OAUTH_SCOPES"`
 	Comment        *string                 `ddl:"parameter,single_quotes" sql:"COMMENT"`
 }
+
 type ApiIntegrationScope struct {
 	Scope string `ddl:"keyword,single_quotes"`
 }
+
 type OauthScopesList struct {
 	OauthScopesList []ApiIntegrationScope `ddl:"list,must_parentheses"`
 }
@@ -85,30 +87,37 @@ type AlterSecretOptions struct {
 	Set      *SecretSet             `ddl:"keyword" sql:"SET"`
 	Unset    *SecretUnset           `ddl:"keyword"`
 }
+
 type SecretSet struct {
 	Comment    *string     `ddl:"parameter,single_quotes" sql:"COMMENT"`
 	SetForFlow *SetForFlow `ddl:"keyword"`
 }
+
 type SetForFlow struct {
 	SetForOAuthClientCredentials *SetForOAuthClientCredentials `ddl:"keyword"`
 	SetForOAuthAuthorization     *SetForOAuthAuthorization     `ddl:"keyword"`
 	SetForBasicAuthentication    *SetForBasicAuthentication    `ddl:"keyword"`
 	SetForGenericString          *SetForGenericString          `ddl:"keyword"`
 }
+
 type SetForOAuthClientCredentials struct {
 	OauthScopes *OauthScopesList `ddl:"parameter,parentheses" sql:"OAUTH_SCOPES"`
 }
+
 type SetForOAuthAuthorization struct {
 	OauthRefreshToken           *string `ddl:"parameter,single_quotes" sql:"OAUTH_REFRESH_TOKEN"`
 	OauthRefreshTokenExpiryTime *string `ddl:"parameter,single_quotes" sql:"OAUTH_REFRESH_TOKEN_EXPIRY_TIME"`
 }
+
 type SetForBasicAuthentication struct {
 	Username *string `ddl:"parameter,single_quotes" sql:"USERNAME"`
 	Password *string `ddl:"parameter,single_quotes" sql:"PASSWORD"`
 }
+
 type SetForGenericString struct {
 	SecretString *string `ddl:"parameter,single_quotes" sql:"SECRET_STRING"`
 }
+
 type SecretUnset struct {
 	Comment *bool `ddl:"keyword" sql:"SET COMMENT = NULL"`
 }
@@ -128,6 +137,7 @@ type ShowSecretOptions struct {
 	Like    *Like       `ddl:"keyword" sql:"LIKE"`
 	In      *ExtendedIn `ddl:"keyword" sql:"IN"`
 }
+
 type secretDBRow struct {
 	CreatedOn     time.Time      `db:"created_on"`
 	Name          string         `db:"name"`
@@ -139,6 +149,7 @@ type secretDBRow struct {
 	OauthScopes   sql.NullString `db:"oauth_scopes"`
 	OwnerRoleType string         `db:"owner_role_type"`
 }
+
 type Secret struct {
 	CreatedOn     time.Time
 	Name          string
@@ -151,14 +162,6 @@ type Secret struct {
 	OwnerRoleType string
 }
 
-func (s *Secret) ID() SchemaObjectIdentifier {
-	return NewSchemaObjectIdentifier(s.DatabaseName, s.SchemaName, s.Name)
-}
-
-func (s *Secret) ObjectType() ObjectType {
-	return ObjectTypeSecret
-}
-
 // DescribeSecretOptions is based on https://docs.snowflake.com/en/sql-reference/sql/desc-secret.
 type DescribeSecretOptions struct {
 	describe bool                   `ddl:"static" sql:"DESCRIBE"`
@@ -193,3 +196,11 @@ type SecretDetails struct {
 	OauthScopes                 []string
 	IntegrationName             *string
 }
+
+func (v *Secret) ID() SchemaObjectIdentifier {
+	return NewSchemaObjectIdentifier(v.Name, v.DatabaseName, v.SchemaName)
+}
+
+func (v *Secret) ObjectType() ObjectType {
+	return ObjectTypeSecret
+}

pkg/sdk/streamlits_def.go

@@ -138,4 +138,4 @@ var StreamlitsDef = g.NewInterface(
 		SQL("STREAMLIT").
 		Name().
 		WithValidation(g.ValidIdentifier, "name"),
-)
+).HelperMethodID()

pkg/sdk/streamlits_gen.go

@@ -28,6 +28,7 @@ type CreateStreamlitOptions struct {
 	Title                      *string                     `ddl:"parameter,single_quotes" sql:"TITLE"`
 	Comment                    *string                     `ddl:"parameter,single_quotes" sql:"COMMENT"`
 }
+
 type ExternalAccessIntegrations struct {
 	ExternalAccessIntegrations []AccountObjectIdentifier `ddl:"list,must_parentheses"`
 }
@@ -42,6 +43,7 @@ type AlterStreamlitOptions struct {
 	Unset     *StreamlitUnset         `ddl:"list,no_parentheses" sql:"UNSET"`
 	RenameTo  *SchemaObjectIdentifier `ddl:"identifier" sql:"RENAME TO"`
 }
+
 type StreamlitSet struct {
 	RootLocation               *string                     `ddl:"parameter,single_quotes" sql:"ROOT_LOCATION"`
 	MainFile                   *string                     `ddl:"parameter,single_quotes" sql:"MAIN_FILE"`
@@ -50,6 +52,7 @@ type StreamlitSet struct {
 	Comment                    *string                     `ddl:"parameter,single_quotes" sql:"COMMENT"`
 	Title                      *string                     `ddl:"parameter,single_quotes" sql:"TITLE"`
 }
+
 type StreamlitUnset struct {
 	QueryWarehouse *bool `ddl:"keyword" sql:"QUERY_WAREHOUSE"`
 	Comment        *bool `ddl:"keyword" sql:"COMMENT"`
@@ -73,6 +76,7 @@ type ShowStreamlitOptions struct {
 	In         *In        `ddl:"keyword" sql:"IN"`
 	Limit      *LimitFrom `ddl:"keyword" sql:"LIMIT"`
 }
+
 type streamlitsRow struct {
 	CreatedOn      string         `db:"created_on"`
 	Name           string         `db:"name"`
@@ -85,6 +89,7 @@ type streamlitsRow struct {
 	UrlId          string         `db:"url_id"`
 	OwnerRoleType  string         `db:"owner_role_type"`
 }
+
 type Streamlit struct {
 	CreatedOn      string
 	Name           string
@@ -104,6 +109,7 @@ type DescribeStreamlitOptions struct {
 	streamlit bool                   `ddl:"static" sql:"STREAMLIT"`
 	name      SchemaObjectIdentifier `ddl:"identifier"`
 }
+
 type streamlitsDetailRow struct {
 	Name                       string         `db:"name"`
 	Title                      sql.NullString `db:"title"`
@@ -117,6 +123,7 @@ type streamlitsDetailRow struct {
 	ExternalAccessIntegrations string         `db:"external_access_integrations"`
 	ExternalAccessSecrets      string         `db:"external_access_secrets"`
 }
+
 type StreamlitDetail struct {
 	Name                       string
 	Title                      string
@@ -131,6 +138,6 @@ type StreamlitDetail struct {
 	ExternalAccessSecrets      string
 }
 
-func (s *Streamlit) ID() SchemaObjectIdentifier {
-	return NewSchemaObjectIdentifier(s.DatabaseName, s.SchemaName, s.Name)
+func (v *Streamlit) ID() SchemaObjectIdentifier {
+	return NewSchemaObjectIdentifier(v.DatabaseName, v.SchemaName, v.Name)
 }