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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
;;; bookmark-tests.el --- Tests for bookmark.el -*- lexical-binding: t -*-
;; Copyright (C) 2019-2020 Free Software Foundation, Inc.
;; Author: Stefan Kangas <stefankangas@gmail.com>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'ert)
(require 'bookmark)
(defvar bookmark-tests-data-dir
(file-truename
(expand-file-name "bookmark-resources/"
(file-name-directory (or load-file-name
buffer-file-name))))
"Base directory of bookmark-tests.el data files.")
(defvar bookmark-tests-bookmark-file
(expand-file-name "test.bmk" bookmark-tests-data-dir)
"Bookmark file used for testing.")
(defvar bookmark-tests-example-file
;; We use abbreviate-file-name here to match the behavior of
;; `bookmark-buffer-file-name'.
(abbreviate-file-name (expand-file-name "example.txt" bookmark-tests-data-dir))
"Example file used for testing.")
;; The values below should match `bookmark-tests-bookmark-file'. We cache
;; these values to speed up tests by avoiding unnecessary I/O. This
;; makes tests run 5-10 times faster on my system.
(eval-and-compile ; needed by `with-bookmark-test' macro
(defvar bookmark-tests-bookmark '("name"
(filename . "/some/file")
(front-context-string . "abc")
(rear-context-string . "def")
(position . 3))
"Cached value used in bookmark-tests.el."))
(defvar bookmark-tests-cache-timestamp
(cons bookmark-tests-bookmark-file
(nth 5 (file-attributes
bookmark-tests-bookmark-file)))
"Cached value used in bookmark-tests.el.")
(defmacro with-bookmark-test (&rest body)
"Create environment for testing bookmark.el and evaluate BODY.
Ensure a clean environment for testing, and do not change user
data when running tests interactively."
`(with-temp-buffer
(let ((bookmark-alist (quote (,(copy-sequence bookmark-tests-bookmark))))
(bookmark-default-file bookmark-tests-bookmark-file)
(bookmark-bookmarks-timestamp bookmark-tests-cache-timestamp)
bookmark-save-flag)
,@body)))
(defmacro with-bookmark-test-file (&rest body)
"Create environment for testing bookmark.el and evaluate BODY.
Same as `with-bookmark-test' but also opens the resource file
example.txt in a buffer, which can be accessed by callers through
the lexically-bound variable `buffer'."
`(let ((buffer (find-file-noselect bookmark-tests-example-file)))
(unwind-protect
(with-bookmark-test
,@body)
(kill-buffer buffer))))
(ert-deftest bookmark-tests-all-names ()
(with-bookmark-test
(should (equal (bookmark-all-names) '("name")))))
(ert-deftest bookmark-tests-get-bookmark ()
(with-bookmark-test
(should (equal (bookmark-get-bookmark "name") bookmark-tests-bookmark))))
(ert-deftest bookmark-tests-get-bookmark-record ()
(with-bookmark-test
(should (equal (bookmark-get-bookmark-record "name") (cdr bookmark-tests-bookmark)))))
(ert-deftest bookmark-tests-record-getters-and-setters-new ()
(with-temp-buffer
(let* ((buffer-file-name "test")
(bmk (bookmark-make-record)))
(bookmark-set-name bmk "foobar")
(should (equal (bookmark-name-from-full-record bmk) "foobar"))
(bookmark-set-filename bmk "file/name")
(should (equal (bookmark-get-filename bmk) "file/name"))
(bookmark-set-position bmk 123)
(should (equal (bookmark-get-position bmk) 123))
(bookmark-set-front-context-string bmk "front")
(should (equal (bookmark-get-front-context-string bmk) "front"))
(bookmark-set-rear-context-string bmk "rear")
(should (equal (bookmark-get-rear-context-string bmk) "rear"))
(bookmark-prop-set bmk 'filename "prop")
(should (equal (bookmark-prop-get bmk 'filename) "prop")))))
(ert-deftest bookmark-tests-maybe-historicize-string ()
(let ((bookmark-history))
(bookmark-maybe-historicize-string "foo")
(should (equal (car bookmark-history) "foo"))))
(ert-deftest bookmark-tests-make-record ()
(with-bookmark-test-file
(let* ((record `("example.txt" (filename . ,bookmark-tests-example-file)
(front-context-string . "is text file is ")
(rear-context-string)
(position . 3)
(defaults "example.txt"))))
(with-current-buffer buffer
(goto-char 3)
(should (equal (bookmark-make-record) record))
;; calling twice gives same record
(should (equal (bookmark-make-record) record))))))
(ert-deftest bookmark-tests-make-record-function ()
(with-bookmark-test
(let ((buffer-file-name "test"))
;; Named bookmark
(let ((bookmark-make-record-function (lambda () '("<name>"))))
(should (equal (bookmark-make-record)
'("<name>"))))
;; SECOND format
(let ((bookmark-make-record-function (lambda () '(((position . 2))))))
(should (equal (bookmark-make-record)
'("test" ((position . 2) (defaults "test"))))))
;; CURRENT format
(let ((bookmark-make-record-function (lambda () '((position . 2)))))
(should (equal (bookmark-make-record)
'("test" (position . 2) (defaults "test"))))))))
(ert-deftest bookmark-tests-set ()
(with-bookmark-test-file
(let ((bmk1 `("foo" (filename . ,bookmark-tests-example-file)
(front-context-string . "This text file i")
(rear-context-string)
(position . 1)))
(bmk2 `("foo" (filename . ,bookmark-tests-example-file)
(front-context-string)
(rear-context-string . ".txt ends here.\n")
(position . 72)))
bookmark-alist)
(with-current-buffer buffer
;; 1. bookmark-set
;; Set first bookmark
(goto-char (point-min))
(bookmark-set "foo")
(should (equal bookmark-alist (list bmk1)))
;; Replace that bookmark
(goto-char (point-max))
(bookmark-set "foo")
(should (equal bookmark-alist (list bmk2)))
;; Push another bookmark with the same name
(goto-char (point-min))
(bookmark-set "foo" t) ; NO-OVERWRITE is t
(should (equal bookmark-alist (list bmk1 bmk2)))
;; 2. bookmark-set-no-overwrite
;; Don't overwrite
(should-error (bookmark-set-no-overwrite "foo"))
;; Set new bookmark
(setq bookmark-alist nil)
(bookmark-set-no-overwrite "foo")
(should (equal bookmark-alist (list bmk1)))
;; Push another bookmark with the same name
(goto-char (point-max))
(bookmark-set-no-overwrite "foo" t) ; PUSH-BOOKMARK is t
(should (equal bookmark-alist (list bmk2 bmk1)))
;; 3. bookmark-set-internal
(should-error (bookmark-set-internal "foo" "bar" t))))))
(ert-deftest bookmark-tests-set/bookmark-use-annotations-t ()
(with-bookmark-test-file
(let ((bookmark-use-annotations t))
(save-window-excursion
(switch-to-buffer buffer)
;; Should jump to edit annotation buffer
(bookmark-set "foo")
(should (equal major-mode 'bookmark-edit-annotation-mode))
;; Should return to the original buffer
(bookmark-send-edited-annotation)
(should (equal (current-buffer) buffer))))))
(ert-deftest bookmark-tests-kill-line ()
(with-temp-buffer
(insert "foobar\n")
(goto-char (point-min))
(bookmark-kill-line)
(should (equal (buffer-string) "\n")))
(with-temp-buffer
(insert "foobar\n")
(goto-char (point-min))
(bookmark-kill-line t) ; including newline
(should (equal (buffer-string) ""))))
(ert-deftest bookmark-tests-default-annotation-text ()
(should (stringp (bookmark-default-annotation-text "foo")))
(should (string-match "foo" (bookmark-default-annotation-text "foo"))))
(ert-deftest bookmark-tests-insert-annotation ()
(with-bookmark-test
(should-error (bookmark-insert-annotation "a missing bookmark"))
(bookmark-insert-annotation "name")
(should (equal (buffer-string) (bookmark-default-annotation-text "name"))))
(with-bookmark-test
(bookmark-set-annotation "name" "some stuff")
(bookmark-insert-annotation "name")
(should (string-match "some stuff" (buffer-string)))))
(ert-deftest bookmark-tests-edit-annotation ()
(with-bookmark-test
(bookmark-edit-annotation "name")
(insert "new text")
(bookmark-send-edited-annotation)
(should (equal (bookmark-get-annotation "name") "new text"))))
(ert-deftest bookmark-tests-jump ()
(with-bookmark-test-file
(with-current-buffer buffer
(bookmark-set "test"))
(bookmark-jump "test")
(should (equal (current-buffer) buffer))
(should-error (bookmark-jump nil))))
(ert-deftest bookmark-tests-insert-location ()
(with-bookmark-test
(bookmark-insert-location "name")
(should (equal (buffer-string) "/some/file"))))
(ert-deftest bookmark-tests-location ()
(with-bookmark-test
(should (equal (bookmark-location "name") "/some/file"))))
(ert-deftest bookmark-tests-rename ()
(with-bookmark-test
(bookmark-rename "name" "newname")
(should (equal (bookmark-all-names) '("newname")))))
(ert-deftest bookmark-tests-insert ()
(with-bookmark-test-file
(with-current-buffer buffer
(bookmark-set "test"))
(bookmark-insert "test")
(should (string-match "^This text file is used by bookmark-tests.el"
(buffer-string)))))
(ert-deftest bookmark-tests-delete ()
(with-bookmark-test
(bookmark-delete "name")
(should (equal bookmark-alist nil))))
(defmacro with-bookmark-test-save-load (&rest body)
"Create environment for testing bookmark.el and evaluate BODY.
Same as `with-bookmark-test' but also sets a temporary
`bookmark-default-file', evaluates BODY, and then runs the test
that saves and then loads the bookmark file."
`(with-bookmark-test
(let ((file (make-temp-file "bookmark-tests-")))
(unwind-protect
(let ((bookmark-default-file file)
(old-alist bookmark-alist))
,@body
(bookmark-save nil file t)
(setq bookmark-alist nil)
(bookmark-load file nil t)
(should (equal bookmark-alist old-alist)))
(delete-file file)))))
(defvar bookmark-tests-non-ascii-data
(concat "Здра́вствуйте!" "中文,普通话,汉语" "åäöøñ"
"こんにちは" "你好" "Dobrý deň"
"∀ p ∈ world • hello p □"
;; These do not yield valid UTF-8 byte sequences.
;; WARNING: If you try to evaluate the first one of these,
;; there is a risk that Emacs will crash. Buyer beware.
(decode-coding-string "\xE3\x32\x9A\x36" 'chinese-gb18030)
(char-to-string (decode-char 'eight-bit #x81))))
(ert-deftest bookmark-tests-save ()
(with-bookmark-test-save-load
;; Just run the default test according to the macro.
t))
(ert-deftest bookmark-tests-save/non-ascii-bookmark-name ()
(with-bookmark-test-save-load
(bookmark-set-name "name" bookmark-tests-non-ascii-data)))
(ert-deftest bookmark-tests-save/non-ascii-annotation ()
(with-bookmark-test-save-load
(bookmark-set-annotation "name" bookmark-tests-non-ascii-data)))
(ert-deftest bookmark-tests-maybe-rename ()
(let ((bookmark '("foo")))
(bookmark-maybe-rename bookmark '("foo"))
(should (equal bookmark '("foo<2>")))))
(ert-deftest bookmark-tests-load ()
(with-bookmark-test
(should-error (bookmark-load "no/such/file"))
(let* ((bookmark-alist '()))
(bookmark-load bookmark-tests-bookmark-file nil t)
(should (equal bookmark-alist (list bookmark-tests-bookmark)))
(bookmark-load bookmark-tests-bookmark-file t t) ; OVERWRITE is t
(should (equal bookmark-alist (list bookmark-tests-bookmark)))
;; Append
(bookmark-load bookmark-tests-bookmark-file nil t) ; OVERWRITE is nil
(should (equal bookmark-alist
(list bookmark-tests-bookmark
(cons "name<2>" (cdr bookmark-tests-bookmark))))))))
;; TODO: Add more tests for bookmark-bmenu.
(defmacro with-bookmark-bmenu-test (&rest body)
"Create environment for testing `bookmark-bmenu-list' and evaluate BODY.
Same as `with-bookmark-test' but with additions suitable for
testing `bookmark-bmenu-list'."
`(with-bookmark-test
(let ((bookmark-bmenu-buffer "*Bookmark List - Testing*"))
(unwind-protect
(save-window-excursion
(bookmark-bmenu-list)
,@body)
(kill-buffer bookmark-bmenu-buffer)))))
(ert-deftest bookmark-bmenu.enu-edit-annotation/show-annotation ()
(with-bookmark-bmenu-test
(bookmark-set-annotation "name" "foo")
(bookmark-bmenu-edit-annotation)
(should (string-match "foo" (buffer-string)))
(kill-buffer (current-buffer))))
(ert-deftest bookmark-bmenu-send-edited-annotation ()
(with-bookmark-bmenu-test
(bookmark-bmenu-edit-annotation)
(insert "foo")
(bookmark-send-edited-annotation)
(should (equal (bookmark-get-annotation "name") "foo"))))
(ert-deftest bookmark-bmenu-send-edited-annotation/restore-focus ()
"Test for https://debbugs.gnu.org/20150 ."
(with-bookmark-bmenu-test
(bookmark-bmenu-edit-annotation)
(insert "foo")
(bookmark-send-edited-annotation)
(should (equal (buffer-name (current-buffer)) bookmark-bmenu-buffer))
(should (looking-at "name"))))
(provide 'bookmark-tests)
;;; bookmark-tests.el ends here
|
