|
| 1 | +package docs |
| 2 | + |
| 3 | +import ( |
| 4 | + "os" |
| 5 | + "path/filepath" |
| 6 | + "strings" |
| 7 | + "testing" |
| 8 | + |
| 9 | + "go.yaml.in/yaml/v3" |
| 10 | +) |
| 11 | + |
| 12 | +func TestLoadAutoRules_MissingReturnsEmpty(t *testing.T) { |
| 13 | + path := filepath.Join(t.TempDir(), "auto-rules.yaml") |
| 14 | + |
| 15 | + set, err := LoadAutoRules(testStateFiles, path) |
| 16 | + if err != nil { |
| 17 | + t.Fatalf("unexpected error: %v", err) |
| 18 | + } |
| 19 | + if set == nil { |
| 20 | + t.Fatal("expected non-nil set") |
| 21 | + } |
| 22 | + if len(set.Rules) != 0 { |
| 23 | + t.Fatalf("expected empty rules, got %v", set.Rules) |
| 24 | + } |
| 25 | +} |
| 26 | + |
| 27 | +func TestAutoRuleSet_RoundTripPreservesFields(t *testing.T) { |
| 28 | + path := filepath.Join(t.TempDir(), "auto-rules.yaml") |
| 29 | + set := &AutoRuleSet{Rules: []AutoRule{{Pattern: "pkg/a.go::Foo", Category: "unannotated", Action: "warn", Auto: true, Created: "2026-05-03"}}} |
| 30 | + |
| 31 | + if err := set.Save(testStateFiles, path); err != nil { |
| 32 | + t.Fatalf("save: %v", err) |
| 33 | + } |
| 34 | + |
| 35 | + loaded, err := LoadAutoRules(testStateFiles, path) |
| 36 | + if err != nil { |
| 37 | + t.Fatalf("load: %v", err) |
| 38 | + } |
| 39 | + if len(loaded.Rules) != 1 { |
| 40 | + t.Fatalf("expected 1 rule, got %d", len(loaded.Rules)) |
| 41 | + } |
| 42 | + rule := loaded.Rules[0] |
| 43 | + if rule.Pattern != "pkg/a.go::Foo" || rule.Category != "unannotated" || rule.Action != "warn" || !rule.Auto || rule.Created != "2026-05-03" { |
| 44 | + t.Fatalf("unexpected round-trip rule: %+v", rule) |
| 45 | + } |
| 46 | +} |
| 47 | + |
| 48 | +func TestAutoRuleSet_UpsertAddsNew(t *testing.T) { |
| 49 | + set := &AutoRuleSet{} |
| 50 | + added := set.Upsert([]string{"unannotated:pkg/a.go::Foo"}) |
| 51 | + |
| 52 | + if len(added) != 1 { |
| 53 | + t.Fatalf("expected 1 added rule, got %d", len(added)) |
| 54 | + } |
| 55 | + if len(set.Rules) != 1 { |
| 56 | + t.Fatalf("expected 1 stored rule, got %d", len(set.Rules)) |
| 57 | + } |
| 58 | + rule := set.Rules[0] |
| 59 | + if rule.Pattern != "pkg/a.go::Foo" { |
| 60 | + t.Fatalf("pattern = %q, want pkg/a.go::Foo", rule.Pattern) |
| 61 | + } |
| 62 | + if rule.Category != "unannotated" || rule.Action != "warn" || !rule.Auto { |
| 63 | + t.Fatalf("unexpected rule metadata: %+v", rule) |
| 64 | + } |
| 65 | + if rule.Created == "" { |
| 66 | + t.Fatal("expected created date to be populated") |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +func TestAutoRuleSet_UpsertIsIdempotent(t *testing.T) { |
| 71 | + set := &AutoRuleSet{} |
| 72 | + set.Upsert([]string{"unannotated:pkg/a.go::Foo"}) |
| 73 | + added := set.Upsert([]string{"unannotated:pkg/a.go::Foo"}) |
| 74 | + |
| 75 | + if len(added) != 0 { |
| 76 | + t.Fatalf("expected no new rules on duplicate upsert, got %d", len(added)) |
| 77 | + } |
| 78 | + if len(set.Rules) != 1 { |
| 79 | + t.Fatalf("expected 1 stored rule, got %d", len(set.Rules)) |
| 80 | + } |
| 81 | +} |
| 82 | + |
| 83 | +func TestAutoRuleSet_SaveCreatesParentDir(t *testing.T) { |
| 84 | + path := filepath.Join(t.TempDir(), "nested", "state", "auto-rules.yaml") |
| 85 | + set := &AutoRuleSet{} |
| 86 | + set.Upsert([]string{"missing:pkg/b.go"}) |
| 87 | + |
| 88 | + if err := set.Save(testStateFiles, path); err != nil { |
| 89 | + t.Fatalf("save: %v", err) |
| 90 | + } |
| 91 | + if _, err := os.Stat(path); err != nil { |
| 92 | + t.Fatalf("expected saved file to exist: %v", err) |
| 93 | + } |
| 94 | +} |
| 95 | + |
| 96 | +func TestAutoRuleSet_SaveUsesYamlPolicyShape(t *testing.T) { |
| 97 | + path := filepath.Join(t.TempDir(), "auto-rules.yaml") |
| 98 | + set := &AutoRuleSet{} |
| 99 | + set.Upsert([]string{"dead-ref:pkg/c.go::Bar"}) |
| 100 | + |
| 101 | + if err := set.Save(testStateFiles, path); err != nil { |
| 102 | + t.Fatalf("save: %v", err) |
| 103 | + } |
| 104 | + |
| 105 | + data, err := os.ReadFile(path) |
| 106 | + if err != nil { |
| 107 | + t.Fatalf("read: %v", err) |
| 108 | + } |
| 109 | + content := string(data) |
| 110 | + for _, want := range []string{"rules:", "pattern: pkg/c.go::Bar", "category: dead-ref", "action: warn", "auto: true"} { |
| 111 | + if !strings.Contains(content, want) { |
| 112 | + t.Fatalf("expected %q in yaml, got:\n%s", want, content) |
| 113 | + } |
| 114 | + } |
| 115 | + |
| 116 | + var loaded AutoRuleSet |
| 117 | + if err := yaml.Unmarshal(data, &loaded); err != nil { |
| 118 | + t.Fatalf("expected valid yaml shape, got error: %v", err) |
| 119 | + } |
| 120 | + if len(loaded.Rules) != 1 || loaded.Rules[0].Pattern != "pkg/c.go::Bar" { |
| 121 | + t.Fatalf("unexpected unmarshaled rules: %+v", loaded.Rules) |
| 122 | + } |
| 123 | +} |
0 commit comments