Add endless-scrolling TUI table for interactive list commands

cmd/workspace/alerts/overrides.go

@@ -0,0 +1,28 @@
+package alerts
+
+import (
+	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
+	"github.com/databricks/databricks-sdk-go/service/sql"
+	"github.com/spf13/cobra"
+)
+
+func listOverride(listCmd *cobra.Command, _ *sql.ListAlertsRequest) {
+	// Template is the text-mode fallback for non-interactive/piped output.
+	// TableConfig drives the interactive TUI when the terminal supports it.
+	listCmd.Annotations["template"] = cmdio.Heredoc(`
+	{{range .}}{{green "%s" .Id}}	{{.DisplayName}}	{{.State}}
+	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+ tableview.Col("ID", func(a sql.ListAlertsResponseAlert) string { return a.Id }),
+ tableview.Col("Name", func(a sql.ListAlertsResponseAlert) string { return a.DisplayName }),
+ tableview.Col("State", func(a sql.ListAlertsResponseAlert) string { return string(a.State) }),
+	}
+
+	tableview.SetTableConfigOnCmd(listCmd, &tableview.TableConfig{Columns: columns})
+}
+
+func init() {
+	listOverrides = append(listOverrides, listOverride)
+}

cmd/workspace/apps/overrides.go

@@ -5,19 +5,41 @@ import (
 
 	appsCli "github.com/databricks/cli/cmd/apps"
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/apps"
 	"github.com/spf13/cobra"
 )
 
-func listOverride(listCmd *cobra.Command, listReq *apps.ListAppsRequest) {
+func listOverride(listCmd *cobra.Command, _ *apps.ListAppsRequest) {
+	// Template is the text-mode fallback for non-interactive/piped output.
+	// TableConfig drives the interactive TUI when the terminal supports it.
 	listCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "Name"}}	{{header "Url"}}	{{header "ComputeStatus"}}	{{header "DeploymentStatus"}}`)
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.Name | green}}	{{.Url}}	{{if .ComputeStatus}}{{if eq .ComputeStatus.State "ACTIVE"}}{{green "%s" .ComputeStatus.State }}{{else}}{{blue "%s" .ComputeStatus.State}}{{end}}{{end}}	{{if .ActiveDeployment}}{{if eq .ActiveDeployment.Status.State "SUCCEEDED"}}{{green "%s" .ActiveDeployment.Status.State }}{{else}}{{blue "%s" .ActiveDeployment.Status.State}}{{end}}{{end}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+ tableview.Col("Name", func(a apps.App) string { return a.Name }),
+ tableview.Col("URL", func(a apps.App) string { return a.Url }),
+ tableview.Col("Compute Status", func(a apps.App) string {
+ if a.ComputeStatus != nil {
+ return string(a.ComputeStatus.State)
+ }
+ return ""
+ }),
+ tableview.Col("Deploy Status", func(a apps.App) string {
+ if a.ActiveDeployment != nil && a.ActiveDeployment.Status != nil {
+ return string(a.ActiveDeployment.Status.State)
+ }
+ return ""
+ }),
+	}
+
+	tableview.SetTableConfigOnCmd(listCmd, &tableview.TableConfig{Columns: columns})
 }
 
-func listDeploymentsOverride(listDeploymentsCmd *cobra.Command, listDeploymentsReq *apps.ListAppDeploymentsRequest) {
+func listDeploymentsOverride(listDeploymentsCmd *cobra.Command, _ *apps.ListAppDeploymentsRequest) {
 	listDeploymentsCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "DeploymentId"}}	{{header "State"}}	{{header "CreatedAt"}}`)
 	listDeploymentsCmd.Annotations["template"] = cmdio.Heredoc(`

cmd/workspace/apps/overrides_test.go

@@ -0,0 +1,68 @@
+package apps
+
+import (
+	"testing"
+
+	"github.com/databricks/cli/libs/tableview"
+	sdkapps "github.com/databricks/databricks-sdk-go/service/apps"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestListTableConfig(t *testing.T) {
+	cmd := newList()
+
+	cfg := tableview.GetTableConfigForCmd(cmd)
+	require.NotNil(t, cfg)
+	require.Len(t, cfg.Columns, 4)
+
+	tests := []struct {
+ name string
+ app sdkapps.App
+ wantName string
+ wantURL string
+ wantCompute string
+ wantDeploy string
+	}{
+ {
+ name: "with nested fields",
+ app: sdkapps.App{
+ Name: "test-app",
+ Url: "https://example.com",
+ ComputeStatus: &sdkapps.ComputeStatus{
+ State: sdkapps.ComputeStateActive,
+ },
+ ActiveDeployment: &sdkapps.AppDeployment{
+ Status: &sdkapps.AppDeploymentStatus{
+ State: sdkapps.AppDeploymentStateSucceeded,
+ },
+ },
+ },
+ wantName: "test-app",
+ wantURL: "https://example.com",
+ wantCompute: "ACTIVE",
+ wantDeploy: "SUCCEEDED",
+ },
+ {
+ name: "nil nested fields",
+ app: sdkapps.App{
+ Name: "test-app",
+ Url: "https://example.com",
+ ActiveDeployment: &sdkapps.AppDeployment{},
+ },
+ wantName: "test-app",
+ wantURL: "https://example.com",
+ wantCompute: "",
+ wantDeploy: "",
+ },
+	}
+
+	for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ assert.Equal(t, tt.wantName, cfg.Columns[0].Extract(tt.app))
+ assert.Equal(t, tt.wantURL, cfg.Columns[1].Extract(tt.app))
+ assert.Equal(t, tt.wantCompute, cfg.Columns[2].Extract(tt.app))
+ assert.Equal(t, tt.wantDeploy, cfg.Columns[3].Extract(tt.app))
+ })
+	}
+}

