[jackhill/guix/guix.git] / tests / guix-system.sh

# GNU Guix --- Functional package management for GNU
# Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
# Copyright © 2017 Tobias Geerinckx-Rice <me@tobias.gr>
# Copyright © 2018 Chris Marusich <cmmarusich@gmail.com>
#
# 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 'guix system', mostly error reporting.
#

set -e

guix system --version

tmpfile="t-guix-system-$$"
errorfile="t-guix-system-error-$$"

# Note: This directory is chosen outside $builddir so that relative file name
# canonicalization doesn't mess up with 'current-source-directory', used by
# 'local-file' ('load' forces 'relative' for
# %FILE-PORT-NAME-CANONICALIZATION.)
tmpdir="${TMPDIR:-/tmp}/t-guix-system-$$"
mkdir "$tmpdir"

trap 'rm -f "$tmpfile" "$errorfile" "$tmpdir"/*; rmdir "$tmpdir"' EXIT

# Reporting of syntax errors.

cat > "$tmpfile"<<EOF
;; This is line 1, and the next one is line 2.
   (operating-system)
;; The 'T' is at column 3.
EOF

if guix system vm "$tmpfile" 2> "$errorfile"
then
    # This must not succeed.
    exit 1
else
    grep "$tmpfile:2:3:.*missing.* initializers" "$errorfile"
fi


