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)
257 (call-with-input-file "/root/logged-in"
260 (if (and (< i 15) (= ENOENT (system-error-errno args)))
264 (apply throw args)))))
267 ;; There should be one utmpx entry for the user logged in on tty1.
268 (test-equal "utmpx entry"
269 '(("root" "tty1" #f))
272 (use-modules (guix build syscalls)
275 (filter-map (lambda (entry)
276 (and (equal? (login-type USER_PROCESS)
277 (utmpx-login-type entry))
278 (list (utmpx-user entry) (utmpx-line entry)
279 (utmpx-host entry))))
283 ;; Likewise for /var/log/wtmp (used by 'last').
284 (test-assert "wtmp entry"
285 (match (marionette-eval
287 (use-modules (guix build syscalls)
290 (define (entry->list entry)
291 (list (utmpx-user entry) (utmpx-line entry)
292 (utmpx-host entry) (utmpx-login-type entry)))
294 (call-with-input-file "/var/log/wtmp"
296 (let loop ((result '()))
297 (if (eof-object? (peek-char port))
298 (map entry->list (reverse result))
299 (loop (cons (read-utmpx port) result)))))))
301 (((users lines hosts types) ..1)
302 (every (lambda (type)
303 (eqv? type (login-type LOGIN_PROCESS)))
306 (test-assert "host name resolution"
307 (match (marionette-eval
309 ;; Wait for nscd or our requests go through it.
310 (use-modules (gnu services herd))
311 (start-service 'nscd)
313 (list (getaddrinfo "localhost")
314 (getaddrinfo #$(operating-system-host-name os))))
316 ((((? vector?) ..1) ((? vector?) ..1))
319 (pk 'failure x #f))))
321 (test-equal "host not found"
324 '(false-if-exception (getaddrinfo "does-not-exist"))
329 (marionette-eval '(let ((before (setlocale LC_ALL "en_US.utf8")))
330 (setlocale LC_ALL before))
333 (test-eq "/run/current-system is a GC root"
335 (marionette-eval '(begin
336 ;; Make sure the (guix …) modules are found.
338 ;; XXX: Currently shepherd and marionette run
339 ;; on Guile 2.0 whereas Guix is on 2.2. Yet
340 ;; we should be able to load the 2.0 Scheme
341 ;; files since it's pure Scheme.
343 #+(file-append guix "/share/guile/site/2.2"))
345 (use-modules (srfi srfi-34) (guix store))
347 (let ((system (readlink "/run/current-system")))
348 (guard (c ((nix-protocol-error? c)
349 (and (file-exists? system)
352 (delete-paths store (list system))
356 ;; This symlink is currently unused, but better have it point to the
358 ;; <https://lists.gnu.org/archive/html/guix-devel/2016-08/msg01641.html>.
359 (test-equal "/var/guix/gcroots/profiles is a valid symlink"
361 (marionette-eval '(readlink "/var/guix/gcroots/profiles")
365 (test-assert "screendump"
367 (marionette-control (string-append "screendump " #$output
370 (file-exists? "tty1.ppm")))
372 (test-assert "screen text"
373 (let ((text (marionette-screen-text marionette
377 ;; Check whether the welcome message and shell prompt are
378 ;; displayed. Note: OCR confuses "y" and "V" for instance, so
379 ;; we cannot reliably match the whole text.
380 (and (string-contains text "This is the GNU")
381 (string-contains text
384 #$(operating-system-host-name os))))))
387 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
389 (gexp->derivation name test))
391 (define %test-basic-os
395 "Instrument %SIMPLE-OS, run it in a VM, and run a series of basic
396 functionality tests.")
398 (let* ((os (marionette-operating-system
400 #:imported-modules '((gnu services herd)
401 (guix combinators))))
402 (vm (virtual-machine os)))
403 ;; XXX: Add call to 'virtualized-operating-system' to get the exact same
404 ;; set of services as the OS produced by
405 ;; 'system-qemu-image/shared-store-script'.
406 (run-basic-test (virtualized-operating-system os '())
414 (define (run-halt-test vm)
415 ;; As reported in <http://bugs.gnu.org/26931>, running tmux would previously
416 ;; lead the 'stop' method of 'user-processes' to an infinite loop, with the
417 ;; tmux server process as a zombie that remains in the list of processes.
418 ;; This test reproduces this scenario.
420 (with-imported-modules '((gnu build marionette))
422 (use-modules (gnu build marionette))
425 (make-marionette '(#$vm)))
428 #$(file-append ocrad "/bin/ocrad"))
430 ;; Wait for tty1 and log in.
431 (marionette-eval '(begin
432 (use-modules (gnu services herd))
433 (start-service 'term-tty1))
435 (marionette-type "root\n" marionette)
436 (wait-for-screen-text marionette
438 (string-contains text "root@komputilo"))
441 ;; Start tmux and wait for it to be ready.
442 (marionette-type "tmux new-session 'echo 1 > /ready; bash'\n"
444 (wait-for-file "/ready" marionette)
446 ;; Make sure to stop the test after a while.
447 (sigaction SIGALRM (lambda _
448 (format (current-error-port)
449 "FAIL: Time is up, but VM still running.\n")
453 ;; Get debugging info.
454 (marionette-eval '(current-output-port
455 (open-file "/dev/console" "w0"))
457 (marionette-eval '(system* #$(file-append procps "/bin/ps")
458 "-eo" "pid,ppid,stat,comm")
461 ;; See if 'halt' actually works.
462 (marionette-eval '(system* "/run/current-system/profile/sbin/halt")
465 ;; If we reach this line, that means the VM was properly stopped in
468 (call-with-output-file #$output
470 (display "success!" port))))))
472 (gexp->derivation "halt" test))
478 "Use the 'halt' command and make sure it succeeds and does not get stuck
479 in a loop. See <http://bugs.gnu.org/26931>.")
481 (let ((os (marionette-operating-system
484 (packages (cons tmux %base-packages)))
485 #:imported-modules '((gnu services herd)
486 (guix combinators)))))
487 (run-halt-test (virtual-machine os))))))
495 ;; System with an mcron service, with one mcron job for "root" and one mcron
496 ;; job for an unprivileged user (note: #:user is an 'mcron2' thing.)
497 (let ((job1 #~(job next-second-from
499 (call-with-output-file "witness"
501 (display (list (getuid) (getgid)) port))))))
502 (job2 #~(job next-second-from
504 (call-with-output-file "witness"
506 (display (list (getuid) (getgid)) port))))
508 (job3 #~(job next-second-from ;to test $PATH
509 "touch witness-touch")))
510 (simple-operating-system
511 (mcron-service (list job1 job2 job3)))))
513 (define (run-mcron-test name)
515 (marionette-operating-system
517 #:imported-modules '((gnu services herd)
518 (guix combinators))))
521 (with-imported-modules '((gnu build marionette))
523 (use-modules (gnu build marionette)
528 (make-marionette (list #$(virtual-machine os))))
535 (test-eq "service running"
539 (use-modules (gnu services herd))
540 (start-service 'mcron)
544 ;; Make sure root's mcron job runs, has its cwd set to "/root", and
545 ;; runs with the right UID/GID.
546 (test-equal "root's job"
548 (wait-for-file "/root/witness" marionette))
550 ;; Likewise for Alice's job. We cannot know what its GID is since
551 ;; it's chosen by 'groupadd', but it's strictly positive.
552 (test-assert "alice's job"
553 (match (wait-for-file "/home/alice/witness" marionette)
557 ;; Last, the job that uses a command; allows us to test whether
558 ;; $PATH is sane. (Note that 'marionette-eval' stringifies objects
559 ;; that don't have a read syntax, hence the string.)
560 (test-equal "root's job with command"
562 (wait-for-file "/root/witness-touch" marionette))
565 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
567 (gexp->derivation name test))
572 (description "Make sure the mcron service works as advertised.")
573 (value (run-mcron-test name))))
577 ;;; Avahi and NSS-mDNS.
583 (name-service-switch %mdns-host-lookup-nss)
584 (services (cons* (avahi-service #:debug? #t)
586 (dhcp-client-service) ;needed for multicast
588 ;; Enable heavyweight debugging output.
589 (modify-services (operating-system-user-services
591 (nscd-service-type config
592 => (nscd-configuration
595 (log-file "/dev/console")))
596 (syslog-service-type config
598 (syslog-configuration
603 "*.* /dev/console\n")))))))))
605 (define (run-nss-mdns-test)
606 ;; Test resolution of '.local' names via libc. Start the marionette service
607 ;; *after* nscd. Failing to do that, libc will try to connect to nscd,
608 ;; fail, then never try again (see '__nss_not_use_nscd_hosts' in libc),
609 ;; leading to '.local' resolution failures.
611 (marionette-operating-system
613 #:requirements '(nscd)
614 #:imported-modules '((gnu services herd)
615 (guix combinators))))
617 (define mdns-host-name
618 (string-append (operating-system-host-name os)
622 (with-imported-modules '((gnu build marionette))
624 (use-modules (gnu build marionette)
630 (make-marionette (list #$(virtual-machine os))))
637 (test-assert "wait for services"
640 (use-modules (gnu services herd))
642 (start-service 'nscd)
644 ;; XXX: Work around a race condition in nscd: nscd creates its
645 ;; PID file before it is listening on its socket.
646 (let ((sock (socket PF_UNIX SOCK_STREAM 0)))
650 (connect sock AF_UNIX "/var/run/nscd/socket")
652 (format #t "nscd is ready~%"))
654 (format #t "waiting for nscd...~%")
658 ;; Wait for the other useful things.
659 (start-service 'avahi-daemon)
660 (start-service 'networking)
665 (test-equal "avahi-resolve-host-name"
669 "/run/current-system/profile/bin/avahi-resolve-host-name"
670 "-v" #$mdns-host-name)
673 (test-equal "avahi-browse"
676 '(system* "avahi-browse" "-avt")
679 (test-assert "getaddrinfo .local"
680 ;; Wait for the 'avahi-daemon' service and perform a resolution.
681 (match (marionette-eval
682 '(getaddrinfo #$mdns-host-name)
684 (((? vector? addrinfos) ..1)
685 (pk 'getaddrinfo addrinfos)
686 (and (any (lambda (ai)
687 (= AF_INET (addrinfo:fam ai)))
690 (= AF_INET6 (addrinfo:fam ai)))
693 (test-assert "gethostbyname .local"
694 (match (pk 'gethostbyname
695 (marionette-eval '(gethostbyname #$mdns-host-name)
698 (and (string=? (hostent:name result) #$mdns-host-name)
699 (= (hostent:addrtype result) AF_INET)))))
703 (exit (= (test-runner-fail-count (test-runner-current)) 0)))))
705 (gexp->derivation "nss-mdns" test))
707 (define %test-nss-mdns
711 "Test Avahi's multicast-DNS implementation, and in particular, test its
712 glibc name service switch (NSS) module.")
713 (value (run-nss-mdns-test))))