cmd/workspace/catalogs/overrides.go

@@ -2,16 +2,27 @@ package catalogs
 
 import (
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/catalog"
 	"github.com/spf13/cobra"
 )
 
-func listOverride(listCmd *cobra.Command, listReq *catalog.ListCatalogsRequest) {
+func listOverride(listCmd *cobra.Command, _ *catalog.ListCatalogsRequest) {
+	// Template is the text-mode fallback for non-interactive/piped output.
+	// TableConfig drives the interactive TUI when the terminal supports it.
 	listCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "Name"}}	{{header "Type"}}	{{header "Comment"}}`)
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.Name|green}}	{{blue "%s" .CatalogType}}	{{.Comment}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+ tableview.Col("Name", func(c catalog.CatalogInfo) string { return c.Name }),
+ tableview.Col("Type", func(c catalog.CatalogInfo) string { return string(c.CatalogType) }),
+ tableview.ColMax("Comment", 40, func(c catalog.CatalogInfo) string { return c.Comment }),
+	}
+
+	tableview.SetTableConfigOnCmd(listCmd, &tableview.TableConfig{Columns: columns})
 }
 
 func init() {

cmd/workspace/cluster-policies/overrides.go

@@ -2,14 +2,30 @@ package cluster_policies
 
 import (
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/compute"
 	"github.com/spf13/cobra"
 )
 
 func listOverride(listCmd *cobra.Command, _ *compute.ListClusterPoliciesRequest) {
+	// Template is the text-mode fallback for non-interactive/piped output.
+	// TableConfig drives the interactive TUI when the terminal supports it.
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.PolicyId | green}}	{{.Name}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+ tableview.Col("Policy ID", func(p compute.Policy) string { return p.PolicyId }),
+ tableview.Col("Name", func(p compute.Policy) string { return p.Name }),
+ tableview.Col("Default", func(p compute.Policy) string {
+ if p.IsDefault {
+ return "yes"
+ }
+ return ""
+ }),
+	}
+
+	tableview.SetTableConfigOnCmd(listCmd, &tableview.TableConfig{Columns: columns})
 }
 
 func getOverride(getCmd *cobra.Command, _ *compute.GetClusterPolicyRequest) {

cmd/workspace/clusters/overrides.go

@@ -4,19 +4,30 @@ import (
 	"strings"
 
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/compute"
 	"github.com/spf13/cobra"
 )
 
 // Below we add overrides for filter flags for cluster list command to allow for custom filtering
 // Auto generating such flags is not yet supported by the CLI generator
 func listOverride(listCmd *cobra.Command, listReq *compute.ListClustersRequest) {
+	// Template is the text-mode fallback for non-interactive/piped output.
+	// TableConfig drives the interactive TUI when the terminal supports it.
 	listCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "ID"}}	{{header "Name"}}	{{header "State"}}`)
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.ClusterId | green}}	{{.ClusterName | cyan}}	{{if eq .State "RUNNING"}}{{green "%s" .State}}{{else if eq .State "TERMINATED"}}{{red "%s" .State}}{{else}}{{blue "%s" .State}}{{end}}
 	{{end}}`)
 
+	columns := []tableview.ColumnDef{
+ tableview.Col("Cluster ID", func(c compute.ClusterDetails) string { return c.ClusterId }),
+ tableview.Col("Name", func(c compute.ClusterDetails) string { return c.ClusterName }),
+ tableview.Col("State", func(c compute.ClusterDetails) string { return string(c.State) }),
+	}
+
+	tableview.SetTableConfigOnCmd(listCmd, &tableview.TableConfig{Columns: columns})
+
 	listReq.FilterBy = &compute.ListClustersFilterBy{}
 	listCmd.Flags().BoolVar(&listReq.FilterBy.IsPinned, "is-pinned", false, "Filter clusters by pinned status")
 	listCmd.Flags().StringVar(&listReq.FilterBy.PolicyId, "policy-id", "", "Filter clusters by policy id")

cmd/workspace/external-locations/overrides.go

@@ -2,16 +2,27 @@ package external_locations
 
 import (
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/catalog"
 	"github.com/spf13/cobra"
 )
 
-func listOverride(listCmd *cobra.Command, listReq *catalog.ListExternalLocationsRequest) {
+func listOverride(listCmd *cobra.Command, _ *catalog.ListExternalLocationsRequest) {
+	// Template is the text-mode fallback for non-interactive/piped output.
+	// TableConfig drives the interactive TUI when the terminal supports it.
 	listCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "Name"}}	{{header "Credential"}}	{{header "URL"}}`)
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.Name|green}}	{{.CredentialName|cyan}}	{{.Url}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+ tableview.Col("Name", func(l catalog.ExternalLocationInfo) string { return l.Name }),
+ tableview.Col("Credential", func(l catalog.ExternalLocationInfo) string { return l.CredentialName }),
+ tableview.Col("URL", func(l catalog.ExternalLocationInfo) string { return l.Url }),
+	}
+
+	tableview.SetTableConfigOnCmd(listCmd, &tableview.TableConfig{Columns: columns})
 }
 
 func init() {

cmd/workspace/instance-pools/overrides.go

@@ -2,13 +2,26 @@ package instance_pools
 
 import (
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
+	"github.com/databricks/databricks-sdk-go/service/compute"
 	"github.com/spf13/cobra"
 )
 
 func listOverride(listCmd *cobra.Command) {
+	// Template is the text-mode fallback for non-interactive/piped output.
+	// TableConfig drives the interactive TUI when the terminal supports it.
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.InstancePoolId|green}}	{{.InstancePoolName}}	{{.NodeTypeId}}	{{.State}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+ tableview.Col("Pool ID", func(p compute.InstancePoolAndStats) string { return p.InstancePoolId }),
+ tableview.Col("Name", func(p compute.InstancePoolAndStats) string { return p.InstancePoolName }),
+ tableview.Col("Node Type", func(p compute.InstancePoolAndStats) string { return p.NodeTypeId }),
+ tableview.Col("State", func(p compute.InstancePoolAndStats) string { return string(p.State) }),
+	}
+
+	tableview.SetTableConfigOnCmd(listCmd, &tableview.TableConfig{Columns: columns})
 }
 
 func init() {

cmd/workspace/jobs/overrides.go

@@ -1,18 +1,50 @@
 package jobs
 
 import (
+	"context"
+	"strconv"
+
+	"github.com/databricks/cli/libs/cmdctx"
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/jobs"
 	"github.com/spf13/cobra"
 )
 
 func listOverride(listCmd *cobra.Command, listReq *jobs.ListJobsRequest) {
+	// Template is the text-mode fallback for non-interactive/piped output.
+	// TableConfig drives the interactive TUI when the terminal supports it.
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{green "%d" .JobId}}	{{.Settings.Name}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+ tableview.Col("Job ID", func(j jobs.BaseJob) string { return strconv.FormatInt(j.JobId, 10) }),
+ tableview.Col("Name", func(j jobs.BaseJob) string {
+ if j.Settings != nil {
+ return j.Settings.Name
+ }
+ return ""
+ }),
+	}
+
+	tableview.SetTableConfigOnCmd(listCmd, &tableview.TableConfig{
+ Columns: columns,
+ Search: &tableview.SearchConfig{
+ Placeholder: "Search by exact name...",
+ NewIterator: func(ctx context.Context, query string) tableview.RowIterator {
+ req := *listReq
+ req.Name = query
+ req.PageToken = ""
+ req.Offset = 0
+ w := cmdctx.WorkspaceClient(ctx)
+ return tableview.WrapIterator(w.Jobs.List(ctx, req), columns)
+ },
+ },
+	})
 }
 
