b9152f8b21
defaultKeybinds() now supplies only help descriptions; the actual keys are read from the embedded config.toml at load time, eliminating the duplicate key definitions that could drift out of sync. Add a test that walks every keybind after loading the defaults and fails if any is missing a key (config.toml) or description (defaultKeybinds).
130 lines
3.2 KiB
Go
130 lines
3.2 KiB
Go
package config
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"reflect"
|
|
"testing"
|
|
|
|
"github.com/BurntSushi/toml"
|
|
"github.com/ayn2op/discordo/internal/consts"
|
|
tviewkeybind "github.com/ayn2op/tview/keybind"
|
|
"github.com/gdamore/tcell/v3"
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/google/go-cmp/cmp/cmpopts"
|
|
)
|
|
|
|
func TestDefaultPath(t *testing.T) {
|
|
t.Run("user config dir fallback", func(t *testing.T) {
|
|
t.Setenv("AppData", "")
|
|
t.Setenv("HOME", "")
|
|
t.Setenv("home", "")
|
|
t.Setenv("XDG_CONFIG_HOME", "")
|
|
|
|
// filepath.Join strips the leading dot.
|
|
got := DefaultPath()
|
|
want := filepath.Join(".", consts.Name, fileName)
|
|
if got != want {
|
|
t.Fatalf("got = %v, want = %v", got, want)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestLoad(t *testing.T) {
|
|
t.Run("invalid default config returns error", func(t *testing.T) {
|
|
orig := defaultCfg
|
|
defaultCfg = []byte("invalid =")
|
|
t.Cleanup(func() { defaultCfg = orig })
|
|
if _, err := Load("does-not-matter.toml"); err == nil {
|
|
t.Fatal(err)
|
|
}
|
|
})
|
|
|
|
t.Run("invalid config returns error", func(t *testing.T) {
|
|
path := filepath.Join(t.TempDir(), "bad.toml")
|
|
if err := os.WriteFile(path, []byte("invalid ="), os.ModePerm); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if _, err := Load(path); err == nil {
|
|
t.Fatal("expected error")
|
|
}
|
|
})
|
|
|
|
t.Run("valid config does not return error", func(t *testing.T) {
|
|
path := filepath.Join(t.TempDir(), "good.toml")
|
|
if err := os.WriteFile(path, []byte("mouse = false"), os.ModePerm); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
cfg, err := Load(path)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if cfg.Mouse != false {
|
|
t.Fatalf("got = %v, want = false", cfg.Mouse)
|
|
}
|
|
})
|
|
|
|
// Keys live in config.toml, descriptions in defaultKeybinds(); fail if either is missing.
|
|
t.Run("default keybinds are fully populated", func(t *testing.T) {
|
|
cfg, err := Load(filepath.Join(t.TempDir(), "missing.toml"))
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
var walk func(path string, v reflect.Value)
|
|
walk = func(path string, v reflect.Value) {
|
|
rt := v.Type()
|
|
for i := range rt.NumField() {
|
|
fv, name := v.Field(i), path+rt.Field(i).Name
|
|
if kb, ok := fv.Interface().(Keybind); ok {
|
|
if len(kb.Keys()) == 0 {
|
|
t.Errorf("%s: no keys (missing from config.toml?)", name)
|
|
}
|
|
if kb.Help().Desc == "" {
|
|
t.Errorf("%s: no help description (missing from defaultKeybinds?)", name)
|
|
}
|
|
if kb.Help().Key == "" {
|
|
t.Errorf("%s: help key not populated from config.toml", name)
|
|
}
|
|
continue
|
|
}
|
|
if fv.Kind() == reflect.Struct {
|
|
walk(name+".", fv)
|
|
}
|
|
}
|
|
}
|
|
walk("Keybinds.", reflect.ValueOf(cfg.Keybinds))
|
|
})
|
|
|
|
t.Run("open with bad path returns error (!= ErrNotExist)", func(t *testing.T) {
|
|
if _, err := Load("bad\x00path"); err == nil {
|
|
t.Fatal("expected error")
|
|
}
|
|
})
|
|
|
|
t.Run("missing file uses defaults", func(t *testing.T) {
|
|
path := filepath.Join(t.TempDir(), "missing.toml")
|
|
cfg, err := Load(path)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
var defCfg Config
|
|
if err := toml.Unmarshal(defaultCfg, &defCfg); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
applyDefaults(&defCfg)
|
|
|
|
if diff := cmp.Diff(
|
|
defCfg,
|
|
*cfg,
|
|
cmpopts.EquateComparable(tcell.Style{}),
|
|
cmpopts.IgnoreUnexported(tviewkeybind.Keybind{}),
|
|
); diff != "" {
|
|
t.Fatalf("got = -, want = +, diff=%s", diff)
|
|
}
|
|
})
|
|
}
|