Migrate databricks_cluster_policy data source to Go SDK (#2155)

Author: nkvuong

docs/data-sources/cluster_policy.md

@@ -34,5 +34,5 @@ Data source allows you to pick a cluster policy by the following attribute
 Data source exposes the following attributes:
 
 - `id` - The id of the cluster policy.
-* `definition` - Policy definition: JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policies.html#cluster-policy-definition).
-
+- `definition` - Policy definition: JSON document expressed in [Databricks Policy Definition Language](https://docs.databricks.com/administration-guide/clusters/policies.html#cluster-policy-definition).
+- `max_clusters_per_user` - Max number of clusters per user that can be active using this policy

policies/data_cluster_policy.go

@@ -2,53 +2,27 @@ package policies
 
 import (
 	"context"
-	"fmt"
 
-	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/databricks/databricks-sdk-go"
+	"github.com/databricks/terraform-provider-databricks/common"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-func getPolicy(ClusterPoliciesAPI ClusterPoliciesAPI, name string) (*ClusterPolicy, error) {
-	policyList, err := ClusterPoliciesAPI.List()
-	if err != nil {
-		return nil, err
-	}
-	for _, policy := range policyList {
-		if policy.Name == name {
-			return &policy, nil
-		}
-	}
-
-	return nil, fmt.Errorf("cluster policy '%s' wasn't found", name)
-}
-
 // DataSourceClusterPolicy returns information about cluster policy specified by name
 func DataSourceClusterPolicy() *schema.Resource {
-	return &schema.Resource{
-		Schema: map[string]*schema.Schema{
-			"name": {
-				Type:     schema.TypeString,
-				Required: true,
-			},
-			"definition": {
-				Type:     schema.TypeString,
-				Computed: true,
-			},
-			"max_clusters_per_user": {
-				Type:     schema.TypeInt,
-				Computed: true,
-			},
-		},
-		ReadContext: func(ctx context.Context, d *schema.ResourceData, m any) diag.Diagnostics {
-			ClusterPoliciesAPI := NewClusterPoliciesAPI(ctx, m)
-			policy, err := getPolicy(ClusterPoliciesAPI, d.Get("name").(string))
-			if err != nil {
-				return diag.FromErr(err)
-			}
-			d.SetId(policy.PolicyID)
-			d.Set("definition", policy.Definition)
-			d.Set("max_clusters_per_user", policy.MaxClustersPerUser)
-			return nil
-		},
-	}
+	return common.WorkspaceData(func(ctx context.Context, data *struct {
+		Id                 string `json:"id,omitempty" tf:"computed"`
+		Name               string `json:"name,omitempty" tf:"computed"`
+		Definition         string `json:"definition,omitempty" tf:"computed"`
+		MaxClustersPerUser int    `json:"max_clusters_per_user,omitempty" tf:"computed"`
+	}, w *databricks.WorkspaceClient) error {
+		policy, err := w.ClusterPolicies.GetByName(ctx, data.Name)
+		if err != nil {
+			return err
+		}
+		data.Id = policy.PolicyId
+		data.Definition = policy.Definition
+		data.MaxClustersPerUser = int(policy.MaxClustersPerUser)
+		return nil
+	})
 }

policies/data_cluster_policy_test.go

@@ -1,22 +1,18 @@
 package policies
 
 import (
-	"context"
 	"testing"
 
 	"github.com/databricks/databricks-sdk-go/apierr"
-	"github.com/databricks/terraform-provider-databricks/common"
 	"github.com/databricks/terraform-provider-databricks/qa"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
 )
 
 func TestDataSourceClusterPolicy(t *testing.T) {
-	d, err := qa.ResourceFixture{
+	qa.ResourceFixture{
 		Fixtures: []qa.HTTPFixture{
 			{
 				Method:   "GET",
-				Resource: "/api/2.0/policies/clusters/list",
+				Resource: "/api/2.0/policies/clusters/list?",
 				Response: ClusterPolicyList{
 					Policies: []ClusterPolicy{
 						{
@@ -32,37 +28,46 @@ func TestDataSourceClusterPolicy(t *testing.T) {
 		NonWritable: true,
 		Resource:    DataSourceClusterPolicy(),
 		ID:          ".",
-		State: map[string]any{
-			"name": "policy",
+		HCL:         `name = "policy"`,
+	}.ApplyAndExpectData(t, map[string]any{
+		"id":         "abc",
+		"definition": `{"abc":"123"}`,
+	})
+}
+
+func TestDataSourceClusterPolicyError(t *testing.T) {
+	qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/policies/clusters/list?",
+				Status:   404,
+				Response: apierr.APIError{
+					Message: "searching_error",
+				},
+			},
 		},
-	}.Apply(t)
-	require.NoError(t, err)
-	assert.Equal(t, "abc", d.Id())
-	assert.Equal(t, `{"abc":"123"}`, d.Get("definition").(string))
+		Read:        true,
+		NonWritable: true,
+		Resource:    DataSourceClusterPolicy(),
+		ID:          ".",
+		HCL:         `name = "policy"`,
+	}.ExpectError(t, "searching_error")
 }
 
 func TestDataSourceClusterPolicyNotFound(t *testing.T) {
-	qa.HTTPFixturesApply(t, []qa.HTTPFixture{
-		{
-			Method:   "GET",
-			Resource: "/api/2.0/policies/clusters/list",
-			Status:   404,
-			Response: apierr.APIError{
-				Message: "searching_error",
+	qa.ResourceFixture{
+		Fixtures: []qa.HTTPFixture{
+			{
+				Method:   "GET",
+				Resource: "/api/2.0/policies/clusters/list?",
+				Response: ClusterPolicyList{},
 			},
 		},
-		{
-			Method:   "GET",
-			Resource: "/api/2.0/policies/clusters/list",
-			Response: ClusterPolicyList{},
-		},
-	}, func(ctx context.Context, client *common.DatabricksClient) {
-		poolsAPI := NewClusterPoliciesAPI(ctx, client)
-
-		_, err := getPolicy(poolsAPI, "searching_error")
-		assert.EqualError(t, err, "searching_error")
-
-		_, err = getPolicy(poolsAPI, "unknown")
-		assert.EqualError(t, err, "cluster policy 'unknown' wasn't found")
-	})
+		Read:        true,
+		NonWritable: true,
+		Resource:    DataSourceClusterPolicy(),
+		ID:          ".",
+		HCL:         `name = "policy"`,
+	}.ExpectError(t, "Policy named 'policy' does not exist")
 }