tests/guix-system.sh

   1 # GNU Guix --- Functional package management for GNU
   2 # Copyright © 2014-2022 Ludovic Courtès <ludo@gnu.org>
   3 # Copyright © 2017 Tobias Geerinckx-Rice <me@tobias.gr>
   4 # Copyright © 2018 Chris Marusich <cmmarusich@gmail.com>
   5 #
   6 # This file is part of GNU Guix.
   7 #
   8 # GNU Guix is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or (at
  11 # your option) any later version.
  12 #
  13 # GNU Guix is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 #
  22 # Test 'guix system', mostly error reporting.
  23 #
  24
  25 set -e
  26
  27 guix system --version
  28
  29 tmpfile="t-guix-system-$$"
  30 errorfile="t-guix-system-error-$$"
  31
  32 # Note: This directory is chosen outside $builddir so that relative file name
  33 # canonicalization doesn't mess up with 'current-source-directory', used by
  34 # 'local-file' ('load' forces 'relative' for
  35 # %FILE-PORT-NAME-CANONICALIZATION.)
  36 tmpdir="${TMPDIR:-/tmp}/t-guix-system-$$"
  37 mkdir "$tmpdir"
  38
  39 trap 'rm -f "$tmpfile" "$errorfile" "$tmpdir"/*; rmdir "$tmpdir"' EXIT
  40
  41 # Reporting of syntax errors.
  42
  43 cat > "$tmpfile"<<EOF
  44 ;; This is line 1, and the next one is line 2.
  45    (operating-system)
  46 ;; The 'T' is at column 3.
  47 EOF
  48
  49 if guix system vm "$tmpfile" 2> "$errorfile"
  50 then
  51     # This must not succeed.
  52     exit 1
  53 else
  54     cat "$errorfile"
  55     grep "$tmpfile:2:3:.*missing.* initializers" "$errorfile"
  56 fi
  57
  58
  59 cat > "$tmpfile"<<EOF
  60 ;; This is line 1, and the next one is line 2.
  61    (operating-system
  62 ;; This is line 3, and there is no closing paren!
  63 EOF
  64
  65 if guix system vm "$tmpfile" 2> "$errorfile"
  66 then
  67     # This must not succeed.
  68     exit 1
  69 else
  70     cat "$errorfile"
  71
  72     # Guile 3.0.6 gets line/column numbers for 'read-error' wrong
  73     # (zero-indexed): <https://bugs.gnu.org/48089>.
  74     grep "$tmpfile:4:1: missing closing paren" "$errorfile" || \
  75     grep "$tmpfile:3:0: missing closing paren" "$errorfile"
  76 fi
  77
  78
  79 # Reporting of module not found errors.
  80
  81 cat > "$tmpfile" <<EOF
  82 ;; Line 1.
  83 (use-modules (gnu))
  84   (use-service-modules openssh)
  85 EOF
  86
  87 if guix system build "$tmpfile" -n 2> "$errorfile"
  88 then false
  89 else
  90     grep "$tmpfile:3:2: .*module .*openssh.*not found" "$errorfile"
  91     grep "Try.*use-service-modules ssh" "$errorfile"
  92 fi
  93
  94 cat > "$tmpfile" <<EOF
  95 ;; Line 1.
  96 (use-modules (gnu))
  97   (use-package-modules qemu)
  98 EOF
  99
 100 if guix system build "$tmpfile" -n 2> "$errorfile"
 101 then false
 102 else
 103     grep "$tmpfile:3:2: .*module .*qemu.*not found" "$errorfile"
 104     grep "Try.*use-package-modules virtualization" "$errorfile"
 105 fi
 106
 107 # Reporting of unbound variables.
 108
 109 cat > "$tmpfile" <<EOF
 110 (use-modules (gnu))                                   ; 1
 111 (use-service-modules networking)                      ; 2
 112
 113 (operating-system                                     ; 4
 114   (host-name "antelope")                              ; 5
 115   (timezone "Europe/Paris")                           ; 6
 116   (locale "en_US.UTF-8")                              ; 7
 117
 118   (bootloader (GRUB-config (targets (list "/dev/sdX"))))        ; 9
 119   (file-systems (cons (file-system
 120                         (device (file-system-label "root"))
 121                         (mount-point "/")
 122                         (type "ext4"))
 123                       %base-file-systems)))
 124 EOF
 125
 126 if guix system build "$tmpfile" -n 2> "$errorfile"
 127 then false
 128 else
 129     if test "`guile -c '(display (effective-version))'`" = 3.0
 130     then
 131         # FIXME: With Guile 3.3.0 the error is reported on line 11.
 132         # See <https://bugs.gnu.org/38388>.
 133         grep "$tmpfile:[0-9]\+:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
 134     elif test "`guile -c '(display (effective-version))'`" = 2.2
 135     then
 136         # FIXME: With Guile 2.2.0 the error is reported on line 4.
 137         # See <http://bugs.gnu.org/26107>.
 138         grep "$tmpfile:[49]:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
 139     else
 140         grep "$tmpfile:9:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
 141     fi
 142 fi
 143
 144 cat > "$tmpfile" <<EOF
 145 (use-modules (gnu))                                    ; 1
 146
 147 (operating-system                                      ; 3
 148   (file-systems (cons (file-system                     ; 4
 149                         (device (file-system-label "root"))
 150                         (mount-point "/")              ; 6
 151                         (type "ext4"))))               ; 7 (!!)
 152                       %base-file-systems)
 153 EOF
 154
 155 if guix system build "$tmpfile" -n 2> "$errorfile"
 156 then false
 157 else
 158     # Here '%base-file-systems' appears as if it were a field specified of the
 159     # enclosing 'operating-system' form due to parenthesis mismatch.
 160     grep "$tmpfile:3:[0-9]\+:.*%base-file-system.*invalid field specifier" \
 161          "$errorfile"
 162 fi
 163
 164 OS_BASE='
 165   (host-name "antelope")
 166   (timezone "Europe/Paris")
 167   (locale "en_US.UTF-8")
 168
 169   (bootloader (bootloader-configuration
 170                (bootloader grub-bootloader)
 171                (targets (list "/dev/sdX"))))
 172   (file-systems (cons (file-system
 173                         (device (file-system-label "root"))
 174                         (mount-point "/")
 175                         (type "ext4"))
 176                       %base-file-systems))
 177 '
 178
 179 # Reporting of duplicate service identifiers.
 180
 181 cat > "$tmpfile" <<EOF
 182 (use-modules (gnu))
 183 (use-service-modules networking)
 184
 185 (operating-system
 186   $OS_BASE
 187   (services (cons* (service dhcp-client-service-type)
 188                    (service dhcp-client-service-type) ;twice!
 189                    %base-services)))
 190 EOF
 191
 192 if guix system vm "$tmpfile" 2> "$errorfile"
 193 then
 194     # This must not succeed.
 195     exit 1
 196 else
 197     grep "service 'networking'.*more than once" "$errorfile"
 198 fi
 199
 200 # Reporting unmet shepherd requirements.
 201
 202 cat > "$tmpfile" <<EOF
 203 (use-modules (gnu) (gnu services shepherd))
 204 (use-service-modules networking)
 205
 206 (define buggy-service-type
 207   (shepherd-service-type
 208     'buggy
 209     (lambda _
 210       (shepherd-service
 211         (provision '(buggy!))
 212         (requirement '(does-not-exist))
 213         (start #t)))
 214     (description "Buggy.")))
 215
 216 (operating-system
 217   $OS_BASE
 218   (services (cons (service buggy-service-type #t)
 219                   %base-services)))
 220 EOF
 221
 222 if guix system build "$tmpfile" 2> "$errorfile"
 223 then
 224     exit 1
 225 else
 226     grep "service 'buggy!'.*'does-not-exist'.*not provided" "$errorfile"
 227 fi
 228
 229 # Reporting inconsistent user accounts.
 230
 231 make_user_config ()
 232 {
 233     cat > "$tmpfile" <<EOF
 234 (use-modules (gnu))
 235 (use-service-modules networking)
 236
 237 (operating-system
 238   (host-name "antelope")
 239   (timezone "Europe/Paris")
 240   (locale "en_US.UTF-8")
 241
 242   (bootloader (bootloader-configuration
 243                 (bootloader grub-bootloader)
 244                 (targets (list "/dev/sdX"))))
 245   (file-systems (cons (file-system
 246                         (device (file-system-label "root"))
 247                         (mount-point "/")
 248                         (type "ext4"))
 249                       %base-file-systems))
 250   (users (list (user-account
 251                  (name "dave")
 252                  (home-directory "/home/dave")
 253                  (group "$1")
 254                  (supplementary-groups '("$2"))))))
 255 EOF
 256 }
 257
 258 make_user_config "users" "wheel"
 259 guix system build "$tmpfile" -n       # succeeds
 260
 261 guix system build "$tmpfile" -d       # succeeds
 262 guix system build "$tmpfile" -d | grep '\.drv$'
 263
 264 guix system vm "$tmpfile" -d          # succeeds
 265 guix system vm "$tmpfile" -d | grep '\.drv$'
 266
 267 # Make sure the behavior is deterministic (<https://bugs.gnu.org/32652>).
 268 drv1="`guix system vm "$tmpfile" -d`"
 269 drv2="`guix system vm "$tmpfile" -d`"
 270 test "$drv1" = "$drv2"
 271 drv1="`guix system image -t iso9660 "$tmpfile" -d`"
 272 drv2="`guix system image -t iso9660 "$tmpfile" -d`"
 273 test "$drv1" = "$drv2"
 274
 275 # Check whether the graph commands work as expected.
 276 guix system extension-graph "$tmpfile" | grep 'label = "file-systems"'
 277 guix system shepherd-graph "$tmpfile" | grep 'label = "guix-daemon"'
 278
 279 make_user_config "group-that-does-not-exist" "users"
 280 if guix system build "$tmpfile" -n 2> "$errorfile"
 281 then false
 282 else grep "primary group.*group-that-does-not-exist.*undeclared" "$errorfile"; fi
 283
 284 make_user_config "users" "group-that-does-not-exist"
 285 if guix system build "$tmpfile" -n 2> "$errorfile"
 286 then false
 287 else grep "supplementary group.*group-that-does-not-exist.*undeclared" "$errorfile"; fi
 288
 289 # Try 'local-file' and relative file name resolution.
 290
 291 cat > "$tmpdir/config.scm"<<EOF
 292 (use-modules (gnu))
 293 (use-service-modules networking)
 294
 295 (operating-system
 296   $OS_BASE
 297   (services (cons (service tor-service-type
 298                            (tor-configuration
 299                              (config-file (local-file "my-torrc"))))
 300                   %base-services)))
 301 EOF
 302
 303 cat > "$tmpdir/my-torrc"<<EOF
 304 # This is an example file.
 305 EOF
 306
 307 # In both cases 'my-torrc' should be properly resolved.
 308 guix system build "$tmpdir/config.scm" -n
 309 (cd "$tmpdir"; guix system build "config.scm" -n)
 310
 311 # Check that we get a warning when passing 'local-file' a non-literal relative
 312 # file name.
 313 cat > "$tmpdir/config.scm" <<EOF
 314 (use-modules (guix))
 315
 316 (define (bad-local-file file)
 317   (local-file file))
 318
 319 (bad-local-file "whatever.scm")
 320 EOF
 321 ! guix system build "$tmpdir/config.scm" -n
 322 guix system build "$tmpdir/config.scm" -n 2>&1 | \
 323     grep "config\.scm:4:2: warning:.*whatever.*relative to current directory"
 324
 325 # Searching.
 326 guix system search tor | grep "^name: tor"
 327 guix system search tor | grep "^shepherdnames: tor"
 328 guix system search anonym network | grep "^name: tor"
 329 guix system search . > "$tmpdir/search"
 330 test $(wc -l < "$tmpdir/search") -gt 500
 331 rm "$tmpdir/search"
 332
 333 # Below, use -n (--dry-run) for the tests because if we actually tried to
 334 # build these images, the commands would take hours to run in the worst case.
 335
 336 # Verify that the examples can be built.
 337 for example in gnu/system/examples/*.tmpl; do
 338     case "$example" in
 339         *hurd*)
 340             options="--target=i586-pc-gnu";;
 341         *asus*)
 342             # 'asus-c201.tmpl' uses 'linux-libre-arm-generic', which is an
 343             # ARM-only package.
 344             options="--system=armhf-linux";;
 345         *vm-image*)
 346             # The VM image tries to build 'current-guix' as per 'guix pull'.
 347             # Skip it.
 348             continue
 349             ;;
 350         *)
 351             options=""
 352             ;;
 353     esac
 354     guix system -n disk-image $options "$example"
 355 done
 356
 357 # Make sure the desktop image can be built on major architectures.
 358 for system in x86_64-linux i686-linux aarch64-linux
 359 do
 360     guix system -n image -s "$system" gnu/system/examples/desktop.tmpl
 361 done
 362
 363 # Verify that the images can be built.
 364 guix system -n vm gnu/system/examples/bare-bones.tmpl
 365 guix system -n image gnu/system/images/pinebook-pro.scm
 366 guix system -n image -t qcow2 gnu/system/examples/bare-bones.tmpl
 367 guix system -n image -t iso9660 gnu/system/examples/bare-bones.tmpl
 368 guix system -n docker-image gnu/system/examples/docker-image.tmpl
 369
 370 # Verify that at least the raw image type is available.
 371 guix system --list-image-types | grep "raw"