Add CustomDiffFunc for health in sql_endpoint resources (#3227)

* update

* update

* update

* update

* update

* update

* update

* update

* update

* update

Author: edwardfeng-db

qa/testing.go

@@ -104,11 +104,13 @@ type ResourceFixture struct {
 	CommandMock common.CommandMock
 
 	// Set one of them to true to test the corresponding CRUD function for the
-	// terraform resource.
-	Create bool
-	Read   bool
-	Update bool
-	Delete bool
+	// terraform resource. Or set ExpectedDiff to skip execution and only test
+	// that the diff is expected.
+	Create       bool
+	Read         bool
+	Update       bool
+	Delete       bool
+	ExpectedDiff map[string]*terraform.ResourceAttrDiff
 
 	Removed     bool
 	ID          string
@@ -171,8 +173,10 @@ func (f ResourceFixture) prepareExecution(r *schema.Resource) (resourceCRUD, err
 			return nil, fmt.Errorf("ID must be set for Delete")
 		}
 		return resourceCRUD(r.DeleteContext).withId(f.ID), nil
+	case f.ExpectedDiff != nil:
+		return nil, nil
 	}
-	return nil, fmt.Errorf("no `Create|Read|Update|Delete: true` specificed")
+	return nil, fmt.Errorf("no `Create|Read|Update|Delete: true` or `ExpectedDiff` specified")
 }
 
 func (f ResourceFixture) setDatabricksEnvironmentForTest(client *common.DatabricksClient, host string) {
@@ -304,6 +308,10 @@ func (f ResourceFixture) Apply(t *testing.T) (*schema.ResourceData, error) {
 	}
 	ctx := context.Background()
 	diff, err := resource.Diff(ctx, is, resourceConfig, client)
+	if f.ExpectedDiff != nil {
+		assert.Equal(t, f.ExpectedDiff, diff.Attributes)
+		return nil, err
+	}
 	// TODO: f.Resource.Data(is) - check why it doesn't work
 	if err != nil {
 		return nil, err

qa/testing_test.go

@@ -106,7 +106,7 @@ var noopContextResource = common.Resource{
 
 func TestResourceFixture_ID(t *testing.T) {
 	_, err := ResourceFixture{}.prepareExecution(nil)
-	assert.EqualError(t, err, "no `Create|Read|Update|Delete: true` specificed")
+	assert.EqualError(t, err, "no `Create|Read|Update|Delete: true` or `ExpectedDiff` specified")
 
 	f := ResourceFixture{
 		Resource: noopResource,

sql/resource_sql_endpoint.go

@@ -145,5 +145,8 @@ func ResourceSqlEndpoint() common.Resource {
 			return w.Warehouses.DeleteById(ctx, d.Id())
 		},
 		Schema: s,
+		CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
+			return d.Clear("health")
+		},
 	}
 }

sql/resource_sql_endpoint_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/databricks/databricks-sdk-go/service/sql"
 	"github.com/databricks/terraform-provider-databricks/common"
 	"github.com/databricks/terraform-provider-databricks/qa"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
@@ -239,6 +240,37 @@ func TestResourceSQLEndpointUpdate(t *testing.T) {
 	assert.Equal(t, "d7c9d05c-7496-4c69-b089-48823edad40c", d.Get("data_source_id"))
 }
 
+// Testing the customizeDiff on clearing "health" diff is working as expected.
+func TestResourceSQLEndpointUpdateHealthNoDiff(t *testing.T) {
+	qa.ResourceFixture{
+		Resource: ResourceSqlEndpoint(),
+		ID:       "abc",
+		InstanceState: map[string]string{
+			"name":                 "foo",
+			"cluster_size":         "Small",
+			"auto_stop_mins":       "120",
+			"enable_photon":        "true",
+			"max_num_clusters":     "1",
+			"spot_instance_policy": "COST_OPTIMIZED",
+		},
+		ExpectedDiff: map[string]*terraform.ResourceAttrDiff{
+			"state":                     {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"odbc_params.#":             {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"num_clusters":              {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"num_active_sessions":       {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"jdbc_url":                  {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"id":                        {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"enable_serverless_compute": {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"data_source_id":            {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+			"creator_name":              {Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false},
+		},
+		HCL: `
+		name = "foo"
+  		cluster_size = "Small"
+		`,
+	}.ApplyNoError(t)
+}
+
 func TestResourceSQLEndpointDelete(t *testing.T) {
 	d, err := qa.ResourceFixture{
 		MockWorkspaceClientFunc: func(mwc *mocks.MockWorkspaceClient) {