fixed deployment failing when the app in in deleting state

Author: varundeepsaini

bundle/deploy/prepare.go

@@ -0,0 +1,77 @@
+package deploy
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/databricks/cli/bundle"
+	"github.com/databricks/cli/libs/diag"
+	"github.com/databricks/cli/libs/log"
+	"github.com/databricks/databricks-sdk-go/apierr"
+	"github.com/databricks/databricks-sdk-go/retries"
+	"github.com/databricks/databricks-sdk-go/service/apps"
+)
+
+type prepareEnvironment struct{}
+
+func (p *prepareEnvironment) Name() string {
+	return "deploy:prepare-environment"
+}
+
+// Apply runs all pre-deployment environment preparation steps.
+func (p *prepareEnvironment) Apply(ctx context.Context, b *bundle.Bundle) diag.Diagnostics {
+	// Check for resources in transient states and wait for them to complete.
+	// This prevents deployment failures due to resources still being deleted.
+	if err := waitForAppsDeletion(ctx, b); err != nil {
+		return diag.FromErr(err)
+	}
+
+	return nil
+}
+
+// PrepareEnvironment returns a mutator that prepares the environment for deployment.
+// It runs checks and waits for resources in transient states before deployment proceeds.
+func PrepareEnvironment() bundle.Mutator {
+	return &prepareEnvironment{}
+}
+
+// waitForAppsDeletion waits for apps to be deleted if they are in DELETING state.
+func waitForAppsDeletion(ctx context.Context, b *bundle.Bundle) error {
+	if len(b.Config.Resources.Apps) == 0 {
+		return nil
+	}
+
+	w := b.WorkspaceClient()
+
+	for _, app := range b.Config.Resources.Apps {
+		appName := app.Name
+		if appName == "" {
+			continue
+		}
+
+		log.Debugf(ctx, "Checking status of app %s", appName)
+
+		_, err := retries.Poll(ctx, 5*time.Minute, func() (*struct{}, *retries.Err) {
+			appStatus, err := w.Apps.GetByName(ctx, appName)
+			if err != nil {
+				if apierr.IsMissing(err) {
+					return nil, nil
+				}
+				return nil, retries.Halt(err)
+			}
+
+			if appStatus.ComputeStatus.State == apps.ComputeStateDeleting {
+				log.Infof(ctx, "App %s is in DELETING state, waiting for it to be deleted...", appName)
+				return nil, retries.Continues("app is deleting")
+			}
+
+			return nil, nil
+		})
+		if err != nil {
+			return fmt.Errorf("failed to wait for app %s deletion: %w", appName, err)
+		}
+	}
+
+	return nil
+}

bundle/deploy/prepare_test.go

@@ -0,0 +1,129 @@
+package deploy
+
+import (
+	"context"
+	"testing"
+
+	"github.com/databricks/cli/bundle"
+	"github.com/databricks/cli/bundle/config"
+	"github.com/databricks/cli/bundle/config/resources"
+	"github.com/databricks/databricks-sdk-go/apierr"
+	"github.com/databricks/databricks-sdk-go/experimental/mocks"
+	"github.com/databricks/databricks-sdk-go/service/apps"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+)
+
+func TestWaitForAppsDeletion(t *testing.T) {
+	ctx := context.Background()
+	b := &bundle.Bundle{
+		Config: config.Root{
+			Resources: config.Resources{
+				Apps: map[string]*resources.App{
+					"my_app": {
+						App: apps.App{
+							Name: "my_app",
+						},
+					},
+				},
+			},
+		},
+	}
+
+	mwc := mocks.NewMockWorkspaceClient(t)
+	b.SetWorkpaceClient(mwc.WorkspaceClient)
+
+	appApi := mwc.GetMockAppsAPI()
+
+	appApi.EXPECT().GetByName(mock.Anything, "my_app").Return(&apps.App{
+		Name: "my_app",
+		ComputeStatus: &apps.ComputeStatus{
+			State: apps.ComputeStateDeleting,
+		},
+	}, nil).Once()
+
+	appApi.EXPECT().GetByName(mock.Anything, "my_app").Return(nil, &apierr.APIError{
+		StatusCode: 404,
+		Message:    "App not found",
+	}).Once()
+
+	err := waitForAppsDeletion(ctx, b)
+	require.NoError(t, err)
+}
+
+func TestWaitForAppsDeletion_NoApps(t *testing.T) {
+	ctx := context.Background()
+	b := &bundle.Bundle{
+		Config: config.Root{},
+	}
+
+	err := waitForAppsDeletion(ctx, b)
+	require.NoError(t, err)
+}
+
+func TestWaitForAppsDeletion_AppNotDeleting(t *testing.T) {
+	ctx := context.Background()
+	b := &bundle.Bundle{
+		Config: config.Root{
+			Resources: config.Resources{
+				Apps: map[string]*resources.App{
+					"my_app": {
+						App: apps.App{
+							Name: "my_app",
+						},
+					},
+				},
+			},
+		},
+	}
+
+	mwc := mocks.NewMockWorkspaceClient(t)
+	b.SetWorkpaceClient(mwc.WorkspaceClient)
+
+	appApi := mwc.GetMockAppsAPI()
+
+	appApi.EXPECT().GetByName(mock.Anything, "my_app").Return(&apps.App{
+		Name: "my_app",
+		ComputeStatus: &apps.ComputeStatus{
+			State: apps.ComputeStateActive,
+		},
+	}, nil).Once()
+
+	err := waitForAppsDeletion(ctx, b)
+	require.NoError(t, err)
+}
+
+func TestPrepareEnvironment(t *testing.T) {
+	ctx := context.Background()
+	b := &bundle.Bundle{
+		Config: config.Root{
+			Resources: config.Resources{
+				Apps: map[string]*resources.App{
+					"my_app": {
+						App: apps.App{
+							Name: "my_app",
+						},
+					},
+				},
+			},
+		},
+	}
+
+	mwc := mocks.NewMockWorkspaceClient(t)
+	b.SetWorkpaceClient(mwc.WorkspaceClient)
+
+	appApi := mwc.GetMockAppsAPI()
+
+	appApi.EXPECT().GetByName(mock.Anything, "my_app").Return(&apps.App{
+		Name: "my_app",
+		ComputeStatus: &apps.ComputeStatus{
+			State: apps.ComputeStateActive,
+		},
+	}, nil).Once()
+
+	m := PrepareEnvironment()
+	require.Equal(t, "deploy:prepare-environment", m.Name())
+
+	diags := m.Apply(ctx, b)
+	require.Empty(t, diags)
+}

bundle/phases/deploy.go

@@ -173,6 +173,7 @@ func Deploy(ctx context.Context, b *bundle.Bundle, outputHandler sync.OutputHand
 		permissions.ApplyWorkspaceRootPermissions(),
 		metrics.TrackUsedCompute(),
 		deploy.ResourcePathMkdir(),
+		deploy.PrepareEnvironment(),
 	)
 
 	if logdiag.HasError(ctx) {