Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix] Fix drift in databricks_cluster when is_single_node is set to true #4416

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Fix] Fix drift in databricks_cluster when is_single_node is set to true #4416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 55 additions & 6 deletions clusters/resource_cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,17 @@ const (

func ResourceCluster() common.Resource {
return common.Resource{
Create: resourceClusterCreate,
Read: resourceClusterRead,
Update: resourceClusterUpdate,
Delete: resourceClusterDelete,
Schema: clusterSchema,
Create: resourceClusterCreate,
Read: resourceClusterRead,
Update: resourceClusterUpdate,
Delete: resourceClusterDelete,
Schema: clusterSchema,
CustomizeDiff: func(ctx context.Context, d *schema.ResourceDiff) error {
if isSingleNode, ok := d.GetOk("is_single_node"); ok && isSingleNode.(bool) {
return singleNodeClusterChangesCustomizeDiff(d)
}
return nil
},
SchemaVersion: clusterSchemaVersion,
Timeouts: resourceClusterTimeouts(),
StateUpgraders: []schema.StateUpgrader{
Expand All @@ -48,6 +54,48 @@ func ResourceCluster() common.Resource {
}
}

// the API automatically sets the `ResourceClass` key in `custom_tags` and two other keys in the `spark_conf`.
// If the user hasn't set these explicitly in their config, the plan marks these keys for removal.
// This method copies the values for these keys from state to the plan.
// This needs to be done in addition to setting these attributes as computed; otherwise, this customization
// won't take effect for users who have set additional `spark_conf` or `custom_tags`.
func singleNodeClusterChangesCustomizeDiff(d *schema.ResourceDiff) error {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, let's include documentation comments for any methods or complex logic. Here's a suggestion:

Suggested change
func singleNodeClusterChangesCustomizeDiff(d *schema.ResourceDiff) error {
// singleNodeClusterChangesCustomizeDiff adjusts the plan when `is_single_node` is `true`. When this happens,
// the API automatically sets the `ResourceClass` key in `custom_tags` and two other keys in the `spark_conf`.
// If the user hasn't set these explicitly in their config, the plan marks these keys for removal.
// This method copies the values for these keys from state to the plan.
// This needs to be done in addition to setting these attributes as computed; otherwise, this customization
// won't take effect for users who have set additional `spark_conf` or `custom_tags`.
func singleNodeClusterChangesCustomizeDiff(d *schema.ResourceDiff) error {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 🙌

autoConfigAttributes := map[string][]string{
"custom_tags": {"ResourceClass"},
"spark_conf": {"spark.databricks.cluster.profile", "spark.master"},
}

for key, attributes := range autoConfigAttributes {
if !d.HasChange(key) {
continue
}

o, n := d.GetChange(key)
old, okOld := o.(map[string]interface{})
new, okNew := n.(map[string]interface{})

if !okNew || !okOld {
return fmt.Errorf("internal type casting error n: %T, o: %T", n, o)
}

log.Printf("[DEBUG] values for key %s, old: %v, new: %v", key, old, new)

for _, attribute := range attributes {
if _, exists := new[attribute]; exists && new[attribute] != nil {
continue
}

new[attribute] = old[attribute]
}

if err := d.SetNew(key, new); err != nil {
return err
}
}

return nil
}

func clusterSchemaV0() cty.Type {
return (&schema.Resource{
Schema: clusterSchema}).CoreConfigSchema().ImpliedType()
Expand Down Expand Up @@ -346,7 +394,8 @@ func (ClusterSpec) CustomizeSchema(s *common.CustomizableSchema) *common.Customi
s.SchemaPath("docker_image", "url").SetRequired()
s.SchemaPath("docker_image", "basic_auth", "password").SetRequired().SetSensitive()
s.SchemaPath("docker_image", "basic_auth", "username").SetRequired()
s.SchemaPath("spark_conf").SetCustomSuppressDiff(SparkConfDiffSuppressFunc)
s.SchemaPath("spark_conf").SetCustomSuppressDiff(SparkConfDiffSuppressFunc).SetComputed().SetOptional()
s.SchemaPath("custom_tags").SetComputed().SetOptional()
s.SchemaPath("aws_attributes").SetSuppressDiff().SetConflictsWith([]string{"azure_attributes", "gcp_attributes"})
s.SchemaPath("aws_attributes", "zone_id").SetCustomSuppressDiff(ZoneDiffSuppress)
s.SchemaPath("azure_attributes").SetSuppressDiff().SetConflictsWith([]string{"aws_attributes", "gcp_attributes"})
Expand Down
106 changes: 106 additions & 0 deletions clusters/resource_cluster_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"github.com/databricks/databricks-sdk-go/service/compute"
"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/require"
)
Expand Down Expand Up @@ -1630,6 +1631,111 @@ func TestResourceClusterCreate_SingleNode(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, 0, d.Get("num_workers"))
}

func TestResourceClusterCreate_SingleNodeAutoPropertiesCustomizeDiff(t *testing.T) {
testCases := []struct {
name string
hcl string
instanceState map[string]string
expectedDiff map[string]*terraform.ResourceAttrDiff
}{
{
"resource with no custom_tags or spark_conf",
"",
map[string]string{
"custom_tags.ResourceClass": "SingleNode",
"spark_conf.spark.master": "local[*]",
"spark_conf.spark.databricks.cluster.profile": "singleNode",
},
nil,
},
{
"resource with custom_tags and spark_conf",
`custom_tags = {
"ClusterName" = "SingleNode"
}
spark_conf = {
"spark.databricks.delta.preview.enabled" = "true"
}`,
map[string]string{
"custom_tags.ClusterName": "SingleNode",
"custom_tags.ResourceClass": "SingleNode",
"spark_conf.spark.master": "local[*]",
"spark_conf.spark.databricks.cluster.profile": "singleNode",
"spark_conf.spark.databricks.delta.preview.enabled": "true",
},
nil,
},
{
"resource with custom_tags and spark_conf changes",
`custom_tags = {
"ClusterName" = "MonoNode"
}
spark_conf = {
"spark.databricks.delta.preview.enabled" = "false"
}`,
map[string]string{
"custom_tags.ClusterName": "SingleNode",
"custom_tags.ResourceClass": "SingleNode",
"spark_conf.spark.master": "local[*]",
"spark_conf.spark.databricks.cluster.profile": "singleNode",
"spark_conf.spark.databricks.delta.preview.enabled": "true",
},
map[string]*terraform.ResourceAttrDiff{
"custom_tags.ClusterName": {New: "MonoNode", Old: "SingleNode"},
"spark_conf.spark.databricks.delta.preview.enabled": {New: "false", Old: "true"},
},
},
}
for _, testCase := range testCases {
t.Run(testCase.name, func(t *testing.T) {
expectedDiff := testCase.expectedDiff

if expectedDiff == nil {
expectedDiff = make(map[string]*terraform.ResourceAttrDiff)
}

expectedDiff["default_tags.%"] = &terraform.ResourceAttrDiff{Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false}
expectedDiff["driver_instance_pool_id"] = &terraform.ResourceAttrDiff{Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false}
expectedDiff["driver_node_type_id"] = &terraform.ResourceAttrDiff{Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false}
expectedDiff["enable_elastic_disk"] = &terraform.ResourceAttrDiff{Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false}
expectedDiff["enable_local_disk_encryption"] = &terraform.ResourceAttrDiff{Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false}
expectedDiff["state"] = &terraform.ResourceAttrDiff{Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false}
expectedDiff["url"] = &terraform.ResourceAttrDiff{Old: "", New: "", NewComputed: true, NewRemoved: false, RequiresNew: false, Sensitive: false}

instanceState := testCase.instanceState
instanceState["cluster_id"] = "abc"
instanceState["autotermination_minutes"] = "60"
instanceState["cluster_name"] = "Single Node Cluster"
instanceState["data_security_mode"] = "SINGLE_USER"
instanceState["spark_version"] = "15.4.x-scala2.12"
instanceState["single_user_name"] = "testuser"
instanceState["runtime_engine"] = "STANDARD"
instanceState["num_workers"] = "0"
instanceState["node_type_id"] = "Standard_F4s"
instanceState["kind"] = "CLASSIC_PREVIEW"
instanceState["is_single_node"] = "true"
Comment on lines +1698 to +1717
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a fan of this; if there's a way to simplify this please lemme know


qa.ResourceFixture{
HCL: `
spark_version = "15.4.x-scala2.12"
runtime_engine = "STANDARD"
node_type_id = "Standard_F4s"
kind = "CLASSIC_PREVIEW"
cluster_name = "Single Node Cluster"
data_security_mode = "SINGLE_USER"
autotermination_minutes = 60
is_single_node = true
single_user_name = "testuser"
` + testCase.hcl,
InstanceState: instanceState,
ExpectedDiff: expectedDiff,
Resource: ResourceCluster(),
}.ApplyNoError(t)
})
}
}

func TestResourceClusterCreate_NegativeNumWorkers(t *testing.T) {
_, err := qa.ResourceFixture{
Create: true,
Expand Down