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
|
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021, 2022 Maxim Cournoyer <maxim.cournoyer@gmail.com>.
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (gnu tests telephony)
#:use-module (gnu)
#:use-module (gnu packages)
#:use-module (gnu packages guile)
#:use-module (gnu packages guile-xyz)
#:use-module (gnu tests)
#:use-module (gnu system vm)
#:use-module (gnu services)
#:use-module (gnu services dbus)
#:use-module (gnu services networking)
#:use-module (gnu services ssh)
#:use-module (gnu services telephony)
#:use-module (guix gexp)
#:use-module (guix modules)
#:export (%test-jami
%test-jami-provisioning
%test-jami-provisioning-partial))
;;;
;;; Jami daemon.
;;;
(include "data/jami-dummy-account.dat") ;defines %jami-account-content-sexp
(define %dummy-jami-account-archive
;; A Jami account archive is a gzipped JSON file.
(computed-file
"dummy-jami-account.gz"
(with-extensions (list guile-json-4 guile-zlib)
#~(begin
(use-modules (json) (zlib))
(let ((port (open-output-file #$output)))
(call-with-gzip-output-port port
(lambda (port)
(scm->json '#$%jami-account-content-sexp port))))))))
(define %allowed-contacts '("1dbcb0f5f37324228235564b79f2b9737e9a008f"
"2dbcb0f5f37324228235564b79f2b9737e9a008f"))
(define %moderators '("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"))
(define %dummy-jami-account (jami-account
(archive %dummy-jami-account-archive)
(allowed-contacts %allowed-contacts)
(moderators %moderators)
(rendezvous-point? #t)
(peer-discovery? #f)
(bootstrap-hostnames '("bootstrap.me"
"fallback.another.host"))
(name-server-uri "https://my.name.server")))
;;; Like %dummy-jami-account, but with allowed-contacts and moderators left
;;; unset (thus taking the value *unspecified*).
(define %dummy-jami-account-partial
(jami-account
(archive %dummy-jami-account-archive)
(rendezvous-point? #t)
(peer-discovery? #f)
(bootstrap-hostnames '("bootstrap.me"
"fallback.another.host"))
(name-server-uri "https://my.name.server")))
(define* (make-jami-os #:key provisioning? partial?)
(operating-system
(host-name "jami")
(timezone "America/Montreal")
(locale "en_US.UTF-8")
(bootloader (bootloader-configuration
(bootloader grub-bootloader)
(targets '("/dev/sdX"))))
(file-systems (cons (file-system
(device (file-system-label "my-root"))
(mount-point "/")
(type "ext4"))
%base-file-systems))
(firmware '())
(services (cons* (service jami-service-type
(if provisioning?
(jami-configuration
(debug? #t)
(accounts
(list (if partial?
%dummy-jami-account-partial
%dummy-jami-account))))
(jami-configuration
(debug? #t))))
(service dbus-root-service-type)
;; The following services/packages are added for
;; debugging purposes.
(service dhcp-client-service-type)
(service openssh-service-type
(openssh-configuration
(permit-root-login #t)
(allow-empty-passwords? #t)))
%base-services))
;; Extra packages for debugging purposes.
(packages (cons (specification->package+output "libjami:debug")
(append (map specification->package
'("gdb"
"guile"
"guile-ac-d-bus"
"guile-readline"
"guile-fibers"
"screen"
"strace"))
%base-packages)))))
(define %jami-os
(make-jami-os))
(define %jami-os-provisioning
(make-jami-os #:provisioning? #t))
(define %jami-os-provisioning-partial
(make-jami-os #:provisioning? #t #:partial? #t))
(define* (run-jami-test #:key provisioning? partial?)
"Run tests in %JAMI-OS. When PROVISIONING? is true, test the accounts
provisioning feature of the service. When PARTIAL? is #t, some fields of the
jami account used as part of the jami configuration are left *unspecified*."
(define os (marionette-operating-system
(if provisioning?
(if partial?
%jami-os-provisioning-partial
%jami-os-provisioning)
%jami-os)
#:imported-modules '((gnu services herd)
(guix combinators))))
(define vm (virtual-machine
(operating-system os)
(memory-size 512)))
(define username (assoc-ref %jami-account-content-sexp
"Account.username"))
(define test
(with-extensions (list guile-packrat ;used by guile-ac-d-bus
guile-ac-d-bus
;; Fibers is needed to provide the non-blocking
;; variant of the 'sleep' procedure.
guile-fibers)
(with-imported-modules (source-module-closure
'((gnu build marionette)
(gnu build dbus-service)
(gnu build jami-service)))
#~(begin
(use-modules (rnrs base)
(srfi srfi-11)
(srfi srfi-64)
(gnu build marionette)
(gnu build dbus-service)
(gnu build jami-service))
(setenv "DBUS_SESSION_BUS_ADDRESS" "unix:path=/var/run/jami/bus")
(define marionette
(make-marionette (list #$vm)))
(test-runner-current (system-test-runner #$output))
(test-begin "jami")
(test-assert "service is running"
(marionette-eval
'(begin
(use-modules (gnu build jami-service))
(jami-service-available?))
marionette))
(test-assert "service can be stopped"
(marionette-eval
'(begin
(use-modules (gnu build jami-service)
(gnu services herd)
(rnrs base))
(assert (jami-service-available?))
(stop-service 'jami)
(with-retries 20 1 (not (jami-service-available?))))
marionette))
(test-assert "service can be restarted"
(marionette-eval
'(begin
(use-modules (gnu build dbus-service)
(gnu build jami-service)
(gnu services herd)
(rnrs base) )
;; Start the service.
(start-service 'jami)
(with-retries 20 1 (jami-service-available?))
;; Restart the service.
(restart-service 'jami)
(with-retries 20 1 (jami-service-available?)))
marionette))
(unless #$provisioning? (test-skip 1))
(test-assert "jami accounts provisioning, account present"
(marionette-eval
'(begin
(use-modules (gnu build dbus-service)
(gnu services herd)
(rnrs base))
;; Accounts take some time to appear after being added.
(with-retries 20 1
(with-shepherd-action 'jami ('list-accounts) results
(let ((account (assoc-ref (car results) #$username)))
(assert (string=? #$username
(assoc-ref account
"Account.username")))))))
marionette))
(unless #$(and provisioning? (not partial?)) (test-skip 1))
(test-assert "jami accounts provisioning, allowed-contacts"
(marionette-eval
'(begin
(use-modules (gnu services herd)
(rnrs base)
(srfi srfi-1))
;; Public mode is disabled.
(with-shepherd-action 'jami ('list-account-details)
results
(let ((account (assoc-ref (car results) #$username)))
(assert (string=? "false"
(assoc-ref account
"DHT.PublicInCalls")))))
;; Allowed contacts match those declared in the configuration.
(with-shepherd-action 'jami ('list-contacts) results
(let ((contacts (assoc-ref (car results) #$username)))
(assert (lset= string-ci=? contacts '#$%allowed-contacts)))))
marionette))
(unless #$(and provisioning? (not partial?)) (test-skip 1))
(test-assert "jami accounts provisioning, moderators"
(marionette-eval
'(begin
(use-modules (gnu services herd)
(rnrs base)
(srfi srfi-1))
;; Moderators match those declared in the configuration.
(with-shepherd-action 'jami ('list-moderators) results
(let ((moderators (assoc-ref (car results) #$username)))
(assert (lset= string-ci=? moderators '#$%moderators))))
;; Moderators can be added via the Shepherd action.
(with-shepherd-action 'jami
('add-moderator "cccccccccccccccccccccccccccccccccccccccc"
#$username) results
(let ((moderators (car results)))
(assert (lset= string-ci=? moderators
(cons "cccccccccccccccccccccccccccccccccccccccc"
'#$%moderators))))))
marionette))
(unless #$provisioning? (test-skip 1))
(test-assert "jami service actions, ban/unban contacts"
(marionette-eval
'(begin
(use-modules (gnu services herd)
(ice-9 match)
(rnrs base)
(srfi srfi-1))
;; Globally ban a contact.
(with-shepherd-action 'jami
('ban-contact "1dbcb0f5f37324228235564b79f2b9737e9a008f") _
(with-shepherd-action 'jami ('list-banned-contacts) results
(every (match-lambda
((username . banned-contacts)
(member "1dbcb0f5f37324228235564b79f2b9737e9a008f"
banned-contacts)))
(car results))))
;; Ban a contact for a single account.
(with-shepherd-action 'jami
('ban-contact "dddddddddddddddddddddddddddddddddddddddd"
#$username) _
(with-shepherd-action 'jami ('list-banned-contacts) results
(every (match-lambda
((username . banned-contacts)
(let ((found? (member "dddddddddddddddddddddddddddddddddddddddd"
banned-contacts)))
(if (string=? #$username username)
found?
(not found?)))))
(car results)))))
marionette))
(unless #$provisioning? (test-skip 1))
(test-assert "jami service actions, enable/disable accounts"
(marionette-eval
'(begin
(use-modules (gnu services herd)
(rnrs base))
(with-shepherd-action 'jami
('disable-account #$username) _
(with-shepherd-action 'jami ('list-accounts) results
(let ((account (assoc-ref (car results) #$username)))
(assert (string= "false"
(assoc-ref account "Account.enable"))))))
(with-shepherd-action 'jami
('enable-account #$username) _
(with-shepherd-action 'jami ('list-accounts) results
(let ((account (assoc-ref (car results) #$username)))
(assert (string= "true"
(assoc-ref account "Account.enable")))))))
marionette))
(unless #$provisioning? (test-skip 1))
(test-assert "jami account parameters"
(marionette-eval
'(begin
(use-modules (gnu services herd)
(rnrs base)
(srfi srfi-1))
(with-shepherd-action 'jami ('list-account-details) results
(let ((account-details (assoc-ref (car results)
#$username)))
(assert (lset<=
equal?
'(("Account.hostname" .
"bootstrap.me;fallback.another.host")
("Account.peerDiscovery" . "false")
("Account.rendezVous" . "true")
("RingNS.uri" . "https://my.name.server"))
account-details)))))
marionette))
(test-end)))))
(gexp->derivation (if provisioning?
(if partial?
"jami-provisioning-partial-test"
"jami-provisioning-test")
"jami-test")
test))
(define %test-jami
(system-test
(name "jami")
(description "Basic tests for the jami service.")
(value (run-jami-test))))
(define %test-jami-provisioning
(system-test
(name "jami-provisioning")
(description "Provisioning test for the jami service.")
(value (run-jami-test #:provisioning? #t))))
;;; Thi test verifies that <jami-account> values can be left unspecified
;;; without causing any issue (see: https://issues.guix.gnu.org/56799).
(define %test-jami-provisioning-partial
(system-test
(name "jami-provisioning-partial")
(description "Provisioning test for the jami service, when some of the
'maybe' fields aren't provided (such that their value end up being
*unspecified*.")
(value (run-jami-test #:provisioning? #t #:partial? #t))))
|