Allow configuring forwards-table columns, order, and width (#82)

* Allow configuring forwards-table columns, order, and width Adds an optional tui.columns section to .kportal.yaml so the visible columns, their order, and their widths can be customized instead of always rendering the hardcoded 8-column layout. Omitting the section keeps the existing default columns/order/widths. Closes #81 * fix(ui): keep the plain table layout and check column widths The plain verbose table must look the same when no tui section is set. It had narrower columns and shorter port headers than before. The default layout is now identical to the old one, and a golden test guards it. A status column that is not last now pads by visible width. Table rules follow the column widths. The UI applies new columns only after a reload succeeds, including the SIGHUP path of the verbose table. The validator rejects a column width above 200. The README describes the tui.columns setting. Refs #81 * fix(httplog): replace the deprecated ReverseProxy Director with Rewrite Staticcheck reports SA1019 because Go 1.26 deprecates Director. The proxy now sets the target in a Rewrite function. Rewrite drops the X-Forwarded-For header that Director sent, so the function calls SetXForwarded to keep that header. A new test checks the target port, the path and the header. * fix(release): drop the deprecated cask url verified key Homebrew warns about the verified parameter of the cask url stanza. The setting is not needed. GoReleaser check now passes without a deprecation warning. The postflight warning remains. GoReleaser generates it from the post install hook, and the upstream fix is not released yet. Refs #79 --------- Co-authored-by: Lukasz Raczylo <[email protected]>
2026-10-18 05:15:43 +00:00 · 2026-10-02 02:24:11 +01:00
parent 232c0f1162
commit f3d3f259a1
15 changed files with 849 additions and 61 deletions
@@ -60,9 +60,29 @@ type Config struct {
 	HealthCheck *HealthCheckSpec `yaml:"healthCheck,omitempty"`
 	Reliability *ReliabilitySpec `yaml:"reliability,omitempty"`
 	MDNS        *MDNSSpec        `yaml:"mdns,omitempty"`
+	TUI         *TUISpec         `yaml:"tui,omitempty"`
 	Contexts    []Context        `yaml:"contexts"`
 }

+// TUISpec configures the terminal UI table display
+type TUISpec struct {
+	// Columns lists the forwards-table columns to display, in the order they
+	// should appear. Omitting this field (or leaving it empty) keeps the
+	// built-in default column set and order. Any column not listed here is
+	// hidden.
+	Columns []TableColumn `yaml:"columns,omitempty"`
+}
+
+// TableColumn configures a single column of the forwards table.
+type TableColumn struct {
+	// Name is the column identifier: context, namespace, alias, type,
+	// resource, remote, local, or status.
+	Name string `yaml:"name"`
+	// Width is the maximum display width for the column, in characters.
+	// If zero or omitted, the column's built-in default width is used.
+	Width int `yaml:"width,omitempty"`
+}
+
 // MDNSSpec configures mDNS (multicast DNS) hostname publishing
 // When enabled, forwards with aliases can be accessed via <alias>.local hostnames
 type MDNSSpec struct {
@@ -174,6 +194,15 @@ func (c *Config) IsMDNSEnabled() bool {
 	return c.MDNS != nil && c.MDNS.Enabled
 }

+// GetTableColumns returns the configured TUI table columns, or nil if the
+// built-in default column set and order should be used.
+func (c *Config) GetTableColumns() []TableColumn {
+	if c == nil || c.TUI == nil || len(c.TUI.Columns) == 0 {
+		return nil
+	}
+	return c.TUI.Columns
+}
+
 // Context represents a Kubernetes context with its namespaces
 type Context struct {
 	Name       string      `yaml:"name"`
@@ -85,6 +85,7 @@ func (v *Validator) ValidateConfigWithOptions(cfg *Config, allowEmpty bool) []Va
 	if allowEmpty && cfg.IsEmpty() {
 		// Still validate health check and reliability if present (they don't require forwards)
 		errs = append(errs, v.validateSpecDurations(cfg)...)
+		errs = append(errs, v.validateTUI(cfg)...)
 		return errs
 	}

@@ -111,6 +112,9 @@ func (v *Validator) ValidateConfigWithOptions(cfg *Config, allowEmpty bool) []Va
 	// Validate duration fields in specs
 	errs = append(errs, v.validateSpecDurations(cfg)...)

+	// Validate TUI table column configuration
+	errs = append(errs, v.validateTUI(cfg)...)
+
 	return errs
 }

@@ -507,6 +511,74 @@ func (v *Validator) validateMDNS(cfg *Config) []ValidationError {
 	return errs
 }

+// maxTableColumnWidth caps tui.columns width so a typo cannot blow up the table.
+const maxTableColumnWidth = 200
+
+// validTableColumnNames are the recognized forwards-table column identifiers.
+var validTableColumnNames = map[string]bool{
+	"context":   true,
+	"namespace": true,
+	"alias":     true,
+	"type":      true,
+	"resource":  true,
+	"remote":    true,
+	"local":     true,
+	"status":    true,
+}
+
+// validateTUI validates the tui.columns configuration.
+func (v *Validator) validateTUI(cfg *Config) []ValidationError {
+	var errs []ValidationError
+
+	if cfg.TUI == nil {
+		return errs
+	}
+
+	seen := make(map[string]bool)
+	for i, col := range cfg.TUI.Columns {
+		name := strings.ToLower(strings.TrimSpace(col.Name))
+
+		if name == "" {
+			errs = append(errs, ValidationError{
+				Field:   fmt.Sprintf("tui.columns[%d].name", i),
+				Message: "Column name cannot be empty",
+			})
+			continue
+		}
+
+		if !validTableColumnNames[name] {
+			errs = append(errs, ValidationError{
+				Field:   fmt.Sprintf("tui.columns[%d].name", i),
+				Message: fmt.Sprintf("Invalid column name '%s' (must be one of: context, namespace, alias, type, resource, remote, local, status)", col.Name),
+			})
+			continue
+		}
+
+		if seen[name] {
+			errs = append(errs, ValidationError{
+				Field:   fmt.Sprintf("tui.columns[%d].name", i),
+				Message: fmt.Sprintf("Duplicate column '%s' in tui.columns", name),
+			})
+			continue
+		}
+		seen[name] = true
+
+		if col.Width < 0 {
+			errs = append(errs, ValidationError{
+				Field:   fmt.Sprintf("tui.columns[%d].width", i),
+				Message: fmt.Sprintf("Column '%s' width cannot be negative", name),
+			})
+		} else if col.Width > maxTableColumnWidth {
+			errs = append(errs, ValidationError{
+				Field:   fmt.Sprintf("tui.columns[%d].width", i),
+				Message: fmt.Sprintf("Column '%s' width cannot exceed %d", name, maxTableColumnWidth),
+			})
+		}
+	}
+
+	return errs
+}
+
 // isValidHostname checks if a string is a valid RFC 1123 hostname.
 // Hostnames must start with alphanumeric, contain only alphanumeric and hyphens,
 // and be 1-63 characters long.
@@ -2050,3 +2050,137 @@ func TestValidateProtocol(t *testing.T) {
 		})
 	}
 }
