1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2016, 2017 Ludovic Courtès <ludo@gnu.org>
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/>.
19 (define-module (gnu tests base)
20 #:use-module (gnu tests)
21 #:use-module (gnu system)
22 #:use-module (gnu system shadow)
23 #:use-module (gnu system nss)
24 #:use-module (gnu system vm)
25 #:use-module (gnu services)
26 #:use-module (gnu services base)
27 #:use-module (gnu services dbus)
28 #:use-module (gnu services avahi)
29 #:use-module (gnu services mcron)
30 #:use-module (gnu services shepherd)
31 #:use-module (gnu services networking)
32 #:use-module (gnu packages imagemagick)
33 #:use-module (gnu packages ocr)
34 #:use-module (gnu packages package-management)
35 #:use-module (gnu packages linux)
36 #:use-module (gnu packages tmux)
37 #:use-module (guix gexp)
38 #:use-module (guix store)
39 #:use-module (guix packages)
40 #:use-module (srfi srfi-1)
41 #:export (run-basic-test
48 (simple-operating-system))
51 (define* (run-basic-test os command #:optional (name "basic")
53 "Return a derivation called NAME that tests basic features of the OS started
54 using COMMAND, a gexp that evaluates to a list of strings. Compare some
55 properties of running system to what's declared in OS, an <operating-system>.
57 When INITIALIZATION is true, it must be a one-argument procedure that is
58 passed a gexp denoting the marionette, and it must return gexp that is
59 inserted before the first test. This is used to introduce an extra
60 initialization step, such as entering a LUKS passphrase."
63 (fold-services (operating-system-services os)
64 #:target-type special-files-service-type)))
67 (with-imported-modules '((gnu build marionette)
68 (guix build syscalls))
70 (use-modules (gnu build marionette)
78 (make-marionette #$command))
86 (initialization #~marionette))
89 (match (marionette-eval '(uname) marionette)
90 (#("Linux" host-name version _ architecture)
91 (and (string=? host-name
92 #$(operating-system-host-name os))
93 (string-prefix? #$(package-version
94 (operating-system-kernel os))
96 (string-prefix? architecture %host-type)))))
98 (test-assert "shell and user commands"
99 ;; Is everything in $PATH?
100 (zero? (marionette-eval '(system "
109 (test-equal "special files"
113 (use-modules (ice-9 match))
117 (list file (readlink file))))
121 (test-assert "accounts"
122 (let ((users (marionette-eval '(begin
123 (use-modules (ice-9 match))
124 (let loop ((result '()))
126 (#f (reverse result))
127 (x (loop (cons x result))))))
130 (map passwd:name users)
132 #$@(map user-account-name
133 (operating-system-user-accounts os))))))
135 (test-assert "shepherd services"
136 (let ((services (marionette-eval
138 (use-modules (gnu services herd))
140 (map (compose car live-service-provision)
144 (pk 'services services)
145 '(root #$@(operating-system-shepherd-service-names os)))))
149 '#$(map user-account-home-directory
150 (filter user-account-create-home-directory?
151 (operating-system-user-accounts os)))))
154 (use-modules (gnu services herd) (srfi srfi-1))
156 ;; Home directories are supposed to exist once 'user-homes'
158 (start-service 'user-homes)
160 (every (lambda (home)
161 (and (file-exists? home)
162 (file-is-directory? home)))
166 (test-assert "skeletons in home directories"
168 '#$(filter-map (lambda (account)
169 (and (user-account-create-home-directory?
171 (not (user-account-system? account))
172 (list (user-account-name account)
173 (user-account-home-directory
175 (operating-system-user-accounts os))))
178 (use-modules (srfi srfi-1) (ice-9 ftw)
183 ;; Make sure HOME has all the skeletons...
184 (and (null? (lset-difference string=?
185 (scandir "/etc/skel/")
188 ;; ... and that everything is user-owned.
189 (let* ((pw (getpwnam user))
190 (uid (passwd:uid pw))
191 (gid (passwd:gid pw))
193 (define (user-owned? file)
194 (= uid (stat:uid (lstat file))))
196 (and (= uid (stat:uid st))
197 (eq? 'directory (stat:type st))
200 #:directories? #t)))))))
204 (test-equal "permissions on /root"
206 (let ((root-home #$(any (lambda (account)
207 (and (zero? (user-account-uid account))
208 (user-account-home-directory
210 (operating-system-user-accounts os))))
211 (stat:perms (marionette-eval `(stat ,root-home) marionette))))
213 (test-equal "no extra home directories"
216 ;; Make sure the home directories that are not supposed to be
217 ;; created are indeed not created.
219 '#$(filter-map (lambda (user)
221 (user-account-create-home-directory?
223 (user-account-home-directory user)))
224 (operating-system-user-accounts os))))
227 (use-modules (srfi srfi-1))
229 ;; Note: Do not flag "/var/empty".
231 ',(remove (cut string-prefix? "/var/" <>)
235 (test-equal "login on tty1"
238 (marionette-control "sendkey ctrl-alt-f1" marionette)
239 ;; Wait for the 'term-tty1' service to be running (using
240 ;; 'start-service' is the simplest and most reliable way to do
244 (use-modules (gnu services herd))
245 (start-service 'term-tty1))
249 (marionette-type "root\n\nid -un > logged-in\n" marionette)
251 ;; It can take a while before the shell commands are executed.
252 (marionette-eval '(use-modules (rnrs io ports)) marionette)
253 (wait-for-file "/root/logged-in" marionette
254 #:read 'get-string-all)))
256 ;; There should be one utmpx entry for the user logged in on tty1.
257 (test-equal "utmpx entry"
258 '(("root" "tty1" #f))
261 (use-modules (guix build syscalls)
264 (filter-map (lambda (entry)
265 (and (equal? (login-type USER_PROCESS)
266 (utmpx-login-type entry))
267 (list (utmpx-user entry) (utmpx-line entry)
268 (utmpx-host entry))))
272 ;; Likewise for /var/log/wtmp (used by 'last').
273 (test-assert "wtmp entry"
274 (match (marionette-eval
276 (use-modules (guix build syscalls)
279 (define (entry->list entry)
280 (list (utmpx-user entry) (utmpx-line entry)
281 (utmpx-host entry) (utmpx-login-type entry)))
283 (call-with-input-file "/var/log/wtmp"
285 (let loop ((result '()))
286 (if (eof-object? (peek-char port))
287 (map entry->list (reverse result))
288 (loop (cons (read-utmpx port) result)))))))
290 (((users lines hosts types) ..1)
291 (every (lambda (type)
292 (eqv? type (login-type LOGIN_PROCESS)))
295 (test-assert "host name resolution"
296 (match (marionette-eval
298 ;; Wait for nscd or our requests go through it.
299 (use-modules (gnu services herd))
300 (start-service 'nscd)
302 (list (getaddrinfo "localhost")
303 (getaddrinfo #$(operating-system-host-name os))))
305 ((((? vector?) ..1) ((? vector?) ..1))
308 (pk 'failure x #f))))
310 (test-equal "host not found"
313 '(false-if-exception (getaddrinfo "does-not-exist"))
318 (marionette-eval '(let ((before (setlocale LC_ALL "en_US.utf8")))
319 (setlocale LC_ALL before))
322 (test-eq "/run/current-system is a GC root"
324 (marionette-eval '(begin
325 ;; Make sure the (guix …) modules are found.
327 #+(file-append guix "/share/guile/site/2.2"))
329 (use-modules (srfi srfi-34) (guix store))
331 (let ((system (readlink "/run/current-system")))
332 (guard (c ((nix-protocol-error? c)
333 (and (file-exists? system)
336 (delete-paths store (list system))
340 ;; This symlink is currently unused, but better have it point to the
342 ;; <https://lists.gnu.org/archive/html/guix-devel/2016-08/msg01641.html>.
343 (test-equal "/var/guix/gcroots/profiles is a valid symlink"
345 (marionette-eval '(readlink "/var/guix/gcroots/profiles")
349 (test-assert "screendump"
351 (marionette-control (string-append "screendump " #$output
354 (file-exists? "tty1.ppm")))
356 (test-assert "screen text"
357 (let ((text (marionette-screen-text marionette
361 ;; Check whether the welcome message and shell prompt are
362 ;; displayed. Note: OCR confuses "y" and "V" for instance, so
363 ;; we cannot reliably match the whole text.
364 (and (string-contains text "This is the GNU")
365 (string-contains text
368 #$(operating-system-host-name os))))))
371 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
373 (gexp->derivation name test))
375 (define %test-basic-os
379 "Instrument %SIMPLE-OS, run it in a VM, and run a series of basic
380 functionality tests.")
382 (let* ((os (marionette-operating-system
384 #:imported-modules '((gnu services herd)
385 (guix combinators))))
386 (vm (virtual-machine os)))
387 ;; XXX: Add call to 'virtualized-operating-system' to get the exact same
388 ;; set of services as the OS produced by
389 ;; 'system-qemu-image/shared-store-script'.
390 (run-basic-test (virtualized-operating-system os '())
398 (define (run-halt-test vm)
399 ;; As reported in <http://bugs.gnu.org/26931>, running tmux would previously
400 ;; lead the 'stop' method of 'user-processes' to an infinite loop, with the
401 ;; tmux server process as a zombie that remains in the list of processes.
402 ;; This test reproduces this scenario.
404 (with-imported-modules '((gnu build marionette))
406 (use-modules (gnu build marionette))
409 (make-marionette '(#$vm)))
412 #$(file-append ocrad "/bin/ocrad"))
414 ;; Wait for tty1 and log in.
415 (marionette-eval '(begin
416 (use-modules (gnu services herd))
417 (start-service 'term-tty1))
419 (marionette-type "root\n" marionette)
420 (wait-for-screen-text marionette
422 (string-contains text "root@komputilo"))
425 ;; Start tmux and wait for it to be ready.
426 (marionette-type "tmux new-session 'echo 1 > /ready; bash'\n"
428 (wait-for-file "/ready" marionette)
430 ;; Make sure to stop the test after a while.
431 (sigaction SIGALRM (lambda _
432 (format (current-error-port)
433 "FAIL: Time is up, but VM still running.\n")
437 ;; Get debugging info.
438 (marionette-eval '(current-output-port
439 (open-file "/dev/console" "w0"))
441 (marionette-eval '(system* #$(file-append procps "/bin/ps")
442 "-eo" "pid,ppid,stat,comm")
445 ;; See if 'halt' actually works.
446 (marionette-eval '(system* "/run/current-system/profile/sbin/halt")
449 ;; If we reach this line, that means the VM was properly stopped in
452 (call-with-output-file #$output
454 (display "success!" port))))))
456 (gexp->derivation "halt" test))
462 "Use the 'halt' command and make sure it succeeds and does not get stuck
463 in a loop. See <http://bugs.gnu.org/26931>.")
465 (let ((os (marionette-operating-system
468 (packages (cons tmux %base-packages)))
469 #:imported-modules '((gnu services herd)
470 (guix combinators)))))
471 (run-halt-test (virtual-machine os))))))
479 ;; System with an mcron service, with one mcron job for "root" and one mcron
480 ;; job for an unprivileged user (note: #:user is an 'mcron2' thing.)
481 (let ((job1 #~(job next-second-from
483 (call-with-output-file "witness"
485 (display (list (getuid) (getgid)) port))))))
486 (job2 #~(job next-second-from
488 (call-with-output-file "witness"
490 (display (list (getuid) (getgid)) port))))
492 (job3 #~(job next-second-from ;to test $PATH
493 "touch witness-touch")))
494 (simple-operating-system
495 (mcron-service (list job1 job2 job3)))))
497 (define (run-mcron-test name)
499 (marionette-operating-system
501 #:imported-modules '((gnu services herd)
502 (guix combinators))))
505 (with-imported-modules '((gnu build marionette))
507 (use-modules (gnu build marionette)
512 (make-marionette (list #$(virtual-machine os))))
519 (test-eq "service running"
523 (use-modules (gnu services herd))
524 (start-service 'mcron)
528 ;; Make sure root's mcron job runs, has its cwd set to "/root", and
529 ;; runs with the right UID/GID.
530 (test-equal "root's job"
532 (wait-for-file "/root/witness" marionette))
534 ;; Likewise for Alice's job. We cannot know what its GID is since
535 ;; it's chosen by 'groupadd', but it's strictly positive.
536 (test-assert "alice's job"
537 (match (wait-for-file "/home/alice/witness" marionette)
541 ;; Last, the job that uses a command; allows us to test whether
543 (test-equal "root's job with command"
545 (wait-for-file "/root/witness-touch" marionette
546 #:read '(@ (ice-9 rdelim) read-string)))
549 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
551 (gexp->derivation name test))
556 (description "Make sure the mcron service works as advertised.")
557 (value (run-mcron-test name))))
561 ;;; Avahi and NSS-mDNS.
567 (name-service-switch %mdns-host-lookup-nss)
568 (services (cons* (avahi-service #:debug? #t)
570 (dhcp-client-service) ;needed for multicast
572 ;; Enable heavyweight debugging output.
573 (modify-services (operating-system-user-services
575 (nscd-service-type config
576 => (nscd-configuration
579 (log-file "/dev/console")))
580 (syslog-service-type config
582 (syslog-configuration
587 "*.* /dev/console\n")))))))))
589 (define (run-nss-mdns-test)
590 ;; Test resolution of '.local' names via libc. Start the marionette service
591 ;; *after* nscd. Failing to do that, libc will try to connect to nscd,
592 ;; fail, then never try again (see '__nss_not_use_nscd_hosts' in libc),
593 ;; leading to '.local' resolution failures.
595 (marionette-operating-system
597 #:requirements '(nscd)
598 #:imported-modules '((gnu services herd)
599 (guix combinators))))
601 (define mdns-host-name
602 (string-append (operating-system-host-name os)
606 (with-imported-modules '((gnu build marionette))
608 (use-modules (gnu build marionette)
614 (make-marionette (list #$(virtual-machine os))))
621 (test-assert "wait for services"
624 (use-modules (gnu services herd))
626 (start-service 'nscd)
628 ;; XXX: Work around a race condition in nscd: nscd creates its
629 ;; PID file before it is listening on its socket.
630 (let ((sock (socket PF_UNIX SOCK_STREAM 0)))
634 (connect sock AF_UNIX "/var/run/nscd/socket")
636 (format #t "nscd is ready~%"))
638 (format #t "waiting for nscd...~%")
642 ;; Wait for the other useful things.
643 (start-service 'avahi-daemon)
644 (start-service 'networking)
649 (test-equal "avahi-resolve-host-name"
653 "/run/current-system/profile/bin/avahi-resolve-host-name"
654 "-v" #$mdns-host-name)
657 (test-equal "avahi-browse"
660 '(system* "avahi-browse" "-avt")
663 (test-assert "getaddrinfo .local"
664 ;; Wait for the 'avahi-daemon' service and perform a resolution.
665 (match (marionette-eval
666 '(getaddrinfo #$mdns-host-name)
668 (((? vector? addrinfos) ..1)
669 (pk 'getaddrinfo addrinfos)
670 (and (any (lambda (ai)
671 (= AF_INET (addrinfo:fam ai)))
674 (= AF_INET6 (addrinfo:fam ai)))
677 (test-assert "gethostbyname .local"
678 (match (pk 'gethostbyname
679 (marionette-eval '(gethostbyname #$mdns-host-name)
682 (and (string=? (hostent:name result) #$mdns-host-name)
683 (= (hostent:addrtype result) AF_INET)))))
687 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
689 (gexp->derivation "nss-mdns" test))
691 (define %test-nss-mdns
695 "Test Avahi's multicast-DNS implementation, and in particular, test its
696 glibc name service switch (NSS) module.")
697 (value (run-nss-mdns-test))))