feat: Go Generator + Network Policy migration to the new SDK (#2061)

Makefile

@@ -101,3 +101,22 @@ clean-generator-poc:
 	rm -f ./pkg/sdk/poc/example/*_gen.go
 	rm -f ./pkg/sdk/poc/example/*_gen_test.go
 .PHONY: run-generator-poc
+
+# TODO Below run-generator-% script won't generate, because there's some complications with the syntax and order how it runs
+#run-generator-%: ./pkg/sdk/%_def.go ## Run go generate on definition
+#	go generate ./pkg/sdk/$*_def.go && go generate ./pkg/sdk/$*_dto_gen.go
+#
+#clean-generator-%: ./pkg/sdk/%_*_gen.go ## Clean generated files for specified resource
+#	rm -f ./pkg/sdk/$*_*_gen.go
+
+# TODO For now use those like this => make file=network_policies clean-generator run-generator
+clean-generator: ## Remove generated files and tests for given ${file}
+	rm -f ./pkg/sdk/${file}*_gen.go
+	rm -f ./pkg/sdk/${file}*_gen_test.go
+	rm -f ./pkg/sdk/${file}*_gen_integration_test.go
+.PHONY: clean-generator
+
+run-generator: ## Generate files and tests for given ${file}
+	go generate ./pkg/sdk/${file}_def.go
+	go generate ./pkg/sdk/${file}_dto_gen.go
+.PHONY: run-generator

go.mod

@@ -20,6 +20,7 @@ require (
 	github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a
 	golang.org/x/crypto v0.7.0
 	golang.org/x/exp v0.0.0-20230315142452-642cacee5cc0
+	golang.org/x/text v0.8.0
 	golang.org/x/tools v0.7.0
 )
 
@@ -120,7 +121,6 @@ require (
 	golang.org/x/sync v0.1.0 // indirect
 	golang.org/x/sys v0.6.0 // indirect
 	golang.org/x/term v0.6.0 // indirect
-	golang.org/x/text v0.8.0 // indirect
 	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/genproto v0.0.0-20230306155012-7f2fa6fef1f4 // indirect

pkg/sdk/client.go

@@ -36,6 +36,7 @@ type Client struct {
 	FileFormats      FileFormats
 	Grants           Grants
 	MaskingPolicies  MaskingPolicies
+	NetworkPolicies  NetworkPolicies
 	Parameters       Parameters
 	PasswordPolicies PasswordPolicies
 	Pipes            Pipes
@@ -134,6 +135,7 @@ func (c *Client) initialize() {
 	c.FileFormats = &fileFormats{client: c}
 	c.Grants = &grants{client: c}
 	c.MaskingPolicies = &maskingPolicies{client: c}
+	c.NetworkPolicies = &networkPolicies{client: c}
 	c.Parameters = &parameters{client: c}
 	c.PasswordPolicies = &passwordPolicies{client: c}
 	c.Pipes = &pipes{client: c}

pkg/sdk/helper_test.go

@@ -722,3 +722,13 @@ func createStageWithURL(t *testing.T, client *Client, name AccountObjectIdentifi
 		require.NoError(t, err)
 	}
 }
+
+func createNetworkPolicy(t *testing.T, client *Client, req *CreateNetworkPolicyRequest) (error, func()) {
+	t.Helper()
+	ctx := context.Background()
+	err := client.NetworkPolicies.Create(ctx, req)
+	return err, func() {
+		err := client.NetworkPolicies.Drop(ctx, NewDropNetworkPolicyRequest(req.name))
+		require.NoError(t, err)
+	}
+}

pkg/sdk/network_policies_def.go

@@ -0,0 +1,92 @@
+package sdk
+
+import g "github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk/poc/generator"
+
+//go:generate go run ./poc/main.go
+
+var (
+	ip = g.QueryStruct("IP").
+		Text("IP", g.KeywordOptions().SingleQuotes().Required())
+
+	NetworkPoliciesDef = g.NewInterface(
+		"NetworkPolicies",
+		"NetworkPolicy",
+		g.KindOfT[AccountObjectIdentifier](),
+	).
+		CreateOperation(
+			"https://docs.snowflake.com/en/sql-reference/sql/create-network-policy",
+			g.QueryStruct("CreateNetworkPolicies").
+				Create().
+				OrReplace().
+				SQL("NETWORK POLICY").
+				Name().
+				ListQueryStructField("AllowedIpList", ip, g.ParameterOptions().SQL("ALLOWED_IP_LIST").Parentheses()).
+				ListQueryStructField("BlockedIpList", ip, g.ParameterOptions().SQL("BLOCKED_IP_LIST").Parentheses()).
+				OptionalTextAssignment("COMMENT", g.ParameterOptions().SingleQuotes()).
+				WithValidation(g.ValidIdentifier, "name"),
+		).
+		AlterOperation(
+			"https://docs.snowflake.com/en/sql-reference/sql/alter-network-policy",
+			g.QueryStruct("AlterNetworkPolicy").
+				Alter().
+				SQL("NETWORK POLICY").
+				IfExists().
+				Name().
+				OptionalQueryStructField(
+					"Set",
+					g.QueryStruct("NetworkPolicySet").
+						ListQueryStructField("AllowedIpList", ip, g.ParameterOptions().SQL("ALLOWED_IP_LIST").Parentheses()).
+						ListQueryStructField("BlockedIpList", ip, g.ParameterOptions().SQL("BLOCKED_IP_LIST").Parentheses()).
+						OptionalTextAssignment("COMMENT", g.ParameterOptions().SingleQuotes()).
+						WithValidation(g.AtLeastOneValueSet, "AllowedIpList", "BlockedIpList", "Comment"),
+					g.KeywordOptions().SQL("SET"),
+				).
+				OptionalSQL("UNSET COMMENT").
+				Identifier("RenameTo", g.KindOfTPointer[AccountObjectIdentifier](), g.IdentifierOptions().SQL("RENAME TO")).
+				WithValidation(g.ValidIdentifier, "name").
+				WithValidation(g.AtLeastOneValueSet, "Set", "UnsetComment", "RenameTo").
+				WithValidation(g.ValidIdentifierIfSet, "RenameTo"),
+		).
+		DropOperation(
+			"https://docs.snowflake.com/en/sql-reference/sql/drop-network-policy",
+			g.QueryStruct("DropNetworkPolicy").
+				Drop().
+				SQL("NETWORK POLICY").
+				IfExists().
+				Name().
+				WithValidation(g.ValidIdentifier, "name"),
+		).
+		ShowOperation(
+			"https://docs.snowflake.com/en/sql-reference/sql/show-network-policies",
+			g.DbStruct("showNetworkPolicyDBRow").
+				Field("created_on", "string").
+				Field("name", "string").
+				Field("comment", "string").
+				Field("entries_in_allowed_ip_list", "int").
+				Field("entries_in_blocked_ip_list", "int"),
+			g.PlainStruct("NetworkPolicy").
+				Field("CreatedOn", "string").
+				Field("Name", "string").
+				Field("Comment", "string").
+				Field("EntriesInAllowedIpList", "int").
+				Field("EntriesInBlockedIpList", "int"),
+			g.QueryStruct("ShowNetworkPolicies").
+				Show().
+				SQL("NETWORK POLICIES"),
+		).
+		DescribeOperation(
+			g.DescriptionMappingKindSlice,
+			"https://docs.snowflake.com/en/sql-reference/sql/desc-network-policy",
+			g.DbStruct("describeNetworkPolicyDBRow").
+				Field("name", "string").
+				Field("value", "string"),
+			g.PlainStruct("NetworkPolicyDescription").
+				Field("Name", "string").
+				Field("Value", "string"),
+			g.QueryStruct("DescribeNetworkPolicy").
+				Describe().
+				SQL("NETWORK POLICY").
+				Name().
+				WithValidation(g.ValidIdentifier, "name"),
+		)
+)

pkg/sdk/network_policies_dto_gen.go

@@ -0,0 +1,48 @@
+package sdk
+
+//go:generate go run ./dto-builder-generator/main.go
+
+var (
+	_ optionsProvider[CreateNetworkPolicyOptions]   = new(CreateNetworkPolicyRequest)
+	_ optionsProvider[AlterNetworkPolicyOptions]    = new(AlterNetworkPolicyRequest)
+	_ optionsProvider[DropNetworkPolicyOptions]     = new(DropNetworkPolicyRequest)
+	_ optionsProvider[ShowNetworkPolicyOptions]     = new(ShowNetworkPolicyRequest)
+	_ optionsProvider[DescribeNetworkPolicyOptions] = new(DescribeNetworkPolicyRequest)
+)
+
+type CreateNetworkPolicyRequest struct {
+	OrReplace     *bool
+	name          AccountObjectIdentifier // required
+	AllowedIpList []IPRequest
+	BlockedIpList []IPRequest
+	Comment       *string
+}
+
+type IPRequest struct {
+	IP string // required
+}
+
+type AlterNetworkPolicyRequest struct {
+	IfExists     *bool
+	name         AccountObjectIdentifier // required
+	Set          *NetworkPolicySetRequest
+	UnsetComment *bool
+	RenameTo     *AccountObjectIdentifier
+}
+
+type NetworkPolicySetRequest struct {
+	AllowedIpList []IPRequest
+	BlockedIpList []IPRequest
+	Comment       *string
+}
+
+type DropNetworkPolicyRequest struct {
+	IfExists *bool
+	name     AccountObjectIdentifier // required
+}
+
+type ShowNetworkPolicyRequest struct{}
+
+type DescribeNetworkPolicyRequest struct {
+	name AccountObjectIdentifier // required
+}