+
+func TestValidator_ValidateTUI(t *testing.T) {
+	validator := NewValidator()
+
+	baseContexts := []Context{
+		{
+			Name: "dev",
+			Namespaces: []Namespace{
+				{
+					Name: "default",
+					Forwards: []Forward{
+						{Resource: "pod/app", Protocol: "tcp", Port: 8080, LocalPort: 8080, contextName: "dev", namespaceName: "default"},
+					},
+				},
+			},
+		},
+	}
+
+	tests := []struct {
+		config        *Config
+		name          string
+		errorContains string
+		expectErrors  bool
+	}{
+		{
+			name:         "no tui config - no validation",
+			config:       &Config{Contexts: baseContexts},
+			expectErrors: false,
+		},
+		{
+			name: "valid columns",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI: &TUISpec{
+					Columns: []TableColumn{
+						{Name: "alias", Width: 30},
+						{Name: "status"},
+					},
+				},
+			},
+			expectErrors: false,
+		},
+		{
+			name: "unknown column name",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI:      &TUISpec{Columns: []TableColumn{{Name: "bogus"}}},
+			},
+			expectErrors:  true,
+			errorContains: "Invalid column name",
+		},
+		{
+			name: "empty column name",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI:      &TUISpec{Columns: []TableColumn{{Name: ""}}},
+			},
+			expectErrors:  true,
+			errorContains: "cannot be empty",
+		},
+		{
+			name: "duplicate column",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI:      &TUISpec{Columns: []TableColumn{{Name: "alias"}, {Name: "Alias"}}},
+			},
+			expectErrors:  true,
+			errorContains: "Duplicate column",
+		},
+		{
+			name: "negative width",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI:      &TUISpec{Columns: []TableColumn{{Name: "alias", Width: -1}}},
+			},
+			expectErrors:  true,
+			errorContains: "cannot be negative",
+		},
+		{
+			name: "width at cap",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI:      &TUISpec{Columns: []TableColumn{{Name: "alias", Width: 200}}},
+			},
+			expectErrors: false,
+		},
+		{
+			name: "width above cap",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI:      &TUISpec{Columns: []TableColumn{{Name: "alias", Width: 201}}},
+			},
+			expectErrors:  true,
+			errorContains: "cannot exceed 200",
+		},
+		{
+			name: "name is case and whitespace insensitive",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI:      &TUISpec{Columns: []TableColumn{{Name: " Alias "}, {Name: "STATUS"}}},
+			},
+			expectErrors: false,
+		},
+		{
+			name: "padded duplicate is detected",
+			config: &Config{
+				Contexts: baseContexts,
+				TUI:      &TUISpec{Columns: []TableColumn{{Name: "alias"}, {Name: " Alias "}}},
+			},
+			expectErrors:  true,
+			errorContains: "Duplicate column",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			errs := validator.ValidateConfig(tt.config)
+
+			if tt.expectErrors {
+				assert.NotEmpty(t, errs)
+				found := false
+				for _, err := range errs {
+					if strings.Contains(err.Message, tt.errorContains) {
+						found = true
+						break
+					}
+				}
+				assert.True(t, found, "expected error message '%s' not found in errors: %v", tt.errorContains, errs)
+			} else {
+				assert.Empty(t, errs, "expected no validation errors, got: %v", errs)
+			}
+		})
+	}
+}