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
|
;;; em-glob-tests.el --- em-glob test suite -*- lexical-binding:t -*-
;; Copyright (C) 2022-2025 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Tests for Eshell's glob expansion.
;;; Code:
(require 'tramp)
(require 'ert)
(require 'em-glob)
(require 'eshell-tests-helpers
(expand-file-name "eshell-tests-helpers"
(file-name-directory (or load-file-name
default-directory))))
(defvar eshell-prefer-lisp-functions)
(defmacro with-fake-files (files &rest body)
"Evaluate BODY forms, pretending that FILES exist on the filesystem.
FILES is a list of file names that should be reported as
appropriate by `file-name-all-completions'. Any file name
component ending in \"symlink\" is treated as a symbolic link."
(declare (indent 1))
`(cl-letf (((symbol-function 'file-name-all-completions)
(lambda (file directory)
(cl-assert (string= file ""))
(setq directory (expand-file-name directory))
`("./" "../"
,@(delete-dups
(remq nil
(mapcar
(lambda (file)
(setq file (expand-file-name file))
(when (string-prefix-p directory file)
(replace-regexp-in-string
"/.*" "/"
(substring file (length directory)))))
,files))))))
((symbol-function 'file-symlink-p)
(lambda (file)
(string-suffix-p "symlink" file))))
,@body))
;;; Tests:
;; Glob expansion
(ert-deftest em-glob-test/expand/splice-results ()
"Test that globs are spliced into the argument list when
`eshell-glob-splice-results' is non-nil."
(let ((eshell-prefer-lisp-functions t)
(eshell-glob-splice-results t))
(with-fake-files '("a.el" "b.el" "c.txt")
;; Ensure the default expansion splices the glob.
(eshell-command-result-equal "funcall list *.el" '("a.el" "b.el"))
(eshell-command-result-equal "funcall list *.txt" '("c.txt"))
;; When splitting, no-matches cases also return a list containing
;; the original non-matching glob.
(eshell-command-result-equal "funcall list *.no" '("*.no"))
(when (eshell-tests-remote-accessible-p)
(let ((remote (file-remote-p ert-remote-temporary-file-directory)))
(eshell-command-result-equal (format "funcall list %s~/a.el" remote)
`(,(format "%s~/a.el" remote))))))))
(ert-deftest em-glob-test/expand/no-splice-results ()
"Test that globs are treated as lists when
`eshell-glob-splice-results' is nil."
(let ((eshell-prefer-lisp-functions t)
(eshell-glob-splice-results nil))
(with-fake-files '("a.el" "b.el" "c.txt")
;; Ensure the default expansion splices the glob.
(eshell-command-result-equal "funcall list *.el" '(("a.el" "b.el")))
(eshell-command-result-equal "funcall list *.txt" '(("c.txt")))
;; The no-matches cases are special here: the glob is just the
;; string, not the list of results.
(eshell-command-result-equal "funcall list *.no" '("*.no"))
(when (eshell-tests-remote-accessible-p)
(let ((remote (file-remote-p ert-remote-temporary-file-directory)))
(eshell-command-result-equal (format "funcall list %s~/a.el" remote)
`(,(format "%s~/a.el" remote))))))))
(ert-deftest em-glob-test/expand/explicitly-splice-results ()
"Test explicitly splicing globs works the same no matter the
value of `eshell-glob-splice-results'."
(let ((eshell-prefer-lisp-functions t))
(dolist (eshell-glob-splice-results '(nil t))
(ert-info ((format "eshell-glob-splice-results: %s"
eshell-glob-splice-results))
(with-fake-files '("a.el" "b.el" "c.txt")
(eshell-command-result-equal "funcall list $@{listify *.el}"
'("a.el" "b.el"))
(eshell-command-result-equal "funcall list $@{listify *.txt}"
'("c.txt"))
(eshell-command-result-equal "funcall list $@{listify *.no}"
'("*.no")))))))
(ert-deftest em-glob-test/expand/explicitly-listify-results ()
"Test explicitly listifying globs works the same no matter the
value of `eshell-glob-splice-results'."
(let ((eshell-prefer-lisp-functions t))
(dolist (eshell-glob-splice-results '(nil t))
(ert-info ((format "eshell-glob-splice-results: %s"
eshell-glob-splice-results))
(with-fake-files '("a.el" "b.el" "c.txt")
(eshell-command-result-equal "funcall list ${listify *.el}"
'(("a.el" "b.el")))
(eshell-command-result-equal "funcall list ${listify *.txt}"
'(("c.txt")))
(eshell-command-result-equal "funcall list ${listify *.no}"
'(("*.no"))))))))
;; Glob conversion
(ert-deftest em-glob-test/convert/current-start-directory ()
"Test converting a glob starting in the current directory."
(should (equal (eshell-glob-convert "*.el")
'("./" (("\\`.*\\.el\\'" . "\\`\\.")) nil))))
(ert-deftest em-glob-test/convert/relative-start-directory ()
"Test converting a glob starting in a relative directory."
(should (equal (eshell-glob-convert "some/where/*.el")
'("./some/where/" (("\\`.*\\.el\\'" . "\\`\\.")) nil))))
(ert-deftest em-glob-test/convert/absolute-start-directory ()
"Test converting a glob starting in an absolute directory."
(should (equal (eshell-glob-convert "/some/where/*.el")
'("/some/where/" (("\\`.*\\.el\\'" . "\\`\\.")) nil))))
(ert-deftest em-glob-test/convert/remote-start-directory ()
"Test converting a glob starting in a remote directory."
(skip-unless (eshell-tests-remote-accessible-p))
(let* ((default-directory ert-remote-temporary-file-directory)
(remote (file-remote-p default-directory)))
(should (equal (eshell-glob-convert (format "%s/some/where/*.el" remote))
`(,(format "%s/some/where/" remote)
(("\\`.*\\.el\\'" . "\\`\\.")) nil)))))
(ert-deftest em-glob-test/convert/quoted-start-directory ()
"Test converting a glob starting in a quoted directory name."
(should (equal (eshell-glob-convert
(concat (eshell-escape-arg "some where/") "*.el"))
'("./some where/" (("\\`.*\\.el\\'" . "\\`\\.")) nil))))
;; Glob matching
(ert-deftest em-glob-test/match-any-string ()
"Test that \"*\" pattern matches any string."
(with-fake-files '("a.el" "b.el" "c.txt" "dir/a.el")
(should (equal (eshell-extended-glob "*.el")
'("a.el" "b.el")))))
(ert-deftest em-glob-test/match-any-directory ()
"Test that \"*/\" pattern matches any directory."
(with-fake-files '("a.el" "b.el" "dir/a.el" "dir/sub/a.el" "symlink/")
(should (equal (eshell-extended-glob "*/")
'("dir/" "symlink/")))))
(ert-deftest em-glob-test/match-any-character ()
"Test that \"?\" pattern matches any character."
(with-fake-files '("a.el" "b.el" "ccc.el" "d.txt" "dir/a.el")
(should (equal (eshell-extended-glob "?.el")
'("a.el" "b.el")))))
(ert-deftest em-glob-test/match-recursive ()
"Test that \"**/\" recursively matches directories."
(with-fake-files '("a.el" "b.el" "ccc.el" "d.txt" "dir/a.el" "dir/sub/a.el"
"dir/symlink/a.el" "symlink/a.el" "symlink/sub/a.el")
(should (equal (eshell-extended-glob "**/a.el")
'("a.el" "dir/a.el" "dir/sub/a.el")))
(should (equal (eshell-extended-glob "**/")
'("dir/" "dir/sub/")))))
(ert-deftest em-glob-test/match-recursive-follow-symlinks ()
"Test that \"***/\" recursively matches directories, following symlinks."
(with-fake-files '("a.el" "b.el" "ccc.el" "d.txt" "dir/a.el" "dir/sub/a.el"
"dir/symlink/a.el" "symlink/a.el" "symlink/sub/a.el")
(should (equal (eshell-extended-glob "***/a.el")
'("a.el" "dir/a.el" "dir/sub/a.el" "dir/symlink/a.el"
"symlink/a.el" "symlink/sub/a.el")))
(should (equal (eshell-extended-glob "***/")
'("dir/" "dir/sub/" "dir/symlink/" "symlink/"
"symlink/sub/")))))
(ert-deftest em-glob-test/match-recursive-mixed ()
"Test combination of \"**/\" and \"***/\"."
(with-fake-files '("dir/a.el" "dir/sub/a.el" "dir/sub2/a.el"
"dir/symlink/a.el" "dir/sub/symlink/a.el" "symlink/a.el"
"symlink/sub/a.el" "symlink/sub/symlink/a.el")
(should (equal (eshell-extended-glob "**/sub/***/a.el")
'("dir/sub/a.el" "dir/sub/symlink/a.el")))
(should (equal (eshell-extended-glob "***/sub/**/a.el")
'("dir/sub/a.el" "symlink/sub/a.el")))))
(ert-deftest em-glob-test/match-character-set-individual ()
"Test \"[...]\" for individual characters."
(with-fake-files '("a.el" "b.el" "c.el" "d.el" "dir/a.el")
(should (equal (eshell-extended-glob "[ab].el")
'("a.el" "b.el")))
(should (equal (eshell-extended-glob "[^ab].el")
'("c.el" "d.el")))))
(ert-deftest em-glob-test/match-character-set-range ()
"Test \"[...]\" for character ranges."
(with-fake-files '("a.el" "b.el" "c.el" "d.el" "dir/a.el")
(should (equal (eshell-extended-glob "[a-c].el")
'("a.el" "b.el" "c.el")))
(should (equal (eshell-extended-glob "[^a-c].el")
'("d.el")))))
(ert-deftest em-glob-test/match-character-set-class ()
"Test \"[...]\" for character classes."
(with-fake-files '("1.el" "a.el" "b.el" "c.el" "dir/a.el")
(should (equal (eshell-extended-glob "[[:alpha:]].el")
'("a.el" "b.el" "c.el")))
(should (equal (eshell-extended-glob "[^[:alpha:]].el")
'("1.el")))))
(ert-deftest em-glob-test/match-character-set-mixed ()
"Test \"[...]\" with multiple kinds of members at once."
(with-fake-files '("1.el" "a.el" "b.el" "c.el" "d.el" "dir/a.el")
(should (equal (eshell-extended-glob "[ac-d[:digit:]].el")
'("1.el" "a.el" "c.el" "d.el")))
(should (equal (eshell-extended-glob "[^ac-d[:digit:]].el")
'("b.el")))))
(ert-deftest em-glob-test/match-group-alternative ()
"Test \"(x|y)\" matches either \"x\" or \"y\"."
(with-fake-files '("em-alias.el" "em-banner.el" "esh-arg.el" "misc.el"
"test/em-xtra.el")
(should (equal (eshell-extended-glob "e(m|sh)-*.el")
'("em-alias.el" "em-banner.el" "esh-arg.el")))))
(ert-deftest em-glob-test/match-n-or-more-characters ()
"Test that \"x#\" and \"x#\" match zero or more instances of \"x\"."
(with-fake-files '("h.el" "ha.el" "hi.el" "hii.el" "dir/hi.el")
(should (equal (eshell-extended-glob "hi#.el")
'("h.el" "hi.el" "hii.el")))
(should (equal (eshell-extended-glob "hi##.el")
'("hi.el" "hii.el")))))
(ert-deftest em-glob-test/match-n-or-more-groups ()
"Test that \"(x)#\" and \"(x)#\" match zero or more instances of \"(x)\"."
(with-fake-files '("h.el" "ha.el" "hi.el" "hii.el" "dir/hi.el")
(should (equal (eshell-extended-glob "hi#.el")
'("h.el" "hi.el" "hii.el")))
(should (equal (eshell-extended-glob "hi##.el")
'("hi.el" "hii.el")))))
(ert-deftest em-glob-test/match-n-or-more-character-sets ()
"Test that \"[x]#\" and \"[x]#\" match zero or more instances of \"[x]\"."
(with-fake-files '("w.el" "wh.el" "wha.el" "whi.el" "whaha.el" "dir/wha.el")
(should (equal (eshell-extended-glob "w[ah]#.el")
'("w.el" "wh.el" "wha.el" "whaha.el")))
(should (equal (eshell-extended-glob "w[ah]##.el")
'("wh.el" "wha.el" "whaha.el")))))
(ert-deftest em-glob-test/match-x-but-not-y ()
"Test that \"x~y\" matches \"x\" but not \"y\"."
(with-fake-files '("1" "12" "123" "42" "dir/1")
(should (equal (eshell-extended-glob "[[:digit:]]##~4?")
'("1" "12" "123")))))
(ert-deftest em-glob-test/match-dot-files ()
"Test that dot files are matched correctly."
(with-fake-files '("foo.el" ".emacs")
(should (equal (eshell-extended-glob ".*")
'("../" "./" ".emacs")))
(let (eshell-glob-include-dot-dot)
(should (equal (eshell-extended-glob ".*")
'(".emacs"))))
(let ((eshell-glob-include-dot-files t))
(should (equal (eshell-extended-glob "*")
'("../" "./" ".emacs" "foo.el")))
(let (eshell-glob-include-dot-dot)
(should (equal (eshell-extended-glob "*")
'(".emacs" "foo.el")))))))
(ert-deftest em-glob-test/no-matches ()
"Test behavior when a glob fails to match any files."
(with-fake-files '("foo.el" "bar.el")
(should (equal (eshell-extended-glob "*.txt")
"*.txt"))
(let ((eshell-glob-splice-results t))
(should (equal (eshell-extended-glob "*.txt")
'("*.txt"))))
(let ((eshell-error-if-no-glob t))
(should-error (eshell-extended-glob "*.txt")))))
(ert-deftest em-glob-test/remote-user-directory ()
"Test that remote directories using \"~\" pass through unchanged."
(skip-unless (eshell-tests-remote-accessible-p))
(let* ((default-directory ert-remote-temporary-file-directory)
(remote (file-remote-p default-directory))
(eshell-error-if-no-glob t))
(should (equal (eshell-extended-glob (format "%s~/file.txt" remote))
(format "%s~/file.txt" remote)))))
;; em-glob-tests.el ends here
|
