aboutsummaryrefslogtreecommitdiff
path: root/tests/guix-pack.sh
blob: 3204e821cfac88aa9ea114ca9638fd227accfc66 (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# GNU Guix --- Functional package management for GNU
# Copyright © 2018 Chris Marusich <cmmarusich@gmail.com>
# Copyright © 2018, 2019, 2020, 2022, 2023 Ludovic Courtès <ludo@gnu.org>
#
# This file is part of GNU Guix.
#
# GNU Guix is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or (at
# your option) any later version.
#
# GNU Guix is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

#
# Test the `guix pack' command-line utility.
#

# A network connection is required to build %bootstrap-coreutils&co,
# which is required to run these tests with the --bootstrap option.
if ! guile -c '(getaddrinfo "www.gnu.org" "80" AI_NUMERICSERV)' 2> /dev/null; then
    exit 77
fi

guix pack --version

# Use --no-substitutes because we need to verify we can do this ourselves.
# Use --no-grafts to avoid interference--e.g., --dry-run passing even when
# given an unsupported package.
GUIX_BUILD_OPTIONS="--no-substitutes --no-grafts"
export GUIX_BUILD_OPTIONS

test_directory="`mktemp -d`"
trap 'chmod -Rf +w "$test_directory"; rm -rf "$test_directory"' EXIT

# Reject unsuppoted packages.
guix pack intelmetool -s armhf-linux -n && false

# Compute the derivation of a pack.
drv="`guix pack coreutils -d --no-grafts`"
guix gc -R "$drv" | grep "`guix build coreutils -d --no-grafts`"

# Compute the derivation of a cross-compiled pack.  Make sure it refers to the
# cross-compiled package and not to the native package.
drv="`guix pack idutils -d --no-grafts --target=arm-linux-gnueabihf`"
guix gc -R "$drv" | \
    grep "`guix build idutils --target=arm-linux-gnueabihf -d --no-grafts`"
guix gc -R "$drv" | grep "`guix build idutils -d --no-grafts`" && false

# Build a tarball with no compression.
guix pack --compression=none --bootstrap guile-bootstrap

# Build a tarball (with compression).  Check that '-e' works as well.
out1="`guix pack --bootstrap guile-bootstrap`"
out2="`guix pack --bootstrap -e '(@ (gnu packages bootstrap) %bootstrap-guile)'`"
test -n "$out1"
test "$out1" = "$out2"

# Test '--root'.
guix pack -r "$test_directory/my-guile" --bootstrap guile-bootstrap
test "`readlink "$test_directory/my-guile"`" = "$out1"
guix gc --list-roots | grep "^$test_directory/my-guile$"
rm "$test_directory/my-guile"

# Build a tarball with a symlink.
the_pack="`guix pack --bootstrap -S /opt/gnu/bin=bin guile-bootstrap`"

# Try to extract it.  Note: we cannot test whether /opt/gnu/bin/guile itself
# exists because /opt/gnu/bin may be an absolute symlink to a store item that
# has been GC'd.
cd "$test_directory"
tar -xf "$the_pack"
test -L opt/gnu/bin

is_available () {
    # Use the "type" shell builtin to see if the program is on PATH.
    type "$1" > /dev/null
}

if is_available chroot && is_available unshare && unshare -r true; then
    # Verify we can use what we built.
    unshare -r chroot . /opt/gnu/bin/guile --version
    cd -
else
    echo "warning: skipped some verification because chroot or unshare is unavailable" >&2
fi

# For the tests that build Docker images below, we currently have to use
# --dry-run because if we don't, there are only two possible cases:
#
#     Case 1: We do not use --bootstrap, and the build takes hours to finish
#             because it needs to build tar etc.
#
#     Case 2: We use --bootstrap, and the build fails because the bootstrap
#             Guile cannot dlopen shared libraries.  Not to mention the fact
#             that we would still have to build many non-bootstrap inputs
#             (e.g., guile-json) in order to create the Docker image.

# Build a Docker image.
guix pack --dry-run --bootstrap -f docker guile-bootstrap

# Build a Docker image with a symlink.
guix pack --dry-run --bootstrap -f docker -S /opt/gnu= guile-bootstrap

# Build a tarball pack of cross-compiled software.  Use coreutils because
# guile-bootstrap is not intended to be cross-compiled.
guix pack --dry-run --bootstrap --target=arm-linux-gnueabihf coreutils

# Likewise, 'guix pack -R' requires a full-blown toolchain (because
# 'glibc-bootstrap' lacks 'libc.a'), hence '--dry-run'.
guix pack -R --dry-run --bootstrap -S /mybin=bin guile-bootstrap

# Make sure package transformation options are honored.
chmod -Rf +w "$test_directory"; rm -r "$test_directory"
mkdir -p "$test_directory" -m 755
drv1="`guix pack --no-grafts -n guile 2>&1 | grep pack.*\.drv`"
drv2="`guix pack --no-grafts -n --with-source=guile=$test_directory guile 2>&1 | grep pack.*\.drv`"
test -n "$drv1"
test "$drv1" != "$drv2"

# Try '--manifest' options.
cat > "$test_directory/manifest1.scm" <<EOF
(specifications->manifest '("guile"))
EOF
cat > "$test_directory/manifest2.scm" <<EOF
(specifications->manifest '("emacs"))
EOF
drv="`guix pack --no-grafts -d -m "$test_directory/manifest1.scm" -m "$test_directory/manifest2.scm"`"
guix gc -R "$drv" | grep `guix build guile -d --no-grafts`
guix gc -R "$drv" | grep `guix build emacs -d --no-grafts`
marionette-eval marionette-control marionette-screen-text wait-for-screen-text %qwerty-us-keystrokes marionette-type)) ;;; Commentary: ;;; ;;; Instrumentation tools for QEMU virtual machines (VMs). A "marionette" is ;;; essentially a VM (a QEMU instance) with its monitor connected to a ;;; Unix-domain socket, and with a REPL inside the guest listening on a ;;; virtual console, which is itself connected to the host via a Unix-domain ;;; socket--these are the marionette's strings, connecting it to the almighty ;;; puppeteer. ;;; ;;; Code: (define-record-type <marionette> (marionette command pid monitor repl) marionette? (command marionette-command) ;list of strings (pid marionette-pid) ;integer (monitor marionette-monitor) ;port (repl %marionette-repl)) ;promise of a port (define-syntax-rule (marionette-repl marionette) (force (%marionette-repl marionette))) (define* (wait-for-monitor-prompt port #:key (quiet? #t)) "Read from PORT until we have seen all of QEMU's monitor prompt. When QUIET? is false, the monitor's output is written to the current output port." (define full-prompt (string->list "(qemu) ")) (let loop ((prompt full-prompt) (matches '()) (prefix '())) (match prompt (() ;; It's useful to set QUIET? so we don't display the echo of our own ;; commands. (unless quiet? (for-each (lambda (line) (format #t "qemu monitor: ~a~%" line)) (string-tokenize (list->string (reverse prefix)) (char-set-complement (char-set #\newline)))))) ((chr rest ...) (let ((read (read-char port))) (cond ((eqv? read chr) (loop rest (cons read matches) prefix)) ((eof-object? read) (error "EOF while waiting for QEMU monitor prompt" (list->string (reverse prefix)))) (else (loop full-prompt '() (cons read (append matches prefix)))))))))) (define* (make-marionette command #:key (socket-directory "/tmp") (timeout 20)) "Return a QEMU marionette--i.e., a virtual machine with open connections to the QEMU monitor and to the guest's backdoor REPL." (define (file->sockaddr file) (make-socket-address AF_UNIX (string-append socket-directory "/" file))) (define extra-options (list "-nographic" "-monitor" (string-append "unix:" socket-directory "/monitor") "-chardev" (string-append "socket,id=repl,path=" socket-directory "/repl") "-device" "virtio-serial" "-device" "virtconsole,chardev=repl")) (define (accept* port) (match (select (list port) '() (list port) timeout) (((port) () ()) (accept port)) (_ (error "timeout in 'accept'" port)))) (let ((monitor (socket AF_UNIX SOCK_STREAM 0)) (repl (socket AF_UNIX SOCK_STREAM 0))) (bind monitor (file->sockaddr "monitor")) (listen monitor 1) (bind repl (file->sockaddr "repl")) (listen repl 1) (match (primitive-fork) (0 (catch #t (lambda () (close monitor) (close repl) (match command ((program . args) (apply execl program program (append args extra-options))))) (lambda (key . args) (print-exception (current-error-port) (stack-ref (make-stack #t) 1) key args) (primitive-exit 1)))) (pid (format #t "QEMU runs as PID ~a~%" pid) (match (accept* monitor) ((monitor-conn . _) (display "connected to QEMU's monitor\n") (close-port monitor) (wait-for-monitor-prompt monitor-conn) (display "read QEMU monitor prompt\n") (marionette (append command extra-options) pid monitor-conn ;; The following 'accept' call connects immediately, but ;; we don't know whether the guest has connected until ;; we actually receive the 'ready' message. (match (accept* repl) ((repl-conn . addr) (display "connected to guest REPL\n") (close-port repl) ;; Delay reception of the 'ready' message so that the ;; caller can already send monitor commands. (delay (match (read repl-conn) ('ready (display "marionette is ready\n") repl-conn)))))))))))) (define (marionette-eval exp marionette) "Evaluate EXP in MARIONETTE's backdoor REPL. Return the result." (match marionette (($ <marionette> command pid monitor (= force repl)) (write exp repl) (newline repl) (read repl)))) (define (marionette-control command marionette) "Run COMMAND in the QEMU monitor of MARIONETTE. COMMAND is a string such as \"sendkey ctrl-alt-f1\" or \"screendump foo.ppm\" (info \"(qemu-doc) pcsys_monitor\")." (match marionette (($ <marionette> _ _ monitor) (display command monitor) (newline monitor) (wait-for-monitor-prompt monitor)))) (define* (marionette-screen-text marionette #:key (ocrad "ocrad")) "Take a screenshot of MARIONETTE, perform optical character recognition (OCR), and return the text read from the screen as a string. Do this by invoking OCRAD (file name for GNU Ocrad's command)" (define (random-file-name) (string-append "/tmp/marionette-screenshot-" (number->string (random (expt 2 32)) 16) ".ppm")) (let ((image (random-file-name))) (dynamic-wind (const #t) (lambda () (marionette-control (string-append "screendump " image) marionette) ;; Tell Ocrad to invert the image colors (make it black on white) and ;; to scale the image up, which significantly improves the quality of ;; the result. In spite of this, be aware that OCR confuses "y" and ;; "V" and sometimes erroneously introduces white space. (let* ((pipe (open-pipe* OPEN_READ ocrad "-i" "-s" "10" image)) (text (get-string-all pipe))) (unless (zero? (close-pipe pipe)) (error "'ocrad' failed" ocrad)) text)) (lambda () (false-if-exception (delete-file image)))))) (define* (wait-for-screen-text marionette predicate #:key (timeout 30) (ocrad "ocrad")) "Wait for TIMEOUT seconds or until the screen text on MARIONETTE matches PREDICATE, whichever comes first. Raise an error when TIMEOUT is exceeded." (define start (car (gettimeofday))) (define end (+ start timeout)) (let loop () (if (> (car (gettimeofday)) end) (error "'wait-for-screen-text' timeout" predicate) (or (predicate (marionette-screen-text marionette #:ocrad ocrad)) (begin (sleep 1) (loop)))))) (define %qwerty-us-keystrokes ;; Maps "special" characters to their keystrokes. '((#\newline . "ret") (#\space . "spc") (#\- . "minus") (#\+ . "shift-equal") (#\* . "shift-8") (#\= . "equal") (#\? . "shift-slash") (#\[ . "bracket_left") (#\] . "bracket_right") (#\( . "shift-9") (#\) . "shift-0") (#\/ . "slash") (#\< . "less") (#\> . "shift-less") (#\. . "dot") (#\, . "comma") (#\; . "semicolon") (#\bs . "backspace") (#\tab . "tab"))) (define* (string->keystroke-commands str #:optional (keystrokes %qwerty-us-keystrokes)) "Return a list of QEMU monitor commands to send the keystrokes corresponding to STR. KEYSTROKES is an alist specifying a mapping from characters to keystrokes." (string-fold-right (lambda (chr result) (cons (string-append "sendkey " (or (assoc-ref keystrokes chr) (string chr))) result)) '() str)) (define* (marionette-type str marionette #:key (keystrokes %qwerty-us-keystrokes)) "Type STR on MARIONETTE's keyboard, using the KEYSTROKES alist to map characters to actual keystrokes." (for-each (cut marionette-control <> marionette) (string->keystroke-commands str keystrokes))) ;;; marionette.scm ends here