beads/cmd/bd/config_side_effects_test.go
Harry Miller 8c8329a1af
Add side-effect hints for config set/unset commands (#3089)
Add side-effect hints for config set/unset commands.

After bd config set/unset changes a key with system-level side effects (federation.remote, dolt.shared-server, routing.mode, backup.enabled, sync.git-remote), prints actionable hints to stderr. Hints are informational and never block the operation.

Maintainer fixes: added missing 'explicit' routing mode, fixed test stderr redirect.

Thanks to @harry-miller-trimble for the contribution!

Closes bd-9qv
2026-04-10 14:04:46 -07:00

126 lines
3.8 KiB
Go

package main
import (
"os"
"testing"
)
func TestCheckConfigSetSideEffects_FederationRemote(t *testing.T) {
effects := checkConfigSetSideEffects("federation.remote", "dolthub://org/proj")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
if effects[0].Command == "" {
t.Error("expected a suggested command")
}
}
func TestCheckConfigSetSideEffects_SharedServerTrue(t *testing.T) {
effects := checkConfigSetSideEffects("dolt.shared-server", "true")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
if effects[0].Command != "bd dolt server start" {
t.Errorf("expected 'bd dolt server start', got %q", effects[0].Command)
}
}
func TestCheckConfigSetSideEffects_SharedServerFalse(t *testing.T) {
effects := checkConfigSetSideEffects("dolt.shared-server", "false")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
if effects[0].Command != "bd dolt server stop" {
t.Errorf("expected 'bd dolt server stop', got %q", effects[0].Command)
}
}
func TestCheckConfigSetSideEffects_RoutingModeInvalid(t *testing.T) {
effects := checkConfigSetSideEffects("routing.mode", "bogus")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
if effects[0].Command != "" {
t.Error("invalid routing mode should not suggest a command")
}
}
func TestCheckConfigSetSideEffects_RoutingModeValid(t *testing.T) {
for _, mode := range []string{"auto", "maintainer", "contributor", "explicit"} {
effects := checkConfigSetSideEffects("routing.mode", mode)
if len(effects) != 0 {
t.Errorf("expected 0 effects for valid routing mode %q, got %d", mode, len(effects))
}
}
}
func TestCheckConfigSetSideEffects_BackupEnabled(t *testing.T) {
effects := checkConfigSetSideEffects("backup.enabled", "true")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
}
func TestCheckConfigSetSideEffects_SyncGitRemote(t *testing.T) {
effects := checkConfigSetSideEffects("sync.git-remote", "origin")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
}
func TestCheckConfigSetSideEffects_UnknownKey(t *testing.T) {
effects := checkConfigSetSideEffects("some.random.key", "value")
if len(effects) != 0 {
t.Errorf("expected 0 effects for unknown key, got %d", len(effects))
}
}
func TestCheckConfigUnsetSideEffects_FederationRemote(t *testing.T) {
effects := checkConfigUnsetSideEffects("federation.remote")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
if effects[0].Command != "bd dolt remote remove origin" {
t.Errorf("expected 'bd dolt remote remove origin', got %q", effects[0].Command)
}
}
func TestCheckConfigUnsetSideEffects_SharedServer(t *testing.T) {
effects := checkConfigUnsetSideEffects("dolt.shared-server")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
}
func TestCheckConfigUnsetSideEffects_BackupEnabled(t *testing.T) {
effects := checkConfigUnsetSideEffects("backup.enabled")
if len(effects) != 1 {
t.Fatalf("expected 1 effect, got %d", len(effects))
}
}
func TestCheckConfigUnsetSideEffects_UnknownKey(t *testing.T) {
effects := checkConfigUnsetSideEffects("some.random.key")
if len(effects) != 0 {
t.Errorf("expected 0 effects for unknown key, got %d", len(effects))
}
}
func TestPrintConfigSideEffects(t *testing.T) {
// Redirect stderr to avoid test noise
old := os.Stderr
r, w, _ := os.Pipe()
os.Stderr = w
defer func() { w.Close(); r.Close(); os.Stderr = old }()
// Should not panic with empty, single, or multiple effects
printConfigSideEffects(nil)
printConfigSideEffects([]configSideEffect{})
printConfigSideEffects([]configSideEffect{
{Message: "test hint", Command: "bd test"},
})
printConfigSideEffects([]configSideEffect{
{Message: "no command hint"},
{Message: "with command", Command: "bd apply"},
})
}