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
|
;;; erc-goodies-tests.el --- Tests for erc-goodies -*- lexical-binding:t -*-
;; Copyright (C) 2023 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:
;;; Code:
(require 'ert-x)
(require 'erc-goodies)
(declare-function erc--initialize-markers "erc" (old-point continued) t)
(defun erc-goodies-tests--assert-face (beg end-str present &optional absent)
(setq beg (+ beg (point-min)))
(let ((end (+ beg (1- (length end-str)))))
(while (and beg (< beg end))
(let* ((val (get-text-property beg 'font-lock-face))
(ft (flatten-tree (ensure-list val))))
(dolist (p (ensure-list present))
(if (consp p)
(should (member p val))
(should (memq p ft))))
(dolist (a (ensure-list absent))
(if (consp a)
(should-not (member a val))
(should-not (memq a ft))))
(setq beg (text-property-not-all beg (point-max)
'font-lock-face val))))))
;; These are from the "Examples" section of
;; https://modern.ircdocs.horse/formatting.html
(ert-deftest erc-controls-highlight--examples ()
;; FIXME remove after adding
(unless (fboundp 'erc--initialize-markers)
(ert-skip "Missing required function"))
(should (eq t erc-interpret-controls-p))
(let ((erc-insert-modify-hook '(erc-controls-highlight))
erc-kill-channel-hook erc-kill-server-hook erc-kill-buffer-hook)
(with-current-buffer (get-buffer-create "#chan")
(erc-mode)
(setq-local erc-interpret-mirc-color t)
(erc--initialize-markers (point) nil)
(let* ((m "I love \C-c3IRC!\C-c It is the \C-c7best protocol ever!")
(msg (erc-format-privmessage "bob" m nil t)))
(erc-display-message nil nil (current-buffer) msg))
(forward-line -1)
(should (search-forward "<bob> " nil t))
(save-restriction
(narrow-to-region (point) (pos-eol))
(erc-goodies-tests--assert-face
0 "I love" 'erc-default-face 'fg:erc-color-face3)
(erc-goodies-tests--assert-face
7 " IRC!" 'fg:erc-color-face3)
(erc-goodies-tests--assert-face
11 " It is the " 'erc-default-face 'fg:erc-color-face7)
(erc-goodies-tests--assert-face
22 "best protocol ever!" 'fg:erc-color-face7))
(let* ((m "This is a \C-]\C-c13,9cool \C-cmessage")
(msg (erc-format-privmessage "alice" m nil t)))
(erc-display-message nil nil (current-buffer) msg))
(should (search-forward "<alice> " nil t))
(save-restriction
(narrow-to-region (point) (pos-eol))
(erc-goodies-tests--assert-face
0 "this is a " 'erc-default-face 'erc-italic-face)
(erc-goodies-tests--assert-face
10 "cool " '(erc-italic-face fg:erc-color-face13 bg:erc-color-face9))
(erc-goodies-tests--assert-face
15 "message" 'erc-italic-face
'(fg:erc-color-face13 bg:erc-color-face9)))
(let* ((m "IRC \C-bis \C-c4,12so \C-cgreat\C-o!")
(msg (erc-format-privmessage "bob" m nil t)))
(erc-display-message nil nil (current-buffer) msg))
(should (search-forward "<bob> " nil t))
(save-restriction
(narrow-to-region (point) (pos-eol))
(erc-goodies-tests--assert-face
0 "IRC " 'erc-default-face 'erc-bold-face)
(erc-goodies-tests--assert-face
4 "is " 'erc-bold-face '(fg:erc-color-face4 bg:erc-color-face12))
(erc-goodies-tests--assert-face
7 "so " '(erc-bold-face fg:erc-color-face4 bg:erc-color-face12))
(erc-goodies-tests--assert-face
10 "great" 'erc-bold-face '(fg:erc-color-face4 bg:erc-color-face12))
(erc-goodies-tests--assert-face
15 "!" 'erc-default-face 'erc-bold-face))
(let* ((m (concat "Rules: Don't spam 5\C-c13,8,6\C-c,7,8, "
"and especially not \C-b9\C-b\C-]!"))
(msg (erc-format-privmessage "alice" m nil t)))
(erc-display-message nil nil (current-buffer) msg))
(should (search-forward "<alice> " nil t))
(save-restriction
(narrow-to-region (point) (pos-eol))
(erc-goodies-tests--assert-face
0 "Rules: Don't spam 5" 'erc-default-face
'(fg:erc-color-face13 bg:erc-color-face8))
(erc-goodies-tests--assert-face
19 ",6" '(fg:erc-color-face13 bg:erc-color-face8))
(erc-goodies-tests--assert-face
21 ",7,8, and especially not " 'erc-default-face
'(fg:erc-color-face13 bg:erc-color-face8 erc-bold-face))
(erc-goodies-tests--assert-face
44 "9" 'erc-bold-face 'erc-italic-face)
(erc-goodies-tests--assert-face
45 "!" 'erc-italic-face 'erc-bold-face))
(when noninteractive
(kill-buffer)))))
;; Like the test above, this is most intuitive when run interactively.
;; Hovering over the redacted area should reveal its underlying text
;; in a high-contrast face.
(ert-deftest erc-controls-highlight--inverse ()
;; FIXME remove after adding
(unless (fboundp 'erc--initialize-markers)
(ert-skip "Missing required function"))
(should (eq t erc-interpret-controls-p))
(let ((erc-insert-modify-hook '(erc-controls-highlight))
erc-kill-channel-hook erc-kill-server-hook erc-kill-buffer-hook)
(with-current-buffer (get-buffer-create "#chan")
(erc-mode)
(setq-local erc-interpret-mirc-color t)
(erc--initialize-markers (point) nil)
(let* ((m "Spoiler: \C-c0,0Hello\C-c1,1World!")
(msg (erc-format-privmessage "bob" m nil t)))
(erc-display-message nil nil (current-buffer) msg))
(forward-line -1)
(should (search-forward "<bob> " nil t))
(save-restriction
(narrow-to-region (point) (pos-eol))
(should (eq (get-text-property (+ 9 (point)) 'mouse-face)
'erc-inverse-face))
(should (eq (get-text-property (1- (pos-eol)) 'mouse-face)
'erc-inverse-face))
(erc-goodies-tests--assert-face
0 "Spoiler: " 'erc-default-face
'(fg:erc-color-face0 bg:erc-color-face0))
(erc-goodies-tests--assert-face
9 "Hello" '(erc-spoiler-face)
'( fg:erc-color-face0 bg:erc-color-face0
fg:erc-color-face1 bg:erc-color-face1))
(erc-goodies-tests--assert-face
18 " World" '(erc-spoiler-face)
'( fg:erc-color-face0 bg:erc-color-face0
fg:erc-color-face1 bg:erc-color-face1 )))
(when noninteractive
(kill-buffer)))))
(defvar erc-goodies-tests--motd
;; This is from ergo's MOTD
'((":- - this is \2bold text\17.")
(":- - this is \35italics text\17.")
(":- - this is \0034red\3 and \0032blue\3 text.")
(":- - this is \0034,12red text with a light blue background\3.")
(":- - this is a normal escaped dollarsign: $")
(":- ")
(":- "
"\0031,0 00 \0030,1 01 \0030,2 02 \0030,3 03 "
"\0031,4 04 \0030,5 05 \0030,6 06 \0031,7 07 ")
(":- "
"\0031,8 08 \0031,9 09 \0030,10 10 \0031,11 11 "
"\0030,12 12 \0031,13 13 \0031,14 14 \0031,15 15 ")
(":- ")
(":- "
"\0030,16 16 \0030,17 17 \0030,18 18 \0030,19 19 "
"\0030,20 20 \0030,21 21 \0030,22 22 \0030,23 23 "
"\0030,24 24 \0030,25 25 \0030,26 26 \0030,27 27 ")
(":- "
"\0030,28 28 \0030,29 29 \0030,30 30 \0030,31 31 "
"\0030,32 32 \0030,33 33 \0030,34 34 \0030,35 35 "
"\0030,36 36 \0030,37 37 \0030,38 38 \0030,39 39 ")
(":- "
"\0030,40 40 \0030,41 41 \0030,42 42 \0030,43 43 "
"\0030,44 44 \0030,45 45 \0030,46 46 \0030,47 47 "
"\0030,48 48 \0030,49 49 \0030,50 50 \0030,51 51 ")
(":- "
"\0030,52 52 \0030,53 53 \0031,54 54 \0031,55 55 "
"\0031,56 56 \0031,57 57 \0031,58 58 \0030,59 59 "
"\0030,60 60 \0030,61 61 \0030,62 62 \0030,63 63 ")
(":- "
"\0030,64 64 \0031,65 65 \0031,66 66 \0031,67 67 "
"\0031,68 68 \0031,69 69 \0031,70 70 \0031,71 71 "
"\0030,72 72 \0030,73 73 \0030,74 74 \0030,75 75 ")
(":- "
"\0031,76 76 \0031,77 77 \0031,78 78 \0031,79 79 "
"\0031,80 80 \0031,81 81 \0031,82 82 \0031,83 83 "
"\0031,84 84 \0031,85 85 \0031,86 86 \0031,87 87 ")
(":- "
"\0030,88 88 \0030,89 89 \0030,90 90 \0030,91 91 "
"\0030,92 92 \0030,93 93 \0030,94 94 \0030,95 95 "
"\0031,96 96 \0031,97 97 \0031,98 98 \399,99 99 ")
(":- ")))
(ert-deftest erc-controls-highlight--motd ()
;; FIXME remove after adding
(unless (fboundp 'erc--initialize-markers)
(ert-skip "Missing required function"))
(should (eq t erc-interpret-controls-p))
(let ((erc-insert-modify-hook '(erc-controls-highlight))
erc-kill-channel-hook erc-kill-server-hook erc-kill-buffer-hook)
(with-current-buffer (get-buffer-create "#chan")
(erc-mode)
(setq-local erc-interpret-mirc-color t)
(erc--initialize-markers (point) nil)
(dolist (parts erc-goodies-tests--motd)
(erc-display-message nil 'notice (current-buffer) (string-join parts)))
;; Spot check
(goto-char (point-min))
(should (search-forward " 16 " nil t))
(save-restriction
(narrow-to-region (point) (pos-eol))
(erc-goodies-tests--assert-face
0 " 17 " '(fg:erc-color-face0 (:background "#472100")))
(erc-goodies-tests--assert-face
4 " 18 " '(fg:erc-color-face0 (:background "#474700"))
'((:background "#472100"))))
(should (search-forward " 71 " nil t))
(save-restriction
(narrow-to-region (point) (pos-eol))
(erc-goodies-tests--assert-face
0 " 72 " '(fg:erc-color-face0 (:background "#5959ff")))
(erc-goodies-tests--assert-face
4 " 73 " '(fg:erc-color-face0 (:background "#c459ff"))
'((:background "#5959ff"))))
(goto-char (point-min))
(when noninteractive
(kill-buffer)))))
;; Among other things, this test also asserts that a local module's
;; minor-mode toggle is allowed to disable its mode variable as
;; needed.
(ert-deftest erc-keep-place-indicator-mode ()
;; FIXME remove after adding
(unless (fboundp 'erc--initialize-markers)
(ert-skip "Missing required function"))
(with-current-buffer (get-buffer-create "*erc-keep-place-indicator-mode*")
(erc-mode)
(erc--initialize-markers (point) nil)
(let ((assert-off
(lambda ()
(should-not erc-keep-place-indicator-mode)
(should-not (local-variable-p 'window-configuration-change-hook))
(should-not erc--keep-place-indicator-overlay)))
(assert-on
(lambda ()
(should erc--keep-place-indicator-overlay)
(should (local-variable-p 'window-configuration-change-hook))
(should window-configuration-change-hook)
(should erc-keep-place-mode)))
;;
erc-insert-pre-hook
erc-modules)
(funcall assert-off)
(ert-info ("Value t")
(should (eq erc-keep-place-indicator-buffer-type t))
(erc-keep-place-indicator-mode +1)
(funcall assert-on)
(goto-char (point-min))
(should (search-forward "Enabling" nil t))
(should (memq 'keep-place erc-modules)))
(erc-keep-place-indicator-mode -1)
(funcall assert-off)
(ert-info ("Value `target'")
(let ((erc-keep-place-indicator-buffer-type 'target))
(erc-keep-place-indicator-mode +1)
(funcall assert-off)
(setq erc--target (erc--target-from-string "#chan"))
(erc-keep-place-indicator-mode +1)
(funcall assert-on)))
(erc-keep-place-indicator-mode -1)
(funcall assert-off)
(ert-info ("Value `server'")
(let ((erc-keep-place-indicator-buffer-type 'server))
(erc-keep-place-indicator-mode +1)
(funcall assert-off)
(setq erc--target nil)
(erc-keep-place-indicator-mode +1)
(funcall assert-on)))
;; Populate buffer
(erc-display-message nil 'notice (current-buffer)
"This buffer is for text that is not saved")
(erc-display-message nil 'notice (current-buffer)
"and for lisp evaluation")
(should (search-forward "saved" nil t))
(erc-keep-place-move nil)
(goto-char erc-input-marker)
(ert-info ("Indicator survives reconnect")
(let ((erc--server-reconnecting (buffer-local-variables)))
(cl-letf (((symbol-function 'erc-server-connect) #'ignore))
(erc-open "localhost" 6667 "tester" "Tester" 'connect
nil nil nil nil nil "tester" nil)))
(funcall assert-on)
(should (= (point) erc-input-marker))
(goto-char (overlay-start erc--keep-place-indicator-overlay))
(should (looking-at (rx "*** This buffer is for text")))))
(when noninteractive
(kill-buffer))))
;;; erc-goodies-tests.el ends here
|
