Add endless-scrolling TUI table for interactive list commands #4729
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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) { | ||
|
Contributor
There was a problem hiding this comment. Why test here and not other commands?
Member
Author
There was a problem hiding this comment. Apps has nested pointer dereferences ( |
||
| 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)) | ||
| }) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)) | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we still need the template if we also use the tableview?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the template is the fallback for non-interactive output (piped,
--output text, non-TTY). The TUI only runs whenSupportsTUI()is true. Added a comment to all overrides clarifying this.