tests/guix-system.sh

   1 # GNU Guix --- Functional package management for GNU
   2 # Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021 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     grep "$tmpfile:2:3:.*missing.* initializers" "$errorfile"
  55 fi
  56
  57
  58 cat > "$tmpfile"<<EOF
  59 ;; This is line 1, and the next one is line 2.
  60    (operating-system
  61 ;; This is line 3, and there is no closing paren!
  62 EOF
  63
  64 if guix system vm "$tmpfile" 2> "$errorfile"
  65 then
  66     # This must not succeed.
  67     exit 1
  68 else
  69     grep "$tmpfile:4:1: missing closing paren" "$errorfile"
  70 fi
  71
  72
  73 # Reporting of module not found errors.
  74
  75 cat > "$tmpfile" <<EOF
  76 ;; Line 1.
  77 (use-modules (gnu))
  78   (use-service-modules openssh)
  79 EOF
  80
  81 if guix system build "$tmpfile" -n 2> "$errorfile"
  82 then false
  83 else
  84     grep "$tmpfile:3:2: .*module .*openssh.*not found" "$errorfile"
  85     grep "Try.*use-service-modules ssh" "$errorfile"
  86 fi
  87
  88 cat > "$tmpfile" <<EOF
  89 ;; Line 1.
  90 (use-modules (gnu))
  91   (use-package-modules qemu)
  92 EOF
  93
  94 if guix system build "$tmpfile" -n 2> "$errorfile"
  95 then false
  96 else
  97     grep "$tmpfile:3:2: .*module .*qemu.*not found" "$errorfile"
  98     grep "Try.*use-package-modules virtualization" "$errorfile"
  99 fi
 100
 101 # Reporting of unbound variables.
 102
 103 cat > "$tmpfile" <<EOF
 104 (use-modules (gnu))                                   ; 1
 105 (use-service-modules networking)                      ; 2
 106
 107 (operating-system                                     ; 4
 108   (host-name "antelope")                              ; 5
 109   (timezone "Europe/Paris")                           ; 6
 110   (locale "en_US.UTF-8")                              ; 7
 111
 112   (bootloader (GRUB-config (target "/dev/sdX")))      ; 9
 113   (file-systems (cons (file-system
 114                         (device (file-system-label "root"))
 115                         (mount-point "/")
 116                         (type "ext4"))
 117                       %base-file-systems)))
 118 EOF
 119
 120 if guix system build "$tmpfile" -n 2> "$errorfile"
 121 then false
 122 else
 123     if test "`guile -c '(display (effective-version))'`" = 3.0
 124     then
 125         # FIXME: With Guile 3.3.0 the error is reported on line 11.
 126         # See <https://bugs.gnu.org/38388>.
 127         grep "$tmpfile:[0-9]\+:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
 128     elif test "`guile -c '(display (effective-version))'`" = 2.2
 129     then
 130         # FIXME: With Guile 2.2.0 the error is reported on line 4.
 131         # See <http://bugs.gnu.org/26107>.
 132         grep "$tmpfile:[49]:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
 133     else
 134         grep "$tmpfile:9:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
 135     fi
 136 fi
 137
 138 cat > "$tmpfile" <<EOF
 139 (use-modules (gnu))                                    ; 1
 140
 141 (operating-system                                      ; 3
 142   (file-systems (cons (file-system                     ; 4
 143                         (device (file-system-label "root"))
 144                         (mount-point "/")              ; 6
 145                         (type "ext4"))))               ; 7 (!!)
 146                       %base-file-systems)
 147 EOF
 148
 149 if guix system build "$tmpfile" -n 2> "$errorfile"
 150 then false
 151 else
 152     # Here '%base-file-systems' appears as if it were a field specified of the
 153     # enclosing 'operating-system' form due to parenthesis mismatch.
 154     grep "$tmpfile:3:[0-9]\+:.*%base-file-system.*invalid field specifier" \
 155          "$errorfile"
 156 fi
 157
 158 OS_BASE='
 159   (host-name "antelope")
 160   (timezone "Europe/Paris")
 161   (locale "en_US.UTF-8")
 162
 163   (bootloader (bootloader-configuration
 164                (bootloader grub-bootloader)
 165                (target "/dev/sdX")))
 166   (file-systems (cons (file-system
 167                         (device (file-system-label "root"))
 168                         (mount-point "/")
 169                         (type "ext4"))
 170                       %base-file-systems))
 171 '
 172
 173 # Reporting of duplicate service identifiers.
 174
 175 cat > "$tmpfile" <<EOF
 176 (use-modules (gnu))
 177 (use-service-modules networking)
 178
 179 (operating-system
 180   $OS_BASE
 181   (services (cons* (service dhcp-client-service-type)
 182                    (service dhcp-client-service-type) ;twice!
 183                    %base-services)))
 184 EOF
 185
 186 if guix system vm "$tmpfile" 2> "$errorfile"
 187 then
 188     # This must not succeed.
 189     exit 1
 190 else
 191     grep "service 'networking'.*more than once" "$errorfile"
 192 fi
 193
 194 # Reporting unmet shepherd requirements.
 195
 196 cat > "$tmpfile" <<EOF
 197 (use-modules (gnu) (gnu services shepherd))
 198 (use-service-modules networking)
 199
 200 (define buggy-service-type
 201   (shepherd-service-type
 202     'buggy
 203     (lambda _
 204       (shepherd-service
 205         (provision '(buggy!))
 206         (requirement '(does-not-exist))
 207         (start #t)))
 208     (description "Buggy.")))
 209
 210 (operating-system
 211   $OS_BASE
 212   (services (cons (service buggy-service-type #t)
 213                   %base-services)))
 214 EOF
 215
 216 if guix system build "$tmpfile" 2> "$errorfile"
 217 then
 218     exit 1
 219 else
 220     grep "service 'buggy!'.*'does-not-exist'.*not provided" "$errorfile"
 221 fi
 222
 223 # Reporting inconsistent user accounts.
 224
 225 make_user_config ()
 226 {
 227     cat > "$tmpfile" <<EOF
 228 (use-modules (gnu))
 229 (use-service-modules networking)
 230
 231 (operating-system
 232   (host-name "antelope")
 233   (timezone "Europe/Paris")
 234   (locale "en_US.UTF-8")
 235
 236   (bootloader (bootloader-configuration
 237                 (bootloader grub-bootloader)
 238                 (target "/dev/sdX")))
 239   (file-systems (cons (file-system
 240                         (device (file-system-label "root"))
 241                         (mount-point "/")
 242                         (type "ext4"))
 243                       %base-file-systems))
 244   (users (list (user-account
 245                  (name "dave")
 246                  (home-directory "/home/dave")
 247                  (group "$1")
 248                  (supplementary-groups '("$2"))))))
 249 EOF
 250 }
 251
 252 make_user_config "users" "wheel"
 253 guix system build "$tmpfile" -n       # succeeds
 254
 255 guix system build "$tmpfile" -d       # succeeds
 256 guix system build "$tmpfile" -d | grep '\.drv$'
 257
 258 guix system vm "$tmpfile" -d          # succeeds
 259 guix system vm "$tmpfile" -d | grep '\.drv$'
 260
 261 # Make sure the behavior is deterministic (<https://bugs.gnu.org/32652>).
 262 drv1="`guix system vm "$tmpfile" -d`"
 263 drv2="`guix system vm "$tmpfile" -d`"
 264 test "$drv1" = "$drv2"
 265 drv1="`guix system image -t iso9660 "$tmpfile" -d`"
 266 drv2="`guix system image -t iso9660 "$tmpfile" -d`"
 267 test "$drv1" = "$drv2"
 268
 269 make_user_config "group-that-does-not-exist" "users"
 270 if guix system build "$tmpfile" -n 2> "$errorfile"
 271 then false
 272 else grep "primary group.*group-that-does-not-exist.*undeclared" "$errorfile"; fi
 273
 274 make_user_config "users" "group-that-does-not-exist"
 275 if guix system build "$tmpfile" -n 2> "$errorfile"
 276 then false
 277 else grep "supplementary group.*group-that-does-not-exist.*undeclared" "$errorfile"; fi
 278
 279 # Try 'local-file' and relative file name resolution.
 280
 281 cat > "$tmpdir/config.scm"<<EOF
 282 (use-modules (gnu))
 283 (use-service-modules networking)
 284
 285 (operating-system
 286   $OS_BASE
 287   (services (cons (service tor-service-type
 288                            (tor-configuration
 289                              (config-file (local-file "my-torrc"))))
 290                   %base-services)))
 291 EOF
 292
 293 cat > "$tmpdir/my-torrc"<<EOF
 294 # This is an example file.
 295 EOF
 296
 297 # In both cases 'my-torrc' should be properly resolved.
 298 guix system build "$tmpdir/config.scm" -n
 299 (cd "$tmpdir"; guix system build "config.scm" -n)
 300
 301 # Check that we get a warning when passing 'local-file' a non-literal relative
 302 # file name.
 303 cat > "$tmpdir/config.scm" <<EOF
 304 (use-modules (guix))
 305
 306 (define (bad-local-file file)
 307   (local-file file))
 308
 309 (bad-local-file "whatever.scm")
 310 EOF
 311 ! guix system build "$tmpdir/config.scm" -n
 312 guix system build "$tmpdir/config.scm" -n 2>&1 | \
 313     grep "config\.scm:4:2: warning:.*whatever.*relative to current directory"
 314
 315 # Searching.
 316 guix system search tor | grep "^name: tor"
 317 guix system search tor | grep "^shepherdnames: tor"
 318 guix system search anonym network | grep "^name: tor"
 319 guix system search . > "$tmpdir/search"
 320 test $(wc -l < "$tmpdir/search") -gt 500
 321 rm "$tmpdir/search"
 322
 323 # Below, use -n (--dry-run) for the tests because if we actually tried to
 324 # build these images, the commands would take hours to run in the worst case.
 325
 326 # Verify that the examples can be built.
 327 for example in gnu/system/examples/*.tmpl; do
 328     if echo "$example" | grep hurd; then
 329         target="--target=i586-pc-gnu"
 330     else
 331         target=
 332     fi
 333     guix system -n disk-image $target "$example"
 334 done
 335
 336 # Verify that the disk image types can be built.
 337 guix system -n vm gnu/system/examples/vm-image.tmpl
 338 guix system -n vm-image gnu/system/examples/vm-image.tmpl
 339 # This invocation was taken care of in the loop above:
 340 # guix system -n disk-image gnu/system/examples/bare-bones.tmpl
 341 guix system -n disk-image -t iso9660 gnu/system/examples/bare-bones.tmpl
 342 guix system -n docker-image gnu/system/examples/docker-image.tmpl
 343
 344 # Verify that at least the raw image type is available.
 345 guix system --list-image-types | grep "raw"