;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2017, 2019 Tobias Geerinckx-Rice <me@tobias.gr>
+;;; Copyright © 2020 Mathieu Othacehe <m.othacehe@gmail.com>
+;;; Copyright © 2020 Danny Milosavljevic <dannym@scratchpost.org>
+;;; Copyright © 2020 Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
;;;
;;; This file is part of GNU Guix.
;;;
(define-module (gnu tests install)
#:use-module (gnu)
#:use-module (gnu bootloader extlinux)
+ #:use-module (gnu image)
#:use-module (gnu tests)
#:use-module (gnu tests base)
#:use-module (gnu system)
+ #:use-module (gnu system image)
#:use-module (gnu system install)
#:use-module (gnu system vm)
#:use-module ((gnu build vm) #:select (qemu-command))
#:use-module (gnu packages admin)
#:use-module (gnu packages bootloaders)
+ #:use-module (gnu packages commencement) ;for 'guile-final'
#:use-module (gnu packages cryptsetup)
#:use-module (gnu packages linux)
#:use-module (gnu packages ocr)
+ #:use-module (gnu packages openbox)
#:use-module (gnu packages package-management)
+ #:use-module (gnu packages ratpoison)
+ #:use-module (gnu packages suckless)
#:use-module (gnu packages virtualization)
+ #:use-module (gnu packages wm)
+ #:use-module (gnu packages xorg)
+ #:use-module (gnu services desktop)
#:use-module (gnu services networking)
+ #:use-module (gnu services xorg)
#:use-module (guix store)
#:use-module (guix monads)
#:use-module (guix packages)
#:use-module (guix grafts)
#:use-module (guix gexp)
#:use-module (guix utils)
+ #:use-module (srfi srfi-1)
#:export (%test-installed-os
%test-installed-extlinux-os
%test-iso-image-installer
%test-raid-root-os
%test-encrypted-root-os
%test-btrfs-root-os
+ %test-btrfs-root-on-subvolume-os
%test-jfs-root-os
+ %test-f2fs-root-os
%test-gui-installed-os
- %test-gui-installed-os-encrypted))
+ %test-gui-installed-os-encrypted
+ %test-gui-installed-desktop-os-encrypted))
;;; Commentary:
;;;
guix build isc-dhcp
parted --script /dev/vdb mklabel gpt \\
mkpart primary ext2 1M 3M \\
- mkpart primary ext2 3M 1.4G \\
+ mkpart primary ext2 3M 1.6G \\
set 1 boot on \\
set 1 bios_grub on
mkfs.ext4 -L my-root /dev/vdb2
export GUIX_BUILD_OPTIONS=--no-grafts
guix build isc-dhcp
parted --script /dev/vdb mklabel gpt \\
- mkpart ext2 1M 1.4G \\
+ mkpart ext2 1M 1.6G \\
set 1 legacy_boot on
mkfs.ext4 -L my-root -O '^64bit' /dev/vdb1
mount /dev/vdb1 /mnt
#:imported-modules '((gnu services herd)
(gnu installer tests)
(guix combinators))))
- (installation-disk-image-file-system-type "ext4")
+ (installation-image-type 'raw)
+ (install-size 'guess)
(target-size (* 2200 MiB)))
"Run SCRIPT (a shell script following the system installation procedure) in
OS to install TARGET-OS. Return a VM image of TARGET-SIZE bytes containing
(mlet* %store-monad ((_ (set-grafting #f))
(system (current-system))
- (target (operating-system-derivation target-os))
;; Since the installation system has no network access,
;; we cheat a little bit by adding TARGET to its GC
;; roots. This way, we know 'guix system init' will
- ;; succeed.
- (image (system-disk-image
- (operating-system-with-gc-roots
- os (list target))
- #:disk-image-size 'guess
- #:file-system-type
- installation-disk-image-file-system-type)))
+ ;; succeed. Also add guile-final, which is pulled in
+ ;; through provenance.drv and may not always be present.
+ (target (operating-system-derivation target-os))
+ (base-image ->
+ (os->image
+ (operating-system-with-gc-roots
+ os (list target guile-final))
+ #:type (lookup-image-type-by-name
+ installation-image-type)))
+ (image ->
+ (system-image
+ (image
+ (inherit base-image)
+ (size install-size)
+
+ ;; Don't provide substitutes; too big.
+ (substitutable? #f)))))
(define install
(with-imported-modules '((guix build utils)
(gnu build marionette))
(make-marionette
`(,(which #$(qemu-command system))
"-no-reboot"
- "-m" "800"
+ "-m" "1200"
#$@(cond
- ((string=? "ext4" installation-disk-image-file-system-type)
+ ((eq? 'raw installation-image-type)
#~("-drive"
,(string-append "file=" #$image
",if=virtio,readonly")))
- ((string=? "iso9660" installation-disk-image-file-system-type)
+ ((eq? 'uncompressed-iso9660 installation-image-type)
#~("-cdrom" #$image))
(else
(error
- "unsupported installation-disk-image-file-system-type:"
- installation-disk-image-file-system-type)))
+ "unsupported installation-image-type:"
+ installation-image-type)))
"-drive"
,(string-append "file=" #$output ",if=virtio")
,@(if (file-exists? "/dev/kvm")
;; Run SCRIPT. It typically invokes 'reboot' as a last step and
;; thus normally gets killed with SIGTERM by PID 1.
(let ((status (marionette-eval '(system #$script) marionette)))
- (exit (or (equal? (status:term-sig status) SIGTERM)
+ (exit (or (eof-object? status)
+ (equal? (status:term-sig status) SIGTERM)
(equal? (status:exit-val status) 0)))))
(when #$(->bool gui-test)
(exit #$(and gui-test
(gui-test #~marionette)))))))
- (gexp->derivation "installation" install)))
+ (gexp->derivation "installation" install
+ #:substitutable? #f))) ;too big
(define* (qemu-command/writable-image image #:key (memory-size 256))
"Return as a monadic value the command to run QEMU on a writable copy of
(services (cons (service marionette-service-type
(marionette-configuration
(imported-modules '((gnu services herd)
+ (guix build utils)
(guix combinators)))))
%base-services))))
guix build isc-dhcp
parted --script /dev/vda mklabel gpt \\
mkpart primary ext2 1M 3M \\
- mkpart primary ext2 3M 1.4G \\
+ mkpart primary ext2 3M 1.6G \\
set 1 boot on \\
set 1 bios_grub on
mkfs.ext4 -L my-root /dev/vda2
%minimal-os-on-vda-source
#:script
%simple-installation-script-for-/dev/vda
- #:installation-disk-image-file-system-type
- "iso9660"))
+ #:installation-image-type
+ 'uncompressed-iso9660))
(command (qemu-command/writable-image image)))
(run-basic-test %minimal-os-on-vda command name)))))
export GUIX_BUILD_OPTIONS=--no-grafts
parted --script /dev/vdb mklabel gpt \\
mkpart primary ext2 1M 3M \\
- mkpart primary ext2 3M 1.4G \\
- mkpart primary ext2 1.4G 2.8G \\
+ mkpart primary ext2 3M 1.6G \\
+ mkpart primary ext2 1.6G 3.2G \\
set 1 boot on \\
set 1 bios_grub on
yes | mdadm --create /dev/md0 --verbose --level=mirror --raid-devices=2 \\
%raid-root-os-source
#:script
%raid-root-installation-script
- #:target-size (* 2800 MiB)))
+ #:target-size (* 3200 MiB)))
(command (qemu-command/writable-image image)))
(run-basic-test %raid-root-os
`(,@command) "raid-root-os")))))
ls -l /run/current-system/gc-roots
parted --script /dev/vdb mklabel gpt \\
mkpart primary ext2 1M 3M \\
- mkpart primary ext2 3M 1.4G \\
+ mkpart primary ext2 3M 1.6G \\
set 1 boot on \\
set 1 bios_grub on
echo -n " %luks-passphrase " | \\
(run-basic-test %btrfs-root-os command "btrfs-root-os")))))
\f
+;;;
+;;; Btrfs root file system on a subvolume.
+;;;
+
+(define-os-with-source (%btrfs-root-on-subvolume-os
+ %btrfs-root-on-subvolume-os-source)
+ ;; The OS we want to install.
+ (use-modules (gnu) (gnu tests) (srfi srfi-1))
+
+ (operating-system
+ (host-name "hurd")
+ (timezone "America/Montreal")
+ (locale "en_US.UTF-8")
+ (bootloader (bootloader-configuration
+ (bootloader grub-bootloader)
+ (target "/dev/vdb")))
+ (kernel-arguments '("console=ttyS0"))
+ (file-systems (cons* (file-system
+ (device (file-system-label "btrfs-pool"))
+ (mount-point "/")
+ (options "subvol=rootfs,compress=zstd")
+ (type "btrfs"))
+ (file-system
+ (device (file-system-label "btrfs-pool"))
+ (mount-point "/home")
+ (options "subvol=homefs,compress=lzo")
+ (type "btrfs"))
+ %base-file-systems))
+ (users (cons (user-account
+ (name "charlie")
+ (group "users")
+ (supplementary-groups '("wheel" "audio" "video")))
+ %base-user-accounts))
+ (services (cons (service marionette-service-type
+ (marionette-configuration
+ (imported-modules '((gnu services herd)
+ (guix combinators)))))
+ %base-services))))
+
+(define %btrfs-root-on-subvolume-installation-script
+ ;; Shell script of a simple installation.
+ "\
+. /etc/profile
+set -e -x
+guix --version
+
+export GUIX_BUILD_OPTIONS=--no-grafts
+ls -l /run/current-system/gc-roots
+parted --script /dev/vdb mklabel gpt \\
+ mkpart primary ext2 1M 3M \\
+ mkpart primary ext2 3M 2G \\
+ set 1 boot on \\
+ set 1 bios_grub on
+
+# Setup the top level Btrfs file system with its subvolume.
+mkfs.btrfs -L btrfs-pool /dev/vdb2
+mount /dev/vdb2 /mnt
+btrfs subvolume create /mnt/rootfs
+btrfs subvolume create /mnt/homefs
+umount /dev/vdb2
+
+# Mount the subvolumes, ready for installation.
+mount LABEL=btrfs-pool -o 'subvol=rootfs,compress=zstd' /mnt
+mkdir /mnt/home
+mount LABEL=btrfs-pool -o 'subvol=homefs,compress=zstd' /mnt/home
+
+herd start cow-store /mnt
+mkdir /mnt/etc
+cp /etc/target-config.scm /mnt/etc/config.scm
+guix system build /mnt/etc/config.scm
+guix system init /mnt/etc/config.scm /mnt --no-substitutes
+sync
+reboot\n")
+
+(define %test-btrfs-root-on-subvolume-os
+ (system-test
+ (name "btrfs-root-on-subvolume-os")
+ (description
+ "Test basic functionality of an OS installed like one would do by hand.
+This test is expensive in terms of CPU and storage usage since we need to
+build (current-guix) and then store a couple of full system images.")
+ (value
+ (mlet* %store-monad
+ ((image
+ (run-install %btrfs-root-on-subvolume-os
+ %btrfs-root-on-subvolume-os-source
+ #:script
+ %btrfs-root-on-subvolume-installation-script))
+ (command (qemu-command/writable-image image)))
+ (run-basic-test %btrfs-root-on-subvolume-os command
+ "btrfs-root-on-subvolume-os")))))
+
+\f
;;;
;;; JFS root file system.
;;;
(run-basic-test %jfs-root-os command "jfs-root-os")))))
\f
+;;;
+;;; F2FS root file system.
+;;;
+
+(define-os-with-source (%f2fs-root-os %f2fs-root-os-source)
+ ;; The OS we want to install.
+ (use-modules (gnu) (gnu tests) (srfi srfi-1))
+
+ (operating-system
+ (host-name "liberigilo")
+ (timezone "Europe/Paris")
+ (locale "en_US.UTF-8")
+
+ (bootloader (bootloader-configuration
+ (bootloader grub-bootloader)
+ (target "/dev/vdb")))
+ (kernel-arguments '("console=ttyS0"))
+ (file-systems (cons (file-system
+ (device (file-system-label "my-root"))
+ (mount-point "/")
+ (type "f2fs"))
+ %base-file-systems))
+ (users (cons (user-account
+ (name "charlie")
+ (group "users")
+ (supplementary-groups '("wheel" "audio" "video")))
+ %base-user-accounts))
+ (services (cons (service marionette-service-type
+ (marionette-configuration
+ (imported-modules '((gnu services herd)
+ (guix combinators)))))
+ %base-services))))
+
+(define %f2fs-root-installation-script
+ ;; Shell script of a simple installation.
+ "\
+. /etc/profile
+set -e -x
+guix --version
+
+export GUIX_BUILD_OPTIONS=--no-grafts
+ls -l /run/current-system/gc-roots
+parted --script /dev/vdb mklabel gpt \\
+ mkpart primary ext2 1M 3M \\
+ mkpart primary ext2 3M 2G \\
+ set 1 boot on \\
+ set 1 bios_grub on
+mkfs.f2fs -l my-root -q /dev/vdb2
+mount /dev/vdb2 /mnt
+herd start cow-store /mnt
+mkdir /mnt/etc
+cp /etc/target-config.scm /mnt/etc/config.scm
+guix system build /mnt/etc/config.scm
+guix system init /mnt/etc/config.scm /mnt --no-substitutes
+sync
+reboot\n")
+
+(define %test-f2fs-root-os
+ (system-test
+ (name "f2fs-root-os")
+ (description
+ "Test basic functionality of an OS installed like one would do by hand.
+This test is expensive in terms of CPU and storage usage since we need to
+build (current-guix) and then store a couple of full system images.")
+ (value
+ (mlet* %store-monad ((image (run-install %f2fs-root-os
+ %f2fs-root-os-source
+ #:script
+ %f2fs-root-installation-script))
+ (command (qemu-command/writable-image image)))
+ (run-basic-test %f2fs-root-os command "f2fs-root-os")))))
+
+\f
;;;
;;; Installation through the graphical interface.
;;;
(define %root-password "foo")
-(define* (gui-test-program marionette #:key (encrypted? #f))
+(define* (gui-test-program marionette
+ #:key
+ (desktop? #f)
+ (encrypted? #f))
#~(let ()
(define (screenshot file)
(marionette-control (string-append "screendump " file)
#$marionette))
+ (define-syntax-rule (marionette-eval* exp marionette)
+ (or (marionette-eval exp marionette)
+ (throw 'marionette-eval-failure 'exp)))
+
(setvbuf (current-output-port) 'none)
(setvbuf (current-error-port) 'none)
- (marionette-eval '(use-modules (gnu installer tests))
- #$marionette)
+ (marionette-eval* '(use-modules (gnu installer tests))
+ #$marionette)
;; Arrange so that 'converse' prints debugging output to the console.
- (marionette-eval '(let ((console (open-output-file "/dev/console")))
- (setvbuf console 'none)
- (conversation-log-port console))
- #$marionette)
+ (marionette-eval* '(let ((console (open-output-file "/dev/console")))
+ (setvbuf console 'none)
+ (conversation-log-port console))
+ #$marionette)
;; Tell the installer to not wait for the Connman "online" status.
- (marionette-eval '(call-with-output-file "/tmp/installer-assume-online"
- (const #t))
- #$marionette)
+ (marionette-eval* '(call-with-output-file "/tmp/installer-assume-online"
+ (const #t))
+ #$marionette)
;; Run 'guix system init' with '--no-grafts', to cope with the lack of
;; network access.
- (marionette-eval '(call-with-output-file
- "/tmp/installer-system-init-options"
- (lambda (port)
- (write '("--no-grafts" "--no-substitutes")
- port)))
- #$marionette)
-
- (marionette-eval '(define installer-socket
- (open-installer-socket))
- #$marionette)
+ (marionette-eval* '(call-with-output-file
+ "/tmp/installer-system-init-options"
+ (lambda (port)
+ (write '("--no-grafts" "--no-substitutes")
+ port)))
+ #$marionette)
+
+ (marionette-eval* '(define installer-socket
+ (open-installer-socket))
+ #$marionette)
(screenshot "installer-start.ppm")
- (marionette-eval '(choose-locale+keyboard installer-socket)
- #$marionette)
+ (marionette-eval* '(choose-locale+keyboard installer-socket)
+ #$marionette)
(screenshot "installer-locale.ppm")
;; Choose the host name that the "basic" test expects.
- (marionette-eval '(enter-host-name+passwords installer-socket
- #:host-name "liberigilo"
- #:root-password
- #$%root-password
- #:users
- '(("alice" "pass1")
- ("bob" "pass2")))
- #$marionette)
+ (marionette-eval* '(enter-host-name+passwords installer-socket
+ #:host-name "liberigilo"
+ #:root-password
+ #$%root-password
+ #:users
+ '(("alice" "pass1")
+ ("bob" "pass2")))
+ #$marionette)
(screenshot "installer-services.ppm")
- (marionette-eval '(choose-services installer-socket
- #:desktop-environments '()
- #:choose-network-service?
- (const #f))
- #$marionette)
+ (marionette-eval* '(choose-services installer-socket
+ #:choose-desktop-environment?
+ (const #$desktop?)
+ #:choose-network-service?
+ (const #f))
+ #$marionette)
(screenshot "installer-partitioning.ppm")
- (marionette-eval '(choose-partitioning installer-socket
- #:encrypted? #$encrypted?
- #:passphrase #$%luks-passphrase)
- #$marionette)
+ (marionette-eval* '(choose-partitioning installer-socket
+ #:encrypted? #$encrypted?
+ #:passphrase #$%luks-passphrase)
+ #$marionette)
(screenshot "installer-run.ppm")
- (marionette-eval '(conclude-installation installer-socket)
- #$marionette)
+ (marionette-eval* '(conclude-installation installer-socket)
+ #$marionette)
(sync)
#t))
(gnu installer tests)
(guix combinators))))
-(define* (guided-installation-test name #:key encrypted?)
- (define os
- (operating-system
- (inherit %minimal-os)
- (users (append (list (user-account
- (name "alice")
- (comment "Bob's sister")
- (group "users")
- (supplementary-groups
- '("wheel" "audio" "video")))
- (user-account
- (name "bob")
- (comment "Alice's brother")
- (group "users")
- (supplementary-groups
- '("wheel" "audio" "video"))))
- %base-user-accounts))
- ;; The installer does not create a swap device in guided mode with
- ;; encryption support.
- (swap-devices (if encrypted? '() '("/dev/vdb2")))
- (services (cons (service dhcp-client-service-type)
- (operating-system-user-services %minimal-os)))))
-
+(define* (installation-target-os-for-gui-tests
+ #:key (encrypted? #f))
+ (operating-system
+ (inherit %minimal-os-on-vda)
+ (users (append (list (user-account
+ (name "alice")
+ (comment "Bob's sister")
+ (group "users")
+ (supplementary-groups
+ '("wheel" "audio" "video")))
+ (user-account
+ (name "bob")
+ (comment "Alice's brother")
+ (group "users")
+ (supplementary-groups
+ '("wheel" "audio" "video"))))
+ %base-user-accounts))
+ ;; The installer does not create a swap device in guided mode with
+ ;; encryption support.
+ (swap-devices (if encrypted? '() '("/dev/vda2")))
+ (services (cons (service dhcp-client-service-type)
+ (operating-system-user-services %minimal-os-on-vda)))))
+
+(define* (installation-target-desktop-os-for-gui-tests
+ #:key (encrypted? #f))
+ (operating-system
+ (inherit (installation-target-os-for-gui-tests
+ #:encrypted? encrypted?))
+ (keyboard-layout (keyboard-layout "us" "altgr-intl"))
+
+ ;; Make sure that all the packages and services that may be used by the
+ ;; graphical installer are available.
+ (packages (append
+ (list openbox awesome i3-wm i3status
+ dmenu st ratpoison xterm)
+ %base-packages))
+ (services
+ (append
+ (list (service gnome-desktop-service-type)
+ (service xfce-desktop-service-type)
+ (service mate-desktop-service-type)
+ (service enlightenment-desktop-service-type)
+ (set-xorg-configuration
+ (xorg-configuration
+ (keyboard-layout keyboard-layout)))
+ (service marionette-service-type
+ (marionette-configuration
+ (imported-modules '((gnu services herd)
+ (guix build utils)
+ (guix combinators))))))
+ %desktop-services))))
+
+(define* (guided-installation-test name
+ #:key
+ (desktop? #f)
+ (encrypted? #f)
+ target-os
+ (install-size 'guess)
+ (target-size (* 2200 MiB)))
(system-test
(name name)
(description
"Install an OS using the graphical installer and test it.")
(value
- (mlet* %store-monad ((image (run-install os '(this is unused)
- #:script #f
- #:os installation-os-for-gui-tests
- #:gui-test
- (lambda (marionette)
- (gui-test-program
- marionette
- #:encrypted? encrypted?))))
- (command (qemu-command/writable-image image)))
- (run-basic-test os command name
+ (mlet* %store-monad
+ ((image (run-install target-os '(this is unused)
+ #:script #f
+ #:os installation-os-for-gui-tests
+ #:install-size install-size
+ #:target-size target-size
+ #:installation-image-type
+ 'uncompressed-iso9660
+ #:gui-test
+ (lambda (marionette)
+ (gui-test-program
+ marionette
+ #:desktop? desktop?
+ #:encrypted? encrypted?))))
+ (command (qemu-command/writable-image image #:memory-size 512)))
+ (run-basic-test target-os command name
#:initialization (and encrypted? enter-luks-passphrase)
- #:root-password %root-password)))))
+ #:root-password %root-password
+ #:desktop? desktop?)))))
(define %test-gui-installed-os
- (guided-installation-test "gui-installed-os"
- #:encrypted? #f))
+ (guided-installation-test
+ "gui-installed-os"
+ #:target-os (installation-target-os-for-gui-tests)))
(define %test-gui-installed-os-encrypted
- (guided-installation-test "gui-installed-os-encrypted"
- #:encrypted? #t))
+ (guided-installation-test
+ "gui-installed-os-encrypted"
+ #:encrypted? #t
+ #:target-os (installation-target-os-for-gui-tests
+ #:encrypted? #t)))
+
+;; Building a desktop image is very time and space consuming. Install all
+;; desktop environments in a single test to reduce the overhead.
+(define %test-gui-installed-desktop-os-encrypted
+ (guided-installation-test "gui-installed-desktop-os-encrypted"
+ #:desktop? #t
+ #:encrypted? #t
+ #:target-os
+ (installation-target-desktop-os-for-gui-tests
+ #:encrypted? #t)
+ ;; XXX: The disk-image size guess is too low. Use
+ ;; a constant value until this is fixed.
+ #:install-size (* 8000 MiB)
+ #:target-size (* 9000 MiB)))
;;; install.scm ends here