AtlatestRepositorysigil-dbus

sigil-dbus / tree / testtest-integration.sgl

1(import (sigil dbus) (sigil async) (sigil process) (sigil string)
2 (sigil time) (sigil test))
3
4(define bus "org.freedesktop.DBus")
5(define bus-path "/org/freedesktop/DBus")
6(define service-name "org.example.SigilTest")
7(define path "/org/example/Test")
8(define iface "org.example.Test")
9(define props "org.freedesktop.DBus.Properties")
10(define sensitive-input #f)
11(define (sensitive bytes)
12 (set! sensitive-input bytes)
13 (dbus-sensitive-reply bytes))
15(with-async
16 (let ((server (dbus-connect-session)) (client (dbus-connect-system))
17 (counter 7) (seen '()) (ownership-events '()))
18 (dynamic-wind
19 (lambda () #t)
20 (lambda ()
21 (dbus-export! server path
22 (list
23 (dbus-interface iface
24 methods:
25 (list
26 (dbus-method "Echo" "s" "s" (lambda (s) (list s)))
27 (dbus-method "Notify" "susssasa{sv}i" "u"
28 (lambda (app replaces icon summary body actions hints timeout)
29 (list (if (= 0 replaces) 42 replaces))))
30 (dbus-method "Fail" "" ""
31 (lambda () (dbus-error "org.example.Error.Refused" "refused")))
32 (dbus-method "Throw" "" "" (lambda () (error "broken handler")))
33 (dbus-method "BadOutput" "" "u" (lambda () '("wrong")))
34 (dbus-method "Sensitive" "" "s" (lambda () (sensitive (bytevector 97 98 99))))
35 (dbus-method "SensitiveInvalid" "" "s" (lambda () (sensitive (bytevector 97 0 98))))
36 (dbus-method "SensitiveWrongSignature" "" "u" (lambda () (sensitive (bytevector 97))))
37 (dbus-method "Caller" "s" "ss"
38 (lambda (message expected-path)
39 (if (string=? expected-path (dbus-message-field message 1))
40 (list (dbus-message-field message 7) expected-path)
41 (dbus-error "org.example.Error.Denied" "Unexpected path")))
42 with-message: #t)
43 (dbus-method "Slow" "u" "u" (lambda (delay) (sleep (/ delay 1000)) (list delay))))
44 properties:
45 (list (dbus-property "Counter" "u" (lambda () counter)
46 setter: (lambda (value) (set! counter value)))
47 (dbus-property "ReadOnly" "s" (lambda () "fixed")))
48 signals: (list (dbus-signal "Changed" "u")))))
49 (go (dbus-run! server))
50 (test-group "real bus and service"
51 (test "session and system entry points authenticate"
52 (assert-true (string-starts-with? (dbus-unique-name server) ":"))
53 (assert-true (string-starts-with? (dbus-unique-name client) ":")))
54 (test "ListNames"
55 (assert-true (member (dbus-unique-name client)
56 (car (dbus-call client bus bus-path bus "ListNames" "" '())))))
57 (test "address fallback"
58 (let ((extra (dbus-connect-session
59 address: (string-append "unix:path=/nonexistent/dbus;"
60 (getenv "DBUS_SESSION_BUS_ADDRESS")))))
61 (assert-true (string-starts-with? (dbus-unique-name extra) ":"))
62 (dbus-close! extra)))
63 (test "wrong GUID is rejected"
64 (assert-error (dbus-connect-session timeout-ms: 500
65 address: (string-append
66 (car (string-split (getenv "DBUS_SESSION_BUS_ADDRESS") ",guid="))
67 ",guid=00000000000000000000000000000000"))))
68 (test "RequestName"
69 (assert-equal 1 (dbus-request-name! server service-name flags: dbus-allow-replacement)))
70 (test "NameAcquired tracks ownership"
71 (dbus-call server bus bus-path bus "ListNames" "" '())
72 (assert-true (member service-name (dbus-owned-names server))))
73 (test "method call"
74 (assert-equal '("hello") (dbus-call client service-name path iface "Echo" "s" '("hello"))))
75 (test "notifications argument types"
76 (assert-equal '(42)
77 (dbus-call client service-name path iface "Notify" "susssasa{sv}i"
78 (list "app" 0 "" "summary" "body" '("default" "Open")
79 (list (cons "urgency" (dbus-variant "y" 2))) -1))))
80 (test "large payload handles partial writes"
81 (let ((payload (make-string 131072 #\x)))
82 (assert-equal (list payload)
83 (dbus-call client service-name path iface "Echo" "s" (list payload) timeout-ms: 5000))))
84 (test "custom method error"
85 (assert-equal "org.example.Error.Refused"
86 (dbus-error-name (dbus-call client service-name path iface "Fail" "" '()))))
87 (test "handler exception becomes Failed"
88 (assert-equal "org.freedesktop.DBus.Error.Failed"
89 (dbus-error-name (dbus-call client service-name path iface "Throw" "" '()))))
90 (test "bad handler output becomes Failed"
91 (assert-equal "org.freedesktop.DBus.Error.Failed"
92 (dbus-error-name (dbus-call client service-name path iface "BadOutput" "" '()))))
93 (test "handler survives previous exceptions"
94 (assert-equal '("still alive")
95 (dbus-call client service-name path iface "Echo" "s" '("still alive"))))
96 (test "sensitive string reply clears its owned input"
97 (assert-equal '("abc") (dbus-call client service-name path iface "Sensitive" "" '()))
98 (assert-equal (bytevector 0 0 0) sensitive-input))
99 (test "opt-in handler receives authenticated sender and object path"
100 (assert-equal (list (dbus-unique-name client) path)
101 (dbus-call client service-name path iface "Caller" "s" (list path)))
102 (assert-equal "org.example.Error.Denied"
103 (dbus-error-name (dbus-call client service-name path iface "Caller" "s" '("/wrong")))))
104 (test "invalid sensitive output fails without closing the connection"
105 (assert-equal "org.freedesktop.DBus.Error.Failed"
106 (dbus-error-name (dbus-call client service-name path iface "SensitiveInvalid" "" '())))
107 (assert-equal (bytevector 0 0 0) sensitive-input)
108 (assert-equal "org.freedesktop.DBus.Error.Failed"
109 (dbus-error-name (dbus-call client service-name path iface "SensitiveWrongSignature" "" '())))
110 (assert-equal (bytevector 0) sensitive-input)
111 (assert-equal '("alive") (dbus-call client service-name path iface "Echo" "s" '("alive"))))
112 (test "unknown method"
113 (assert-equal "org.freedesktop.DBus.Error.UnknownMethod"
114 (dbus-error-name (dbus-call client service-name path iface "Missing" "" '()))))
115 (test "unknown object"
116 (assert-equal "org.freedesktop.DBus.Error.UnknownObject"
117 (dbus-error-name (dbus-call client service-name "/missing" iface "Echo" "s" '("a")))))
118 (test "unknown interface"
119 (assert-equal "org.freedesktop.DBus.Error.UnknownInterface"
120 (dbus-error-name (dbus-call client service-name path "org.example.Missing" "Echo" "s" '("a")))))
121 (test "incorrect input signature"
122 (assert-equal "org.freedesktop.DBus.Error.InvalidArgs"
123 (dbus-error-name (dbus-call client service-name path iface "Echo" "i" '(1)))))
124 (test "Peer.Ping"
125 (assert-equal '() (dbus-call client service-name path "org.freedesktop.DBus.Peer" "Ping" "" '())))
126 (test "Get property"
127 (assert-equal (list (dbus-variant "u" 7))
128 (dbus-call client service-name path props "Get" "ss" (list iface "Counter"))))
129 (test "GetAll properties"
130 (assert-equal
131 (list (list (cons "Counter" (dbus-variant "u" 7)) (cons "ReadOnly" (dbus-variant "s" "fixed"))))
132 (dbus-call client service-name path props "GetAll" "s" (list iface))))
133 (test "subscribe and Set emits PropertiesChanged"
134 (let ((token (dbus-subscribe! client
135 (list (cons 'interface props) (cons 'member "PropertiesChanged") (cons 'path path))
136 (lambda (message) (set! seen (cons (dbus-message-body message) seen))))))
137 (assert-false (dbus-error? token))
138 (assert-equal '() (dbus-call client service-name path props "Set" "ssv"
139 (list iface "Counter" (dbus-variant "u" 8))))
140 (let loop ((n 0))
141 (when (and (null? seen) (< n 20)) (dbus-pump! client timeout-ms: 5) (sleep 0.001) (loop (+ n 1))))
142 (assert-equal (list iface (list (cons "Counter" (dbus-variant "u" 8))) '()) (car seen))
143 (dbus-unsubscribe! client token)))
144 (test "subscription control uses the supplied await and one total deadline"
145 (let ((calls 0) (before (length (vector-ref client 3))))
146 (let ((result
147 (dbus-subscribe! client
148 (list (cons 'sender service-name) (cons 'interface iface)) (lambda (m) #f)
149 timeout-ms: 20
150 await: (lambda (pending)
151 (set! calls (+ calls 1))
152 (sleep 0.03)
153 (dbus-await pending)))))
154 (assert-true (dbus-error? result))
155 (assert-equal "org.freedesktop.DBus.Error.NoReply" (dbus-error-name result))
156 (assert-equal 1 calls)
157 (assert-equal before (length (vector-ref client 3))))))
158 (test "well-known subscription stages share their remaining budget"
159 (let ((calls 0))
160 (let ((result
161 (dbus-subscribe! client
162 (list (cons 'sender service-name) (cons 'interface iface)) (lambda (m) #f)
163 timeout-ms: 20
164 await: (lambda (pending)
165 (set! calls (+ calls 1))
166 (sleep 0.012)
167 (dbus-await pending)))))
168 (assert-true (dbus-error? result))
169 (assert-equal "org.freedesktop.DBus.Error.NoReply" (dbus-error-name result))
170 (assert-true (<= calls 2)))))
171 (test "canceled subscription setup leaves no local callback"
172 (let ((before (length (vector-ref client 3))))
173 (assert-error
174 (dbus-subscribe! client (list (cons 'interface iface)) (lambda (m) #f)
175 await: (lambda (pending) (error "Canceled test subscription"))))
176 (assert-equal before (length (vector-ref client 3)))
177 (assert-equal '("alive")
178 (dbus-call client service-name path iface "Echo" "s" '("alive")))))
179 (test "unsubscribe detaches locally when its await fails"
180 (let* ((seen 0)
181 (token (dbus-subscribe! client (list (cons 'interface iface))
182 (lambda (m) (set! seen (+ seen 1))))))
183 (assert-error (dbus-unsubscribe! client token
184 await: (lambda (pending) (error "Canceled removal"))))
185 (assert-false (memq token (vector-ref client 3)))
186 (dbus-send-signal! server path iface "Changed" "u" '(1))
187 (dbus-call client bus bus-path bus "ListNames" "" '())
188 (assert-equal 0 seen)))
189 (test "no-reply unsubscribe does not call await"
190 (let ((token (dbus-subscribe! client (list (cons 'interface iface)) (lambda (m) #f))))
191 (dbus-unsubscribe! client token timeout-ms: 10 wait?: #f
192 await: (lambda (pending) (error "Unexpected wait")))
193 (assert-false (memq token (vector-ref client 3)))))
194 (test "read-only property"
195 (assert-equal "org.freedesktop.DBus.Error.PropertyReadOnly"
196 (dbus-error-name (dbus-call client service-name path props "Set" "ssv"
197 (list iface "ReadOnly" (dbus-variant "s" "x"))))))
198 (test "property variant type"
199 (assert-equal "org.freedesktop.DBus.Error.InvalidArgs"
200 (dbus-error-name (dbus-call client service-name path props "Set" "ssv"
201 (list iface "Counter" (dbus-variant "s" "x"))))))
202 (test "well-known sender and overlapping subscriptions"
203 (let* ((matched 0) (other 0)
204 (token (dbus-subscribe! client
205 (list (cons 'sender service-name) (cons 'interface iface) (cons 'member "Changed"))
206 (lambda (m) (set! matched (+ matched 1)))))
207 (other-token (dbus-subscribe! client
208 (list (cons 'sender (dbus-unique-name client))
209 (cons 'interface iface) (cons 'member "Changed"))
210 (lambda (m) (set! other (+ other 1))))))
211 (dbus-send-signal! server path iface "Changed" "u" '(9))
212 (let loop ((n 0))
213 (when (and (= matched 0) (< n 20))
214 (dbus-pump! client timeout-ms: 5) (sleep 0.001) (loop (+ n 1))))
215 (assert-equal 1 matched)
216 (assert-equal 0 other)
217 (dbus-unsubscribe! client token)
218 (dbus-send-signal! server path iface "Changed" "u" '(10))
219 (dbus-call client bus bus-path bus "ListNames" "" '())
220 (assert-equal 1 matched)
221 (dbus-unsubscribe! client other-token)))
222 (test "unknown property"
223 (assert-equal "org.freedesktop.DBus.Error.UnknownProperty"
224 (dbus-error-name (dbus-call client service-name path props "Get" "ss" (list iface "Missing")))))
225 (test "introspection XML"
226 (let ((xml (car (dbus-call client service-name path "org.freedesktop.DBus.Introspectable"
227 "Introspect" "" '()))))
228 (assert-true (string-contains? xml "method name=\"Echo\""))
229 (assert-true (string-contains? xml "property name=\"Counter\" type=\"u\" access=\"readwrite\""))
230 (assert-true (string-contains? xml "signal name=\"Changed\""))))
231 (test "out of order async replies"
232 (let ((slow (dbus-call-async client service-name path iface "Slow" "u" '(30)))
233 (fast (dbus-call-async client service-name path iface "Echo" "s" '("fast"))))
234 (assert-equal '("fast") (dbus-await fast))
235 (assert-false (dbus-pending-ready? slow))
236 (assert-equal '(30) (dbus-await slow))))
237 (test "method timeout and late reply isolation"
238 (assert-equal "org.freedesktop.DBus.Error.NoReply"
239 (dbus-error-name (dbus-call client service-name path iface "Slow" "u" '(30) timeout-ms: 5)))
240 (assert-equal '("after timeout")
241 (dbus-call client service-name path iface "Echo" "s" '("after timeout"))))
242 (test "dbus-send interoperates"
243 (assert-true
244 (string-contains?
245 (process-output->string "dbus-send" "--session" "--print-reply" "--dest=org.example.SigilTest"
246 path "org.example.Test.Echo" "string:external") "external")))
247 (test "busctl interoperates"
248 (assert-true
249 (string-contains?
250 (process-output->string "busctl" (string-append "--address=" (getenv "DBUS_SESSION_BUS_ADDRESS"))
251 "call" service-name path iface "Echo" "s" "busctl") "busctl")))
252 (test "busctl property access"
253 (assert-true
254 (string-contains?
255 (process-output->string "busctl" (string-append "--address=" (getenv "DBUS_SESSION_BUS_ADDRESS"))
256 "get-property" service-name path iface "Counter") "8")))
257 (test "NameOwnerChanged and replacement flags"
258 (let ((token (dbus-subscribe! client
259 (list (cons 'interface bus) (cons 'member "NameOwnerChanged")
260 (cons 'arg0 service-name))
261 (lambda (m) (set! ownership-events (cons (dbus-message-body m) ownership-events))))))
262 (assert-equal 3 (dbus-request-name! client service-name flags: dbus-do-not-queue))
263 (assert-equal 1 (dbus-request-name! client service-name flags: (+ dbus-replace-existing dbus-do-not-queue)))
264 (let loop ((n 0))
265 (when (and (null? ownership-events) (< n 20))
266 (dbus-pump! client timeout-ms: 5) (sleep 0.001) (loop (+ n 1))))
267 (assert-equal (list service-name (dbus-unique-name server) (dbus-unique-name client))
268 (car ownership-events))
269 (dbus-call server bus bus-path bus "ListNames" "" '())
270 (assert-false (member service-name (dbus-owned-names server)))
271 (dbus-unsubscribe! client token)))
272 (test "ReleaseName" (assert-equal 1 (dbus-release-name! client service-name)))
273 (test "disconnect resolves pending calls"
274 (let ((p (dbus-call-async client bus bus-path bus "ListNames" "" '())))
275 (dbus-close! client)
276 (assert-equal "org.freedesktop.DBus.Error.Disconnected" (dbus-error-name (dbus-await p))))))
277 (unless (run-tests) (exit 1)))
278 (lambda () (dbus-close! client) (dbus-close! server)))))