-func listRunsOverride(listRunsCmd *cobra.Command, listRunsReq *jobs.ListRunsRequest) {
+func listRunsOverride(listRunsCmd *cobra.Command, _ *jobs.ListRunsRequest) {
 	listRunsCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "Job ID"}}	{{header "Run ID"}}	{{header "Result State"}}	URL`)
 	listRunsCmd.Annotations["template"] = cmdio.Heredoc(`

cmd/workspace/jobs/overrides_test.go

@@ -0,0 +1,50 @@
+package jobs
+
+import (
+	"testing"
+
+	"github.com/databricks/cli/libs/tableview"
+	sdkjobs "github.com/databricks/databricks-sdk-go/service/jobs"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestListTableConfig(t *testing.T) {
+	cmd := newList()
+
+	cfg := tableview.GetTableConfigForCmd(cmd)
+	require.NotNil(t, cfg)
+	require.Len(t, cfg.Columns, 2)
+
+	tests := []struct {
+ name string
+ job sdkjobs.BaseJob
+ wantID string
+ wantName string
+	}{
+ {
+ name: "with settings",
+ job: sdkjobs.BaseJob{
+ JobId: 123,
+ Settings: &sdkjobs.JobSettings{Name: "test-job"},
+ },
+ wantID: "123",
+ wantName: "test-job",
+ },
+ {
+ name: "nil settings",
+ job: sdkjobs.BaseJob{
+ JobId: 456,
+ },
+ wantID: "456",
+ wantName: "",
+ },
+	}
+
+	for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+ assert.Equal(t, tt.wantID, cfg.Columns[0].Extract(tt.job))
+ assert.Equal(t, tt.wantName, cfg.Columns[1].Extract(tt.job))
+ })
+	}
+}