1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2016, 2017, 2018, 2019 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 #:use-module (ice-9 match)
46 #:export (run-basic-test
54 (simple-operating-system))
57 (define* (run-basic-test os command #:optional (name "basic")
59 "Return a derivation called NAME that tests basic features of the OS started
60 using COMMAND, a gexp that evaluates to a list of strings. Compare some
61 properties of running system to what's declared in OS, an <operating-system>.
63 When INITIALIZATION is true, it must be a one-argument procedure that is
64 passed a gexp denoting the marionette, and it must return gexp that is
65 inserted before the first test. This is used to introduce an extra
66 initialization step, such as entering a LUKS passphrase."
69 (fold-services (operating-system-services os)
70 #:target-type special-files-service-type)))
73 (match (package-transitive-propagated-inputs guix)
74 (((labels packages) ...)
75 (cons guix packages))))
78 (with-imported-modules '((gnu build marionette)
79 (guix build syscalls))
81 (use-modules (gnu build marionette)
89 (make-marionette #$command))
97 (initialization #~marionette))
100 (match (marionette-eval '(uname) marionette)
101 (#("Linux" host-name version _ architecture)
102 (and (string=? host-name
103 #$(operating-system-host-name os))
104 (string-prefix? #$(package-version
105 (operating-system-kernel os))
107 (string-prefix? architecture %host-type)))))
109 ;; Shepherd reads the config file *before* binding its control
110 ;; socket, so /var/run/shepherd/socket might not exist yet when the
111 ;; 'marionette' service is started.
112 (test-assert "shepherd socket ready"
115 (use-modules (gnu services herd))
117 (cond ((file-exists? (%shepherd-socket-file))
126 (test-eq "stdin is /dev/null"
128 ;; Make sure services can no longer read from stdin once the
129 ;; system has booted.
132 (use-modules (gnu services herd))
133 (start 'user-processes)
134 ((@@ (gnu services herd) eval-there)
135 '(let ((result (read (current-input-port))))
136 (if (eof-object? result)
141 (test-assert "shell and user commands"
142 ;; Is everything in $PATH?
143 (zero? (marionette-eval '(system "
152 (test-equal "special files"
156 (use-modules (ice-9 match))
160 (list file (readlink file))))
164 (test-assert "accounts"
165 (let ((users (marionette-eval '(begin
166 (use-modules (ice-9 match))
167 (let loop ((result '()))
169 (#f (reverse result))
170 (x (loop (cons x result))))))
174 (list (passwd:name user)
178 #$@(map (lambda (account)
179 `(list ,(user-account-name account)
180 ,(user-account-home-directory account)))
181 (operating-system-user-accounts os))))))
183 (test-assert "shepherd services"
184 (let ((services (marionette-eval
186 (use-modules (gnu services herd))
188 (map (compose car live-service-provision)
192 (pk 'services services)
193 '(root #$@(operating-system-shepherd-service-names os)))))
197 '#$(map user-account-home-directory
198 (filter user-account-create-home-directory?
199 (operating-system-user-accounts os)))))
202 (use-modules (gnu services herd) (srfi srfi-1))
204 ;; Home directories are supposed to exist once 'user-homes'
206 (start-service 'user-homes)
208 (every (lambda (home)
209 (and (file-exists? home)
210 (file-is-directory? home)))
214 (test-assert "skeletons in home directories"
216 '#$(filter-map (lambda (account)
217 (and (user-account-create-home-directory?
219 (not (user-account-system? account))
220 (list (user-account-name account)
221 (user-account-home-directory
223 (operating-system-user-accounts os))))
226 (use-modules (srfi srfi-1) (ice-9 ftw)
231 ;; Make sure HOME has all the skeletons...
232 (and (null? (lset-difference string=?
233 (scandir "/etc/skel/")
236 ;; ... and that everything is user-owned.
237 (let* ((pw (getpwnam user))
238 (uid (passwd:uid pw))
239 (gid (passwd:gid pw))
241 (define (user-owned? file)
242 (= uid (stat:uid (lstat file))))
244 (and (= uid (stat:uid st))
245 (eq? 'directory (stat:type st))
248 #:directories? #t)))))))
252 (test-equal "permissions on /root"
254 (let ((root-home #$(any (lambda (account)
255 (and (zero? (user-account-uid account))
256 (user-account-home-directory
258 (operating-system-user-accounts os))))
259 (stat:perms (marionette-eval `(stat ,root-home) marionette))))
261 (test-equal "no extra home directories"
264 ;; Make sure the home directories that are not supposed to be
265 ;; created are indeed not created.
267 '#$(filter-map (lambda (user)
269 (user-account-create-home-directory?
271 (user-account-home-directory user)))
272 (operating-system-user-accounts os))))
275 (use-modules (srfi srfi-1))
277 ;; Note: Do not flag "/var/empty".
279 ',(remove (cut string-prefix? "/var/" <>)
283 (test-equal "login on tty1"
286 (marionette-control "sendkey ctrl-alt-f1" marionette)
287 ;; Wait for the 'term-tty1' service to be running (using
288 ;; 'start-service' is the simplest and most reliable way to do
292 (use-modules (gnu services herd))
293 (start-service 'term-tty1))
297 (marionette-type "root\n\nid -un > logged-in\n" marionette)
299 ;; It can take a while before the shell commands are executed.
300 (marionette-eval '(use-modules (rnrs io ports)) marionette)
301 (wait-for-file "/root/logged-in" marionette
302 #:read 'get-string-all)))
304 ;; There should be one utmpx entry for the user logged in on tty1.
305 (test-equal "utmpx entry"
306 '(("root" "tty1" #f))
309 (use-modules (guix build syscalls)
312 (filter-map (lambda (entry)
313 (and (equal? (login-type USER_PROCESS)
314 (utmpx-login-type entry))
315 (list (utmpx-user entry) (utmpx-line entry)
316 (utmpx-host entry))))
320 ;; Likewise for /var/log/wtmp (used by 'last').
321 (test-assert "wtmp entry"
322 (match (marionette-eval
324 (use-modules (guix build syscalls)
327 (define (entry->list entry)
328 (list (utmpx-user entry) (utmpx-line entry)
329 (utmpx-host entry) (utmpx-login-type entry)))
331 (call-with-input-file "/var/log/wtmp"
333 (let loop ((result '()))
334 (if (eof-object? (peek-char port))
335 (map entry->list (reverse result))
336 (loop (cons (read-utmpx port) result)))))))
338 (((users lines hosts types) ..1)
339 (every (lambda (type)
340 (eqv? type (login-type LOGIN_PROCESS)))
343 (test-assert "host name resolution"
344 (match (marionette-eval
346 ;; Wait for nscd or our requests go through it.
347 (use-modules (gnu services herd))
348 (start-service 'nscd)
350 (list (getaddrinfo "localhost")
351 (getaddrinfo #$(operating-system-host-name os))))
353 ((((? vector?) ..1) ((? vector?) ..1))
356 (pk 'failure x #f))))
358 (test-equal "nscd invalidate action"
360 (marionette-eval '(with-shepherd-action 'nscd ('invalidate "hosts")
365 (test-equal "nscd invalidate action, wrong table"
367 (marionette-eval '(with-shepherd-action 'nscd ('invalidate "xyz")
372 (test-equal "host not found"
375 '(false-if-exception (getaddrinfo "does-not-exist"))
380 (marionette-eval '(let ((before (setlocale LC_ALL "en_US.utf8")))
381 (setlocale LC_ALL before))
384 (test-eq "/run/current-system is a GC root"
386 (marionette-eval '(begin
387 ;; Make sure the (guix …) modules are found.
388 (eval-when (expand load eval)
390 (append (map (lambda (package)
391 (string-append package
393 (effective-version)))
397 (use-modules (srfi srfi-34) (guix store))
399 (let ((system (readlink "/run/current-system")))
400 (guard (c ((store-protocol-error? c)
401 (and (file-exists? system)
404 (delete-paths store (list system))
408 ;; This symlink is currently unused, but better have it point to the
410 ;; <https://lists.gnu.org/archive/html/guix-devel/2016-08/msg01641.html>.
411 (test-equal "/var/guix/gcroots/profiles is a valid symlink"
413 (marionette-eval '(readlink "/var/guix/gcroots/profiles")
417 (test-assert "screendump"
419 (marionette-control (string-append "screendump " #$output
422 (file-exists? "tty1.ppm")))
424 (test-assert "screen text"
425 (let ((text (marionette-screen-text marionette
429 ;; Check whether the welcome message and shell prompt are
430 ;; displayed. Note: OCR confuses "y" and "V" for instance, so
431 ;; we cannot reliably match the whole text.
432 (and (string-contains text "This is the GNU")
433 (string-contains text
436 #$(operating-system-host-name os))))))
439 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
441 (gexp->derivation name test))
443 (define %test-basic-os
447 "Instrument %SIMPLE-OS, run it in a VM, and run a series of basic
448 functionality tests.")
450 (let* ((os (marionette-operating-system
452 #:imported-modules '((gnu services herd)
453 (guix combinators))))
454 (vm (virtual-machine os)))
455 ;; XXX: Add call to 'virtualized-operating-system' to get the exact same
456 ;; set of services as the OS produced by
457 ;; 'system-qemu-image/shared-store-script'.
458 (run-basic-test (virtualized-operating-system os '())
466 (define (run-halt-test vm)
467 ;; As reported in <http://bugs.gnu.org/26931>, running tmux would previously
468 ;; lead the 'stop' method of 'user-processes' to an infinite loop, with the
469 ;; tmux server process as a zombie that remains in the list of processes.
470 ;; This test reproduces this scenario.
472 (with-imported-modules '((gnu build marionette))
474 (use-modules (gnu build marionette))
477 (make-marionette '(#$vm)))
480 #$(file-append ocrad "/bin/ocrad"))
482 ;; Wait for tty1 and log in.
483 (marionette-eval '(begin
484 (use-modules (gnu services herd))
485 (start-service 'term-tty1))
487 (marionette-type "root\n" marionette)
488 (wait-for-screen-text marionette
490 (string-contains text "root@komputilo"))
493 ;; Start tmux and wait for it to be ready.
494 (marionette-type "tmux new-session 'echo 1 > /ready; bash'\n"
496 (wait-for-file "/ready" marionette)
498 ;; Make sure to stop the test after a while.
499 (sigaction SIGALRM (lambda _
500 (format (current-error-port)
501 "FAIL: Time is up, but VM still running.\n")
505 ;; Get debugging info.
506 (marionette-eval '(current-output-port
507 (open-file "/dev/console" "w0"))
509 (marionette-eval '(system* #$(file-append procps "/bin/ps")
510 "-eo" "pid,ppid,stat,comm")
513 ;; See if 'halt' actually works.
514 (marionette-eval '(system* "/run/current-system/profile/sbin/halt")
517 ;; If we reach this line, that means the VM was properly stopped in
520 (call-with-output-file #$output
522 (display "success!" port))))))
524 (gexp->derivation "halt" test))
530 "Use the 'halt' command and make sure it succeeds and does not get stuck
531 in a loop. See <http://bugs.gnu.org/26931>.")
533 (let ((os (marionette-operating-system
536 (packages (cons tmux %base-packages)))
537 #:imported-modules '((gnu services herd)
538 (guix combinators)))))
539 (run-halt-test (virtual-machine os))))))
543 ;;; Cleanup of /tmp, /var/run, etc.
547 (simple-operating-system
548 (simple-service 'dirty-things
550 (let ((script (plain-file
551 "create-utf8-file.sh"
553 "echo $0: dirtying /tmp...\n"
556 "exec touch /tmp/λαμβδα"))))
557 (with-imported-modules '((guix build utils))
560 #$(file-append coreutils "/bin"))
561 (invoke #$(file-append bash "/bin/sh")
564 (define (run-cleanup-test name)
566 (marionette-operating-system %cleanup-os
567 #:imported-modules '((gnu services herd)
568 (guix combinators))))
570 (with-imported-modules '((gnu build marionette))
572 (use-modules (gnu build marionette)
577 (make-marionette (list #$(virtual-machine os))))
582 (test-begin "cleanup")
584 (test-assert "dirty service worked"
585 (marionette-eval '(file-exists? "/witness") marionette))
587 (test-equal "/tmp cleaned up"
589 (marionette-eval '(begin
590 (use-modules (ice-9 ftw))
595 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
597 (gexp->derivation "cleanup" test))
599 (define %test-cleanup
600 ;; See <https://bugs.gnu.org/26353>.
603 (description "Make sure the 'cleanup' service can remove files with
604 non-ASCII names from /tmp.")
605 (value (run-cleanup-test name))))
613 ;; System with an mcron service, with one mcron job for "root" and one mcron
614 ;; job for an unprivileged user.
615 (let ((job1 #~(job '(next-second '(0 5 10 15 20 25 30 35 40 45 50 55))
617 (unless (file-exists? "witness")
618 (call-with-output-file "witness"
620 (display (list (getuid) (getgid)) port)))))))
621 (job2 #~(job next-second-from
623 (call-with-output-file "witness"
625 (display (list (getuid) (getgid)) port))))
627 (job3 #~(job next-second-from ;to test $PATH
628 "touch witness-touch")))
629 (simple-operating-system
630 (service mcron-service-type
631 (mcron-configuration (jobs (list job1 job2 job3)))))))
633 (define (run-mcron-test name)
635 (marionette-operating-system
637 #:imported-modules '((gnu services herd)
638 (guix combinators))))
641 (with-imported-modules '((gnu build marionette))
643 (use-modules (gnu build marionette)
648 (make-marionette (list #$(virtual-machine os))))
655 (test-assert "service running"
658 (use-modules (gnu services herd))
659 (start-service 'mcron))
662 ;; Make sure root's mcron job runs, has its cwd set to "/root", and
663 ;; runs with the right UID/GID.
664 (test-equal "root's job"
666 (wait-for-file "/root/witness" marionette))
668 ;; Likewise for Alice's job. We cannot know what its GID is since
669 ;; it's chosen by 'groupadd', but it's strictly positive.
670 (test-assert "alice's job"
671 (match (wait-for-file "/home/alice/witness" marionette)
675 ;; Last, the job that uses a command; allows us to test whether
677 (test-equal "root's job with command"
679 (wait-for-file "/root/witness-touch" marionette
680 #:read '(@ (ice-9 rdelim) read-string)))
682 ;; Make sure the 'schedule' action is accepted.
683 (test-equal "schedule action"
685 (marionette-eval '(with-shepherd-action 'mcron ('schedule) result
690 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
692 (gexp->derivation name test))
697 (description "Make sure the mcron service works as advertised.")
698 (value (run-mcron-test name))))
702 ;;; Avahi and NSS-mDNS.
708 (name-service-switch %mdns-host-lookup-nss)
709 (services (cons* (service avahi-service-type
710 (avahi-configuration (debug? #t)))
712 (service dhcp-client-service-type) ;needed for multicast
714 ;; Enable heavyweight debugging output.
715 (modify-services (operating-system-user-services
717 (nscd-service-type config
718 => (nscd-configuration
721 (log-file "/dev/console")))
722 (syslog-service-type config
724 (syslog-configuration
729 "*.* /dev/console\n")))))))))
731 (define (run-nss-mdns-test)
732 ;; Test resolution of '.local' names via libc. Start the marionette service
733 ;; *after* nscd. Failing to do that, libc will try to connect to nscd,
734 ;; fail, then never try again (see '__nss_not_use_nscd_hosts' in libc),
735 ;; leading to '.local' resolution failures.
737 (marionette-operating-system
739 #:requirements '(nscd)
740 #:imported-modules '((gnu services herd)
741 (guix combinators))))
743 (define mdns-host-name
744 (string-append (operating-system-host-name os)
748 (with-imported-modules '((gnu build marionette))
750 (use-modules (gnu build marionette)
756 (make-marionette (list #$(virtual-machine os))))
763 (test-assert "nscd PID file is created"
766 (use-modules (gnu services herd))
767 (start-service 'nscd))
770 (test-assert "nscd is listening on its socket"
772 ;; XXX: Work around a race condition in nscd: nscd creates its
773 ;; PID file before it is listening on its socket.
774 '(let ((sock (socket PF_UNIX SOCK_STREAM 0)))
778 (connect sock AF_UNIX "/var/run/nscd/socket")
780 (format #t "nscd is ready~%")
783 (format #t "waiting for nscd...~%")
788 (test-assert "avahi is running"
791 (use-modules (gnu services herd))
792 (start-service 'avahi-daemon))
795 (test-assert "network is up"
798 (use-modules (gnu services herd))
799 (start-service 'networking))
802 (test-equal "avahi-resolve-host-name"
806 "/run/current-system/profile/bin/avahi-resolve-host-name"
807 "-v" #$mdns-host-name)
810 (test-equal "avahi-browse"
813 '(system* "avahi-browse" "-avt")
816 (test-assert "getaddrinfo .local"
817 ;; Wait for the 'avahi-daemon' service and perform a resolution.
818 (match (marionette-eval
819 '(getaddrinfo #$mdns-host-name)
821 (((? vector? addrinfos) ..1)
822 (pk 'getaddrinfo addrinfos)
823 (and (any (lambda (ai)
824 (= AF_INET (addrinfo:fam ai)))
827 (= AF_INET6 (addrinfo:fam ai)))
830 (test-assert "gethostbyname .local"
831 (match (pk 'gethostbyname
832 (marionette-eval '(gethostbyname #$mdns-host-name)
835 (and (string=? (hostent:name result) #$mdns-host-name)
836 (= (hostent:addrtype result) AF_INET)))))
840 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
842 (gexp->derivation "nss-mdns" test))
844 (define %test-nss-mdns
848 "Test Avahi's multicast-DNS implementation, and in particular, test its
849 glibc name service switch (NSS) module.")
850 (value (run-nss-mdns-test))))