Fix yaml sync snapshot when bundle is deployed without any resources

Author: ilyakuz-db

acceptance/bundle/config-remote-sync/empty_deploy/databricks.yml.tmpl

@@ -0,0 +1,2 @@
+bundle:
+  name: test-bundle-$UNIQUE_NAME

acceptance/bundle/config-remote-sync/empty_deploy/output.txt

@@ -0,0 +1,11 @@
+
+>>> [CLI] bundle deploy
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/default/files...
+Deploying resources...
+Deployment complete!
+
+>>> [CLI] bundle destroy --auto-approve
+All files and directories at the following location will be deleted: /Workspace/Users/[USERNAME]/.bundle/test-bundle-[UNIQUE_NAME]/default
+
+Deleting files...
+Destroy complete!

acceptance/bundle/config-remote-sync/empty_deploy/script

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+envsubst < databricks.yml.tmpl > databricks.yml
+
+cleanup() {
+  trace $CLI bundle destroy --auto-approve
+}
+trap cleanup EXIT
+
+trace $CLI bundle deploy

acceptance/bundle/config-remote-sync/empty_deploy/test.toml

@@ -0,0 +1,10 @@
+Cloud = true
+
+RecordRequests = false
+Ignore = [".databricks", "databricks.yml"]
+
+[Env]
+DATABRICKS_BUNDLE_ENABLE_EXPERIMENTAL_YAML_SYNC = "true"
+
+[EnvMatrix]
+DATABRICKS_BUNDLE_ENGINE = ["terraform"]

bundle/statemgmt/upload_state_for_yaml_sync.go

@@ -54,8 +54,8 @@ func (m *uploadStateForYamlSync) Apply(ctx context.Context, b *bundle.Bundle) di
 
 	_, snapshotPath := b.StateFilenameConfigSnapshot(ctx)
 
-	diags := m.convertState(ctx, b, snapshotPath)
-	if diags.HasError() {
+	created, diags := m.convertState(ctx, b, snapshotPath)
+	if diags.HasError() || !created {
 		return diags
 	}
 
@@ -92,10 +92,22 @@ func uploadState(ctx context.Context, b *bundle.Bundle) error {
 	return nil
 }
 
-func (m *uploadStateForYamlSync) convertState(ctx context.Context, b *bundle.Bundle, snapshotPath string) (diags diag.Diagnostics) {
+func (m *uploadStateForYamlSync) convertState(ctx context.Context, b *bundle.Bundle, snapshotPath string) (bool, diag.Diagnostics) {
 	terraformResources, err := terraform.ParseResourcesState(ctx, b)
 	if err != nil {
-		return diag.FromErr(err)
+		return false, diag.FromErr(fmt.Errorf("failed to parse terraform state for config snapshot: %w", err))
+	}
+
+	// ParseResourcesState returns nil when the terraform state file doesn't exist
+	// (e.g. first deploy with no resources).
+	if terraformResources == nil {
+		return false, nil
+	}
+
+	_, localTerraformPath := b.StateFilenameTerraform(ctx)
+	data, err := os.ReadFile(localTerraformPath)
+	if err != nil {
+		return false, diag.FromErr(fmt.Errorf("failed to read terraform state for config snapshot: %w", err))
 	}
 
 	state := make(map[string]dstate.ResourceEntry)
@@ -111,18 +123,12 @@ func (m *uploadStateForYamlSync) convertState(ctx context.Context, b *bundle.Bun
 		}
 	}
 
-	_, localTerraformPath := b.StateFilenameTerraform(ctx)
-	data, err := os.ReadFile(localTerraformPath)
-	if err != nil {
-		return diag.FromErr(err)
-	}
-
 	var tfState struct {
 		Lineage string `json:"lineage"`
 		Serial  int    `json:"serial"`
 	}
 	if err := json.Unmarshal(data, &tfState); err != nil {
-		return diag.FromErr(err)
+		return false, diag.FromErr(err)
 	}
 
 	migratedDB := dstate.NewDatabase(tfState.Lineage, tfState.Serial+1)
@@ -141,26 +147,27 @@ func (m *uploadStateForYamlSync) convertState(ctx context.Context, b *bundle.Bun
 	interpolatedRoot := b.Config.Value()
 	uninterpolatedRoot, err := reverseInterpolate(interpolatedRoot)
 	if err != nil {
-		return diag.FromErr(fmt.Errorf("failed to reverse interpolation: %w", err))
+		return false, diag.FromErr(fmt.Errorf("failed to reverse interpolation: %w", err))
 	}
 
 	var uninterpolatedConfig config.Root
 	err = uninterpolatedConfig.Mutate(func(_ dyn.Value) (dyn.Value, error) {
 		return uninterpolatedRoot, nil
 	})
 	if err != nil {
-		return diag.FromErr(fmt.Errorf("failed to create uninterpolated config: %w", err))
+		return false, diag.FromErr(fmt.Errorf("failed to create uninterpolated config: %w", err))
 	}
 
 	plan, err := deploymentBundle.CalculatePlan(ctx, b.WorkspaceClient(), &uninterpolatedConfig, snapshotPath)
 	if err != nil {
-		return diag.FromErr(err)
+		return false, diag.FromErr(err)
 	}
 
 	for _, entry := range plan.Plan {
 		entry.Action = deployplan.Update
 	}
 
+	var diags diag.Diagnostics
 	for key := range plan.Plan {
 		etag := etags[key]
 		if etag == "" {
@@ -178,7 +185,7 @@ func (m *uploadStateForYamlSync) convertState(ctx context.Context, b *bundle.Bun
 
 	deploymentBundle.Apply(ctx, b.WorkspaceClient(), plan, direct.MigrateMode(true))
 
-	return diags
+	return true, diags
 }
 
 // reverseInterpolate reverses the terraform.Interpolate transformation.