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
|
;;; files-x-tests.el --- tests for files-x.el. -*- lexical-binding: t -*-
;; Copyright (C) 2016-2021 Free Software Foundation, Inc.
;; Author: Michael Albinus <michael.albinus@gmx.de>
;; 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/>.
;;; Code:
(require 'ert)
(require 'files-x)
(defconst files-x-test--variables1
'((remote-shell-file-name . "/bin/bash")
(remote-shell-command-switch . "-c")
(remote-shell-interactive-switch . "-i")
(remote-shell-login-switch . "-l")))
(defconst files-x-test--variables2
'((remote-shell-file-name . "/bin/ksh")))
(defconst files-x-test--variables3
'((remote-null-device . "/dev/null")))
(defconst files-x-test--variables4
'((remote-null-device . "null")))
(defvar remote-null-device)
(put 'remote-shell-file-name 'safe-local-variable #'identity)
(put 'remote-shell-command-switch 'safe-local-variable #'identity)
(put 'remote-shell-interactive-switch 'safe-local-variable #'identity)
(put 'remote-shell-login-switch 'safe-local-variable #'identity)
(put 'remote-null-device 'safe-local-variable #'identity)
(defconst files-x-test--application '(:application 'my-application))
(defconst files-x-test--another-application
'(:application 'another-application))
(defconst files-x-test--protocol '(:protocol "my-protocol"))
(defconst files-x-test--user '(:user "my-user"))
(defconst files-x-test--machine '(:machine "my-machine"))
(defvar files-x-test--criteria nil)
(defconst files-x-test--criteria1
(append files-x-test--application files-x-test--protocol
files-x-test--user files-x-test--machine))
(defconst files-x-test--criteria2
(append files-x-test--another-application files-x-test--protocol
files-x-test--user files-x-test--machine))
(ert-deftest files-x-test-connection-local-set-profile-variables ()
"Test setting connection-local profile variables."
;; Declare (PROFILE VARIABLES) objects.
(let (connection-local-profile-alist connection-local-criteria-alist)
(connection-local-set-profile-variables
'remote-bash files-x-test--variables1)
(should
(equal
(connection-local-get-profile-variables 'remote-bash)
files-x-test--variables1))
(connection-local-set-profile-variables
'remote-ksh files-x-test--variables2)
(should
(equal
(connection-local-get-profile-variables 'remote-ksh)
files-x-test--variables2))
(connection-local-set-profile-variables
'remote-nullfile files-x-test--variables3)
(should
(equal
(connection-local-get-profile-variables 'remote-nullfile)
files-x-test--variables3))
;; A redefinition overwrites existing values.
(connection-local-set-profile-variables
'remote-nullfile files-x-test--variables4)
(should
(equal
(connection-local-get-profile-variables 'remote-nullfile)
files-x-test--variables4))))
(ert-deftest files-x-test-connection-local-set-profiles ()
"Test setting connection-local profiles."
;; Declare (CRITERIA PROFILES) objects.
(let (connection-local-profile-alist connection-local-criteria-alist)
(connection-local-set-profile-variables
'remote-bash files-x-test--variables1)
(connection-local-set-profile-variables
'remote-ksh files-x-test--variables2)
(connection-local-set-profile-variables
'remote-nullfile files-x-test--variables3)
;; Use a criteria with all properties.
(setq files-x-test--criteria
(append files-x-test--application files-x-test--protocol
files-x-test--user files-x-test--machine))
;; An empty variable list is accepted (but makes no sense).
(connection-local-set-profiles files-x-test--criteria)
(should-not (connection-local-get-profiles files-x-test--criteria))
;; First test, all declared properties.
(connection-local-set-profiles
files-x-test--criteria 'remote-bash 'remote-ksh)
(should
(equal
(connection-local-get-profiles files-x-test--criteria)
'(remote-bash remote-ksh)))
;; Changing the order of properties doesn't matter.
(setq files-x-test--criteria
(append files-x-test--protocol files-x-test--application
files-x-test--machine files-x-test--user))
(should
(equal
(connection-local-get-profiles files-x-test--criteria)
'(remote-bash remote-ksh)))
;; A further call adds profiles.
(connection-local-set-profiles files-x-test--criteria 'remote-nullfile)
(should
(equal
(connection-local-get-profiles files-x-test--criteria)
'(remote-bash remote-ksh remote-nullfile)))
;; Adding existing profiles doesn't matter.
(connection-local-set-profiles
files-x-test--criteria 'remote-bash 'remote-nullfile)
(should
(equal
(connection-local-get-profiles files-x-test--criteria)
'(remote-bash remote-ksh remote-nullfile)))
;; Use different properties.
(dolist (criteria
`(;; All properties.
,(append files-x-test--application files-x-test--protocol
files-x-test--user files-x-test--machine)
;; Without :application.
,(append files-x-test--protocol
files-x-test--user files-x-test--machine)
;; Without :protocol.
,(append files-x-test--application
files-x-test--user files-x-test--machine)
;; Without :user.
,(append files-x-test--application files-x-test--protocol
files-x-test--machine)
;; Without :machine.
,(append files-x-test--application files-x-test--protocol
files-x-test--user)
;; No property at all.
nil))
(should
(equal
(connection-local-get-profiles criteria)
'(remote-bash remote-ksh remote-nullfile))))
;; Using a nil criteria also works. Duplicate profiles are trashed.
(connection-local-set-profiles
nil 'remote-bash 'remote-ksh 'remote-ksh 'remote-bash)
;; This matches also the existing profiles from other criteria.
(should
(equal
(connection-local-get-profiles nil)
'(remote-bash remote-ksh remote-nullfile)))
;; A criteria other than plist is wrong.
(should-error (connection-local-set-profiles 'dummy))))
(ert-deftest files-x-test-hack-connection-local-variables-apply ()
"Test setting connection-local variables."
(let (connection-local-profile-alist connection-local-criteria-alist)
(connection-local-set-profile-variables
'remote-bash files-x-test--variables1)
(connection-local-set-profile-variables
'remote-ksh files-x-test--variables2)
(connection-local-set-profile-variables
'remote-nullfile files-x-test--variables3)
(connection-local-set-profiles
files-x-test--criteria1 'remote-bash 'remote-ksh)
(connection-local-set-profiles
files-x-test--criteria2 'remote-ksh 'remote-nullfile)
;; Apply the variables.
(with-temp-buffer
(let ((enable-connection-local-variables t))
(should-not connection-local-variables-alist)
(should-not (local-variable-p 'remote-shell-file-name))
(should-not (boundp 'remote-shell-file-name))
(hack-connection-local-variables-apply files-x-test--criteria1)
;; All connection-local variables are set. They apply in
;; reverse order in `connection-local-variables-alist'. The
;; settings from `remote-ksh' are not contained, because they
;; declare same variables as in `remote-bash'.
(should
(equal connection-local-variables-alist
(nreverse (copy-tree files-x-test--variables1))))
;; The variables exist also as local variables.
(should (local-variable-p 'remote-shell-file-name))
;; The proper variable value is set.
(should
(string-equal (symbol-value 'remote-shell-file-name) "/bin/bash"))))
;; The second test case.
(with-temp-buffer
(let ((enable-connection-local-variables t))
(should-not connection-local-variables-alist)
(should-not (local-variable-p 'remote-shell-file-name))
(should-not (boundp 'remote-shell-file-name))
(hack-connection-local-variables-apply files-x-test--criteria2)
;; All connection-local variables are set. They apply in
;; reverse order in `connection-local-variables-alist'.
(should
(equal connection-local-variables-alist
(append
(nreverse (copy-tree files-x-test--variables3))
(nreverse (copy-tree files-x-test--variables2)))))
;; The variables exist also as local variables.
(should (local-variable-p 'remote-shell-file-name))
;; The proper variable value is set.
(should
(string-equal (symbol-value 'remote-shell-file-name) "/bin/ksh"))))
;; The third test case. Both criteria `files-x-test--criteria1'
;; and `files-x-test--criteria2' apply, but there are no double
;; entries.
(connection-local-set-profiles
nil 'remote-bash 'remote-ksh)
(with-temp-buffer
(let ((enable-connection-local-variables t))
(should-not connection-local-variables-alist)
(should-not (local-variable-p 'remote-shell-file-name))
(should-not (boundp 'remote-shell-file-name))
(hack-connection-local-variables-apply nil)
;; All connection-local variables are set. They apply in
;; reverse order in `connection-local-variables-alist'. The
;; settings from `remote-ksh' are not contained, because they
;; declare same variables as in `remote-bash'.
(should
(equal connection-local-variables-alist
(append
(nreverse (copy-tree files-x-test--variables3))
(nreverse (copy-tree files-x-test--variables1)))))
;; The variables exist also as local variables.
(should (local-variable-p 'remote-shell-file-name))
;; The proper variable value is set.
(should
(string-equal (symbol-value 'remote-shell-file-name) "/bin/bash"))))
;; When `enable-connection-local-variables' is nil, nothing happens.
(with-temp-buffer
(let ((enable-connection-local-variables nil))
(should-not connection-local-variables-alist)
(should-not (local-variable-p 'remote-shell-file-name))
(should-not (boundp 'remote-shell-file-name))
(hack-connection-local-variables-apply nil)
(should-not connection-local-variables-alist)
(should-not (local-variable-p 'remote-shell-file-name))
(should-not (boundp 'remote-shell-file-name))))))
(defvar tramp-connection-local-default-shell-variables)
(defvar tramp-connection-local-default-system-variables)
(ert-deftest files-x-test-with-connection-local-variables ()
"Test setting connection-local variables."
(let (connection-local-profile-alist connection-local-criteria-alist)
(connection-local-set-profile-variables
'remote-bash files-x-test--variables1)
(connection-local-set-profile-variables
'remote-ksh files-x-test--variables2)
(connection-local-set-profile-variables
'remote-nullfile files-x-test--variables3)
(connection-local-set-profiles
nil 'remote-ksh 'remote-nullfile)
(with-temp-buffer
(let ((enable-connection-local-variables t))
(hack-connection-local-variables-apply nil)
;; All connection-local variables are set. They apply in
;; reverse order in `connection-local-variables-alist'.
(should
(equal connection-local-variables-alist
(append
(nreverse (copy-tree files-x-test--variables3))
(nreverse (copy-tree files-x-test--variables2)))))
;; The variables exist also as local variables.
(should (local-variable-p 'remote-shell-file-name))
(should (local-variable-p 'remote-null-device))
;; The proper variable values are set.
(should
(string-equal (symbol-value 'remote-shell-file-name) "/bin/ksh"))
(should
(string-equal (symbol-value 'remote-null-device) "/dev/null"))
;; A candidate connection-local variable is not bound yet.
(should-not (local-variable-p 'remote-shell-command-switch))))
(with-temp-buffer
;; Use the macro. We need a remote `default-directory'.
(let ((enable-connection-local-variables t)
(default-directory "/method:host:")
(remote-null-device "null"))
(should-not connection-local-variables-alist)
(should-not (local-variable-p 'remote-shell-file-name))
(should-not (local-variable-p 'remote-null-device))
(should-not (boundp 'remote-shell-file-name))
(should (string-equal (symbol-value 'remote-null-device) "null"))
(with-connection-local-variables
;; All connection-local variables are set. They apply in
;; reverse order in `connection-local-variables-alist'.
;; Since we ha a remote default directory, Tramp's settings
;; are appended as well.
(should
(equal
connection-local-variables-alist
(append
(nreverse (copy-tree files-x-test--variables3))
(nreverse (copy-tree files-x-test--variables2))
(nreverse
(copy-tree tramp-connection-local-default-shell-variables))
(nreverse
(copy-tree tramp-connection-local-default-system-variables)))))
;; The variables exist also as local variables.
(should (local-variable-p 'remote-shell-file-name))
(should (local-variable-p 'remote-null-device))
;; The proper variable values are set.
(should
(string-equal (symbol-value 'remote-shell-file-name) "/bin/ksh"))
(should
(string-equal (symbol-value 'remote-null-device) "/dev/null")))
;; Everything is rewound. The old variable values are reset.
(should-not connection-local-variables-alist)
;; The variables don't exist as local variables.
(should-not (local-variable-p 'remote-shell-file-name))
(should-not (local-variable-p 'remote-null-device))
;; The variable values are reset.
(should-not (boundp 'remote-shell-file-name))
(should (string-equal (symbol-value 'remote-null-device) "null"))))))
(provide 'files-x-tests)
;;; files-x-tests.el ends here
|
