# GNU Guix --- Functional package management for GNU
# Copyright © 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
# Copyright © 2020 Eric Bavier <bavier@posteo.net>
#
# 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 --relocatable' using the external store, if any.
#

guix pack --version

# 'guix pack --relocatable' requires a C compiler and libc.a, which our
# bootstrap binaries don't provide.  To make the test relatively inexpensive,
# run it on the user's global store if possible, on the grounds that binaries
# may already be there or can be built or downloaded inexpensively.

storedir="`guile -c '(use-modules (guix config))(display %storedir)'`"
localstatedir="`guile -c '(use-modules (guix config))(display %localstatedir)'`"
NIX_STORE_DIR="$storedir"
GUIX_DAEMON_SOCKET="$localstatedir/guix/daemon-socket/socket"
export NIX_STORE_DIR GUIX_DAEMON_SOCKET

if ! guile -c '(use-modules (guix)) (exit (false-if-exception (open-connection)))'
then
    exit 77
fi

STORE_PARENT="`dirname $NIX_STORE_DIR`"
export STORE_PARENT
if test "$STORE_PARENT" = "/"; then exit 77; fi

if unshare -mrf sh -c 'mount -t tmpfs none "$STORE_PARENT"'
then
    # Test the wrapper that relies on user namespaces.
    relocatable_option="-R"
else
    case "`uname -m`" in
	x86_64|i?86)
	    # Test the wrapper that falls back to PRoot.
	    relocatable_option="-RR";;
	*)
	    # XXX: Our 'proot' package currently fails tests on non-Intel
	    # architectures, so skip this by default.
	    exit 77;;
    esac
fi

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

export relocatable_option
tarball="`guix pack $relocatable_option -S /Bin=bin sed`"
(cd "$test_directory"; tar xvf "$tarball")

if unshare -r true		# Are user namespaces supported?
then
    # Run that relocatable 'sed' in a user namespace where we "erase" the store by
    # mounting an empty file system on top of it.  That way, we exercise the
    # wrapper code that creates the user namespace and bind-mounts the store.
    unshare -mrf sh -c 'mount -t tmpfs none "$STORE_PARENT"; echo "$STORE_PARENT"/*; "$test_directory/Bin/sed" --version > "$test_directory/output"'

    # Check whether the exit code is preserved.
    if unshare -mrf sh -c 'mount -t tmpfs none "$STORE_PARENT"; echo "$STORE_PARENT"/*; "$test_directory/Bin/sed" --does-not-exist';
    then false; else true; fi
else
    # Run the relocatable 'sed' in the current namespaces.  This is a weak
    # test because we're going to access store items from the host store.
    "$test_directory/Bin/sed" --version > "$test_directory/output"
fi
grep 'GNU sed' "$test_directory/output"
chmod -Rf +w "$test_directory"; rm -rf "$test_directory"/*

case "`uname -m`" in
    x86_64|i?86)
	# Try '-RR' and PRoot.
	tarball="`guix pack -RR -S /Bin=bin sed`"
	tar tvf "$tarball" | grep /bin/proot
	(cd "$test_directory"; tar xvf "$tarball")
	GUIX_EXECUTION_ENGINE="proot"
	export GUIX_EXECUTION_ENGINE
	"$test_directory/Bin/sed" --version > "$test_directory/output"
	grep 'GNU sed' "$test_directory/output"

	# Now with fakechroot.
	GUIX_EXECUTION_ENGINE="fakechroot"
	"$test_directory/Bin/sed" --version > "$test_directory/output"
	grep 'GNU sed' "$test_directory/output"
	unset GUIX_EXECUTION_ENGINE

	chmod -Rf +w "$test_directory"; rm -rf "$test_directory"/*
	;;
    *)
	echo "skipping PRoot test" >&2
	;;
esac

# Ensure '-R' works with outputs other than "out".
tarball="`guix pack -R -S /share=share groff:doc`"
(cd "$test_directory"; tar xvf "$tarball")
test -d "$test_directory/share/doc/groff/html"
chmod -Rf +w "$test_directory"; rm -rf "$test_directory"/*

# Ensure '-R' applies to propagated inputs.  Failing to do that, it would fail
# with a profile collision error in this case because 'python-scipy'
# propagates 'python-numpy'.  See <https://bugs.gnu.org/42510>.
guix pack -RR python-numpy python-scipy --no-grafts -n

# Check that packages that mix executable and support files (e.g. git) in the
# "binary" directories still work after wrapped.
cat >"$test_directory/manifest.scm" <<'EOF'
(use-modules (guix) (guix profiles)
             (gnu packages bootstrap))
(manifest
 (list (manifest-entry
	(name "test") (version "0")
	(item (file-union "test"
			  `(("bin/hello"
			     ,(program-file
                               "hello"
                               #~(format #t "~d~%" (load "../libexec/msg"))
                               #:guile %bootstrap-guile))
			    ("libexec/msg"
			     ,(plain-file "msg" "42"))))))))
EOF
tarball="`guix pack $relocatable_option -S /opt= -m $test_directory/manifest.scm`"
(cd "$test_directory"; tar xvf "$tarball")
do_test='"$test_directory/opt/bin/hello" >"$test_directory/output"'
if unshare -r true		# Are user namespaces supported?
then
    unshare -mrf sh -c 'mount -t tmpfs none "$STORE_PARENT"; '"$do_test"
else
    ( $do_test )
fi
test "`cat $test_directory/output`" = "42"