| 1 | package builtin |
| 2 | |
| 3 | import ( |
| 4 | "context" |
| 5 | "encoding/json" |
| 6 | "os" |
| 7 | "path/filepath" |
| 8 | "strings" |
| 9 | "testing" |
| 10 | ) |
| 11 | |
| 12 | // The disk copy is the last saved version; the overlay holds the user's unsaved |
| 13 | // buffer. An edit must read and write the buffer, never round-trip through the |
| 14 | // stale disk copy and overwrite what the user has not saved yet. |
| 15 | func TestEditFileOverlayEditsUnsavedBuffer(t *testing.T) { |
| 16 | dir := t.TempDir() |
| 17 | path := filepath.Join(dir, "a.go") |
| 18 | if err := os.WriteFile(path, []byte("saved\n"), 0o644); err != nil { |
| 19 | t.Fatal(err) |
| 20 | } |
| 21 | overlay := &fakeOverlay{ |
| 22 | files: map[string]string{path: "unsaved edit\n"}, |
| 23 | writes: map[string]string{}, |
| 24 | } |
| 25 | ef := editFile{workDir: dir, roots: realRoots([]string{dir}), overlay: overlay} |
| 26 | |
| 27 | args, _ := json.Marshal(map[string]string{ |
| 28 | "path": "a.go", "old_string": "unsaved", "new_string": "agent", |
| 29 | }) |
| 30 | if _, err := ef.Execute(context.Background(), json.RawMessage(args)); err != nil { |
| 31 | t.Fatalf("Execute: %v — old_string only exists in the buffer, so a disk read fails here", err) |
| 32 | } |
| 33 | if got := overlay.writes[path]; got != "agent edit\n" { |
| 34 | t.Fatalf("overlay writes[a.go] = %q, want %q", got, "agent edit\n") |
| 35 | } |
| 36 | if b, _ := os.ReadFile(path); string(b) != "saved\n" { |
| 37 | t.Fatalf("disk = %q, want it untouched — the host owns persisting the buffer", b) |
| 38 | } |
| 39 | } |
| 40 | |
| 41 | // Preview must resolve the file exactly as Execute will, or the diff a user |
| 42 | // approves is not the change that runs. |
| 43 | func TestEditFilePreviewMatchesOverlayExecute(t *testing.T) { |
| 44 | dir := t.TempDir() |
| 45 | path := filepath.Join(dir, "a.go") |
| 46 | if err := os.WriteFile(path, []byte("saved\n"), 0o644); err != nil { |
| 47 | t.Fatal(err) |
| 48 | } |
| 49 | overlay := &fakeOverlay{ |
| 50 | files: map[string]string{path: "unsaved edit\n"}, |
| 51 | writes: map[string]string{}, |
| 52 | } |
| 53 | ef := editFile{workDir: dir, roots: realRoots([]string{dir}), overlay: overlay} |
| 54 | args, _ := json.Marshal(map[string]string{ |
| 55 | "path": "a.go", "old_string": "unsaved", "new_string": "agent", |
| 56 | }) |
| 57 | |
| 58 | change, err := ef.Preview(context.Background(), json.RawMessage(args)) |
| 59 | if err != nil { |
| 60 | t.Fatalf("Preview: %v", err) |
| 61 | } |
| 62 | if change.OldText != "unsaved edit\n" { |
| 63 | t.Fatalf("preview OldText = %q, want the buffer content", change.OldText) |
| 64 | } |
| 65 | if _, err := ef.Execute(context.Background(), json.RawMessage(args)); err != nil { |
| 66 | t.Fatalf("Execute: %v", err) |
| 67 | } |
| 68 | if got := overlay.writes[path]; got != change.NewText { |
| 69 | t.Fatalf("executed %q but previewed %q", got, change.NewText) |
| 70 | } |
| 71 | } |
| 72 | |
| 73 | func TestMultiEditOverlayEditsUnsavedBuffer(t *testing.T) { |
| 74 | dir := t.TempDir() |
| 75 | path := filepath.Join(dir, "m.go") |
| 76 | if err := os.WriteFile(path, []byte("saved\n"), 0o644); err != nil { |
| 77 | t.Fatal(err) |
| 78 | } |
| 79 | overlay := &fakeOverlay{ |
| 80 | files: map[string]string{path: "alpha\nbeta\n"}, |
| 81 | writes: map[string]string{}, |
| 82 | } |
| 83 | me := multiEdit{workDir: dir, roots: realRoots([]string{dir}), overlay: overlay} |
| 84 | |
| 85 | args, _ := json.Marshal(map[string]any{ |
| 86 | "path": "m.go", |
| 87 | "edits": []map[string]any{ |
| 88 | {"old_string": "alpha", "new_string": "ALPHA"}, |
| 89 | {"old_string": "beta", "new_string": "BETA"}, |
| 90 | }, |
| 91 | }) |
| 92 | if _, err := me.Execute(context.Background(), json.RawMessage(args)); err != nil { |
| 93 | t.Fatalf("Execute: %v", err) |
| 94 | } |
| 95 | if got := overlay.writes[path]; got != "ALPHA\nBETA\n" { |
| 96 | t.Fatalf("overlay writes = %q, want %q", got, "ALPHA\nBETA\n") |
| 97 | } |
| 98 | if b, _ := os.ReadFile(path); string(b) != "saved\n" { |
| 99 | t.Fatalf("disk = %q, want untouched", b) |
| 100 | } |
| 101 | } |
| 102 | |
| 103 | // A non-UTF-8 file must stay entirely on the disk route. Routing it through the |
| 104 | // text-only overlay would rewrite it as UTF-8 and destroy the original encoding. |
| 105 | func TestEditFileOverlaySkipsNonUTF8(t *testing.T) { |
| 106 | dir := t.TempDir() |
| 107 | path := filepath.Join(dir, "utf16.txt") |
| 108 | if err := os.WriteFile(path, []byte{0xFF, 0xFE, 'h', 0, 'i', 0}, 0o644); err != nil { |
| 109 | t.Fatal(err) |
| 110 | } |
| 111 | // Content that would make the edit fail if the overlay were consulted. |
| 112 | overlay := &fakeOverlay{ |
| 113 | files: map[string]string{path: "OVERLAY"}, |
| 114 | writes: map[string]string{}, |
| 115 | } |
| 116 | ef := editFile{workDir: dir, roots: realRoots([]string{dir}), overlay: overlay} |
| 117 | |
| 118 | args, _ := json.Marshal(map[string]string{ |
| 119 | "path": "utf16.txt", "old_string": "hi", "new_string": "ok", |
| 120 | }) |
| 121 | if _, err := ef.Execute(context.Background(), json.RawMessage(args)); err != nil { |
| 122 | t.Fatalf("Execute: %v", err) |
| 123 | } |
| 124 | if len(overlay.writes) != 0 { |
| 125 | t.Fatalf("non-UTF-8 target must bypass the overlay; writes = %v", overlay.writes) |
| 126 | } |
| 127 | b, err := os.ReadFile(path) |
| 128 | if err != nil || len(b) < 2 || b[0] != 0xFF || b[1] != 0xFE { |
| 129 | t.Fatalf("local write must preserve the UTF-16 BOM; got % x, %v", b, err) |
| 130 | } |
| 131 | } |
| 132 | |
| 133 | func TestEditFileOverlayMissFallsBackToDisk(t *testing.T) { |
| 134 | dir := t.TempDir() |
| 135 | path := filepath.Join(dir, "d.go") |
| 136 | if err := os.WriteFile(path, []byte("disk only\n"), 0o644); err != nil { |
| 137 | t.Fatal(err) |
| 138 | } |
| 139 | overlay := &fakeOverlay{files: map[string]string{}, writes: map[string]string{}} |
| 140 | ef := editFile{workDir: dir, roots: realRoots([]string{dir}), overlay: overlay} |
| 141 | |
| 142 | args, _ := json.Marshal(map[string]string{ |
| 143 | "path": "d.go", "old_string": "disk", "new_string": "local", |
| 144 | }) |
| 145 | if _, err := ef.Execute(context.Background(), json.RawMessage(args)); err != nil { |
| 146 | t.Fatalf("Execute: %v", err) |
| 147 | } |
| 148 | if len(overlay.writes) != 0 { |
| 149 | t.Fatalf("a read that missed the overlay must not write to it; writes = %v", overlay.writes) |
| 150 | } |
| 151 | b, _ := os.ReadFile(path) |
| 152 | if !strings.Contains(string(b), "local only") { |
| 153 | t.Fatalf("disk = %q, want the edit applied locally", b) |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | func TestDeleteRangeOverlayEditsUnsavedBuffer(t *testing.T) { |
| 158 | dir := t.TempDir() |
| 159 | path := filepath.Join(dir, "r.txt") |
| 160 | if err := os.WriteFile(path, []byte("saved\n"), 0o644); err != nil { |
| 161 | t.Fatal(err) |
| 162 | } |
| 163 | overlay := &fakeOverlay{ |
| 164 | files: map[string]string{path: "keep\ncut one\ncut two\nkeep tail\n"}, |
| 165 | writes: map[string]string{}, |
| 166 | } |
| 167 | dr := deleteRange{workDir: dir, roots: realRoots([]string{dir}), overlay: overlay} |
| 168 | |
| 169 | args, _ := json.Marshal(map[string]string{ |
| 170 | "path": "r.txt", "start_anchor": "cut one", "end_anchor": "cut two", |
| 171 | }) |
| 172 | if _, err := dr.Execute(context.Background(), json.RawMessage(args)); err != nil { |
| 173 | t.Fatalf("Execute: %v", err) |
| 174 | } |
| 175 | if got := overlay.writes[path]; got != "keep\nkeep tail\n" { |
| 176 | t.Fatalf("overlay writes = %q, want %q", got, "keep\nkeep tail\n") |
| 177 | } |
| 178 | if b, _ := os.ReadFile(path); string(b) != "saved\n" { |
| 179 | t.Fatalf("disk = %q, want untouched", b) |
| 180 | } |
| 181 | } |
| 182 |