Add remote modification check for dashboards

This change adds a mutator that checks if dashboards have been modified
remotely since the last bundle deployment. It compares the ETag of the
dashboard in the deployment state with the current ETag from the API.

If a dashboard has been modified remotely, it:
- Returns an error during deploy to prevent overwriting untracked changes
- Returns a warning during plan to inform the user

Users can bypass this check using `databricks bundle deploy --force`.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

Author: shreyas-goenka

bundle/deploy/terraform/check_dashboards_modified_remotely.go

@@ -16,9 +16,19 @@ type dashboardState struct {
 }
 
 func collectDashboardsFromState(ctx context.Context, b *bundle.Bundle) ([]dashboardState, error) {
-	state, err := ParseResourcesState(ctx, b)
-	if err != nil && state == nil {
-		return nil, err
+	var state ExportedResourcesMap
+	var err error
+	if b.DirectDeployment {
+		err := b.OpenStateFile(ctx)
+		if err != nil {
+			return nil, err
+		}
+		state = b.DeploymentBundle.StateDB.ExportState(ctx)
+	} else {
+		state, err = ParseResourcesState(ctx, b)
+		if err != nil && state == nil {
+			return nil, err
+		}
 	}
 
 	var dashboards []dashboardState
@@ -33,7 +43,9 @@ func collectDashboardsFromState(ctx context.Context, b *bundle.Bundle) ([]dashbo
 	return dashboards, nil
 }
 
-type checkDashboardsModifiedRemotely struct{}
+type checkDashboardsModifiedRemotely struct {
+	isPlan bool
+}
 
 func (l *checkDashboardsModifiedRemotely) Name() string {
 	return "CheckDashboardsModifiedRemotely"
@@ -45,11 +57,6 @@ func (l *checkDashboardsModifiedRemotely) Apply(ctx context.Context, b *bundle.B
 		return nil
 	}
 
-	if b.DirectDeployment {
-		// TODO: not implemented yet
-		return nil
-	}
-
 	// If the user has forced the deployment, skip this check.
 	if b.Config.Bundle.Force {
 		return nil
@@ -87,8 +94,14 @@ func (l *checkDashboardsModifiedRemotely) Apply(ctx context.Context, b *bundle.B
 			continue
 		}
 
+		// Downgrade this to a warning in plan mode.
+		severity := diag.Error
+		if l.isPlan {
+			severity = diag.Warning
+		}
+
 		diags = diags.Append(diag.Diagnostic{
-			Severity: diag.Error,
+			Severity: severity,
 			Summary:  fmt.Sprintf("dashboard %q has been modified remotely", dashboard.Name),
 			Detail: "" +
 				"This dashboard has been modified remotely since the last bundle deployment.\n" +
@@ -107,6 +120,6 @@ func (l *checkDashboardsModifiedRemotely) Apply(ctx context.Context, b *bundle.B
 	return diags
 }
 
-func CheckDashboardsModifiedRemotely() *checkDashboardsModifiedRemotely {
-	return &checkDashboardsModifiedRemotely{}
+func CheckDashboardsModifiedRemotely(isPlan bool) *checkDashboardsModifiedRemotely {
+	return &checkDashboardsModifiedRemotely{isPlan: isPlan}
 }

bundle/deploy/terraform/check_dashboards_modified_remotely_test.go

@@ -53,13 +53,13 @@ func TestCheckDashboardsModifiedRemotely_NoDashboards(t *testing.T) {
 		},
 	}
 
-	diags := bundle.Apply(context.Background(), b, CheckDashboardsModifiedRemotely())
+	diags := bundle.Apply(context.Background(), b, CheckDashboardsModifiedRemotely(false))
 	assert.Empty(t, diags)
 }
 
 func TestCheckDashboardsModifiedRemotely_FirstDeployment(t *testing.T) {
 	b := mockDashboardBundle(t)
-	diags := bundle.Apply(context.Background(), b, CheckDashboardsModifiedRemotely())
+	diags := bundle.Apply(context.Background(), b, CheckDashboardsModifiedRemotely(false))
 	assert.Empty(t, diags)
 }
 
@@ -82,7 +82,7 @@ func TestCheckDashboardsModifiedRemotely_ExistingStateNoChange(t *testing.T) {
 	b.SetWorkpaceClient(m.WorkspaceClient)
 
 	// No changes, so no diags.
-	diags := bundle.Apply(ctx, b, CheckDashboardsModifiedRemotely())
+	diags := bundle.Apply(ctx, b, CheckDashboardsModifiedRemotely(false))
 	assert.Empty(t, diags)
 }
 
@@ -105,7 +105,7 @@ func TestCheckDashboardsModifiedRemotely_ExistingStateChange(t *testing.T) {
 	b.SetWorkpaceClient(m.WorkspaceClient)
 
 	// The dashboard has changed, so expect an error.
-	diags := bundle.Apply(ctx, b, CheckDashboardsModifiedRemotely())
+	diags := bundle.Apply(ctx, b, CheckDashboardsModifiedRemotely(false))
 	if assert.Len(t, diags, 1) {
 		assert.Equal(t, diag.Error, diags[0].Severity)
 		assert.Equal(t, `dashboard "dash1" has been modified remotely`, diags[0].Summary)
@@ -128,13 +128,39 @@ func TestCheckDashboardsModifiedRemotely_ExistingStateFailureToGet(t *testing.T)
 	b.SetWorkpaceClient(m.WorkspaceClient)
 
 	// Unable to get the dashboard, so expect an error.
-	diags := bundle.Apply(ctx, b, CheckDashboardsModifiedRemotely())
+	diags := bundle.Apply(ctx, b, CheckDashboardsModifiedRemotely(false))
 	if assert.Len(t, diags, 1) {
 		assert.Equal(t, diag.Error, diags[0].Severity)
 		assert.Equal(t, `failed to get dashboard "dash1"`, diags[0].Summary)
 	}
 }
 
+func TestCheckDashboardsModifiedRemotely_ExistingStateChangePlanMode(t *testing.T) {
+	ctx := context.Background()
+
+	b := mockDashboardBundle(t)
+	writeFakeDashboardState(t, ctx, b)
+
+	// Mock the call to the API.
+	m := mocks.NewMockWorkspaceClient(t)
+	dashboardsAPI := m.GetMockLakeviewAPI()
+	dashboardsAPI.EXPECT().
+		GetByDashboardId(mock.Anything, "id1").
+		Return(&dashboards.Dashboard{
+			DisplayName: "My Special Dashboard",
+			Etag:        "1234",
+		}, nil).
+		Once()
+	b.SetWorkpaceClient(m.WorkspaceClient)
+
+	// The dashboard has changed, but in plan mode expect a warning instead of an error.
+	diags := bundle.Apply(ctx, b, CheckDashboardsModifiedRemotely(true))
+	if assert.Len(t, diags, 1) {
+		assert.Equal(t, diag.Warning, diags[0].Severity)
+		assert.Equal(t, `dashboard "dash1" has been modified remotely`, diags[0].Summary)
+	}
+}
+
 func writeFakeDashboardState(t *testing.T, ctx context.Context, b *bundle.Bundle) {
 	path, err := b.StateLocalPath(ctx)
 	require.NoError(t, err)