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
|
;;; custom-tests.el --- tests for custom.el -*- lexical-binding: t -*-
;; Copyright (C) 2018-2021 Free Software Foundation, Inc.
;; 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 this program. If not, see <https://www.gnu.org/licenses/>.
;;; Code:
(require 'ert)
(require 'ert-x)
(require 'wid-edit)
(require 'cus-edit)
(defmacro custom-tests--with-temp-dir (&rest body)
"Eval BODY with `temporary-file-directory' bound to a fresh directory.
Ensure the directory is recursively deleted after the fact."
(declare (debug t) (indent 0))
(let ((dir (make-symbol "dir")))
`(let ((,dir (file-name-as-directory (make-temp-file "custom-tests-" t))))
(unwind-protect
(let ((temporary-file-directory ,dir))
,@body)
(delete-directory ,dir t)))))
(ert-deftest custom-theme--load-path ()
"Test `custom-theme--load-path' behavior."
(custom-tests--with-temp-dir
;; Path is empty.
(let ((custom-theme-load-path ()))
(should (null (custom-theme--load-path))))
;; Path comprises non-existent file.
(let* ((name (make-temp-name temporary-file-directory))
(custom-theme-load-path (list name)))
(should (not (file-exists-p name)))
(should (null (custom-theme--load-path))))
;; Path comprises existing file.
(let* ((file (make-temp-file "file"))
(custom-theme-load-path (list file)))
(should (file-exists-p file))
(should (not (file-directory-p file)))
(should (null (custom-theme--load-path))))
;; Path comprises existing directory.
(let* ((dir (make-temp-file "dir" t))
(custom-theme-load-path (list dir)))
(should (file-directory-p dir))
(should (equal (custom-theme--load-path) custom-theme-load-path)))
;; Expand `custom-theme-directory' path element.
(let ((custom-theme-load-path '(custom-theme-directory)))
(let ((custom-theme-directory (make-temp-name temporary-file-directory)))
(should (not (file-exists-p custom-theme-directory)))
(should (null (custom-theme--load-path))))
(let ((custom-theme-directory (make-temp-file "file")))
(should (file-exists-p custom-theme-directory))
(should (not (file-directory-p custom-theme-directory)))
(should (null (custom-theme--load-path))))
(let ((custom-theme-directory (make-temp-file "dir" t)))
(should (file-directory-p custom-theme-directory))
(should (equal (custom-theme--load-path)
(list custom-theme-directory)))))
;; Expand t path element.
(let ((custom-theme-load-path '(t)))
(let ((data-directory (make-temp-name temporary-file-directory)))
(should (not (file-exists-p data-directory)))
(should (null (custom-theme--load-path))))
(let ((data-directory temporary-file-directory)
(themedir (expand-file-name "themes" temporary-file-directory)))
(should (not (file-exists-p themedir)))
(should (null (custom-theme--load-path)))
(with-temp-file themedir)
(should (file-exists-p themedir))
(should (not (file-directory-p themedir)))
(should (null (custom-theme--load-path)))
(delete-file themedir)
(make-directory themedir)
(should (file-directory-p themedir))
(should (equal (custom-theme--load-path) (list themedir)))))))
(ert-deftest custom-tests-require-theme ()
"Test `require-theme'."
(custom-tests--with-temp-dir
(let* ((default-directory temporary-file-directory)
(custom-theme-load-path (list default-directory))
(load-path ()))
;; Generate some `.el' and `.elc' files.
(with-temp-file "custom-tests--a.el"
(insert "(provide 'custom-tests--a)"))
(make-empty-file "custom-tests--b.el")
(with-temp-file "custom-tests--b.elc"
(byte-compile-insert-header nil (current-buffer))
(insert "(provide 'custom-tests--b)"))
(make-empty-file "custom-tests--c.el")
(with-temp-file "custom-tests--d.elc"
(byte-compile-insert-header nil (current-buffer)))
;; Load them.
(dolist (feature '(a b c d e))
(should-not (featurep (intern (format "custom-tests--%s" feature)))))
(should (eq (require-theme 'custom-tests--a) 'custom-tests--a))
(delete-file "custom-tests--a.el")
(dolist (feature '(custom-tests--a custom-tests--b))
(should (eq (require-theme feature) feature))
(should (featurep feature)))
(dolist (feature '(custom-tests--c custom-tests--d))
(dolist (noerror '(nil t))
(let ((err (should-error (require-theme feature noerror))))
(should (string-search "failed to provide feature" (cadr err))))))
(should-error (require-theme 'custom-tests--e) :type 'file-missing)
(should-not (require-theme 'custom-tests--e t))
(dolist (feature '(custom-tests--c custom-tests--d custom-tests--e))
(should-not (featurep feature))))))
(defcustom custom--test-user-option 'foo
"User option for test."
:group 'emacs
:type 'symbol)
(defvar custom--test-variable 'foo
"Variable for test.")
;; This is demonstrating bug#34027.
(ert-deftest custom--test-theme-variables ()
"Test variables setting with enabling / disabling a custom theme."
;; We load custom-resources/custom--test-theme.el.
(let ((custom-theme-load-path `(,(ert-resource-directory))))
(load-theme 'custom--test 'no-confirm 'no-enable)
;; The variables have still their initial values.
(should (equal custom--test-user-option 'foo))
(should (equal custom--test-variable 'foo))
(custom-set-variables
'(custom--test-user-option 'baz)
'(custom--test-variable 'baz))
;; The initial values have been changed.
(should (equal custom--test-user-option 'baz))
(should (equal custom--test-variable 'baz))
;; Enable and then disable.
(enable-theme 'custom--test)
(disable-theme 'custom--test)
;; The variables should have the changed values, by reverting.
(should (equal custom--test-user-option 'baz))
(should (equal custom--test-variable 'baz))))
;; This tests Bug#5358.
(ert-deftest custom-test-show-comment-preserves-changes ()
"Test that adding a comment doesn't discard modifications in progress."
(customize-option 'custom--test-user-option)
(let* ((field (seq-find (lambda (widget)
(eq custom--test-user-option (widget-value widget)))
widget-field-list))
(parent (widget-get field :parent))
(origvalue (widget-value field)))
;; Move to the end of the text of the widget, and modify it. This
;; modification should be preserved after showing the comment field.
(goto-char (widget-field-text-end field))
(insert "bar")
(custom-comment-show parent)
;; From now on, must use `widget-at' to get the value of the widget.
(should-not (eq origvalue (widget-value (widget-at))))
(should (eq (widget-get parent :custom-state) 'modified))
(should (eq (widget-value (widget-at))
(widget-apply field
:value-to-external
(concat
(widget-apply field :value-to-internal origvalue)
"bar"))))))
(ert-deftest custom-test-enable-theme-keeps-settings ()
"Test that enabling a theme doesn't change its settings."
(let* ((custom-theme-load-path `(,(ert-resource-directory)))
settings)
(load-theme 'custom--test 'no-confirm 'no-enable)
(setq settings (get 'custom--test 'theme-settings))
(enable-theme 'custom--test)
(should (equal settings (get 'custom--test 'theme-settings)))))
(defcustom custom--test-local-option 'initial
"Buffer-local user option for testing."
:group 'emacs
:type '(choice (const initial) (const changed))
:local t)
(defcustom custom--test-permanent-option 'initial
"Permanently local user option for testing."
:group 'emacs
:type '(choice (const initial) (const changed))
:local 'permanent)
(ert-deftest custom-test-local-option ()
"Test :local user options."
;; Initial default values.
(should (eq custom--test-local-option 'initial))
(should (eq custom--test-permanent-option 'initial))
(should (eq (default-value 'custom--test-local-option) 'initial))
(should (eq (default-value 'custom--test-permanent-option) 'initial))
(let ((obuf (current-buffer)))
(with-temp-buffer
;; Changed buffer-local values.
(setq custom--test-local-option 'changed)
(setq custom--test-permanent-option 'changed)
(should (eq custom--test-local-option 'changed))
(should (eq custom--test-permanent-option 'changed))
(should (eq (default-value 'custom--test-local-option) 'initial))
(should (eq (default-value 'custom--test-permanent-option) 'initial))
(with-current-buffer obuf
(should (eq custom--test-local-option 'initial))
(should (eq custom--test-permanent-option 'initial)))
;; Permanent variable remains unchanged.
(kill-all-local-variables)
(should (eq custom--test-local-option 'initial))
(should (eq custom--test-permanent-option 'changed))
(should (eq (default-value 'custom--test-local-option) 'initial))
(should (eq (default-value 'custom--test-permanent-option) 'initial)))))
;; The following three tests demonstrate Bug#21355.
;; In this one, we set an user option for the current session and then
;; we enable a theme that doesn't have a setting for it, ending up with
;; a non-nil saved-value property. Since the `caar' of the theme-value
;; property is user (i.e., the user theme setting is active), we might
;; save the setting to the custom-file, even though it was meant for the
;; current session only. So there should be a nil saved-value property
;; for this test to pass.
(ert-deftest custom-test-no-saved-value-after-enabling-theme ()
"Test that we don't record a saved-value property when we shouldn't."
(let ((custom-theme-load-path `(,(ert-resource-directory))))
(customize-option 'mark-ring-max)
(let* ((field (seq-find (lambda (widget)
(eq mark-ring-max (widget-value widget)))
widget-field-list))
(parent (widget-get field :parent)))
;; Move to the editable widget, modify the value and save it.
(goto-char (widget-field-text-end field))
(insert "0")
(widget-apply parent :custom-set)
;; Just setting for the current session should not store a saved-value
;; property.
(should-not (get 'mark-ring-max 'saved-value))
;; Now enable and disable the test theme.
(load-theme 'custom--test 'no-confirm)
(disable-theme 'custom--test)
;; Since the user customized the option, this is OK.
(should (eq (caar (get 'mark-ring-max 'theme-value)) 'user))
;; The saved-value property should still be nil.
(should-not (get 'mark-ring-max 'saved-value)))))
;; In this second test, we load a theme that has a setting for the user option
;; above. We must check that we don't end up with a non-nil saved-value
;; property and a user setting active in the theme-value property, which
;; means we might inadvertently save the session setting in the custom-file.
(defcustom custom--test-bug-21355-before 'foo
"User option for `custom-test-no-saved-value-after-enabling-theme-2'."
:type 'symbol :group 'emacs)
(ert-deftest custom-test-no-saved-value-after-enabling-theme-2 ()
"Test that we don't record a saved-value property when we shouldn't."
(let ((custom-theme-load-path `(,(ert-resource-directory))))
(customize-option 'custom--test-bug-21355-before)
(let* ((field (seq-find
(lambda (widget)
(eq custom--test-bug-21355-before (widget-value widget)))
widget-field-list))
(parent (widget-get field :parent)))
;; Move to the editable widget, modify the value and save it.
(goto-char (widget-field-text-end field))
(insert "bar")
(widget-apply parent :custom-set)
;; Just setting for the current session should not store a saved-value
;; property.
(should-not (get 'custom--test-bug-21355-before 'saved-value))
;; Now load our test theme, which has a setting for
;; `custom--test-bug-21355-before'.
(load-theme 'custom--test 'no-confirm 'no-enable)
(enable-theme 'custom--test)
;; Since the user customized the option, this is OK.
(should (eq (caar (get 'custom--test-bug-21355-before 'theme-value))
'user))
;; But the saved-value property has to be nil, since the user didn't mark
;; this variable to save for future sessions.
(should-not (get 'custom--test-bug-21355-before 'saved-value)))))
(defvar custom--test-bug-21355-after)
;; In this test, we check that stashing a theme value for a not yet defined
;; option works, but that later on if the user customizes the option for the
;; current session, we might save the theme setting in the custom file.
(ert-deftest custom-test-no-saved-value-after-customizing-option ()
"Test for a nil saved-value after setting an option for the current session."
(let ((custom-theme-load-path `(,(ert-resource-directory))))
;; Check that we correctly stashed the value.
(load-theme 'custom--test 'no-confirm 'no-enable)
(enable-theme 'custom--test)
(should (and (not (boundp 'custom--test-bug-21355-after))
(eq (eval
(car (get 'custom--test-bug-21355-after 'saved-value)))
'after)))
;; Now Emacs finds the defcustom.
(defcustom custom--test-bug-21355-after 'initially "..."
:type 'symbol :group 'emacs)
;; And we used the stashed value correctly.
(should (and (boundp 'custom--test-bug-21355-after)
(eq custom--test-bug-21355-after 'after)))
;; Now customize it.
(customize-option 'custom--test-bug-21355-after)
(let* ((field (seq-find (lambda (widget)
(eq custom--test-bug-21355-after
(widget-value widget)))
widget-field-list))
(parent (widget-get field :parent)))
;; Move to the editable widget, modify the value and save it.
(goto-char (widget-field-text-end field))
(insert "bar")
(widget-apply parent :custom-set)
;; The user customized the variable, so this is OK.
(should (eq (caar (get 'custom--test-bug-21355-after 'theme-value))
'user))
;; But it was only for the current session, so this should not happen.
(should-not (get 'custom--test-bug-21355-after 'saved-value)))))
;;; custom-tests.el ends here
|
