Files
skillshare/internal/config/format_test.go
T
Willie 0792d0e1a2 fix(config): keep the comments of a key the command removed (#528)
A comment on a key the command removed was lost. It now sits in front of the next surviving key, or on the last entry of its section, in source order. Adds the config_keeps_comments runbook.

Refs #525
2026-10-11 22:02:55 +08:00

237 lines
6.8 KiB
Go

package config
import (
"os"
"path/filepath"
"strings"
"testing"
"gopkg.in/yaml.v3"
)
func hooksNode(t *testing.T) yaml.Node {
t.Helper()
var wrapper struct {
Hooks yaml.Node `yaml:"hooks"`
}
if err := yaml.Unmarshal([]byte("hooks:\n claude:\n - name: lint\n"), &wrapper); err != nil {
t.Fatal(err)
}
return wrapper.Hooks
}
func TestSave_OrdersAndSpacesSections(t *testing.T) {
cfgPath := filepath.Join(t.TempDir(), "config.yaml")
t.Setenv("SKILLSHARE_CONFIG", cfgPath)
cfg := &Config{
Hooks: hooksNode(t),
Sources: GlobalSources{Skills: "/src/skills"},
Mode: "merge",
Targets: map[string]TargetConfig{
"claude": {Skills: &ResourceTargetConfig{Path: "/home/u/.claude/skills"}},
},
Ignore: []string{"tmp"},
}
if err := cfg.Save(); err != nil {
t.Fatal(err)
}
data, err := os.ReadFile(cfgPath)
if err != nil {
t.Fatal(err)
}
want := string(schemaComment) + `
sources:
skills: /src/skills
mode: merge
targets:
claude:
skills:
path: /home/u/.claude/skills
hooks:
claude:
- name: lint
ignore:
- tmp
`
if got := string(data); got != want {
t.Errorf("Save output mismatch\ngot:\n%s\nwant:\n%s", got, want)
}
}
func TestProjectSaveIn_OrdersAndSpacesSections(t *testing.T) {
dir := t.TempDir()
cfg := &ProjectConfig{
Hooks: hooksNode(t),
Targets: []ProjectTargetEntry{{Name: "claude"}},
}
if err := cfg.SaveIn(dir); err != nil {
t.Fatal(err)
}
data, err := os.ReadFile(filepath.Join(dir, "config.yaml"))
if err != nil {
t.Fatal(err)
}
want := string(projectSchemaComment) + "\ntargets:\n - claude\n\nhooks:\n"
if got := string(data); !strings.HasPrefix(got, want) {
t.Errorf("project config should start with targets then hooks\ngot:\n%s", got)
}
}
func TestMarshalConfig_KeepsOrderWhenSortingWouldBreakAnAlias(t *testing.T) {
var cfg Config
src := "hooks: &shared\n claude: []\nmcp:\n servers: *shared\nsources:\n skills: /src\n"
if err := yaml.Unmarshal([]byte(src), &cfg); err != nil {
t.Fatal(err)
}
data, err := marshalConfig(&cfg, schemaComment, nil)
if err != nil {
t.Fatal(err)
}
var reloaded Config
if err := yaml.Unmarshal(data, &reloaded); err != nil {
t.Errorf("saved config does not load: %v\n%s", err, data)
}
}
func TestSave_KeepsCommentsOfTheExistingFile(t *testing.T) {
cfgPath := filepath.Join(t.TempDir(), "config.yaml")
t.Setenv("SKILLSHARE_CONFIG", cfgPath)
src := string(schemaComment) + `
# BEGIN HUMAN-ONLY (generated)
sources:
skills: /src/skills # where skills live
# END HUMAN-ONLY
mode: merge
targets:
claude:
skills:
path: /home/u/.claude/skills
`
if err := os.WriteFile(cfgPath, []byte(src), 0644); err != nil {
t.Fatal(err)
}
cfg, err := Load()
if err != nil {
t.Fatal(err)
}
cfg.Mode = "copy"
if err := cfg.Save(); err != nil {
t.Fatal(err)
}
data, err := os.ReadFile(cfgPath)
if err != nil {
t.Fatal(err)
}
got := string(data)
if strings.Count(got, "yaml-language-server") != 1 {
t.Errorf("schema header should appear once:\n%s", got)
}
if !strings.Contains(got, "mode: copy") {
t.Errorf("changed value missing:\n%s", got)
}
for _, want := range []string{"# BEGIN HUMAN-ONLY (generated)\nsources:", "/src/skills # where skills live", "# END HUMAN-ONLY\n\nmode: copy"} {
if !strings.Contains(got, want) {
t.Errorf("comment %q lost:\n%s", want, got)
}
}
}
func TestMarshalConfig_CommentOnReorderedKeyFollowsIt(t *testing.T) {
existing := []byte(string(schemaComment) + "\n# kept on mode\nmode: merge\nsources:\n skills: /src\n")
cfg := Config{Mode: "merge", Sources: GlobalSources{Skills: "/src"}}
data, err := marshalConfig(&cfg, schemaComment, existing)
if err != nil {
t.Fatal(err)
}
got := string(data)
if strings.Count(got, "yaml-language-server") != 1 || !strings.Contains(got, "# kept on mode\nmode: merge") {
t.Errorf("comment should move with the key, header once:\n%s", got)
}
}
func TestMarshalConfig_CommentOnListItemSurvivesListEdit(t *testing.T) {
existing := []byte("ignore:\n - tmp # scratch\n - build\n")
cfg := Config{Ignore: []string{"build", "tmp"}}
data, err := marshalConfig(&cfg, schemaComment, existing)
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "- tmp # scratch") {
t.Errorf("item comment lost:\n%s", data)
}
}
func TestMarshalConfig_CommentOfRemovedKeyMovesToNextKey(t *testing.T) {
existing := []byte("# BEGIN block\nmode: merge # was merge\n# END block\nsources:\n skills: /src\n")
cfg := Config{Sources: GlobalSources{Skills: "/src"}}
data, err := marshalConfig(&cfg, schemaComment, existing)
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "# BEGIN block\n# was merge\n# END block\nsources:") {
t.Errorf("comments of the removed key should sit in front of the next key:\n%s", data)
}
}
func TestMarshalConfig_CommentOfRemovedLastKeyEndsTheFile(t *testing.T) {
existing := []byte("sources:\n skills: /src\n# BEGIN block\nmode: merge # note\n# END block\n")
cfg := Config{Sources: GlobalSources{Skills: "/src"}}
data, err := marshalConfig(&cfg, schemaComment, existing)
if err != nil {
t.Fatal(err)
}
if !strings.HasSuffix(strings.TrimSpace(string(data)), "# BEGIN block\n# note\n# END block") {
t.Errorf("comments of a removed last key should end the file in source order:\n%s", data)
}
}
func TestMarshalConfig_ListOfMappingsMatchesByName(t *testing.T) {
existing := []byte("targets:\n - files:\n - a\n name: first # one\n - files:\n - b\n name: second # two\n")
var cfg ProjectConfig
if err := yaml.Unmarshal(existing, &cfg); err != nil {
t.Fatal(err)
}
cfg.Targets = cfg.Targets[1:]
data, err := marshalConfig(&cfg, projectSchemaComment, existing)
if err != nil {
t.Fatal(err)
}
got := string(data)
if !strings.Contains(got, "# one\n - files:") || !strings.Contains(got, "second # two") {
t.Errorf("the removed target's comment should lead the next one, whose own comment stays:\n%s", got)
}
}
func TestMarshalConfig_ScalarAndObjectTargetShareComments(t *testing.T) {
existing := []byte("targets:\n - claude # mine\n")
cfg := ProjectConfig{Targets: []ProjectTargetEntry{{Name: "claude", Files: []string{"a"}}}}
data, err := marshalConfig(&cfg, projectSchemaComment, existing)
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "# mine") {
t.Errorf("comment should survive the switch to object form:\n%s", data)
}
}
func TestMarshalConfig_RemovedNestedEntryKeepsCommentOrder(t *testing.T) {
existing := []byte("sources:\n skills: /src\ntargets:\n claude:\n skills:\n # BEGIN\n path: /a # note\n # END\n")
cfg := Config{Sources: GlobalSources{Skills: "/src"}}
data, err := marshalConfig(&cfg, schemaComment, existing)
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(data), "# BEGIN\n# note\n# END") {
t.Errorf("nested comments should keep their order:\n%s", data)
}
}