add 'debug states' command

Author: denik

acceptance/bundle/state/state_present/output.txt

@@ -102,3 +102,13 @@ Deployment complete!
 
 >>> print_requests.py --get //api/2.1/unity-catalog/schemas
 "cli/[DEV_VERSION] databricks-sdk-go/[SDK_VERSION] go/[GO_VERSION] os/[OS] cmd/bundle_deploy cmd-exec-id/[UUID] engine/direct auth/pat"
+
+>>> DATABRICKS_BUNDLE_ENGINE= [CLI] bundle debug states
+[TEST_TMP_DIR]/.databricks/bundle/default/terraform/terraform.tfstate: local terraform state serial=3 lineage=""
+[TEST_TMP_DIR]/.databricks/bundle/default/resources.json: local direct state serial=10 lineage=""
+
+>>> DATABRICKS_BUNDLE_ENGINE= [CLI] bundle debug states --force-pull
+terraform.tfstate: remote terraform state serial=3 lineage=""
+[TEST_TMP_DIR]/.databricks/bundle/default/terraform/terraform.tfstate: local terraform state serial=3 lineage=""
+resources.json: remote direct state serial=10 lineage=""
+[TEST_TMP_DIR]/.databricks/bundle/default/resources.json: local direct state serial=10 lineage=""

acceptance/bundle/state/state_present/script

@@ -36,3 +36,8 @@ trace DATABRICKS_BUNDLE_ENGINE=terraform musterr $CLI bundle deploy
 
 trace DATABRICKS_BUNDLE_ENGINE= $CLI bundle deploy
 trace print_requests.py --get //api/2.1/unity-catalog/schemas | jq '.headers["User-Agent"][0]' | contains.py 'engine/direct' '!terraform' '!tf-provider'
+
+trace DATABRICKS_BUNDLE_ENGINE= $CLI bundle debug states
+trace DATABRICKS_BUNDLE_ENGINE= $CLI bundle debug states --force-pull
+
+rm out.requests.txt

bundle/statemgmt/state_pull.go

@@ -35,6 +35,8 @@ type StateDesc struct {
 
 	IsDirect bool `json:"-"`
 	IsLocal  bool `json:"-"`
+
+	AllStates []*StateDesc
 }
 
 func (s *StateDesc) String() string {
@@ -146,6 +148,7 @@ func PullResourcesState(ctx context.Context, b *bundle.Bundle, alwaysPull Always
 		}
 	} else {
 		winner = states[len(states)-1]
+		winner.AllStates = states
 	}
 
 	log.Infof(ctx, "Available resource state files (from least to most preferred): %v", states)

cmd/bundle/debug.go

@@ -16,5 +16,6 @@ func newDebugCommand() *cobra.Command {
 	cmd.AddCommand(debug.NewTerraformCommand())
 	cmd.AddCommand(debug.NewRefSchemaCommand())
 	cmd.AddCommand(debug.NewPlanCommand())
+	cmd.AddCommand(debug.NewStatesCommand())
 	return cmd
 }

cmd/bundle/debug/states.go

@@ -0,0 +1,47 @@
+package debug
+
+import (
+	"strings"
+
+	"github.com/databricks/cli/cmd/bundle/utils"
+	"github.com/databricks/cli/cmd/root"
+	"github.com/databricks/cli/libs/cmdio"
+	"github.com/spf13/cobra"
+)
+
+func NewStatesCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "states",
+		Short: "Show available state files",
+		Args:  root.NoArgs,
+	}
+
+	var forcePull bool
+	cmd.Flags().BoolVar(&forcePull, "force-pull", false, "Skip local cache and load the state from the remote workspace")
+
+	cmd.RunE = func(cmd *cobra.Command, args []string) error {
+		opts := utils.ProcessOptions{
+			// when using filers must run Initialize() phase otherwise some paths are not present and this happens:
+			// Error: reading terraform.tfstate: opening: relative path escapes root: terraform.tfstate
+			SkipInitialize: !forcePull,
+			ReadState:      true,
+			AlwaysPull:     forcePull,
+		}
+
+		_, stateDesc, err := utils.ProcessBundleRet(cmd, opts)
+		ctx := cmd.Context()
+
+		if err != nil {
+			return err
+		}
+
+		var stateStrs []string
+		for _, state := range stateDesc.AllStates {
+			stateStrs = append(stateStrs, state.String())
+		}
+		cmdio.LogString(ctx, strings.Join(stateStrs, "\n"))
+		return nil
+	}
+
+	return cmd
+}