blob: 14bcb2a5135417457f0aa39d5313aea45a26cf3d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
;;; test-gptel-tools-write-text-file.el --- Tests for write_text_file gptel tool -*- lexical-binding: t; -*-
;;; Commentary:
;; Tests for `cj/write-text-file--run' and its helpers.
;;; Code:
(require 'ert)
(require 'cl-lib)
(eval-and-compile
(add-to-list 'load-path (expand-file-name "tests" user-emacs-directory))
(add-to-list 'load-path (expand-file-name "gptel-tools" user-emacs-directory))
(setq load-prefer-newer t)
(unless (featurep 'gptel)
(defvar gptel-tools nil)
(defun gptel-make-tool (&rest _args) nil)
(defun gptel-get-tool (&rest _args) nil)
(provide 'gptel)))
(require 'write_text_file)
;; ------------------------------------------------------- helpers
(defun test-gptel-tools-write-text-file--in-home (suffix fn)
"Run FN with a fresh path under HOME using SUFFIX. Clean up after."
(let* ((name (format ".test-gptel-tools-write-text-file-%s-%s.tmp"
suffix (format-time-string "%s%N")))
(path (expand-file-name name "~")))
(unwind-protect
(funcall fn path)
(when (file-exists-p path) (delete-file path))
(dolist (b (file-expand-wildcards (concat path "-*.bak")))
(when (file-exists-p b) (delete-file b))))))
;; --------------------------------------------- validate-path
(ert-deftest test-gptel-tools-write-text-file-validate-path-normal ()
"Normal: returns the expanded path for a HOME-relative input."
(let ((result (cj/write-text-file--validate-path "foo.txt")))
(should (string-prefix-p (expand-file-name "~") result))
(should (string-suffix-p "/foo.txt" result))))
(ert-deftest test-gptel-tools-write-text-file-validate-path-error-outside-home ()
"Error: a path outside HOME signals."
(should-error (cj/write-text-file--validate-path "/etc/hostname")))
(ert-deftest test-gptel-tools-write-text-file-validate-path-boundary-absolute-home-path ()
"Boundary: absolute HOME paths are accepted."
(test-gptel-tools-write-text-file--in-home
"absolute"
(lambda (path)
(should (equal (cj/write-text-file--validate-path path) path)))))
(ert-deftest test-gptel-tools-write-text-file-validate-path-error-existing-symlink-outside-home ()
"Error: an existing symlink inside HOME pointing outside HOME is rejected."
(let ((outside (make-temp-file "test-gptel-tools-write-text-file-outside-"))
(link (expand-file-name
(format ".test-gptel-tools-write-text-file-outside-link-%s.tmp"
(format-time-string "%s%N"))
"~")))
(unwind-protect
(progn
(make-symbolic-link outside link t)
(should-error (cj/write-text-file--validate-path link)))
(when (file-exists-p outside) (delete-file outside))
(when (file-symlink-p link) (delete-file link)))))
(ert-deftest test-gptel-tools-write-text-file-validate-path-error-parent-symlink-outside-home ()
"Error: a parent symlink inside HOME pointing outside HOME is rejected."
(let ((outside-dir (make-temp-file "test-gptel-tools-write-text-file-outside-dir-" t))
(link-dir (expand-file-name
(format ".test-gptel-tools-write-text-file-outside-dir-link-%s"
(format-time-string "%s%N"))
"~")))
(unwind-protect
(progn
(make-symbolic-link outside-dir link-dir t)
(should-error
(cj/write-text-file--validate-path
(expand-file-name "child.txt" link-dir))))
(when (file-symlink-p link-dir) (delete-file link-dir))
(when (file-exists-p outside-dir) (delete-directory outside-dir t)))))
;; --------------------------------------------- backup-name
(ert-deftest test-gptel-tools-write-text-file-backup-name-shape ()
"Backup names append a YYYY-MM-DD-HHMMSS suffix and .bak."
(let ((name (cj/write-text-file--backup-name "/home/user/foo.txt")))
(should (string-prefix-p "/home/user/foo.txt-" name))
(should (string-suffix-p ".bak" name))
(should (string-match-p "-[0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}-[0-9]\\{6\\}\\.bak\\'"
name))))
;; --------------------------------------------- ensure-parent
(ert-deftest test-gptel-tools-write-text-file-ensure-parent-creates-missing ()
"Normal: creates missing parent directories."
(let* ((base (make-temp-file "test-gptel-tools-write-text-file-" t))
(deep (expand-file-name "a/b/c/file.txt" base)))
(unwind-protect
(progn
(cj/write-text-file--ensure-parent deep)
(should (file-directory-p (file-name-directory deep))))
(delete-directory base t))))
(ert-deftest test-gptel-tools-write-text-file-ensure-parent-error-unwritable ()
"Error: an unwritable parent signals."
(let* ((parent (make-temp-file "test-gptel-tools-write-text-file-ro-" t))
(target (expand-file-name "child.txt" parent)))
(unwind-protect
(progn
(set-file-modes parent #o500)
(should-error (cj/write-text-file--ensure-parent target)))
(set-file-modes parent #o700)
(delete-directory parent t))))
(ert-deftest test-gptel-tools-write-text-file-ensure-parent-error-create-fails ()
"Error: directory creation failures are wrapped with context."
(cl-letf (((symbol-function 'make-directory)
(lambda (&rest _args) (error "boom"))))
(should-error
(cj/write-text-file--ensure-parent
(expand-file-name "missing/child.txt" temporary-file-directory)))))
;; --------------------------------------------- run
(ert-deftest test-gptel-tools-write-text-file-run-normal ()
"Normal: writes new content and returns a status string."
(test-gptel-tools-write-text-file--in-home
"new"
(lambda (path)
(let ((result (cj/write-text-file--run
(file-name-nondirectory path) "hello\n" nil)))
(should (string-match-p "Successfully wrote" result))
(with-temp-buffer
(insert-file-contents path)
(should (equal (buffer-string) "hello\n")))))))
(ert-deftest test-gptel-tools-write-text-file-run-error-existing-no-overwrite ()
"Error: existing file without overwrite signals."
(test-gptel-tools-write-text-file--in-home
"existing"
(lambda (path)
(with-temp-file path (insert "old content\n"))
(should-error (cj/write-text-file--run
(file-name-nondirectory path) "new content\n" nil))
;; File preserved
(with-temp-buffer
(insert-file-contents path)
(should (equal (buffer-string) "old content\n"))))))
(ert-deftest test-gptel-tools-write-text-file-run-overwrite-creates-backup ()
"Overwrite path makes a timestamped backup before writing."
(test-gptel-tools-write-text-file--in-home
"overwrite"
(lambda (path)
(with-temp-file path (insert "old content\n"))
(cj/write-text-file--run
(file-name-nondirectory path) "new content\n" t)
;; New content landed
(with-temp-buffer
(insert-file-contents path)
(should (equal (buffer-string) "new content\n")))
;; Backup exists with old content
(let ((backups (file-expand-wildcards (concat path "-*.bak"))))
(should (= 1 (length backups)))
(with-temp-buffer
(insert-file-contents (car backups))
(should (equal (buffer-string) "old content\n")))))))
(ert-deftest test-gptel-tools-write-text-file-run-boundary-empty-content ()
"Boundary: nil content writes an empty file."
(test-gptel-tools-write-text-file--in-home
"empty"
(lambda (path)
(cj/write-text-file--run (file-name-nondirectory path) nil nil)
(should (file-exists-p path))
(should (= 0 (file-attribute-size (file-attributes path)))))))
(ert-deftest test-gptel-tools-write-text-file-run-large-user-accepts ()
"Boundary: large writes proceed when the user accepts."
(test-gptel-tools-write-text-file--in-home
"large-accept"
(lambda (path)
(let ((cj/write-text-file--size-limit 3))
(cl-letf (((symbol-function 'y-or-n-p) (lambda (_prompt) t)))
(cj/write-text-file--run (file-name-nondirectory path) "abcdef" nil)))
(with-temp-buffer
(insert-file-contents path)
(should (equal (buffer-string) "abcdef"))))))
(ert-deftest test-gptel-tools-write-text-file-run-large-user-declines ()
"Error: large writes cancel cleanly when the user declines."
(test-gptel-tools-write-text-file--in-home
"large-decline"
(lambda (path)
(let ((cj/write-text-file--size-limit 3))
(cl-letf (((symbol-function 'y-or-n-p) (lambda (_prompt) nil)))
(should-error
(cj/write-text-file--run (file-name-nondirectory path) "abcdef" nil))))
(should-not (file-exists-p path)))))
(ert-deftest test-gptel-tools-write-text-file-run-error-overwrite-backup-failure-preserves-file ()
"Error: backup failure prevents overwrite and preserves existing file."
(test-gptel-tools-write-text-file--in-home
"backup-fails"
(lambda (path)
(with-temp-file path (insert "old\n"))
(cl-letf (((symbol-function 'copy-file)
(lambda (&rest _args) (error "copy failed"))))
(should-error
(cj/write-text-file--run (file-name-nondirectory path) "new\n" t)))
(with-temp-buffer
(insert-file-contents path)
(should (equal (buffer-string) "old\n"))))))
(ert-deftest test-gptel-tools-write-text-file-run-error-outside-home ()
"Error: a path outside HOME signals."
(should-error (cj/write-text-file--run "/etc/test-write.txt" "x" nil)))
(provide 'test-gptel-tools-write-text-file)
;;; test-gptel-tools-write-text-file.el ends here
|
