1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2016, 2017, 2018 Ludovic Courtès <ludo@gnu.org>
3 ;;; Copyright © 2018 Clément Lassieur <clement@lassieur.org>
5 ;;; This file is part of GNU Guix.
7 ;;; GNU Guix is free software; you can redistribute it and/or modify it
8 ;;; under the terms of the GNU General Public License as published by
9 ;;; the Free Software Foundation; either version 3 of the License, or (at
10 ;;; your option) any later version.
12 ;;; GNU Guix is distributed in the hope that it will be useful, but
13 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;;; GNU General Public License for more details.
17 ;;; You should have received a copy of the GNU General Public License
18 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
20 (define-module (gnu tests base)
21 #:use-module (gnu tests)
22 #:use-module (gnu system)
23 #:use-module (gnu system shadow)
24 #:use-module (gnu system nss)
25 #:use-module (gnu system vm)
26 #:use-module (gnu services)
27 #:use-module (gnu services base)
28 #:use-module (gnu services dbus)
29 #:use-module (gnu services avahi)
30 #:use-module (gnu services mcron)
31 #:use-module (gnu services shepherd)
32 #:use-module (gnu services networking)
33 #:use-module (gnu packages base)
34 #:use-module (gnu packages bash)
35 #:use-module (gnu packages imagemagick)
36 #:use-module (gnu packages ocr)
37 #:use-module (gnu packages package-management)
38 #:use-module (gnu packages linux)
39 #:use-module (gnu packages tmux)
40 #:use-module (guix gexp)
41 #:use-module (guix store)
42 #:use-module (guix monads)
43 #:use-module (guix packages)
44 #:use-module (srfi srfi-1)
45 #:export (run-basic-test
53 (simple-operating-system))
56 (define* (run-basic-test os command #:optional (name "basic")
58 "Return a derivation called NAME that tests basic features of the OS started
59 using COMMAND, a gexp that evaluates to a list of strings. Compare some
60 properties of running system to what's declared in OS, an <operating-system>.
62 When INITIALIZATION is true, it must be a one-argument procedure that is
63 passed a gexp denoting the marionette, and it must return gexp that is
64 inserted before the first test. This is used to introduce an extra
65 initialization step, such as entering a LUKS passphrase."
68 (fold-services (operating-system-services os)
69 #:target-type special-files-service-type)))
72 (with-imported-modules '((gnu build marionette)
73 (guix build syscalls))
75 (use-modules (gnu build marionette)
83 (make-marionette #$command))
91 (initialization #~marionette))
94 (match (marionette-eval '(uname) marionette)
95 (#("Linux" host-name version _ architecture)
96 (and (string=? host-name
97 #$(operating-system-host-name os))
98 (string-prefix? #$(package-version
99 (operating-system-kernel os))
101 (string-prefix? architecture %host-type)))))
103 (test-assert "shell and user commands"
104 ;; Is everything in $PATH?
105 (zero? (marionette-eval '(system "
114 (test-equal "special files"
118 (use-modules (ice-9 match))
122 (list file (readlink file))))
126 (test-assert "accounts"
127 (let ((users (marionette-eval '(begin
128 (use-modules (ice-9 match))
129 (let loop ((result '()))
131 (#f (reverse result))
132 (x (loop (cons x result))))))
135 (map passwd:name users)
137 #$@(map user-account-name
138 (operating-system-user-accounts os))))))
140 (test-assert "shepherd services"
141 (let ((services (marionette-eval
143 (use-modules (gnu services herd))
145 (map (compose car live-service-provision)
149 (pk 'services services)
150 '(root #$@(operating-system-shepherd-service-names os)))))
154 '#$(map user-account-home-directory
155 (filter user-account-create-home-directory?
156 (operating-system-user-accounts os)))))
159 (use-modules (gnu services herd) (srfi srfi-1))
161 ;; Home directories are supposed to exist once 'user-homes'
163 (start-service 'user-homes)
165 (every (lambda (home)
166 (and (file-exists? home)
167 (file-is-directory? home)))
171 (test-assert "skeletons in home directories"
173 '#$(filter-map (lambda (account)
174 (and (user-account-create-home-directory?
176 (not (user-account-system? account))
177 (list (user-account-name account)
178 (user-account-home-directory
180 (operating-system-user-accounts os))))
183 (use-modules (srfi srfi-1) (ice-9 ftw)
188 ;; Make sure HOME has all the skeletons...
189 (and (null? (lset-difference string=?
190 (scandir "/etc/skel/")
193 ;; ... and that everything is user-owned.
194 (let* ((pw (getpwnam user))
195 (uid (passwd:uid pw))
196 (gid (passwd:gid pw))
198 (define (user-owned? file)
199 (= uid (stat:uid (lstat file))))
201 (and (= uid (stat:uid st))
202 (eq? 'directory (stat:type st))
205 #:directories? #t)))))))
209 (test-equal "permissions on /root"
211 (let ((root-home #$(any (lambda (account)
212 (and (zero? (user-account-uid account))
213 (user-account-home-directory
215 (operating-system-user-accounts os))))
216 (stat:perms (marionette-eval `(stat ,root-home) marionette))))
218 (test-equal "no extra home directories"
221 ;; Make sure the home directories that are not supposed to be
222 ;; created are indeed not created.
224 '#$(filter-map (lambda (user)
226 (user-account-create-home-directory?
228 (user-account-home-directory user)))
229 (operating-system-user-accounts os))))
232 (use-modules (srfi srfi-1))
234 ;; Note: Do not flag "/var/empty".
236 ',(remove (cut string-prefix? "/var/" <>)
240 (test-equal "login on tty1"
243 (marionette-control "sendkey ctrl-alt-f1" marionette)
244 ;; Wait for the 'term-tty1' service to be running (using
245 ;; 'start-service' is the simplest and most reliable way to do
249 (use-modules (gnu services herd))
250 (start-service 'term-tty1))
254 (marionette-type "root\n\nid -un > logged-in\n" marionette)
256 ;; It can take a while before the shell commands are executed.
257 (marionette-eval '(use-modules (rnrs io ports)) marionette)
258 (wait-for-file "/root/logged-in" marionette
259 #:read 'get-string-all)))
261 ;; There should be one utmpx entry for the user logged in on tty1.
262 (test-equal "utmpx entry"
263 '(("root" "tty1" #f))
266 (use-modules (guix build syscalls)
269 (filter-map (lambda (entry)
270 (and (equal? (login-type USER_PROCESS)
271 (utmpx-login-type entry))
272 (list (utmpx-user entry) (utmpx-line entry)
273 (utmpx-host entry))))
277 ;; Likewise for /var/log/wtmp (used by 'last').
278 (test-assert "wtmp entry"
279 (match (marionette-eval
281 (use-modules (guix build syscalls)
284 (define (entry->list entry)
285 (list (utmpx-user entry) (utmpx-line entry)
286 (utmpx-host entry) (utmpx-login-type entry)))
288 (call-with-input-file "/var/log/wtmp"
290 (let loop ((result '()))
291 (if (eof-object? (peek-char port))
292 (map entry->list (reverse result))
293 (loop (cons (read-utmpx port) result)))))))
295 (((users lines hosts types) ..1)
296 (every (lambda (type)
297 (eqv? type (login-type LOGIN_PROCESS)))
300 (test-assert "host name resolution"
301 (match (marionette-eval
303 ;; Wait for nscd or our requests go through it.
304 (use-modules (gnu services herd))
305 (start-service 'nscd)
307 (list (getaddrinfo "localhost")
308 (getaddrinfo #$(operating-system-host-name os))))
310 ((((? vector?) ..1) ((? vector?) ..1))
313 (pk 'failure x #f))))
315 (test-equal "host not found"
318 '(false-if-exception (getaddrinfo "does-not-exist"))
323 (marionette-eval '(let ((before (setlocale LC_ALL "en_US.utf8")))
324 (setlocale LC_ALL before))
327 (test-eq "/run/current-system is a GC root"
329 (marionette-eval '(begin
330 ;; Make sure the (guix …) modules are found.
332 #+(file-append guix "/share/guile/site/2.2"))
334 (use-modules (srfi srfi-34) (guix store))
336 (let ((system (readlink "/run/current-system")))
337 (guard (c ((nix-protocol-error? c)
338 (and (file-exists? system)
341 (delete-paths store (list system))
345 ;; This symlink is currently unused, but better have it point to the
347 ;; <https://lists.gnu.org/archive/html/guix-devel/2016-08/msg01641.html>.
348 (test-equal "/var/guix/gcroots/profiles is a valid symlink"
350 (marionette-eval '(readlink "/var/guix/gcroots/profiles")
354 (test-assert "screendump"
356 (marionette-control (string-append "screendump " #$output
359 (file-exists? "tty1.ppm")))
361 (test-assert "screen text"
362 (let ((text (marionette-screen-text marionette
366 ;; Check whether the welcome message and shell prompt are
367 ;; displayed. Note: OCR confuses "y" and "V" for instance, so
368 ;; we cannot reliably match the whole text.
369 (and (string-contains text "This is the GNU")
370 (string-contains text
373 #$(operating-system-host-name os))))))
376 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
378 (gexp->derivation name test))
380 (define %test-basic-os
384 "Instrument %SIMPLE-OS, run it in a VM, and run a series of basic
385 functionality tests.")
387 (let* ((os (marionette-operating-system
389 #:imported-modules '((gnu services herd)
390 (guix combinators))))
391 (vm (virtual-machine os)))
392 ;; XXX: Add call to 'virtualized-operating-system' to get the exact same
393 ;; set of services as the OS produced by
394 ;; 'system-qemu-image/shared-store-script'.
395 (run-basic-test (virtualized-operating-system os '())
403 (define (run-halt-test vm)
404 ;; As reported in <http://bugs.gnu.org/26931>, running tmux would previously
405 ;; lead the 'stop' method of 'user-processes' to an infinite loop, with the
406 ;; tmux server process as a zombie that remains in the list of processes.
407 ;; This test reproduces this scenario.
409 (with-imported-modules '((gnu build marionette))
411 (use-modules (gnu build marionette))
414 (make-marionette '(#$vm)))
417 #$(file-append ocrad "/bin/ocrad"))
419 ;; Wait for tty1 and log in.
420 (marionette-eval '(begin
421 (use-modules (gnu services herd))
422 (start-service 'term-tty1))
424 (marionette-type "root\n" marionette)
425 (wait-for-screen-text marionette
427 (string-contains text "root@komputilo"))
430 ;; Start tmux and wait for it to be ready.
431 (marionette-type "tmux new-session 'echo 1 > /ready; bash'\n"
433 (wait-for-file "/ready" marionette)
435 ;; Make sure to stop the test after a while.
436 (sigaction SIGALRM (lambda _
437 (format (current-error-port)
438 "FAIL: Time is up, but VM still running.\n")
442 ;; Get debugging info.
443 (marionette-eval '(current-output-port
444 (open-file "/dev/console" "w0"))
446 (marionette-eval '(system* #$(file-append procps "/bin/ps")
447 "-eo" "pid,ppid,stat,comm")
450 ;; See if 'halt' actually works.
451 (marionette-eval '(system* "/run/current-system/profile/sbin/halt")
454 ;; If we reach this line, that means the VM was properly stopped in
457 (call-with-output-file #$output
459 (display "success!" port))))))
461 (gexp->derivation "halt" test))
467 "Use the 'halt' command and make sure it succeeds and does not get stuck
468 in a loop. See <http://bugs.gnu.org/26931>.")
470 (let ((os (marionette-operating-system
473 (packages (cons tmux %base-packages)))
474 #:imported-modules '((gnu services herd)
475 (guix combinators)))))
476 (run-halt-test (virtual-machine os))))))
480 ;;; Cleanup of /tmp, /var/run, etc.
484 (simple-operating-system
485 (simple-service 'dirty-things
487 (let ((script (plain-file
488 "create-utf8-file.sh"
490 "echo $0: dirtying /tmp...\n"
493 "exec touch /tmp/λαμβδα"))))
494 (with-imported-modules '((guix build utils))
497 #$(file-append coreutils "/bin"))
498 (invoke #$(file-append bash "/bin/sh")
501 (define (run-cleanup-test name)
503 (marionette-operating-system %cleanup-os
504 #:imported-modules '((gnu services herd)
505 (guix combinators))))
507 (with-imported-modules '((gnu build marionette))
509 (use-modules (gnu build marionette)
514 (make-marionette (list #$(virtual-machine os))))
519 (test-begin "cleanup")
521 (test-assert "dirty service worked"
522 (marionette-eval '(file-exists? "/witness") marionette))
524 (test-equal "/tmp cleaned up"
526 (marionette-eval '(begin
527 (use-modules (ice-9 ftw))
532 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
534 (gexp->derivation "cleanup" test))
536 (define %test-cleanup
537 ;; See <https://bugs.gnu.org/26353>.
540 (description "Make sure the 'cleanup' service can remove files with
541 non-ASCII names from /tmp.")
542 (value (run-cleanup-test name))))
550 ;; System with an mcron service, with one mcron job for "root" and one mcron
551 ;; job for an unprivileged user.
552 (let ((job1 #~(job '(next-second '(0 5 10 15 20 25 30 35 40 45 50 55))
554 (unless (file-exists? "witness")
555 (call-with-output-file "witness"
557 (display (list (getuid) (getgid)) port)))))))
558 (job2 #~(job next-second-from
560 (call-with-output-file "witness"
562 (display (list (getuid) (getgid)) port))))
564 (job3 #~(job next-second-from ;to test $PATH
565 "touch witness-touch")))
566 (simple-operating-system
567 (mcron-service (list job1 job2 job3)))))
569 (define (run-mcron-test name)
571 (marionette-operating-system
573 #:imported-modules '((gnu services herd)
574 (guix combinators))))
577 (with-imported-modules '((gnu build marionette))
579 (use-modules (gnu build marionette)
584 (make-marionette (list #$(virtual-machine os))))
591 (test-assert "service running"
594 (use-modules (gnu services herd))
595 (start-service 'mcron))
598 ;; Make sure root's mcron job runs, has its cwd set to "/root", and
599 ;; runs with the right UID/GID.
600 (test-equal "root's job"
602 (wait-for-file "/root/witness" marionette))
604 ;; Likewise for Alice's job. We cannot know what its GID is since
605 ;; it's chosen by 'groupadd', but it's strictly positive.
606 (test-assert "alice's job"
607 (match (wait-for-file "/home/alice/witness" marionette)
611 ;; Last, the job that uses a command; allows us to test whether
613 (test-equal "root's job with command"
615 (wait-for-file "/root/witness-touch" marionette
616 #:read '(@ (ice-9 rdelim) read-string)))
619 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
621 (gexp->derivation name test))
626 (description "Make sure the mcron service works as advertised.")
627 (value (run-mcron-test name))))
631 ;;; Avahi and NSS-mDNS.
637 (name-service-switch %mdns-host-lookup-nss)
638 (services (cons* (avahi-service #:debug? #t)
640 (dhcp-client-service) ;needed for multicast
642 ;; Enable heavyweight debugging output.
643 (modify-services (operating-system-user-services
645 (nscd-service-type config
646 => (nscd-configuration
649 (log-file "/dev/console")))
650 (syslog-service-type config
652 (syslog-configuration
657 "*.* /dev/console\n")))))))))
659 (define (run-nss-mdns-test)
660 ;; Test resolution of '.local' names via libc. Start the marionette service
661 ;; *after* nscd. Failing to do that, libc will try to connect to nscd,
662 ;; fail, then never try again (see '__nss_not_use_nscd_hosts' in libc),
663 ;; leading to '.local' resolution failures.
665 (marionette-operating-system
667 #:requirements '(nscd)
668 #:imported-modules '((gnu services herd)
669 (guix combinators))))
671 (define mdns-host-name
672 (string-append (operating-system-host-name os)
676 (with-imported-modules '((gnu build marionette))
678 (use-modules (gnu build marionette)
684 (make-marionette (list #$(virtual-machine os))))
691 (test-assert "nscd PID file is created"
694 (use-modules (gnu services herd))
695 (start-service 'nscd))
698 (test-assert "nscd is listening on its socket"
700 ;; XXX: Work around a race condition in nscd: nscd creates its
701 ;; PID file before it is listening on its socket.
702 '(let ((sock (socket PF_UNIX SOCK_STREAM 0)))
706 (connect sock AF_UNIX "/var/run/nscd/socket")
708 (format #t "nscd is ready~%")
711 (format #t "waiting for nscd...~%")
716 (test-assert "avahi is running"
719 (use-modules (gnu services herd))
720 (start-service 'avahi-daemon))
723 (test-assert "network is up"
726 (use-modules (gnu services herd))
727 (start-service 'networking))
730 (test-equal "avahi-resolve-host-name"
734 "/run/current-system/profile/bin/avahi-resolve-host-name"
735 "-v" #$mdns-host-name)
738 (test-equal "avahi-browse"
741 '(system* "avahi-browse" "-avt")
744 (test-assert "getaddrinfo .local"
745 ;; Wait for the 'avahi-daemon' service and perform a resolution.
746 (match (marionette-eval
747 '(getaddrinfo #$mdns-host-name)
749 (((? vector? addrinfos) ..1)
750 (pk 'getaddrinfo addrinfos)
751 (and (any (lambda (ai)
752 (= AF_INET (addrinfo:fam ai)))
755 (= AF_INET6 (addrinfo:fam ai)))
758 (test-assert "gethostbyname .local"
759 (match (pk 'gethostbyname
760 (marionette-eval '(gethostbyname #$mdns-host-name)
763 (and (string=? (hostent:name result) #$mdns-host-name)
764 (= (hostent:addrtype result) AF_INET)))))
768 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
770 (gexp->derivation "nss-mdns" test))
772 (define %test-nss-mdns
776 "Test Avahi's multicast-DNS implementation, and in particular, test its
777 glibc name service switch (NSS) module.")
778 (value (run-nss-mdns-test))))