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
| | ;;; dbus-tests.el --- Tests of D-Bus integration into Emacs -*- lexical-binding:t -*-
;; Copyright (C) 2013-2020 Free Software Foundation, Inc.
;; Author: Michael Albinus <michael.albinus@gmx.de>
;; 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/'.
;;; Code:
(require 'ert)
(require 'dbus)
(defvar dbus-debug nil)
(declare-function dbus-get-unique-name "dbusbind.c" (bus))
(defconst dbus--test-enabled-session-bus
(and (featurep 'dbusbind)
(dbus-ignore-errors (dbus-get-unique-name :session)))
"Check, whether we are registered at the session bus.")
(defconst dbus--test-enabled-system-bus
(and (featurep 'dbusbind)
(dbus-ignore-errors (dbus-get-unique-name :system)))
"Check, whether we are registered at the system bus.")
(defconst dbus--test-service "org.gnu.Emacs.TestDBus"
"Test service.")
(defconst dbus--test-path "/org/gnu/Emacs/TestDBus"
"Test object path.")
(defconst dbus--test-interface "org.gnu.Emacs.TestDBus.Interface"
"Test interface.")
(defun dbus--test-availability (bus)
"Test availability of D-Bus BUS."
(should (dbus-list-names bus))
(should (dbus-list-activatable-names bus))
(should (dbus-list-known-names bus))
(should (dbus-get-unique-name bus)))
(ert-deftest dbus-test00-availability-session ()
"Test availability of D-Bus `:session'."
:expected-result (if dbus--test-enabled-session-bus :passed :failed)
(dbus--test-availability :session))
(ert-deftest dbus-test00-availability-system ()
"Test availability of D-Bus `:system'."
:expected-result (if dbus--test-enabled-system-bus :passed :failed)
(dbus--test-availability :system))
(ert-deftest dbus-test01-type-conversion ()
"Check type conversion functions."
(let ((ustr "0123abc_xyz\x01\xff")
(mstr "Grüß Göttin"))
(should
(string-equal
(dbus-byte-array-to-string (dbus-string-to-byte-array "")) ""))
(should
(string-equal
(dbus-byte-array-to-string (dbus-string-to-byte-array ustr)) ustr))
(should
(string-equal
(dbus-byte-array-to-string (dbus-string-to-byte-array mstr) 'multibyte)
mstr))
;; Should not work for multibyte strings.
(should-not
(string-equal
(dbus-byte-array-to-string (dbus-string-to-byte-array mstr)) mstr))
(should
(string-equal
(dbus-unescape-from-identifier (dbus-escape-as-identifier "")) ""))
(should
(string-equal
(dbus-unescape-from-identifier (dbus-escape-as-identifier ustr)) ustr))
;; Should not work for multibyte strings.
(should-not
(string-equal
(dbus-unescape-from-identifier (dbus-escape-as-identifier mstr)) mstr))))
(ert-deftest dbus-test01-basic-types ()
"Check basic D-Bus type arguments."
;; Unknown keyword.
(should-error
(dbus-check-arguments :session dbus--test-service :keyword)
:type 'wrong-type-argument)
;; `:string'.
(should (dbus-check-arguments :session dbus--test-service "string"))
(should (dbus-check-arguments :session dbus--test-service :string "string"))
(should-error
(dbus-check-arguments :session dbus--test-service :string 0.5)
:type 'wrong-type-argument)
;; `:object-path'.
(should
(dbus-check-arguments
:session dbus--test-service :object-path "/object/path"))
(should-error
(dbus-check-arguments :session dbus--test-service :object-path "string")
:type 'dbus-error)
(should-error
(dbus-check-arguments :session dbus--test-service :object-path 0.5)
:type 'wrong-type-argument)
;; `:signature'.
(should (dbus-check-arguments :session dbus--test-service :signature "as"))
(should-error
(dbus-check-arguments :session dbus--test-service :signature "string")
:type 'dbus-error)
(should-error
(dbus-check-arguments :session dbus--test-service :signature 0.5)
:type 'wrong-type-argument)
;; `:boolean'.
(should (dbus-check-arguments :session dbus--test-service nil))
(should (dbus-check-arguments :session dbus--test-service t))
(should (dbus-check-arguments :session dbus--test-service :boolean nil))
(should (dbus-check-arguments :session dbus--test-service :boolean t))
;; Will be handled as `nil'.
(should (dbus-check-arguments :session dbus--test-service :boolean))
;; Will be handled as `t'.
(should (dbus-check-arguments :session dbus--test-service :boolean 'whatever))
;; `:byte'.
(should (dbus-check-arguments :session dbus--test-service :byte 0))
;; Only the least significant byte is taken into account.
(should
(dbus-check-arguments :session dbus--test-service :byte most-positive-fixnum))
(should-error
(dbus-check-arguments :session dbus--test-service :byte -1)
:type 'wrong-type-argument)
(should-error
(dbus-check-arguments :session dbus--test-service :byte 0.5)
:type 'wrong-type-argument)
(should-error
(dbus-check-arguments :session dbus--test-service :byte "string")
:type 'wrong-type-argument)
;; `:int16'.
(should (dbus-check-arguments :session dbus--test-service :int16 0))
(should (dbus-check-arguments :session dbus--test-service :int16 #x7fff))
(should (dbus-check-arguments :session dbus--test-service :int16 #x-8000))
(should-error
(dbus-check-arguments :session dbus--test-service :int16 #x8000)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :int16 #x-8001)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :int16 0.5)
:type 'wrong-type-argument)
(should-error
(dbus-check-arguments :session dbus--test-service :int16 "string")
:type 'wrong-type-argument)
;; `:uint16'.
(should (dbus-check-arguments :session dbus--test-service :uint16 0))
(should (dbus-check-arguments :session dbus--test-service :uint16 #xffff))
(should-error
(dbus-check-arguments :session dbus--test-service :uint16 #x10000)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :uint16 -1)
:type 'wrong-type-argument)
(should-error
(dbus-check-arguments :session dbus--test-service :uint16 0.5)
:type 'wrong-type-argument)
(should-error
(dbus-check-arguments :session dbus--test-service :uint16 "string")
:type 'wrong-type-argument)
;; `:int32'.
(should (dbus-check-arguments :session dbus--test-service :int32 0))
(should (dbus-check-arguments :session dbus--test-service :int32 #x7fffffff))
(should (dbus-check-arguments :session dbus--test-service :int32 #x-80000000))
(should-error
(dbus-check-arguments :session dbus--test-service :int32 #x80000000)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :int32 #x-80000001)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :int32 0.5)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :int32 "string")
:type 'wrong-type-argument)
;; `:uint32'.
(should (dbus-check-arguments :session dbus--test-service 0))
(should (dbus-check-arguments :session dbus--test-service :uint32 0))
(should (dbus-check-arguments :session dbus--test-service :uint32 #xffffffff))
(should-error
(dbus-check-arguments :session dbus--test-service :uint32 #x100000000)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :uint32 -1)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :uint32 0.5)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :uint32 "string")
:type 'wrong-type-argument)
;; `:int64'.
(should (dbus-check-arguments :session dbus--test-service :int64 0))
(should
(dbus-check-arguments :session dbus--test-service :int64 #x7fffffffffffffff))
(should
(dbus-check-arguments :session dbus--test-service :int64 #x-8000000000000000))
(should-error
(dbus-check-arguments :session dbus--test-service :int64 #x8000000000000000)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :int64 #x-8000000000000001)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :int64 0.5)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :int64 "string")
:type 'wrong-type-argument)
;; `:uint64'.
(should (dbus-check-arguments :session dbus--test-service :uint64 0))
(should
(dbus-check-arguments :session dbus--test-service :uint64 #xffffffffffffffff))
(should-error
(dbus-check-arguments :session dbus--test-service :uint64 #x10000000000000000)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :uint64 -1)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :uint64 0.5)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :uint64 "string")
:type 'wrong-type-argument)
;; `:double'.
(should (dbus-check-arguments :session dbus--test-service :double 0))
(should (dbus-check-arguments :session dbus--test-service :double 0.5))
(should (dbus-check-arguments :session dbus--test-service :double -0.5))
(should (dbus-check-arguments :session dbus--test-service :double -1))
;; Shall both be supported?
(should (dbus-check-arguments :session dbus--test-service :double 1.0e+INF))
(should (dbus-check-arguments :session dbus--test-service :double 0.0e+NaN))
(should-error
(dbus-check-arguments :session dbus--test-service :double "string")
:type 'wrong-type-argument)
;; `:unix-fd'. Value range 0 .. 9.
(should (dbus-check-arguments :session dbus--test-service :unix-fd 0))
(should (dbus-check-arguments :session dbus--test-service :unix-fd 9))
(should-error
(dbus-check-arguments :session dbus--test-service :unix-fd 10)
:type 'dbus-error)
(should-error
(dbus-check-arguments :session dbus--test-service :unix-fd -1)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :unix-fd 0.5)
:type 'args-out-of-range)
(should-error
(dbus-check-arguments :session dbus--test-service :unix-fd "string")
:type 'wrong-type-argument))
(ert-deftest dbus-test01-compound-types ()
"Check basic D-Bus type arguments."
;; `:array'. It contains several elements of the same type.
(should (dbus-check-arguments :session dbus--test-service '("string")))
(should (dbus-check-arguments :session dbus--test-service '(:array "string")))
(should
(dbus-check-arguments :session dbus--test-service '(:array :string "string")))
(should
(dbus-check-arguments
:session dbus--test-service '(:array :string "string1" "string2")))
;; Empty array.
(should (dbus-check-arguments :session dbus--test-service '(:array)))
(should
(dbus-check-arguments :session dbus--test-service '(:array :signature "o")))
;; Different element types.
(should-error
(dbus-check-arguments
:session dbus--test-service
'(:array :string "string" :object-path "/object/path"))
:type 'wrong-type-argument)
;; `:variant'. It contains exactly one element.
(should
(dbus-check-arguments
:session dbus--test-service '(:variant :string "string")))
(should
(dbus-check-arguments
:session dbus--test-service '(:variant (:array "string"))))
;; More than one element.
(should-error
(dbus-check-arguments
:session dbus--test-service
'(:variant :string "string" :object-path "/object/path"))
:type 'wrong-type-argument)
;; `:dict-entry'. It must contain two elements; the first one must
;; be of a basic type. It must be an element of an array.
(should
(dbus-check-arguments
:session dbus--test-service
'(:array (:dict-entry :string "string" :boolean t))))
;; The second element is `nil' (implicitly). FIXME: Is this right?
(should
(dbus-check-arguments
:session dbus--test-service '(:array (:dict-entry :string "string"))))
;; Not two elements.
(should-error
(dbus-check-arguments
:session dbus--test-service
'(:array (:dict-entry :string "string" :boolean t :boolean t)))
:type 'wrong-type-argument)
;; The first element ist not of a basic type.
(should-error
(dbus-check-arguments
:session dbus--test-service
'(:array (:dict-entry (:array :string "string") :boolean t)))
:type 'wrong-type-argument)
;; It is not an element of an array.
(should-error
(dbus-check-arguments
:session dbus--test-service '(:dict-entry :string "string" :boolean t))
:type 'wrong-type-argument)
;; Different dict entry types can be part of an array.
(should
(dbus-check-arguments
:session dbus--test-service
'(:array
(:dict-entry :string "string1" :boolean t)
(:dict-entry :string "string2" :object-path "/object/path"))))
;; `:struct'. There is no restriction what could be an element of a struct.
(should
(dbus-check-arguments
:session dbus--test-service
'(:struct
:string "string"
:object-path "/object/path"
(:variant (:array :unix-fd 1 :unix-fd 2 :unix-fd 3 :unix-fd 4))))))
(defun dbus--test-register-service (bus)
"Check service registration at BUS."
;; Cleanup.
(dbus-ignore-errors (dbus-unregister-service bus dbus--test-service))
;; Register an own service.
(should (eq (dbus-register-service bus dbus--test-service) :primary-owner))
(should (member dbus--test-service (dbus-list-known-names bus)))
(should (eq (dbus-register-service bus dbus--test-service) :already-owner))
(should (member dbus--test-service (dbus-list-known-names bus)))
;; Unregister the service.
(should (eq (dbus-unregister-service bus dbus--test-service) :released))
(should-not (member dbus--test-service (dbus-list-known-names bus)))
(should (eq (dbus-unregister-service bus dbus--test-service) :non-existent))
(should-not (member dbus--test-service (dbus-list-known-names bus)))
;; `dbus-service-dbus' is reserved for the BUS itself.
(should
(equal
(butlast
(should-error (dbus-register-service bus dbus-service-dbus)))
`(dbus-error ,dbus-error-invalid-args)))
(should
(equal
(butlast
(should-error (dbus-unregister-service bus dbus-service-dbus)))
`(dbus-error ,dbus-error-invalid-args))))
(ert-deftest dbus-test02-register-service-session ()
"Check service registration at `:session' bus."
(skip-unless (and dbus--test-enabled-session-bus
(dbus-register-service :session dbus--test-service)))
(dbus--test-register-service :session)
(let ((service "org.freedesktop.Notifications"))
(when (member service (dbus-list-known-names :session))
;; Cleanup.
(dbus-ignore-errors (dbus-unregister-service :session service))
(should (eq (dbus-register-service :session service) :in-queue))
(should (eq (dbus-unregister-service :session service) :released))
(should
(eq (dbus-register-service :session service :do-not-queue) :exists))
(should (eq (dbus-unregister-service :session service) :not-owner)))))
(ert-deftest dbus-test02-register-service-system ()
"Check service registration at `:system' bus."
(skip-unless (and dbus--test-enabled-system-bus
(dbus-register-service :system dbus--test-service)))
(dbus--test-register-service :system))
(ert-deftest dbus-test02-register-service-own-bus ()
"Check service registration with an own bus.
This includes initialization and closing the bus."
;; Start bus.
(let ((output
(ignore-errors
(shell-command-to-string "env DISPLAY= dbus-launch --sh-syntax")))
bus pid)
(skip-unless (stringp output))
(when (string-match "DBUS_SESSION_BUS_ADDRESS='\\(.+\\)';" output)
(setq bus (match-string 1 output)))
(when (string-match "DBUS_SESSION_BUS_PID=\\([[:digit:]]+\\);" output)
(setq pid (match-string 1 output)))
(unwind-protect
(progn
(skip-unless
(dbus-ignore-errors
(and bus pid
(featurep 'dbusbind)
(dbus-init-bus bus)
(dbus-get-unique-name bus)
(dbus-register-service bus dbus--test-service))))
;; Run the test.
(dbus--test-register-service bus))
;; Save exit.
(when pid (call-process "kill" nil nil nil pid)))))
(ert-deftest dbus-test03-peer-interface ()
"Check `dbus-interface-peer' methods."
(skip-unless
(and dbus--test-enabled-session-bus
(dbus-register-service :session dbus--test-service)
;; "GetMachineId" is not implemented (yet). When it returns a
;; value, another D-Bus client like dbus-monitor is reacting
;; on `dbus-interface-peer'. We cannot test then.
(not
(dbus-ignore-errors
(dbus-call-method
:session dbus--test-service dbus-path-dbus
dbus-interface-peer "GetMachineId" :timeout 100)))))
(should (dbus-ping :session dbus--test-service 100))
(dbus-unregister-service :session dbus--test-service)
(should-not (dbus-ping :session dbus--test-service 100)))
(defun dbus--test-method-handler (&rest args)
"Method handler for `dbus-test04-register-method'."
(cond
;; No argument.
((null args)
:ignore)
;; One argument.
((= 1 (length args))
(car args))
;; Two arguments.
((= 2 (length args))
`(:error ,dbus-error-invalid-args
,(format-message "Wrong arguments %s" args)))
;; More than two arguments.
(t (signal 'dbus-error (cons "D-Bus signal" args)))))
(ert-deftest dbus-test04-register-method ()
"Check method registration for an own service."
(skip-unless dbus--test-enabled-session-bus)
(dbus-ignore-errors (dbus-unregister-service :session dbus--test-service))
(unwind-protect
(let ((method1 "Method1")
(method2 "Method2")
(handler #'dbus--test-method-handler)
registered)
;; The service is not registered yet.
(should
(equal
(butlast
(should-error
(dbus-call-method
:session dbus--test-service dbus--test-path
dbus--test-interface method1 :timeout 10 "foo")))
`(dbus-error ,dbus-error-service-unknown)))
;; Register.
(should
(equal
(setq
registered
(dbus-register-method
:session dbus--test-service dbus--test-path
dbus--test-interface method1 handler))
`((:method :session ,dbus--test-interface ,method1)
(,dbus--test-service ,dbus--test-path ,handler))))
(should
(equal
(dbus-register-method
:session dbus--test-service dbus--test-path
dbus--test-interface method2 handler)
`((:method :session ,dbus--test-interface ,method2)
(,dbus--test-service ,dbus--test-path ,handler))))
;; No argument, returns nil.
(should-not
(dbus-call-method
:session dbus--test-service dbus--test-path
dbus--test-interface method1))
;; One argument, returns the argument.
(should
(string-equal
(dbus-call-method
:session dbus--test-service dbus--test-path
dbus--test-interface method1 "foo")
"foo"))
;; Two arguments, D-Bus error activated as `(:error ...)' list.
(should
(equal
(should-error
(dbus-call-method
:session dbus--test-service dbus--test-path
dbus--test-interface method1 "foo" "bar"))
`(dbus-error ,dbus-error-invalid-args "Wrong arguments (foo bar)")))
;; Three arguments, D-Bus error activated by `dbus-error' signal.
(should
(equal
(should-error
(dbus-call-method
:session dbus--test-service dbus--test-path
dbus--test-interface method1 "foo" "bar" "baz"))
`(dbus-error
,dbus-error-failed
"D-Bus error: \"D-Bus signal\", \"foo\", \"bar\", \"baz\"")))
;; Unregister method.
(should (dbus-unregister-object registered))
(should-not (dbus-unregister-object registered))
(should
(equal
(butlast
(should-error
(dbus-call-method
:session dbus--test-service dbus--test-path
dbus--test-interface method1 :timeout 10 "foo")))
`(dbus-error ,dbus-error-no-reply))))
;; Cleanup.
(dbus-unregister-service :session dbus--test-service)))
(defvar dbus--test-signal-received nil
"Received signal value in `dbus--test-signal-handler'.")
(defun dbus--test-signal-handler (&rest args)
"Signal handler for `dbus-test*-signal'."
(setq dbus--test-signal-received args))
(defun dbus--test-timeout-handler (&rest _ignore)
"Timeout handler, reporting a failed test."
(ert-fail (format "`%s' timed out" (ert-test-name (ert-running-test)))))
(ert-deftest dbus-test05-register-signal ()
"Check signal registration for an own service."
(skip-unless dbus--test-enabled-session-bus)
(dbus-ignore-errors (dbus-unregister-service :session dbus--test-service))
(unwind-protect
(let ((member "Member")
(handler #'dbus--test-signal-handler)
registered)
;; Register signal handler.
(should
(equal
(setq
registered
(dbus-register-signal
:session dbus--test-service dbus--test-path
dbus--test-interface member handler))
`((:signal :session ,dbus--test-interface ,member)
(,dbus--test-service ,dbus--test-path ,handler))))
;; Send one argument, basic type.
(setq dbus--test-signal-received nil)
(dbus-send-signal
:session dbus--test-service dbus--test-path
dbus--test-interface member "foo")
(with-timeout (1 (dbus--test-timeout-handler))
(while (null dbus--test-signal-received)
(read-event nil nil 0.1)))
(should (equal dbus--test-signal-received '("foo")))
;; Send two arguments, compound types.
(setq dbus--test-signal-received nil)
(dbus-send-signal
:session dbus--test-service dbus--test-path
dbus--test-interface member
'(:array :byte 1 :byte 2 :byte 3) '(:variant :string "bar"))
(with-timeout (1 (dbus--test-timeout-handler))
(while (null dbus--test-signal-received)
(read-event nil nil 0.1)))
(should (equal dbus--test-signal-received '((1 2 3) ("bar"))))
;; Unregister signal.
(should (dbus-unregister-object registered))
(should-not (dbus-unregister-object registered)))
;; Cleanup.
(dbus-unregister-service :session dbus--test-service)))
(ert-deftest dbus-test06-register-property ()
"Check property registration for an own service."
(skip-unless dbus--test-enabled-session-bus)
(dbus-ignore-errors (dbus-unregister-service :session dbus--test-service))
(unwind-protect
(let ((property1 "Property1")
(property2 "Property2")
(property3 "Property3")
(property4 "Property4")
registered)
;; `:read' property.
(should
(equal
(setq
registered
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1 :read "foo"))
`((:property :session ,dbus--test-interface ,property1)
(,dbus--test-service ,dbus--test-path))))
(should
(string-equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1)
"foo"))
;; Due to `:read' access type, we don't get a proper reply
;; from `dbus-set-property'.
(should
(equal
(butlast
(should-error
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1 "foofoo")))
`(dbus-error ,dbus-error-property-read-only)))
(should
(string-equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1)
"foo"))
;; `:write' property.
(should
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface property2 :write "bar")
`((:property :session ,dbus--test-interface ,property2)
(,dbus--test-service ,dbus--test-path))))
;; Due to `:write' access type, we don't get a proper reply
;; from `dbus-get-property'.
(should
(equal
(butlast
(should-error
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property2)))
`(dbus-error ,dbus-error-access-denied)))
(should
(string-equal
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface property2 "barbar")
"barbar"))
;; Still `:write' access type.
(should
(equal
(butlast
(should-error
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property2)))
`(dbus-error ,dbus-error-access-denied)))
;; `:readwrite' property, typed value (Bug#43252).
(should
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface property3 :readwrite :object-path "/baz")
`((:property :session ,dbus--test-interface ,property3)
(,dbus--test-service ,dbus--test-path))))
(should
(string-equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property3)
"/baz"))
(should
(string-equal
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface property3 :object-path "/baz/baz")
"/baz/baz"))
(should
(string-equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property3)
"/baz/baz"))
;; Not registered property.
(should
(equal
(butlast
(should-error
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property4)))
`(dbus-error ,dbus-error-unknown-property)))
(should
(equal
(butlast
(should-error
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface property4 "foobarbaz")))
`(dbus-error ,dbus-error-unknown-property)))
;; `dbus-get-all-properties'. We cannot retrieve a value for
;; the property with `:write' access type.
(let ((result
(dbus-get-all-properties
:session dbus--test-service dbus--test-path
dbus--test-interface)))
(should (string-equal (cdr (assoc property1 result)) "foo"))
(should (string-equal (cdr (assoc property3 result)) "/baz/baz"))
(should-not (assoc property2 result)))
;; `dbus-get-all-managed-objects'. We cannot retrieve a value for
;; the property with `:write' access type.
(let ((result
(dbus-get-all-managed-objects
:session dbus--test-service dbus--test-path)))
(should (setq result (cadr (assoc dbus--test-path result))))
(should (setq result (cadr (assoc dbus--test-interface result))))
(should (string-equal (cdr (assoc property1 result)) "foo"))
(should (string-equal (cdr (assoc property3 result)) "/baz/baz"))
(should-not (assoc property2 result)))
;; Unregister property.
(should (dbus-unregister-object registered))
(should-not (dbus-unregister-object registered))
(should
(equal
(butlast
(should-error
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1)))
`(dbus-error ,dbus-error-unknown-property))))
;; Cleanup.
(dbus-unregister-service :session dbus--test-service)))
;; The following test is inspired by Bug#43146.
(ert-deftest dbus-test06-register-property-several-paths ()
"Check property registration for an own service at several paths."
(skip-unless dbus--test-enabled-session-bus)
(dbus-ignore-errors (dbus-unregister-service :session dbus--test-service))
(unwind-protect
(let ((property1 "Property1")
(property2 "Property2")
(property3 "Property3"))
;; First path.
(should
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1 :readwrite "foo")
`((:property :session ,dbus--test-interface ,property1)
(,dbus--test-service ,dbus--test-path))))
(should
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface property2 :readwrite "bar")
`((:property :session ,dbus--test-interface ,property2)
(,dbus--test-service ,dbus--test-path))))
(should
(string-equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1)
"foo"))
(should
(string-equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property2)
"bar"))
(should
(string-equal
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1 "foofoo")
"foofoo"))
(should
(string-equal
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface property2 "barbar")
"barbar"))
(should
(string-equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property1)
"foofoo"))
(should
(string-equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property2)
"barbar"))
;; Second path.
(should
(equal
(dbus-register-property
:session dbus--test-service (concat dbus--test-path dbus--test-path)
dbus--test-interface property2 :readwrite "foo")
`((:property :session ,dbus--test-interface ,property2)
(,dbus--test-service ,(concat dbus--test-path dbus--test-path)))))
(should
(equal
(dbus-register-property
:session dbus--test-service (concat dbus--test-path dbus--test-path)
dbus--test-interface property3 :readwrite "bar")
`((:property :session ,dbus--test-interface ,property3)
(,dbus--test-service ,(concat dbus--test-path dbus--test-path)))))
(should
(string-equal
(dbus-get-property
:session dbus--test-service (concat dbus--test-path dbus--test-path)
dbus--test-interface property2)
"foo"))
(should
(string-equal
(dbus-get-property
:session dbus--test-service (concat dbus--test-path dbus--test-path)
dbus--test-interface property3)
"bar"))
(should
(string-equal
(dbus-set-property
:session dbus--test-service (concat dbus--test-path dbus--test-path)
dbus--test-interface property2 "foofoo")
"foofoo"))
(should
(string-equal
(dbus-set-property
:session dbus--test-service (concat dbus--test-path dbus--test-path)
dbus--test-interface property3 "barbar")
"barbar"))
(should
(string-equal
(dbus-get-property
:session dbus--test-service (concat dbus--test-path dbus--test-path)
dbus--test-interface property2)
"foofoo"))
(should
(string-equal
(dbus-get-property
:session dbus--test-service (concat dbus--test-path dbus--test-path)
dbus--test-interface property3)
"barbar"))
;; Everything is still fine, tested with `dbus-get-all-properties'.
(let ((result
(dbus-get-all-properties
:session dbus--test-service dbus--test-path
dbus--test-interface)))
(should (string-equal (cdr (assoc property1 result)) "foofoo"))
(should (string-equal (cdr (assoc property2 result)) "barbar"))
(should-not (assoc property3 result)))
(let ((result
(dbus-get-all-properties
:session dbus--test-service
(concat dbus--test-path dbus--test-path) dbus--test-interface)))
(should (string-equal (cdr (assoc property2 result)) "foofoo"))
(should (string-equal (cdr (assoc property3 result)) "barbar"))
(should-not (assoc property1 result)))
;; Final check with `dbus-get-all-managed-objects'.
(let ((result
(dbus-get-all-managed-objects :session dbus--test-service "/"))
result1)
(should (setq result1 (cadr (assoc dbus--test-path result))))
(should (setq result1 (cadr (assoc dbus--test-interface result1))))
(should (string-equal (cdr (assoc property1 result1)) "foofoo"))
(should (string-equal (cdr (assoc property2 result1)) "barbar"))
(should-not (assoc property3 result1))
(should
(setq
result1
(cadr (assoc (concat dbus--test-path dbus--test-path) result))))
(should (setq result1 (cadr (assoc dbus--test-interface result1))))
(should (string-equal (cdr (assoc property2 result1)) "foofoo"))
(should (string-equal (cdr (assoc property3 result1)) "barbar"))
(should-not (assoc property1 result1))))
;; Cleanup.
(dbus-unregister-service :session dbus--test-service)))
(ert-deftest dbus-test06-register-property-emits-signal ()
"Check property registration for an own service, including signalling."
(skip-unless dbus--test-enabled-session-bus)
(dbus-ignore-errors (dbus-unregister-service :session dbus--test-service))
(unwind-protect
(let ((property "Property")
(handler #'dbus--test-signal-handler))
;; Register signal handler.
(should
(equal
(dbus-register-signal
:session dbus--test-service dbus--test-path
dbus-interface-properties "PropertiesChanged" handler)
`((:signal :session ,dbus-interface-properties "PropertiesChanged")
(,dbus--test-service ,dbus--test-path ,handler))))
;; Register property.
(setq dbus--test-signal-received nil)
(should
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface property :readwrite "foo" 'emits-signal)
`((:property :session ,dbus--test-interface ,property)
(,dbus--test-service ,dbus--test-path))))
(with-timeout (1 (dbus--test-timeout-handler))
(while (null dbus--test-signal-received)
(read-event nil nil 0.1)))
;; It returns two arguments, "changed_properties" (an array of
;; dict entries) and "invalidated_properties" (an array of
;; strings).
(should (equal dbus--test-signal-received `(((,property ("foo"))) ())))
(should
(equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property)
"foo"))
;; Set property. The new value shall be signalled.
(setq dbus--test-signal-received nil)
(should
(equal
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface property
'(:array :byte 1 :byte 2 :byte 3))
'(1 2 3)))
(with-timeout (1 (dbus--test-timeout-handler))
(while (null dbus--test-signal-received)
(read-event nil nil 0.1)))
(should
(equal
dbus--test-signal-received `(((,property ((1 2 3)))) ())))
(should
(equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface property)
'(1 2 3))))
;; Cleanup.
(dbus-unregister-service :session dbus--test-service)))
(defsubst dbus--test-run-property-test (selector name value expected)
"Generate a property test: register, set, get, getall sequence.
This is a helper function for the macro `dbus--test-property'.
The argument SELECTOR indicates whether the test should expand to
'dbus-register-property' (if SELECTOR is 'register) or
`dbus-set-property' (if SELECTOR is 'set).
The argument NAME is the property name.
The argument VALUE is the value to register or set.
The argument EXPECTED is a transformed VALUE representing the
form `dbus-get-property' should return."
(cond
((eq selector 'register)
(should
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface name :readwrite value)
`((:property :session ,dbus--test-interface ,name)
(,dbus--test-service ,dbus--test-path)))))
((eq selector 'set)
(should
(equal
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface name value)
expected)))
(t (signal 'wrong-type-argument "Selector should be 'register or 'set.")))
(should
(equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface name)
expected))
(let ((result
(dbus-get-all-properties
:session dbus--test-service dbus--test-path
dbus--test-interface)))
(should (equal (cdr (assoc name result)) expected)))
(let ((result
(dbus-get-all-managed-objects :session dbus--test-service "/"))
result1)
(should (setq result1 (cadr (assoc dbus--test-path result))))
(should (setq result1 (cadr (assoc dbus--test-interface result1))))
(should (equal (cdr (assoc name result1)) expected))))
(defsubst dbus--test-property (name &rest value-list)
"Test a DBus property named by string argument NAME.
The argument VALUE-LIST is a sequence of pairs, where each pair
represents a value form and an expected returned value form. The
first pair in VALUES is used for `dbus-register-property'.
Subsequent pairs of the list are tested with
`dbus-set-property'."
(let ((values (car value-list)))
(dbus--test-run-property-test
'register
name
(car values)
(cdr values)))
(dolist (values (cdr value-list))
(dbus--test-run-property-test
'set
name
(car values)
(cdr values))))
(ert-deftest dbus-test06-test-property-types ()
"Check property access and mutation for an own service."
(skip-unless dbus--test-enabled-session-bus)
(dbus-ignore-errors (dbus-unregister-service :session dbus--test-service))
(dbus-register-service :session dbus--test-service)
(unwind-protect
(progn
(dbus--test-property
"ByteArray"
'((:array :byte 1 :byte 2 :byte 3) . (1 2 3))
'((:array :byte 4 :byte 5 :byte 6) . (4 5 6)))
(dbus--test-property
"StringArray"
'((:array "one" "two" :string "three") . ("one" "two" "three"))
'((:array :string "four" :string "five" "six") . ("four" "five" "six")))
(dbus--test-property
"ObjectArray"
'((:array
:object-path "/node00"
:object-path "/node01"
:object-path "/node0/node02") .
("/node00" "/node01" "/node0/node02"))
'((:array
:object-path "/node10"
:object-path "/node11"
:object-path "/node0/node12") .
("/node10" "/node11" "/node0/node12")))
(dbus--test-property
"Dictionary"
'((:array
:dict-entry (:string "four" (:variant :string "value of four"))
:dict-entry ("five" (:variant :object-path "/nodex"))
:dict-entry ("six" (:variant (:array :byte 4 :byte 5 :byte 6)))) .
(("four"
("value of four"))
("five"
("/nodex"))
("six"
((4 5 6)))))
'((:array
:dict-entry (:string "key0" (:variant (:array :byte 7 :byte 8 :byte 9)))
:dict-entry ("key1" (:variant :string "value"))
:dict-entry ("key2" (:variant :object-path "/node0/node1"))) .
(("key0"
((7 8 9)))
("key1"
("value"))
("key2"
("/node0/node1")))))
(dbus--test-property
"ByteDictionary"
'((:array
(:dict-entry :byte 8 (:variant :string "byte-eight"))
(:dict-entry :byte 16 (:variant :object-path "/byte/sixteen"))
(:dict-entry :byte 48 (:variant (:array :byte 8 :byte 9 :byte 10)))) .
((8 ("byte-eight"))
(16 ("/byte/sixteen"))
(48 ((8 9 10))))))
(dbus--test-property
"Variant"
'((:variant "Variant string") . ("Variant string"))
'((:variant :byte 42) . (42))
'((:variant :uint32 1000000) . (1000000))
'((:variant :object-path "/variant/path") . ("/variant/path"))
'((:variant :signature "a{sa{sv}}") . ("a{sa{sv}}"))
'((:variant (:struct 42 "string" (:object-path "/structure/path") (:variant "last"))) .
((42 "string" ("/structure/path") ("last")))))
;; Test that :read prevents writes
(should
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface "StringArray" :read
'(:array "one" "two" :string "three"))
`((:property :session ,dbus--test-interface "StringArray")
(,dbus--test-service ,dbus--test-path))))
(should-error ; Cannot set property with :read access
(equal
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface "StringArray"
'(:array "seven" "eight" :string "nine"))
nil))
(should-not
(equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface "StringArray")
'("seven" "eight" "nine")))
(should ; Verify property has registered value
(equal
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface "StringArray")
'("one" "two" "three")))
;; Test mismatched types in array
(should-error
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface "MixedArray" :readwrite
'(:array
:object-path "/node00"
:string "/node01"
:object-path "/node0/node02"))
`((:property :session ,dbus--test-interface "MixedArray")
(,dbus--test-service ,dbus--test-path))))
;; Test integer overflow
(should
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface "ByteValue" :readwrite
:byte 128)
`((:property :session ,dbus--test-interface "ByteValue")
(,dbus--test-service ,dbus--test-path))))
(should
(=
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface "ByteValue")
128))
(should ; dbus-set-property may change property type
(=
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface "ByteValue" 1024)
1024))
(should
(=
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface "ByteValue")
1024))
(should
(=
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface "ByteValue" :byte 520)
8))
(should
(=
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface "ByteValue")
8))
(should ; Another change property type
(equal
(dbus-set-property
:session dbus--test-service dbus--test-path
dbus--test-interface "ByteValue" :boolean t)
t))
(should
(eq
(dbus-get-property
:session dbus--test-service dbus--test-path
dbus--test-interface "ByteValue")
t))
;; Test invalid type specification
(should-error
(equal
(dbus-register-property
:session dbus--test-service dbus--test-path
dbus--test-interface "InvalidType" :readwrite
:keyword 128)
`((:property :session ,dbus--test-interface "InvalidType")
(,dbus--test-service ,dbus--test-path)))))
;; Cleanup.
(message "cleanup")
(dbus-unregister-service :session dbus--test-service)))
(defun dbus-test-all (&optional interactive)
"Run all tests for \\[dbus]."
(interactive "p")
(funcall (if interactive #'ert-run-tests-interactively #'ert-run-tests-batch)
"^dbus"))
(provide 'dbus-tests)
;;; dbus-tests.el ends here
|