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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
| | ;;; erc-d-self.el --- tests for erc-d -*- lexical-binding: t -*-
;; This file is part of GNU Emacs.
;;
;; This program 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.
;;
;; This program 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/>.
;;; Commentary:
;;
;; This file tests the dumb server itself. The file name does not end
;; in "-tests.el" because test/Makefile looks for corresponding
;; library files and raises an error when one isn't found.
;;; Code:
(require 'ert-x)
(eval-and-compile (let ((dir (getenv "EMACS_TEST_DIRECTORY")))
(when dir
(load (concat dir "/lisp/erc/erc-d/erc-d") nil t)
(load (concat dir "/lisp/erc/erc-d/erc-d-t") nil t))))
(require 'erc-d)
(require 'erc-d-t)
(require 'erc-backend)
(ert-deftest erc-d-u--canned-load-dialog--basic ()
(should-not (get-buffer "basic.eld"))
(should-not erc-d-u--canned-buffers)
(let* ((exes (erc-d-u--canned-load-dialog 'basic))
(reap (lambda ()
(cl-loop with e = (erc-d-u--read-dialog exes)
for s = (erc-d-u--read-exchange e)
while s collect s))))
(should (get-buffer "basic.eld"))
(should (memq (get-buffer "basic.eld") erc-d-u--canned-buffers))
(should (equal (funcall reap) '((pass 10.0 "PASS " (? ?:) "changeme"))))
(should (equal (funcall reap) '((nick 0.2 "NICK tester"))))
(let ((r (funcall reap)))
(should (equal (car r) '(user 0.2 "USER user 0 * :tester")))
(should (equal
(car (last r))
'(0 ":irc.example.org 422 tester :MOTD File is missing"))))
(should (equal (car (funcall reap)) '(mode-user 1.2 "MODE tester +i")))
(should (equal (funcall reap)
'((mode-chan 1.2 "MODE #chan")
(0.1 ":bob!~bob@example.org PRIVMSG #chan :hey"))))
;; See `define-error' site for `iter-end-of-sequence'
(ert-info ("EOB detected") (should-not (erc-d-u--read-dialog exes))))
(should-not (get-buffer "basic.eld"))
(should-not erc-d-u--canned-buffers))
(defun erc-d-self--make-hunk-reader (hunks)
(let ((p (erc-d-u--read-dialog hunks)))
(lambda () (erc-d-u--read-exchange p))))
;; Fuzzies need to be able to access any non-exhausted genny.
(ert-deftest erc-d-u--canned-load-dialog--intermingled ()
(should-not (get-buffer "basic.eld"))
(should-not erc-d-u--canned-buffers)
(let* ((exes (erc-d-u--canned-load-dialog 'basic))
(pass (erc-d-self--make-hunk-reader exes))
(nick (erc-d-self--make-hunk-reader exes))
(user (erc-d-self--make-hunk-reader exes))
(modu (erc-d-self--make-hunk-reader exes))
(modc (erc-d-self--make-hunk-reader exes)))
(should (equal (funcall user) '(user 0.2 "USER user 0 * :tester")))
(should (equal (funcall modu) '(mode-user 1.2 "MODE tester +i")))
(should (equal (funcall modc) '(mode-chan 1.2 "MODE #chan")))
(cl-loop repeat 8 do (funcall user)) ; skip a few
(should (equal (funcall user)
'(0 ":irc.example.org 254 tester 1 :channels formed")))
(should (equal (funcall modu)
'(0 ":irc.example.org 221 tester +Zi")))
(should (equal (cl-loop for s = (funcall modc) while s collect s) ; done
'((0.1 ":bob!~bob@example.org PRIVMSG #chan :hey"))))
(cl-loop repeat 3 do (funcall user))
(cl-loop repeat 3 do (funcall modu))
(ert-info ("Change up the order")
(should
(equal (funcall modu)
'(0 ":irc.example.org 366 alice #chan :End of NAMES list")))
(should
(equal (funcall user)
'(0 ":irc.example.org 422 tester :MOTD File is missing"))))
;; Exhaust these
(should (equal (cl-loop for s = (funcall pass) while s collect s) ; done
'((pass 10.0 "PASS " (? ?:) "changeme"))))
(should (equal (cl-loop for s = (funcall nick) while s collect s) ; done
'((nick 0.2 "NICK tester"))))
(ert-info ("End of file but no teardown because hunks outstanding")
(should-not (erc-d-u--read-dialog exes))
(should (get-buffer "basic.eld")))
;; Finish
(should-not (funcall user))
(should-not (funcall modu)))
(should-not (get-buffer "basic.eld"))
(should-not erc-d-u--canned-buffers))
;; This indirectly tests `erc-d-u--canned-read' cleanup/teardown
(ert-deftest erc-d-u--rewrite-for-slow-mo ()
(should-not (get-buffer "basic.eld"))
(should-not (get-buffer "basic.eld<2>"))
(should-not (get-buffer "basic.eld<3>"))
(should-not erc-d-u--canned-buffers)
(let ((exes (erc-d-u--canned-load-dialog 'basic))
(exes-lower (erc-d-u--canned-load-dialog 'basic))
(exes-custom (erc-d-u--canned-load-dialog 'basic))
(reap (lambda (e) (cl-loop with p = (erc-d-u--read-dialog e)
for s = (erc-d-u--read-exchange p)
while s collect s))))
(should (get-buffer "basic.eld"))
(should (get-buffer "basic.eld<2>"))
(should (get-buffer "basic.eld<3>"))
(should (equal (list (get-buffer "basic.eld<3>")
(get-buffer "basic.eld<2>")
(get-buffer "basic.eld"))
erc-d-u--canned-buffers))
(ert-info ("Rewrite for slowmo basic")
(setq exes (erc-d-u--rewrite-for-slow-mo 10 exes))
(should (equal (funcall reap exes)
'((pass 20.0 "PASS " (? ?:) "changeme"))))
(should (equal (funcall reap exes)
'((nick 10.2 "NICK tester"))))
(let ((r (funcall reap exes)))
(should (equal (car r) '(user 10.2 "USER user 0 * :tester")))
(should (equal
(car (last r))
'(0 ":irc.example.org 422 tester :MOTD File is missing"))))
(should (equal (car (funcall reap exes))
'(mode-user 11.2 "MODE tester +i")))
(should (equal (car (funcall reap exes))
'(mode-chan 11.2 "MODE #chan")))
(should-not (erc-d-u--read-dialog exes)))
(ert-info ("Rewrite for slowmo bounded")
(setq exes-lower (erc-d-u--rewrite-for-slow-mo -5 exes-lower))
(should (equal (funcall reap exes-lower)
'((pass 10.0 "PASS " (? ?:) "changeme"))))
(should (equal (funcall reap exes-lower)
'((nick 5 "NICK tester"))))
(should (equal (car (funcall reap exes-lower))
'(user 5 "USER user 0 * :tester")))
(should (equal (car (funcall reap exes-lower))
'(mode-user 5 "MODE tester +i")))
(should (equal (car (funcall reap exes-lower))
'(mode-chan 5 "MODE #chan")))
(should-not (erc-d-u--read-dialog exes-lower)))
(ert-info ("Rewrite for slowmo custom")
(setq exes-custom (erc-d-u--rewrite-for-slow-mo
(lambda (n) (* 2 n)) exes-custom))
(should (equal (funcall reap exes-custom)
'((pass 20.0 "PASS " (? ?:) "changeme"))))
(should (equal (funcall reap exes-custom)
'((nick 0.4 "NICK tester"))))
(should (equal (car (funcall reap exes-custom))
'(user 0.4 "USER user 0 * :tester")))
(should (equal (car (funcall reap exes-custom))
'(mode-user 2.4 "MODE tester +i")))
(should (equal (car (funcall reap exes-custom))
'(mode-chan 2.4 "MODE #chan")))
(should-not (erc-d-u--read-dialog exes-custom))))
(should-not (get-buffer "basic.eld"))
(should-not (get-buffer "basic.eld<2>"))
(should-not (get-buffer "basic.eld<3>"))
(should-not erc-d-u--canned-buffers))
(ert-deftest erc-d--active-ex-p ()
(let ((ring (make-ring 5)))
(ert-info ("Empty ring returns nil for not active")
(should-not (erc-d--active-ex-p ring)))
(ert-info ("One fuzzy member returns nil for not active")
(ring-insert ring (make-erc-d-exchange :tag '~foo))
(should-not (erc-d--active-ex-p ring)))
(ert-info ("One active member returns t for active")
(ring-insert-at-beginning ring (make-erc-d-exchange :tag 'bar))
(should (erc-d--active-ex-p ring)))))
(defun erc-d-self--parse-message-upstream (raw)
"Hack shim for parsing RAW line recvd from peer."
(cl-letf (((symbol-function #'erc-handle-parsed-server-response)
(lambda (_ p) p)))
(let ((erc-active-buffer nil))
(erc-parse-server-response nil raw))))
(ert-deftest erc-d-i--validate-tags ()
(should (erc-d-i--validate-tags
(concat "batch=4cc99692bf24a4bec4aa03da437364f5;"
"time=2021-01-04T00:32:13.839Z")))
(should (erc-d-i--validate-tags "+foo=bar;baz=spam"))
(should (erc-d-i--validate-tags "foo=\\:ok;baz=\\s"))
(should (erc-d-i--validate-tags "foo=\303\247edilla"))
(should (erc-d-i--validate-tags "foo=\\"))
(should (erc-d-i--validate-tags "foo=bar\\baz"))
(should-error (erc-d-i--validate-tags "foo=\\\\;baz=\\\r\\\n"))
(should-error (erc-d-i--validate-tags "foo=\n"))
(should-error (erc-d-i--validate-tags "foo=\0ok"))
(should-error (erc-d-i--validate-tags "foo=bar baz"))
(should-error (erc-d-i--validate-tags "foo=bar\r"))
(should-error (erc-d-i--validate-tags "foo=bar;")))
(ert-deftest erc-d-i--parse-message ()
(let* ((raw (concat "@time=2020-11-23T09:10:33.088Z "
":tilde.chat BATCH +1 chathistory :#meta"))
(upstream (erc-d-self--parse-message-upstream raw))
(ours (erc-d-i--parse-message raw)))
(ert-info ("Baseline upstream")
(should (equal (erc-response.unparsed upstream) raw))
(should (equal (erc-response.sender upstream) "tilde.chat"))
(should (equal (erc-response.command upstream) "BATCH"))
(should (equal (erc-response.command-args upstream)
'("+1" "chathistory" "#meta")))
(should (equal (erc-response.contents upstream) "#meta")))
(ert-info ("Ours my not compare cl-equalp but is otherwise the same")
(should (equal (erc-d-i-message.unparsed ours) raw))
(should (equal (erc-d-i-message.sender ours) "tilde.chat"))
(should (equal (erc-d-i-message.command ours) "BATCH"))
(should (equal (erc-d-i-message.command-args ours)
'("+1" "chathistory" "#meta")))
(should (equal (erc-d-i-message.contents ours) "#meta"))
(should (equal (erc-d-i-message.tags ours)
'((time . "2020-11-23T09:10:33.088Z")))))
(ert-info ("No compat decodes the whole message as utf-8")
(setq ours (erc-d-i--parse-message
"@foo=\303\247edilla TAGMSG #ch\303\240n"
'decode))
(should-not (erc-d-i-message.compat ours))
(should (equal (erc-d-i-message.command-args ours) '("#chàn")))
(should (equal (erc-d-i-message.contents ours) ""))
(should (equal (erc-d-i-message.tags ours) '((foo . "çedilla")))))))
(ert-deftest erc-d-i--unescape-tag-value ()
(should (equal (erc-d-i--unescape-tag-value
"\\sabc\\sdef\\s\\sxyz\\s")
" abc def xyz "))
(should (equal (erc-d-i--unescape-tag-value
"\\\\abc\\\\def\\\\\\\\xyz\\\\")
"\\abc\\def\\\\xyz\\"))
(should (equal (erc-d-i--unescape-tag-value "a\\bc") "abc"))
(should (equal (erc-d-i--unescape-tag-value
"\\\\abc\\\\def\\\\\\\\xyz\\")
"\\abc\\def\\\\xyz"))
(should (equal (erc-d-i--unescape-tag-value "a\\:b\\r\\nc\\sd")
"a;b\r\nc d")))
(ert-deftest erc-d-i--escape-tag-value ()
(should (equal (erc-d-i--escape-tag-value " abc def xyz ")
"\\sabc\\sdef\\s\\sxyz\\s"))
(should (equal (erc-d-i--escape-tag-value "\\abc\\def\\\\xyz\\")
"\\\\abc\\\\def\\\\\\\\xyz\\\\"))
(should (equal (erc-d-i--escape-tag-value "a;b\r\nc d")
"a\\:b\\r\\nc\\sd")))
;; TODO add tests for msg-join, mask-match, userhost-split,
;; validate-hostname
(ert-deftest erc-d-i--parse-message--irc-parser-tests ()
(let* ((data (with-temp-buffer
(insert-file-contents
(ert-resource-file "irc-parser-tests.eld"))
(read (current-buffer))))
(tests (assoc-default 'tests (assoc-default 'msg-split data)))
input atoms m ours)
(dolist (test tests)
(setq input (assoc-default 'input test)
atoms (assoc-default 'atoms test)
m (erc-d-i--parse-message input))
(ert-info ("Parses tags correctly")
(setq ours (erc-d-i-message.tags m))
(if-let ((tags (assoc-default 'tags atoms)))
(pcase-dolist (`(,key . ,value) ours)
(should (string= (cdr (assq key tags)) (or value ""))))
(should-not ours)))
(ert-info ("Parses verbs correctly")
(setq ours (erc-d-i-message.command m))
(if-let ((verbs (assoc-default 'verb atoms)))
(should (string= (downcase verbs) (downcase ours)))
(should (string-empty-p ours))))
(ert-info ("Parses sources correctly")
(setq ours (erc-d-i-message.sender m))
(if-let ((source (assoc-default 'source atoms)))
(should (string= source ours))
(should (string-empty-p ours))))
(ert-info ("Parses params correctly")
(setq ours (erc-d-i-message.command-args m))
(if-let ((params (assoc-default 'params atoms)))
(should (equal ours params))
(should-not ours))))))
(defun erc-d-self--new-ex (existing raw-hunk)
(let* ((f (lambda (_) (pop raw-hunk)))
(sd (make-erc-d-u-scan-d :f f)))
(setf (erc-d-exchange-hunk existing) (make-erc-d-u-scan-e :sd sd)
(erc-d-exchange-spec existing) (make-erc-d-spec)))
(erc-d--iter existing))
(ert-deftest erc-d--render-entries ()
(let* ((dialog (make-erc-d-dialog :vars `((:a . 1)
(c . ((a b) (: a space b)))
(d . (c alpha digit))
(bee . 2)
(f . ,(lambda () "3"))
(i . emacs-pid))))
(exchange (make-erc-d-exchange :dialog dialog))
(mex (apply-partially #'erc-d-self--new-ex exchange))
it)
(erc-d-exchange-reload dialog exchange)
(ert-info ("Baseline Outgoing")
(setq it (funcall mex '((0 "abc"))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "abc")))
(ert-info ("Incoming are regexp escaped")
(setq it (funcall mex '((i 0.0 "fsf" ".org"))))
(should (equal (cons (funcall it) (funcall it)) '(i . 0.0)))
(should (equal (funcall it) "\\`fsf\\.org")))
(ert-info ("Incoming can access vars via rx-let")
(setq it (funcall mex '((i 0.0 bee))))
(should (equal (cons (funcall it) (funcall it)) '(i . 0.0)))
(should (equal (funcall it) "\\`\002")))
(ert-info ("Incoming rx-let params")
(setq it (funcall mex '((i 0.0 d))))
(should (equal (cons (funcall it) (funcall it)) '(i . 0.0)))
(should (equal (funcall it) "\\`[[:alpha:]][[:space:]][[:digit:]]")))
(ert-info ("Incoming literal rx forms")
(setq it (funcall mex '((i 0.0 (= 3 alpha) ".org"))))
(should (equal (cons (funcall it) (funcall it)) '(i . 0.0)))
(should (equal (funcall it) "\\`[[:alpha:]]\\{3\\}\\.org")))
(ert-info ("Self-quoting disallowed")
(setq it (funcall mex '((0 :a "abc"))))
(should (equal (funcall it) 0))
(should-error (funcall it)))
(ert-info ("Outgoing mixed")
(setq it (funcall mex
'((0 (format "%s" (not (zerop i))) (string bee) f))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "t\0023")))
(ert-info ("Exits clean")
(when (listp (alist-get 'f (erc-d-dialog-vars dialog))) ; may be compiled
(should (eq 'closure (car (alist-get 'f (erc-d-dialog-vars dialog))))))
(should-not (funcall it))
(should (equal (erc-d-dialog-vars dialog)
`((:a . 1)
(c . ((a b) (: a space b)))
(d . (c alpha digit))
(bee . 2)
(f . ,(alist-get 'f (erc-d-dialog-vars dialog)))
(i . emacs-pid)))))))
(ert-deftest erc-d--render-entries--matches ()
(let* ((alist (list
(cons 'f (lambda (a) (funcall a :match 1)))
(cons 'g (lambda () (match-string 2 "foo bar baz")))
(cons 'h (lambda (a) (concat (funcall a :match 0)
(funcall a :request))))
(cons 'i (lambda (_ e) (erc-d-exchange-request e)))
(cons 'j (lambda ()
(set-match-data '(0 1))
(match-string 0 "j")))))
(dialog (make-erc-d-dialog :vars alist))
(exchange (make-erc-d-exchange :dialog dialog
:request "foo bar baz"
;; 11 222
:match-data '(4 11 4 6 8 11)))
(mex (apply-partially #'erc-d-self--new-ex exchange))
it)
(erc-d-exchange-reload dialog exchange)
(ert-info ("Baseline outgoing")
(setq it (funcall mex '((0 :request))))
(should (equal (funcall it) 0))
(should-error (funcall it)))
(ert-info ("One arg, match")
(setq it (funcall mex '((0 f))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "ba")))
(ert-info ("No args")
(setq it (funcall mex '((0 g))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "baz")))
(ert-info ("Second arg is exchange object")
(setq it (funcall mex '((0 i))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "foo bar baz")))
(ert-info ("One arg, multiple calls")
(setq it (funcall mex '((0 h))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "bar bazfoo bar baz")))
(ert-info ("Match data restored")
(setq it (funcall mex '((0 j))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "j"))
(setq it (funcall mex '((0 g))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "baz")))
(ert-info ("Bad signature")
(let ((qlist (list 'f '(lambda (p q x) (ignore)))))
(setf (erc-d-dialog-vars dialog) qlist)
(should-error (erc-d-exchange-reload dialog exchange))))))
(ert-deftest erc-d--render-entries--dynamic ()
(let* ((alist (list
(cons 'foo "foo") '(f . (lambda () foo))
(cons 'g '(lambda (a) (funcall a :rebind 'g f) "bar"))
(cons 'j (lambda (a) (funcall a :set "123") "abc"))
(cons 'k (lambda () "abc"))))
(dialog (make-erc-d-dialog :vars alist))
(exchange (make-erc-d-exchange :dialog dialog))
(mex (apply-partially #'erc-d-self--new-ex exchange))
it)
(erc-d-exchange-reload dialog exchange)
(ert-info ("Initial reference calls function")
(setq it (funcall mex '((0 j) (0 j))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "abc")))
(ert-info ("Subsequent reference expands to string")
(should (equal (funcall it) 0))
(should (equal (funcall it) "123")))
(ert-info ("Outside manipulation: initial reference calls function")
(setq it (funcall mex '((0 k) (0 k))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "abc")))
(ert-info ("Outside manipulation: subsequent reference expands to string")
(erc-d-exchange-rebind dialog exchange 'k "123")
(should (equal (funcall it) 0))
(should (equal (funcall it) "123")))
(ert-info ("Swap one function for another")
(setq it (funcall mex '((0 g) (0 g))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "bar"))
(should (equal (funcall it) 0))
(should (equal (funcall it) "foo")))
(ert-info ("Bindings accessible inside functions") ; anti-feature?
(setq it (funcall mex '((0 f))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "foo")))
(ert-info ("Rebuild alist by sending flag")
(setq it (funcall mex '((0 f) (1 f) (2 f) (i 3 f))))
(should (equal (funcall it) 0))
(should (equal (funcall it) "foo"))
(erc-d-exchange-rebind dialog exchange 'f "bar")
(should (equal (funcall it) 1))
(should (equal (funcall it) "bar"))
(setq alist (setf (alist-get 'f (erc-d-dialog-vars dialog))
(lambda nil "baz")))
(should (eq (funcall it) 2))
(should (equal (funcall it 'reload) "baz"))
(setq alist (setf (alist-get 'f (erc-d-dialog-vars dialog)) "spam"))
(should (eq (funcall it) 'i))
(should (eq (funcall it 'reload) 3))
(should (equal (funcall it) "\\`spam")))))
(ert-deftest erc-d-t-with-cleanup ()
(should-not (get-buffer "*echo*"))
(should-not (get-buffer "*foo*"))
(should-not (get-buffer "*bar*"))
(should-not (get-buffer "*baz*"))
(erc-d-t-with-cleanup
((echo (start-process "echo" (get-buffer-create "*echo*") "sleep" "1"))
(buffer-foo (get-buffer-create "*foo*"))
(buffer-bar (get-buffer-create "*bar*"))
(clean-up (list (intern (process-name echo)))) ; let*
buffer-baz)
(ert-info ("Clean Up")
(should (equal clean-up '(ran echo)))
(should (bufferp buffer-baz))
(should (bufferp buffer-foo))
(setq buffer-foo nil))
(setq buffer-baz (get-buffer-create "*baz*"))
(push 'ran clean-up))
(ert-info ("Buffers and procs destroyed")
(should-not (get-buffer "*echo*"))
(should-not (get-buffer "*bar*"))
(should-not (get-buffer "*baz*")))
(ert-info ("Buffer foo spared")
(should (get-buffer "*foo*"))
(kill-buffer "*foo*")))
(defvar erc-d-self-with-server-password "changeme")
;; Compromise between removing `autojoin' from `erc-modules' entirely
;; and allowing side effects to meddle excessively
(defvar erc-autojoin-channels-alist)
;; This is only meant to be used by tests in this file.
(cl-defmacro erc-d-self-with-server ((dumb-server-var erc-server-buffer-var)
dialog &rest body)
"Create server for DIALOG and run BODY.
DIALOG may also be a list of dialogs. ERC-SERVER-BUFFER-VAR and
DUMB-SERVER-VAR are bound accordingly in BODY."
(declare (indent 2))
(when (eq '_ dumb-server-var)
(setq dumb-server-var (make-symbol "dumb-server-var")))
(when (eq '_ erc-server-buffer-var)
(setq erc-server-buffer-var (make-symbol "erc-server-buffer-var")))
(if (listp dialog)
(setq dialog (mapcar (lambda (f) (list 'quote f)) dialog))
(setq dialog `((quote ,dialog))))
`(let* (auth-source-do-cache
(,dumb-server-var (erc-d-run "localhost" t ,@dialog))
,erc-server-buffer-var
;;
(erc-server-flood-penalty 0.05)
erc-autojoin-channels-alist
erc-server-auto-reconnect)
(should-not erc-d--slow-mo)
(with-current-buffer "*erc-d-server*" (erc-d-t-search-for 4 "Starting"))
;; Allow important messages through, even in -batch mode.
(advice-add #'erc-handle-login :around #'erc-d-t-silence-around)
(advice-add #'erc-server-connect :around #'erc-d-t-silence-around)
(unless (or noninteractive erc-debug-irc-protocol)
(erc-toggle-debug-irc-protocol))
(setq ,erc-server-buffer-var
(erc :server "localhost"
:password erc-d-self-with-server-password
:port (process-contact ,dumb-server-var :service)
:nick "tester"
:full-name "tester"))
(unwind-protect
(progn
,@body
(erc-d-t-wait-for 1 "dumb-server death"
(not (process-live-p ,dumb-server-var))))
(when (process-live-p erc-server-process)
(delete-process erc-server-process))
(advice-remove #'erc-handle-login #'erc-d-t-silence-around)
(advice-remove #'erc-server-connect #'erc-d-t-silence-around)
(when noninteractive
(kill-buffer ,erc-server-buffer-var)
(erc-d-t-kill-related-buffers)))))
(defmacro erc-d-self-with-failure-spy (found func-syms &rest body)
"Wrap functions with advice for inspecting errors caused by BODY.
Do this for functions whose names appear in FUNC-SYMS. When running
advice code, add errors to list FOUND. Note: the teardown finalizer is
not added by default. Also, `erc-d-linger-secs' likely has to
be nonzero for this to work."
(declare (indent 2))
;; Catch errors thrown by timers that `should-error'ignores
`(progn
(cl-labels ((ad (f o &rest r)
(condition-case err
(apply o r)
(error (push err ,found)
(advice-remove f 'spy)))))
(dolist (sym ,func-syms)
(advice-add sym :around (apply-partially #'ad sym) '((name . spy))))
(progn ,@body))
(setq ,found (nreverse ,found))
(dolist (sym ,func-syms)
(advice-remove sym 'spy))))
(ert-deftest erc-d-run-nonstandard-messages ()
(let* ((erc-d-linger-secs 0.2)
(dumb-server (erc-d-run "localhost" t 'nonstandard))
(dumb-server-buffer (get-buffer "*erc-d-server*"))
(expect (erc-d-t-make-expecter))
client)
(with-current-buffer "*erc-d-server*" (erc-d-t-search-for 4 "Starting"))
(setq client (open-network-stream "erc-d-client" nil
"localhost"
(process-contact dumb-server :service)
:coding 'binary))
(ert-info ("Server splits CRLF delimited lines")
(process-send-string client "ONE one\r\nTWO two\r\n")
(with-current-buffer dumb-server-buffer
(funcall expect 1 '(: "<- nonstandard:" (+ digit) " ONE one" eol))
(funcall expect 1 '(regex "<- nonstandard:[[:digit:]]+ TWO two$"))))
(ert-info ("Server doesn't discard empty lines")
(process-send-string client "\r\n")
(with-current-buffer dumb-server-buffer
(funcall expect 1 '(regex "<- nonstandard:[[:digit:]]+ $"))))
(ert-info ("Server preserves spaces")
(process-send-string client " \r\n")
(with-current-buffer dumb-server-buffer
(funcall expect 1 '(regex "<- nonstandard:[[:digit:]]+ \\{2\\}$")))
(process-send-string client " \r\n")
(with-current-buffer dumb-server-buffer
(funcall expect 1 '(regex "<- nonstandard:[[:digit:]]+ \\{3\\}$"))))
(erc-d-t-wait-for 3 "dumb-server death"
(not (process-live-p dumb-server)))
(delete-process client)
(when noninteractive
(kill-buffer dumb-server-buffer))))
(ert-deftest erc-d-run-basic ()
(erc-d-self-with-server (_ _) basic
(with-current-buffer (erc-d-t-wait-for 3 (get-buffer "#chan"))
(erc-d-t-search-for 2 "hey"))
(when noninteractive
(kill-buffer "#chan"))))
(ert-deftest erc-d-run-eof ()
(skip-unless noninteractive)
(erc-d-self-with-server (_ erc-s-buf) eof
(with-current-buffer (erc-d-t-wait-for 3 (get-buffer "#chan"))
(erc-d-t-search-for 2 "hey"))
(with-current-buffer erc-s-buf
(process-send-eof erc-server-process))))
(ert-deftest erc-d-run-eof-fail ()
(let (errors)
(erc-d-self-with-failure-spy errors '(erc-d--teardown)
(erc-d-self-with-server (_ _) eof
(with-current-buffer (erc-d-t-wait-for 5 (get-buffer "#chan"))
(erc-d-t-search-for 2 "hey"))
(erc-d-t-wait-for 10 errors)))
(should (string-match-p "Timed out awaiting request.*__EOF__"
(cadr (pop errors))))))
(ert-deftest erc-d-run-linger ()
(erc-d-self-with-server (dumb-s _) linger
(with-current-buffer (erc-d-t-wait-for 3 (get-buffer "#chan"))
(erc-d-t-search-for 2 "hey"))
(with-current-buffer (process-buffer dumb-s)
(erc-d-t-search-for 2 "Lingering for 1.00 seconds"))
(with-current-buffer (process-buffer dumb-s)
(erc-d-t-search-for 3 "Lingered for 1.00 seconds"))))
(ert-deftest erc-d-run-linger-fail ()
(let ((erc-server-flood-penalty 0.1)
errors)
(erc-d-self-with-failure-spy
errors '(erc-d--teardown erc-d-command)
(erc-d-self-with-server (_ _) linger
(with-current-buffer (erc-d-t-wait-for 3 (get-buffer "#chan"))
(erc-d-t-search-for 2 "hey")
(erc-cmd-MSG "#chan hi"))
(erc-d-t-wait-for 10 "Bad match" errors)))
(should (string-match-p "Match failed.*hi" (cadr (pop errors))))))
(ert-deftest erc-d-run-linger-direct ()
(let* ((dumb-server (erc-d-run "localhost" t
'linger-multi-a 'linger-multi-b))
(port (process-contact dumb-server :service))
(dumb-server-buffer (get-buffer "*erc-d-server*"))
(client-buffer-a (get-buffer-create "*erc-d-client-a*"))
(client-buffer-b (get-buffer-create "*erc-d-client-b*"))
(start (current-time))
client-a client-b)
(with-current-buffer "*erc-d-server*" (erc-d-t-search-for 4 "Starting"))
(setq client-a (open-network-stream "erc-d-client-a" client-buffer-a
"localhost" port
:coding 'binary)
client-b (open-network-stream "erc-d-client-b" client-buffer-b
"localhost" port
:coding 'binary))
(process-send-string client-a "PASS :a\r\n")
(sleep-for 0.01)
(process-send-string client-b "PASS :b\r\n")
(sleep-for 0.01)
(erc-d-t-wait-for 3 "dumb-server death"
(not (process-live-p dumb-server)))
(ert-info ("Ensure linger of one second")
(should (time-less-p 1 (time-subtract (current-time) start)))
(should (time-less-p (time-subtract (current-time) start) 1.5)))
(delete-process client-a)
(delete-process client-b)
(when noninteractive
(kill-buffer client-buffer-a)
(kill-buffer client-buffer-b)
(kill-buffer dumb-server-buffer))))
(ert-deftest erc-d-run-drop-direct ()
(let* ((dumb-server (erc-d-run "localhost" t 'drop-a 'drop-b))
(port (process-contact dumb-server :service))
(dumb-server-buffer (get-buffer "*erc-d-server*"))
(client-buffer-a (get-buffer-create "*erc-d-client-a*"))
(client-buffer-b (get-buffer-create "*erc-d-client-b*"))
(start (current-time))
client-a client-b)
(with-current-buffer "*erc-d-server*" (erc-d-t-search-for 4 "Starting"))
(setq client-a (open-network-stream "erc-d-client-a" client-buffer-a
"localhost" port
:coding 'binary)
client-b (open-network-stream "erc-d-client-b" client-buffer-b
"localhost" port
:coding 'binary))
(process-send-string client-a "PASS :a\r\n")
(sleep-for 0.01)
(process-send-string client-b "PASS :b\r\n")
(erc-d-t-wait-for 3 "client-a dies" (not (process-live-p client-a)))
(should (time-less-p (time-subtract (current-time) start) 0.32))
(erc-d-t-wait-for 3 "dumb-server death"
(not (process-live-p dumb-server)))
(ert-info ("Ensure linger of one second")
(should (time-less-p 1 (time-subtract (current-time) start))))
(delete-process client-a)
(delete-process client-b)
(when noninteractive
(kill-buffer client-buffer-a)
(kill-buffer client-buffer-b)
(kill-buffer dumb-server-buffer))))
(ert-deftest erc-d-run-no-match ()
(let ((erc-d-linger-secs 1)
erc-server-auto-reconnect
errors)
(erc-d-self-with-failure-spy errors '(erc-d--teardown erc-d-command)
(erc-d-self-with-server (_ erc-server-buffer) no-match
(with-current-buffer erc-server-buffer
(erc-d-t-search-for 2 "away")
(erc-cmd-JOIN "#foo")
(erc-d-t-wait-for 10 "Bad match" errors))))
(should (string-match-p "Match failed.*foo.*chan" (cadr (pop errors))))
(should-not (get-buffer "#foo"))))
(ert-deftest erc-d-run-timeout ()
(let ((erc-d-linger-secs 1)
err errors)
(erc-d-self-with-failure-spy errors '(erc-d--teardown)
(erc-d-self-with-server (_ _) timeout
(erc-d-t-wait-for 10 "error caught" errors)))
(setq err (pop errors))
(should (eq (car err) 'erc-d-timeout))
(should (string-match-p "Timed out" (cadr err)))))
(ert-deftest erc-d-run-unexpected ()
(let ((erc-d-linger-secs 2)
errors)
(erc-d-self-with-failure-spy
errors '(erc-d--teardown erc-d-command)
(erc-d-self-with-server (_ _) unexpected
(ert-info ("All specs consumed when more input arrives")
(erc-d-t-wait-for 10 "error caught" (cdr errors)))))
(should (string-match-p "unexpected.*MODE" (cadr (pop errors))))
;; Nonsensical normally because func would have already exited when
;; first error was thrown
(should (string-match-p "Match failed" (cadr (pop errors))))))
(ert-deftest erc-d-run-unexpected-depleted ()
(let ((erc-d-linger-secs 3)
errors)
(erc-d-self-with-failure-spy errors '(erc-d--teardown erc-d-command)
(let* ((dumb-server-buffer (get-buffer-create "*erc-d-server*"))
(dumb-server (erc-d-run "localhost" t 'depleted))
(expect (erc-d-t-make-expecter))
(client-buf (get-buffer-create "*erc-d-client*"))
client-proc)
(with-current-buffer dumb-server-buffer
(erc-d-t-search-for 3 "Starting"))
(setq client-proc (make-network-process
:buffer client-buf
:name "erc-d-client"
:family 'ipv4
:noquery t
:coding 'binary
:service (process-contact dumb-server :service)
:host "localhost"))
(with-current-buffer dumb-server-buffer
(funcall expect 3 "Connection"))
(process-send-string client-proc "PASS :changeme\r\n")
(sleep-for 0.01)
(process-send-string client-proc "NICK tester\r\n")
(sleep-for 0.01)
(process-send-string client-proc "USER user 0 * :tester\r\n")
(sleep-for 0.01)
(when (process-live-p client-proc)
(process-send-string client-proc "BLAH :too much\r\n")
(sleep-for 0.01))
(with-current-buffer client-buf
(funcall expect 3 "Welcome to the Internet"))
(erc-d-t-wait-for 2 "dumb-server death"
(not (process-live-p dumb-server)))
(delete-process client-proc)
(when noninteractive
(kill-buffer client-buf)
(kill-buffer dumb-server-buffer))))
(should (string-match-p "unexpected.*BLAH" (cadr (pop errors))))
;; Wouldn't happen IRL
(should (string-match-p "unexpected.*BLAH" (cadr (pop errors))))
(should-not errors)))
(defun erc-d-self--dynamic-match-user (_dialog exchange)
"Shared pattern/response handler for canned dynamic DIALOG test."
(should (string= (match-string 1 (erc-d-exchange-request exchange))
"tester")))
(defun erc-d-self--run-dynamic ()
"Perform common assertions for \"dynamic\" dialog."
(erc-d-self-with-server (dumb-server erc-server-buffer) dynamic
(with-current-buffer (erc-d-t-wait-for 3 (get-buffer "#chan"))
(erc-d-t-search-for 2 "tester: hey"))
(with-current-buffer erc-server-buffer
(let ((expect (erc-d-t-make-expecter)))
(funcall expect 2 "host is irc.fsf.org")
(funcall expect 2 "modes for tester")))
(with-current-buffer (process-buffer dumb-server)
(erc-d-t-search-for 2 "irc.fsf.org"))
(when noninteractive
(kill-buffer "#chan"))))
(ert-deftest erc-d-run-dynamic-default-match ()
(let* (dynamic-tally
(erc-d-spec-vars '((user . "user")
(ignored . ((a b) (: a space b)))
(realname . (group (+ graph)))))
(nick (lambda (a)
(push '(nick . match-user) dynamic-tally)
(funcall a :set (funcall a :match 1) 'export)))
(dom (lambda (a)
(push '(dom . match-user) dynamic-tally)
(funcall a :set erc-d-server-fqdn)))
(erc-d-match-handlers
(list :user (lambda (d e)
(erc-d-exchange-rebind d e 'nick nick)
(erc-d-exchange-rebind d e 'dom dom)
(erc-d-self--dynamic-match-user d e))
:mode-user (lambda (d e)
(erc-d-exchange-rebind d e 'nick "tester")
(erc-d-exchange-rebind d e 'dom dom))))
(erc-d-server-fqdn "irc.fsf.org"))
(erc-d-self--run-dynamic)
(should (equal '((dom . match-user) (nick . match-user) (dom . match-user))
dynamic-tally))))
(ert-deftest erc-d-run-dynamic-default-match-rebind ()
(let* (tally
;;
(erc-d-spec-vars '((user . "user")
(ignored . ((a b) (: a space b)))
(realname . (group (+ graph)))))
(erc-d-match-handlers
(list :user
(lambda (d e)
(erc-d-exchange-rebind
d e 'nick
(lambda (a)
(push 'bind-nick tally)
(funcall a :rebind 'nick (funcall a :match 1) 'export)))
(erc-d-exchange-rebind
d e 'dom
(lambda ()
(push 'bind-dom tally)
(erc-d-exchange-rebind d e 'dom erc-d-server-fqdn)))
(erc-d-self--dynamic-match-user d e))
:mode-user
(lambda (d e)
(erc-d-exchange-rebind d e 'nick "tester")
(erc-d-exchange-rebind d e 'dom erc-d-server-fqdn))))
(erc-d-server-fqdn "irc.fsf.org"))
(erc-d-self--run-dynamic)
(should (equal '(bind-nick bind-dom) tally))))
(ert-deftest erc-d-run-dynamic-runtime-stub ()
(let ((erc-d-spec-vars '((token . (group (or "barnet" "foonet")))))
(erc-d-match-handlers
(list :pass (lambda (d _e)
(erc-d-load-replacement-dialog d 'dynamic-foonet))))
(erc-d-self-with-server-password "foonet:changeme"))
(erc-d-self-with-server (_ erc-server-buffer)
(dynamic-stub dynamic-foonet)
(with-current-buffer (erc-d-t-wait-for 3 (get-buffer "#chan"))
(erc-d-t-search-for 2 "alice:")
(erc-d-t-absent-for 0.1 "joe"))
(with-current-buffer erc-server-buffer
(let ((expect (erc-d-t-make-expecter)))
(funcall expect 2 "host is irc.foonet.org")
(funcall expect 2 "NETWORK=FooNet")))
(when noninteractive
(kill-buffer "#chan")))))
(ert-deftest erc-d-run-dynamic-runtime-stub-skip ()
(let ((erc-d-spec-vars '((token . "barnet")))
(erc-d-match-handlers
(list :pass (lambda (d _e)
(erc-d-load-replacement-dialog
d 'dynamic-barnet 1))))
(erc-d-self-with-server-password "barnet:changeme"))
(erc-d-self-with-server (_ erc-server-buffer)
(dynamic-stub dynamic-barnet)
(with-current-buffer (erc-d-t-wait-for 3 (get-buffer "#chan"))
(erc-d-t-search-for 2 "joe:")
(erc-d-t-absent-for 0.1 "alice"))
(with-current-buffer erc-server-buffer
(let ((expect (erc-d-t-make-expecter)))
(funcall expect 2 "host is irc.barnet.org")
(funcall expect 2 "NETWORK=BarNet")))
(when noninteractive
(kill-buffer "#chan")))))
;; Two servers, in-process, one client per
(ert-deftest erc-d-run-dual-direct ()
(let* ((erc-d--slow-mo -1)
(server-a (erc-d-run "localhost" t "erc-d-server-a" 'dynamic-foonet))
(server-b (erc-d-run "localhost" t "erc-d-server-b" 'dynamic-barnet))
(server-a-buffer (get-buffer "*erc-d-server-a*"))
(server-b-buffer (get-buffer "*erc-d-server-b*"))
(client-a-buffer (get-buffer-create "*erc-d-client-a*"))
(client-b-buffer (get-buffer-create "*erc-d-client-b*"))
client-a client-b)
(with-current-buffer server-a-buffer (erc-d-t-search-for 4 "Starting"))
(with-current-buffer server-b-buffer (erc-d-t-search-for 4 "Starting"))
(setq client-a (make-network-process
:buffer client-a-buffer
:name "erc-d-client-a"
:family 'ipv4
:noquery t
:coding 'binary
:service (process-contact server-a :service)
:host "localhost")
client-b (make-network-process
:buffer client-b-buffer
:name "erc-d-client-b"
:family 'ipv4
:noquery t
:coding 'binary
:service (process-contact server-b :service)
:host "localhost"))
;; Also tests slo-mo indirectly because FAKE would fail without it
(process-send-string client-a "NICK tester\r\n")
(process-send-string client-b "FAKE noop\r\nNICK tester\r\n")
(sleep-for 0.01)
(process-send-string client-a "USER user 0 * :tester\r\n")
(process-send-string client-b "USER user 0 * :tester\r\n")
(sleep-for 0.01)
(process-send-string client-a "MODE tester +i\r\n")
(process-send-string client-b "MODE tester +i\r\n")
(sleep-for 0.01)
(process-send-string client-a "MODE #chan\r\n")
(process-send-string client-b "MODE #chan\r\n")
(sleep-for 0.01)
(erc-d-t-wait-for 1 "server-a death" (not (process-live-p server-a)))
(erc-d-t-wait-for 1 "server-b death" (not (process-live-p server-b)))
(when noninteractive
(kill-buffer client-a-buffer)
(kill-buffer client-b-buffer)
(kill-buffer server-a-buffer)
(kill-buffer server-b-buffer))))
;; This can be removed; only exists to get a baseline for next test
(ert-deftest erc-d-run-fuzzy-direct ()
(let* ((erc-d-spec-vars
`((now . ,(lambda () (format-time-string "%FT%T.%3NZ" nil t)))))
(dumb-server (erc-d-run "localhost" t 'fuzzy))
(dumb-server-buffer (get-buffer "*erc-d-server*"))
(client-buffer (get-buffer-create "*erc-d-client*"))
client)
(with-current-buffer "*erc-d-server*" (erc-d-t-search-for 4 "Starting"))
(setq client (make-network-process
:buffer client-buffer
:name "erc-d-client"
:family 'ipv4
:noquery t
:coding 'binary
:service (process-contact dumb-server :service)
:host "localhost"))
;; We could also just send this as a single fatty
(process-send-string client "PASS :changeme\r\n")
(sleep-for 0.01)
(process-send-string client "NICK tester\r\n")
(sleep-for 0.01)
(process-send-string client "USER user 0 * :tester\r\n")
(sleep-for 0.01)
(process-send-string client "MODE tester +i\r\n")
(sleep-for 0.01)
(process-send-string client "JOIN #bar\r\n")
(sleep-for 0.01)
(process-send-string client "JOIN #foo\r\n")
(sleep-for 0.01)
(process-send-string client "MODE #bar\r\n")
(sleep-for 0.01)
(process-send-string client "MODE #foo\r\n")
(sleep-for 0.01)
(erc-d-t-wait-for 1 "dumb-server death"
(not (process-live-p dumb-server)))
(when noninteractive
(kill-buffer client-buffer)
(kill-buffer dumb-server-buffer))))
;; Without adjusting penalty, takes ~15 secs. With is comprable to direct ^.
(ert-deftest erc-d-run-fuzzy ()
(let ((erc-server-flood-penalty 1.2) ; penalty < margin/sends is basically 0
(erc-d-linger-secs 0.1)
(erc-d-spec-vars
`((now . ,(lambda () (format-time-string "%FT%T.%3NZ" nil t)))))
erc-server-auto-reconnect)
(erc-d-self-with-server (_ erc-server-buffer) fuzzy
(with-current-buffer erc-server-buffer
(erc-d-t-search-for 2 "away")
(goto-char erc-input-marker)
(erc-cmd-JOIN "#bar"))
(erc-d-t-wait-for 2 (get-buffer "#bar"))
(with-current-buffer erc-server-buffer
(erc-cmd-JOIN "#foo"))
(erc-d-t-wait-for 20 (get-buffer "#foo"))
(with-current-buffer "#bar"
(erc-d-t-search-for 1 "was created on"))
(with-current-buffer "#foo"
(erc-d-t-search-for 5 "was created on")))))
(ert-deftest erc-d-run-no-block ()
(let ((erc-server-flood-penalty 1)
(erc-d-linger-secs 1.2)
(expect (erc-d-t-make-expecter))
erc-server-auto-reconnect)
(erc-d-self-with-server (_ erc-server-buffer) no-block
(with-current-buffer erc-server-buffer
(funcall expect 2 "away")
(funcall expect 1 erc-prompt)
(with-current-buffer erc-server-buffer (erc-cmd-JOIN "#foo")))
(with-current-buffer (erc-d-t-wait-for 2 (get-buffer "#foo"))
(funcall expect 2 "was created on"))
(ert-info ("Join #bar")
(with-current-buffer erc-server-buffer (erc-cmd-JOIN "#bar"))
(erc-d-t-wait-for 2 (get-buffer "#bar")))
(with-current-buffer "#bar" (funcall expect 1 "was created on"))
(ert-info ("Server expects next pattern but keeps sending")
(with-current-buffer "#foo" (funcall expect 2 "Rosalind"))
(with-current-buffer "#bar" (funcall expect 1 "hi"))
(with-current-buffer "#foo"
(should-not (search-forward "<bob> I am heard" nil t))
(funcall expect 1.5 "<bob> I am heard"))))))
(defun erc-d-self--run-proxy-direct (dumb-server dumb-server-buffer port)
"Start DUMB-SERVER with DUMB-SERVER-BUFFER and PORT.
These are steps shared by in-proc and subproc variants testing a
bouncer-like setup."
(when (version< emacs-version "28") (ert-skip "TODO connection refused"))
(let ((client-buffer-foo (get-buffer-create "*erc-d-client-foo*"))
(client-buffer-bar (get-buffer-create "*erc-d-client-bar*"))
(expect (erc-d-t-make-expecter))
client-foo
client-bar)
(setq client-foo (make-network-process
:buffer client-buffer-foo
:name "erc-d-client-foo"
:family 'ipv4
:noquery t
:coding 'binary
:service port
:host "localhost")
client-bar (make-network-process
:buffer client-buffer-bar
:name "erc-d-client-bar"
:family 'ipv4
:noquery t
:coding 'binary
:service port
:host "localhost"))
(with-current-buffer dumb-server-buffer
(funcall expect 3 "Connection"))
(process-send-string client-foo "PASS :foo:changeme\r\n")
(process-send-string client-bar "PASS :bar:changeme\r\n")
(sleep-for 0.01)
(process-send-string client-foo "NICK tester\r\n")
(process-send-string client-bar "NICK tester\r\n")
(sleep-for 0.01)
(process-send-string client-foo "USER user 0 * :tester\r\n")
(process-send-string client-bar "USER user 0 * :tester\r\n")
(sleep-for 0.01)
(process-send-string client-foo "MODE tester +i\r\n")
(process-send-string client-bar "MODE tester +i\r\n")
(sleep-for 0.01)
(with-current-buffer client-buffer-foo
(funcall expect 3 "FooNet")
(funcall expect 3 "irc.foo.net")
(funcall expect 3 "marked as being away")
(goto-char (point-min))
(should-not (search-forward "bar" nil t)))
(with-current-buffer client-buffer-bar
(funcall expect 3 "BarNet")
(funcall expect 3 "irc.bar.net")
(funcall expect 3 "marked as being away")
(goto-char (point-min))
(should-not (search-forward "foo" nil t)))
(erc-d-t-wait-for 2 "dumb-server death"
(not (process-live-p dumb-server)))
(delete-process client-foo)
(delete-process client-bar)
(when noninteractive
(kill-buffer client-buffer-foo)
(kill-buffer client-buffer-bar)
(kill-buffer dumb-server-buffer))))
;; This test shows the simplest way to set up template variables: put
;; everything needed for the whole session in `erc-d-spec-vars' before
;; starting the server.
(ert-deftest erc-d-run-proxy-direct-spec-vars ()
(let* ((dumb-server-buffer (get-buffer-create "*erc-d-server*"))
(erc-d-linger-secs 0.5)
(erc-d-spec-vars
`((network . (group (+ alpha)))
(fqdn . ,(lambda (a)
(let ((network (funcall a :match 1 'pass)))
(should (member network '("foo" "bar")))
(funcall a :set (concat "irc." network ".net")))))
(net . ,(lambda (a)
(let ((network (funcall a :match 1 'pass)))
(should (member network '("foo" "bar")))
(concat (capitalize network) "Net"))))))
(dumb-server (erc-d-run "localhost" t 'proxy-foonet 'proxy-barnet))
(port (process-contact dumb-server :service)))
(with-current-buffer dumb-server-buffer
(erc-d-t-search-for 3 "Starting"))
(erc-d-self--run-proxy-direct dumb-server dumb-server-buffer port)))
(cl-defun erc-d-self--start-server (&key dialogs buffer linger program libs)
"Start and return a server in a subprocess using BUFFER and PORT.
DIALOGS are symbols representing the base names of dialog files in
`erc-d-u-canned-dialog-dir'. LIBS are extra files to load."
(push (locate-library "erc-d" nil (list erc-d-u--library-directory)) libs)
(cl-assert (car libs))
(let* ((args `("erc-d-server" ,buffer
,(concat invocation-directory invocation-name)
"-Q" "-batch" "-L" ,erc-d-u--library-directory
,@(let (o) (while libs (push (pop libs) o) (push "-l" o)) o)
"-eval" ,(format "%S" program) "-f" "erc-d-serve"
,@(when linger (list "--linger" (number-to-string linger)))
,@(mapcar #'erc-d-u--expand-dialog-symbol dialogs)))
(proc (apply #'start-process args)))
(set-process-query-on-exit-flag proc nil)
(with-current-buffer buffer
(erc-d-t-search-for 5 "Starting")
(search-forward " (")
(backward-char))
(let ((pair (read buffer)))
(cons proc (cdr pair)))))
(ert-deftest erc-d-run-proxy-direct-subprocess ()
(let* ((buffer (get-buffer-create "*erc-d-server*"))
;; These are quoted because they're passed as printed forms to subproc
(fqdn '(lambda (a e)
(let* ((d (erc-d-exchange-dialog e))
(name (erc-d-dialog-name d)))
(funcall a :set (if (eq name 'proxy-foonet)
"irc.foo.net"
"irc.bar.net")))))
(net '(lambda (a)
(funcall a :rebind 'net
(if (eq (funcall a :dialog-name) 'proxy-foonet)
"FooNet"
"BarNet"))))
(program `(setq erc-d-spec-vars '((fqdn . ,fqdn)
(net . ,net)
(network . (group (+ alpha))))))
(port (erc-d-self--start-server
:linger 0.3
:program program
:buffer buffer
:dialogs '(proxy-foonet proxy-barnet)))
(server (pop port)))
(erc-d-self--run-proxy-direct server buffer port)))
(ert-deftest erc-d-run-proxy-direct-subprocess-lib ()
(let* ((buffer (get-buffer-create "*erc-d-server*"))
(lib (ert-resource-file "proxy-subprocess.el"))
(port (erc-d-self--start-server :linger 0.3
:buffer buffer
:dialogs '(proxy-foonet proxy-barnet)
:libs (list lib)))
(server (pop port)))
(erc-d-self--run-proxy-direct server buffer port)))
(ert-deftest erc-d-run-no-pong ()
(let* (erc-d-auto-pong
;;
(erc-d-spec-vars
`((nonce . (group (: digit digit)))
(echo . ,(lambda (a)
(should (string= (funcall a :match 1) "42")) "42"))))
(dumb-server-buffer (get-buffer-create "*erc-d-server*"))
(dumb-server (erc-d-run "localhost" t 'no-pong))
(expect (erc-d-t-make-expecter))
(client-buf (get-buffer-create "*erc-d-client*"))
client-proc)
(with-current-buffer dumb-server-buffer
(erc-d-t-search-for 3 "Starting"))
(setq client-proc (make-network-process
:buffer client-buf
:name "erc-d-client"
:family 'ipv4
:noquery t
:coding 'binary
:service (process-contact dumb-server :service)
:host "localhost"))
(with-current-buffer dumb-server-buffer
(funcall expect 3 "Connection"))
(process-send-string client-proc "PASS :changeme\r\nNICK tester\r\n")
(sleep-for 0.01)
(process-send-string client-proc "USER user 0 * :tester\r\n")
(sleep-for 0.01)
(process-send-string client-proc "MODE tester +i\r\n")
(sleep-for 0.01)
(with-current-buffer client-buf
(funcall expect 3 "ExampleOrg")
(funcall expect 3 "irc.example.org")
(funcall expect 3 "marked as being away"))
(ert-info ("PING is not intercepted by specialized method")
(process-send-string client-proc "PING 42\r\n")
(with-current-buffer client-buf
(funcall expect 3 "PONG")))
(erc-d-t-wait-for 2 "dumb-server death"
(not (process-live-p dumb-server)))
(delete-process client-proc)
(when noninteractive
(kill-buffer client-buf)
(kill-buffer dumb-server-buffer))))
;; Inspect replies as they arrive within a single exchange, i.e., ensure we
;; don't regress to prior buggy version in which inspection wasn't possible
;; until all replies had been sent by the server.
(ert-deftest erc-d-run-incremental ()
(let ((erc-server-flood-penalty 0)
(expect (erc-d-t-make-expecter))
erc-d-linger-secs)
(erc-d-self-with-server (_ erc-server-buffer) incremental
(with-current-buffer erc-server-buffer
(funcall expect 3 "marked as being away"))
(with-current-buffer erc-server-buffer
(erc-cmd-JOIN "#foo"))
(with-current-buffer (erc-d-t-wait-for 1 (get-buffer "#foo"))
(funcall expect 1 "Users on #foo")
(funcall expect 1 "Look for me")
(not (search-forward "Done" nil t))
(funcall expect 10 "Done")
(erc-send-message "Hi")))))
(ert-deftest erc-d-unix-socket-direct ()
(skip-unless (featurep 'make-network-process '(:family local)))
(let* ((erc-d-linger-secs 0.1)
(sock (expand-file-name "erc-d.sock" temporary-file-directory))
(dumb-server (erc-d-run nil sock 'basic))
(dumb-server-buffer (get-buffer "*erc-d-server*"))
(client-buffer (get-buffer-create "*erc-d-client*"))
client)
(with-current-buffer "*erc-d-server*"
(erc-d-t-search-for 4 "Starting"))
(unwind-protect
(progn
(setq client (make-network-process
:buffer client-buffer
:name "erc-d-client"
:family 'local
:noquery t
:coding 'binary
:service sock))
(process-send-string client "PASS :changeme\r\n")
(sleep-for 0.01)
(process-send-string client "NICK tester\r\n")
(sleep-for 0.01)
(process-send-string client "USER user 0 * :tester\r\n")
(sleep-for 0.1)
(process-send-string client "MODE tester +i\r\n")
(sleep-for 0.01)
(process-send-string client "MODE #chan\r\n")
(sleep-for 0.01)
(erc-d-t-wait-for 1 "dumb-server death"
(not (process-live-p dumb-server)))
(when noninteractive
(kill-buffer client-buffer)
(kill-buffer dumb-server-buffer)))
(delete-file sock))))
;;; erc-d-self.el ends here
|