1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2021 Simon South <simon@simonsouth.net>
4 ;;; This file is part of GNU Guix.
6 ;;; GNU Guix is free software; you can redistribute it and/or modify it
7 ;;; under the terms of the GNU General Public License as published by
8 ;;; the Free Software Foundation; either version 3 of the License, or (at
9 ;;; your option) any later version.
11 ;;; GNU Guix is distributed in the hope that it will be useful, but
12 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;; GNU General Public License for more details.
16 ;;; You should have received a copy of the GNU General Public License
17 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
20 ;;; The Transmission Daemon service.
23 (define-module (gnu tests file-sharing)
24 #:use-module (gnu packages bittorrent)
25 #:use-module (gnu services)
26 #:use-module (gnu services file-sharing)
27 #:use-module (gnu services networking)
28 #:use-module (gnu system vm)
29 #:use-module (gnu tests)
30 #:use-module (guix gexp)
31 #:export (%test-transmission-daemon))
33 (define %transmission-daemon-user "transmission")
34 (define %transmission-daemon-group "transmission")
36 (define %transmission-daemon-config-dir "/var/lib/transmission-daemon")
37 (define %transmission-daemon-watch-dir
38 (string-append %transmission-daemon-config-dir "/watch"))
39 (define %transmission-daemon-incomplete-dir
40 (string-append %transmission-daemon-config-dir "/incomplete"))
42 (define %transmission-daemon-settings-file
43 (string-append %transmission-daemon-config-dir "/settings.json"))
45 (define %transmission-daemon-peer-port 51000) ; default is 51413
47 (define %transmission-daemon-rpc-port 9999) ; default is 9091
48 (define %transmission-daemon-rpc-username "test-username")
49 (define %transmission-daemon-rpc-password "test-password")
51 (define %transmission-daemon-test-configuration
52 (transmission-daemon-configuration
53 (incomplete-dir-enabled? #t)
54 (incomplete-dir %transmission-daemon-incomplete-dir)
56 (watch-dir-enabled? #t)
57 (watch-dir %transmission-daemon-watch-dir)
59 (peer-port-random-on-start? #f)
60 (peer-port %transmission-daemon-peer-port)
63 (rpc-port %transmission-daemon-rpc-port)
64 (rpc-whitelist-enabled? #f)
65 (rpc-authentication-required? #t)
66 (rpc-username %transmission-daemon-rpc-username)
67 (rpc-password (transmission-password-hash %transmission-daemon-rpc-password
70 (define (run-transmission-daemon-test)
72 (marionette-operating-system
73 (simple-operating-system
74 (service dhcp-client-service-type)
75 (service transmission-daemon-service-type
76 %transmission-daemon-test-configuration))
77 #:imported-modules '((gnu services herd)
79 #:requirements '(transmission-daemon)))
82 (with-imported-modules '((gnu build marionette))
84 (use-modules (gnu build marionette)
89 (list #$(virtual-machine
92 `((9091 . ,%transmission-daemon-rpc-port)))))))
97 (test-begin "transmission-daemon")
99 ;; Make sure the "transmission" user and group have been created.
100 (test-assert "\"transmission\" user exists"
103 (getpwnam #$%transmission-daemon-user)
106 (test-assert "\"transmission\" group exists"
109 (getgrnam #$%transmission-daemon-group)
113 ;; Make sure Transmission Daemon's configuration directory has been
114 ;; created with the correct ownership and permissions.
115 (test-assert "configuration directory exists"
117 '(eq? (stat:type (stat #$%transmission-daemon-config-dir))
120 (test-assert "configuration directory has correct ownership"
122 '(let ((config-dir (stat #$%transmission-daemon-config-dir))
123 (transmission-user (getpwnam #$%transmission-daemon-user)))
124 (and (eqv? (stat:uid config-dir)
125 (passwd:uid transmission-user))
126 (eqv? (stat:gid config-dir)
127 (passwd:gid transmission-user))))
129 (test-assert "configuration directory has expected permissions"
131 '(eqv? (stat:perms (stat #$%transmission-daemon-config-dir))
135 ;; Make sure the incomplete-downloads and watch directories have been
136 ;; created with the correct ownership and permissions.
137 (test-assert "incomplete-downloads directory exists"
139 '(eq? (stat:type (stat #$%transmission-daemon-incomplete-dir))
142 (test-assert "incomplete-downloads directory has correct ownership"
144 '(let ((incomplete-dir
145 (stat #$%transmission-daemon-incomplete-dir))
147 (getpwnam #$%transmission-daemon-user)))
148 (and (eqv? (stat:uid incomplete-dir)
149 (passwd:uid transmission-user))
150 (eqv? (stat:gid incomplete-dir)
151 (passwd:gid transmission-user))))
154 "incomplete-downloads directory has expected permissions"
156 '(eqv? (stat:perms (stat #$%transmission-daemon-incomplete-dir))
160 (test-assert "watch directory exists"
162 '(eq? (stat:type (stat #$%transmission-daemon-watch-dir))
165 (test-assert "watch directory has correct ownership"
167 '(let ((watch-dir (stat #$%transmission-daemon-watch-dir))
168 (transmission-user (getpwnam #$%transmission-daemon-user)))
169 (and (eqv? (stat:uid watch-dir)
170 (passwd:uid transmission-user))
171 (eqv? (stat:gid watch-dir)
172 (passwd:gid transmission-user))))
174 (test-assert "watch directory has expected permissions"
176 '(eqv? (stat:perms (stat #$%transmission-daemon-watch-dir))
180 ;; Make sure the settings file has been created and appears valid.
181 (test-assert "settings file exists"
183 '(file-exists? #$%transmission-daemon-settings-file)
185 (test-assert "settings file is valid JSON"
188 (use-modules (json parser))
189 (with-input-from-file #$%transmission-daemon-settings-file
194 (test-assert "settings file contains a non-empty JSON object"
197 (use-modules (json parser)
199 (let ((settings (with-input-from-file
200 #$%transmission-daemon-settings-file
203 (and (list? settings)
204 (not (null? settings))
205 (every pair? settings))))
208 ;; Make sure Transmission Daemon is running.
209 (test-assert "transmission-daemon is running"
212 (use-modules (gnu services herd))
213 (live-service-running
214 (find (lambda (live-service)
215 (memq 'transmission-daemon
216 (live-service-provision live-service)))
217 (current-services))))
220 ;; Make sure the daemon is listening for peer connections.
221 (test-assert "transmission-daemon is listening for peers"
222 (wait-for-tcp-port #$%transmission-daemon-peer-port marionette))
224 ;; Make sure the daemon is listening for RPC-client connections.
225 (test-assert "transmission-daemon is listening for RPC clients"
226 (wait-for-tcp-port #$%transmission-daemon-rpc-port marionette))
228 ;; Make sure the RPC-authentication settings are honored.
229 (test-assert "transmission-daemon requires RPC authentication"
230 (let ((transmission-remote
231 (string-append #+transmission "/bin/transmission-remote")))
232 (with-error-to-port (%make-void-port "w")
234 (not (zero? (system* transmission-remote
235 "--session-info")))))))
236 (test-assert "transmission-daemon rejects incorrect RPC credentials"
237 (let ((transmission-remote
238 (string-append #+transmission "/bin/transmission-remote"))
240 (string-append #$%transmission-daemon-rpc-username
243 #$%transmission-daemon-rpc-password)))
244 (with-error-to-port (%make-void-port "w")
246 (not (zero? (system* transmission-remote
247 "--auth" wrong-auth-string
248 "--session-info")))))))
249 (test-assert "transmission-daemon accepts correct RPC credentials"
250 (let ((transmission-remote
251 (string-append #+transmission "/bin/transmission-remote"))
253 (string-append #$%transmission-daemon-rpc-username
255 #$%transmission-daemon-rpc-password)))
256 (with-output-to-port (%make-void-port "w")
258 (zero? (system* transmission-remote
260 "--session-info"))))))
263 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
265 (gexp->derivation "transmission-daemon-test" test))
267 (define %test-transmission-daemon
269 (name "transmission-daemon")
270 (description "Test a running Transmission Daemon service.")
271 (value (run-transmission-daemon-test))))