cat > "$tmpfile"<<EOF
;; This is line 1, and the next one is line 2.
   (operating-system
;; This is line 3, and there is no closing paren!
EOF

if guix system vm "$tmpfile" 2> "$errorfile"
then
    # This must not succeed.
    exit 1
else
    grep "$tmpfile:4:1: missing closing paren" "$errorfile"
fi


# Reporting of module not found errors.

cat > "$tmpfile" <<EOF
;; Line 1.
(use-modules (gnu))
  (use-service-modules openssh)
EOF

if guix system build "$tmpfile" -n 2> "$errorfile"
then false
else
    grep "$tmpfile:3:2: .*module .*openssh.*not found" "$errorfile"
    grep "Try.*use-service-modules ssh" "$errorfile"
fi

cat > "$tmpfile" <<EOF
;; Line 1.
(use-modules (gnu))
  (use-package-modules qemu)
EOF

if guix system build "$tmpfile" -n 2> "$errorfile"
then false
else
    grep "$tmpfile:3:2: .*module .*qemu.*not found" "$errorfile"
    grep "Try.*use-package-modules virtualization" "$errorfile"
fi

# Reporting of unbound variables.

cat > "$tmpfile" <<EOF
(use-modules (gnu))                                   ; 1
(use-service-modules networking)                      ; 2

(operating-system                                     ; 4
  (host-name "antelope")                              ; 5
  (timezone "Europe/Paris")                           ; 6
  (locale "en_US.UTF-8")                              ; 7

  (bootloader (GRUB-config (target "/dev/sdX")))      ; 9
  (file-systems (cons (file-system
                        (device (file-system-label "root"))
                        (mount-point "/")
                        (type "ext4"))
                      %base-file-systems)))
EOF

if guix system build "$tmpfile" -n 2> "$errorfile"
then false
else
    if test "`guile -c '(display (effective-version))'`" = 3.0
    then
	# FIXME: With Guile 3.3.0 the error is reported on line 11.
	# See <https://bugs.gnu.org/38388>.
	grep "$tmpfile:[0-9]\+:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
    elif test "`guile -c '(display (effective-version))'`" = 2.2
    then
	# FIXME: With Guile 2.2.0 the error is reported on line 4.
	# See <http://bugs.gnu.org/26107>.
	grep "$tmpfile:[49]:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
    else
	grep "$tmpfile:9:[0-9]\+:.*GRUB-config.*[Uu]nbound variable" "$errorfile"
    fi
fi

cat > "$tmpfile" <<EOF
(use-modules (gnu))                                    ; 1

(operating-system                                      ; 3
  (file-systems (cons (file-system                     ; 4
                        (device (file-system-label "root"))
                        (mount-point "/")              ; 6
                        (type "ext4"))))               ; 7 (!!)
                      %base-file-systems)
EOF

if guix system build "$tmpfile" -n 2> "$errorfile"
then false
else
    # Here '%base-file-systems' appears as if it were a field specified of the
    # enclosing 'operating-system' form due to parenthesis mismatch.
    grep "$tmpfile:3:[0-9]\+:.*%base-file-system.*invalid field specifier" \
	 "$errorfile"
fi

OS_BASE='
  (host-name "antelope")
  (timezone "Europe/Paris")
  (locale "en_US.UTF-8")

  (bootloader (bootloader-configuration
               (bootloader grub-bootloader)
               (target "/dev/sdX")))
  (file-systems (cons (file-system
                        (device (file-system-label "root"))
                        (mount-point "/")
                        (type "ext4"))
                      %base-file-systems))
'

# Reporting of duplicate service identifiers.

cat > "$tmpfile" <<EOF
(use-modules (gnu))
(use-service-modules networking)

(operating-system
  $OS_BASE
  (services (cons* (service dhcp-client-service-type)
                   (service dhcp-client-service-type) ;twice!
                   %base-services)))
EOF

if guix system vm "$tmpfile" 2> "$errorfile"
then
    # This must not succeed.
    exit 1
else
    grep "service 'networking'.*more than once" "$errorfile"
fi

# Reporting unmet shepherd requirements.

cat > "$tmpfile" <<EOF
(use-modules (gnu) (gnu services shepherd))
(use-service-modules networking)

(define buggy-service-type
  (shepherd-service-type
    'buggy
    (lambda _
      (shepherd-service
        (provision '(buggy!))
        (requirement '(does-not-exist))
        (start #t)))))

(operating-system
  $OS_BASE
  (services (cons (service buggy-service-type #t)
                  %base-services)))
EOF

if guix system build "$tmpfile" 2> "$errorfile"
then
    exit 1
else
    grep "service 'buggy!'.*'does-not-exist'.*not provided" "$errorfile"
fi

# Reporting inconsistent user accounts.

make_user_config ()
{
    cat > "$tmpfile" <<EOF
(use-modules (gnu))
(use-service-modules networking)

(operating-system
  (host-name "antelope")
  (timezone "Europe/Paris")
  (locale "en_US.UTF-8")

  (bootloader (bootloader-configuration
                (bootloader grub-bootloader)
                (target "/dev/sdX")))
  (file-systems (cons (file-system
                        (device (file-system-label "root"))
                        (mount-point "/")
                        (type "ext4"))
                      %base-file-systems))
  (users (list (user-account
                 (name "dave")
                 (home-directory "/home/dave")
                 (group "$1")
                 (supplementary-groups '("$2"))))))
EOF
}

make_user_config "users" "wheel"
guix system build "$tmpfile" -n       # succeeds

guix system build "$tmpfile" -d	      # succeeds
guix system build "$tmpfile" -d | grep '\.drv$'

guix system vm "$tmpfile" -d	      # succeeds
guix system vm "$tmpfile" -d | grep '\.drv$'

# Make sure the behavior is deterministic (<https://bugs.gnu.org/32652>).
drv1="`guix system vm "$tmpfile" -d`"
drv2="`guix system vm "$tmpfile" -d`"
test "$drv1" = "$drv2"
drv1="`guix system disk-image --file-system-type=iso9660 "$tmpfile" -d`"
drv2="`guix system disk-image --file-system-type=iso9660 "$tmpfile" -d`"
test "$drv1" = "$drv2"

make_user_config "group-that-does-not-exist" "users"
if guix system build "$tmpfile" -n 2> "$errorfile"
then false
else grep "primary group.*group-that-does-not-exist.*undeclared" "$errorfile"; fi

make_user_config "users" "group-that-does-not-exist"
if guix system build "$tmpfile" -n 2> "$errorfile"
then false
else grep "supplementary group.*group-that-does-not-exist.*undeclared" "$errorfile"; fi

# Try 'local-file' and relative file name resolution.

cat > "$tmpdir/config.scm"<<EOF
(use-modules (gnu))
(use-service-modules networking)

(operating-system
  $OS_BASE
  (services (cons (service tor-service-type
                           (tor-configuration
                             (config-file (local-file "my-torrc"))))
                  %base-services)))
EOF

cat > "$tmpdir/my-torrc"<<EOF
# This is an example file.
EOF

# In both cases 'my-torrc' should be properly resolved.
guix system build "$tmpdir/config.scm" -n
(cd "$tmpdir"; guix system build "config.scm" -n)

# Searching.
guix system search tor | grep "^name: tor"
guix system search tor | grep "^shepherdnames: tor"
guix system search anonym network | grep "^name: tor"

# Below, use -n (--dry-run) for the tests because if we actually tried to
# build these images, the commands would take hours to run in the worst case.

# Verify that the examples can be built.
for example in gnu/system/examples/*.tmpl; do
    if echo "$example" | grep hurd; then
        target="--target=i586-pc-gnu"
    else
        target=
    fi
    guix system -n disk-image $target "$example"
done

# Verify that the disk image types can be built.
guix system -n vm gnu/system/examples/vm-image.tmpl
guix system -n vm-image gnu/system/examples/vm-image.tmpl
# This invocation was taken care of in the loop above:
# guix system -n disk-image gnu/system/examples/bare-bones.tmpl
guix system -n disk-image --file-system-type=iso9660 gnu/system/examples/bare-bones.tmpl
guix system -n docker-image gnu/system/examples/docker-image.tmpl
Commit	Line	Data
c1202fb1	1	# GNU Guix --- Functional package management for GNU
47212fc7	2	# Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
fdfdecdb	3	# Copyright © 2017 Tobias Geerinckx-Rice <me@tobias.gr>
8e88f6fa	4	# Copyright © 2018 Chris Marusich <cmmarusich@gmail.com>
c1202fb1 LC	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	#
9d3994f7	22	# Test 'guix system', mostly error reporting.
c1202fb1 LC	23	#
	24
	25	set -e
	26
	27	guix system --version
	28
	29	tmpfile="t-guix-system-$$"
	30	errorfile="t-guix-system-error-$$"
9d3994f7 LC	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
c1202fb1	40
116244df LC	41	# Reporting of syntax errors.
116244df LC	42
c1202fb1 LC	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
116244df LC	56
116244df LC	57
a6e22d84 LC	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
c5a4a92f LC	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
2abcc97f LC	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
f61e6e52	112	(bootloader (GRUB-config (target "/dev/sdX"))) ; 9
2abcc97f	113	(file-systems (cons (file-system
9ceeca08	114	(device (file-system-label "root"))
2abcc97f LC	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
1bb30aa3 LC	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
13159c68 LC	129	then
	130	# FIXME: With Guile 2.2.0 the error is reported on line 4.
	131	# See <http://bugs.gnu.org/26107>.
7acdecec	132	grep "$tmpfile:[49]:[0-9]\+:.GRUB-config.[Uu]nbound variable" "$errorfile"
13159c68	133	else
7acdecec	134	grep "$tmpfile:9:[0-9]\+:.GRUB-config.[Uu]nbound variable" "$errorfile"
13159c68	135	fi
2abcc97f LC	136	fi
2abcc97f LC	137
47212fc7 LC	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
2d2651e7	158	OS_BASE='
116244df LC	159	(host-name "antelope")
	160	(timezone "Europe/Paris")
	161	(locale "en_US.UTF-8")
	162
fdfdecdb TGR	163	(bootloader (bootloader-configuration
fdfdecdb TGR	164	(bootloader grub-bootloader)
f61e6e52	165	(target "/dev/sdX")))
116244df	166	(file-systems (cons (file-system
9ceeca08	167	(device (file-system-label "root"))
116244df LC	168	(mount-point "/")
	169	(type "ext4"))
	170	%base-file-systems))
2d2651e7	171	'
116244df	172
2d2651e7 LC	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
39d7fdce LC	181	(services (cons* (service dhcp-client-service-type)
39d7fdce LC	182	(service dhcp-client-service-type) ;twice!
116244df LC	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
0c09a306	193
0190c1c0	194	# Reporting unmet shepherd requirements.
2d2651e7 LC	195
2d2651e7 LC	196	cat > "$tmpfile" <<EOF
0190c1c0	197	(use-modules (gnu) (gnu services shepherd))
2d2651e7 LC	198	(use-service-modules networking)
	199
	200	(define buggy-service-type
d4053c71	201	(shepherd-service-type
2d2651e7 LC	202	'buggy
2d2651e7 LC	203	(lambda _
d4053c71	204	(shepherd-service
2d2651e7 LC	205	(provision '(buggy!))
	206	(requirement '(does-not-exist))
	207	(start #t)))))
	208
	209	(operating-system
	210	$OS_BASE
	211	(services (cons (service buggy-service-type #t)
	212	%base-services)))
	213	EOF
	214
	215	if guix system build "$tmpfile" 2> "$errorfile"
	216	then
	217	exit 1
	218	else
a8492735	219	grep "service 'buggy!'.'does-not-exist'.not provided" "$errorfile"
2d2651e7 LC	220	fi
	221
	222	# Reporting inconsistent user accounts.
	223
0c09a306 LC	224	make_user_config ()
	225	{
	226	cat > "$tmpfile" <<EOF
	227	(use-modules (gnu))
	228	(use-service-modules networking)
	229
	230	(operating-system
	231	(host-name "antelope")
	232	(timezone "Europe/Paris")
	233	(locale "en_US.UTF-8")
	234
fdfdecdb TGR	235	(bootloader (bootloader-configuration
fdfdecdb TGR	236	(bootloader grub-bootloader)
f61e6e52	237	(target "/dev/sdX")))
0c09a306	238	(file-systems (cons (file-system
9ceeca08	239	(device (file-system-label "root"))
0c09a306 LC	240	(mount-point "/")
	241	(type "ext4"))
	242	%base-file-systems))
	243	(users (list (user-account
	244	(name "dave")
	245	(home-directory "/home/dave")
	246	(group "$1")
	247	(supplementary-groups '("$2"))))))
	248	EOF
	249	}
	250
	251	make_user_config "users" "wheel"
	252	guix system build "$tmpfile" -n # succeeds
	253
f3f427c2 LC	254	guix system build "$tmpfile" -d # succeeds
	255	guix system build "$tmpfile" -d \| grep '\.drv$'
	256
	257	guix system vm "$tmpfile" -d # succeeds
	258	guix system vm "$tmpfile" -d \| grep '\.drv$'
	259
1540075c LC	260	# Make sure the behavior is deterministic (<https://bugs.gnu.org/32652>).
	261	drv1="`guix system vm "$tmpfile" -d`"
	262	drv2="`guix system vm "$tmpfile" -d`"
	263	test "$drv1" = "$drv2"
	264	drv1="`guix system disk-image --file-system-type=iso9660 "$tmpfile" -d`"
	265	drv2="`guix system disk-image --file-system-type=iso9660 "$tmpfile" -d`"
	266	test "$drv1" = "$drv2"
	267
0c09a306 LC	268	make_user_config "group-that-does-not-exist" "users"
	269	if guix system build "$tmpfile" -n 2> "$errorfile"
	270	then false
	271	else grep "primary group.group-that-does-not-exist.undeclared" "$errorfile"; fi
	272
	273	make_user_config "users" "group-that-does-not-exist"
	274	if guix system build "$tmpfile" -n 2> "$errorfile"
	275	then false
	276	else grep "supplementary group.group-that-does-not-exist.undeclared" "$errorfile"; fi
9d3994f7 LC	277
	278	# Try 'local-file' and relative file name resolution.
	279
	280	cat > "$tmpdir/config.scm"<<EOF
	281	(use-modules (gnu))
	282	(use-service-modules networking)
	283
	284	(operating-system
	285	$OS_BASE
84a2de36 LC	286	(services (cons (service tor-service-type
	287	(tor-configuration
	288	(config-file (local-file "my-torrc"))))
9d3994f7 LC	289	%base-services)))
	290	EOF
	291
	292	cat > "$tmpdir/my-torrc"<<EOF
	293	# This is an example file.
	294	EOF
	295
	296	# In both cases 'my-torrc' should be properly resolved.
	297	guix system build "$tmpdir/config.scm" -n
	298	(cd "$tmpdir"; guix system build "config.scm" -n)
0649321d LC	299
	300	# Searching.
	301	guix system search tor \| grep "^name: tor"
6ac8b735	302	guix system search tor \| grep "^shepherdnames: tor"
0649321d	303	guix system search anonym network \| grep "^name: tor"
8e88f6fa CM	304
	305	# Below, use -n (--dry-run) for the tests because if we actually tried to
	306	# build these images, the commands would take hours to run in the worst case.
	307
	308	# Verify that the examples can be built.
09a9f109	309	for example in gnu/system/examples/*.tmpl; do
59bcffa3 JN	310	if echo "$example" \| grep hurd; then
	311	target="--target=i586-pc-gnu"
	312	else
	313	target=
	314	fi
	315	guix system -n disk-image $target "$example"
8e88f6fa CM	316	done
	317
	318	# Verify that the disk image types can be built.
	319	guix system -n vm gnu/system/examples/vm-image.tmpl
	320	guix system -n vm-image gnu/system/examples/vm-image.tmpl
	321	# This invocation was taken care of in the loop above:
	322	# guix system -n disk-image gnu/system/examples/bare-bones.tmpl
	323	guix system -n disk-image --file-system-type=iso9660 gnu/system/examples/bare-bones.tmpl
	324	guix system -n docker-image gnu/system/examples/docker-image.tmpl