[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
02/02: scripts: environment: Build environments as profiles.
|
From: |
David Thompson |
|
Subject: |
02/02: scripts: environment: Build environments as profiles. |
|
Date: |
Mon, 21 Dec 2015 17:21:04 +0000 |
davexunit pushed a commit to branch wip-environment-profiles
in repository guix.
commit aac49c4c18681bdd01c81e965f38113c9d29bd7d
Author: David Thompson <address@hidden>
Date: Sat Oct 31 17:19:30 2015 -0400
scripts: environment: Build environments as profiles.
Fixes: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=19816
* guix/scripts/environment.scm (evaluate-input-search-paths,
build-inputs): Delete.
(evaluate-profile-search-paths, strip-input-name,
package-or-package+output?, package-environment-inputs,
build-environment, inputs->profile-derivations): New procedures.
(create-environment, show-search-paths, launch-environment,
launch-environment/container): Replace 'inputs' argument
with 'profile' argument.
(package+propagated-inputs): Strip off names off of input tuples.
(options/resolve-packages): Handle input tuples that specify an output
in expressions.
(guix-environment): Convert inputs into a profile to use in the
environment. Remove non-package inputs such as origins from
environment inputs.
* doc/guix.texi ("invoking guix environment"): Document package+output
tuples for --expression option.
* tests/guix-environment.sh: Update tests.
* tests/guix-environment-container.sh: Likewise.
---
doc/guix.texi | 7 +
guix/scripts/environment.scm | 239 +++++++++++++++++++----------------
tests/guix-environment-container.sh | 2 +-
tests/guix-environment.sh | 61 +++++++---
4 files changed, 184 insertions(+), 125 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index e12bc9f..0383550 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -4891,6 +4891,13 @@ guix environment --ad-hoc -e '(@@ (gnu) %base-packages)'
starts a shell with all the GuixSD base packages available.
+The above commands only the use default output of the given packages.
+To select other outputs, two element tuples can be specified:
+
address@hidden
+guix environment --ad-hoc -e '(list (@ (gnu packages bash) bash) "include")'
address@hidden example
+
@item address@hidden
@itemx -l @var{file}
Create an environment for the package or list of packages that the code
diff --git a/guix/scripts/environment.scm b/guix/scripts/environment.scm
index 2cc5f36..0e462de 100644
--- a/guix/scripts/environment.scm
+++ b/guix/scripts/environment.scm
@@ -35,6 +35,9 @@
#:use-module (gnu system file-systems)
#:use-module (gnu packages)
#:use-module (gnu packages bash)
+ #:use-module (gnu packages commencement)
+ #:use-module (gnu packages guile)
+ #:use-module ((gnu packages bootstrap) #:select (%bootstrap-guile))
#:use-module (ice-9 format)
#:use-module (ice-9 match)
#:use-module (ice-9 rdelim)
@@ -45,19 +48,10 @@
#:use-module (srfi srfi-98)
#:export (guix-environment))
-(define (evaluate-input-search-paths inputs search-paths)
+(define (evaluate-profile-search-paths profile search-paths)
"Evaluate SEARCH-PATHS, a list of search-path specifications, for the
-directories corresponding to INPUTS, a list of (DERIVATION) or (DERIVATION
-OUTPUT) tuples."
- (let ((directories (map (match-lambda
- (((? derivation? drv))
- (derivation->output-path drv))
- (((? derivation? drv) output)
- (derivation->output-path drv output))
- (((? string? item))
- item))
- inputs)))
- (evaluate-search-paths search-paths directories)))
+directories in PROFILE, the store path of a profile."
+ (evaluate-search-paths search-paths (list profile)))
;; Protect some env vars from purification. Borrowed from nix-shell.
(define %precious-variables
@@ -81,11 +75,10 @@ as 'HOME' and 'USER' are left untouched."
(((names . _) ...)
names)))))
-(define (create-environment inputs paths pure?)
- "Set the environment variables specified by PATHS for all the packages
-within INPUTS. When PURE? is #t, unset the variables in the current
-environment. Otherwise, augment existing enviroment variables with additional
-search paths."
+(define (create-environment profile paths pure?)
+ "Set the environment variables specified by PATHS for PROFILE. When PURE?
+is #t, unset the variables in the current environment. Otherwise, augment
+existing enviroment variables with additional search paths."
(when pure? (purify-environment))
(for-each (match-lambda
((($ <search-path-specification> variable _ separator) . value)
@@ -94,15 +87,14 @@ search paths."
(if (and current (not pure?))
(string-append value separator current)
value)))))
- (evaluate-input-search-paths inputs paths))
+ (evaluate-profile-search-paths profile paths))
;; Give users a way to know that they're in 'guix environment', so they can
;; adjust 'PS1' accordingly, for instance.
(setenv "GUIX_ENVIRONMENT" "t"))
-(define (show-search-paths inputs search-paths pure?)
- "Display SEARCH-PATHS applied to the packages specified by INPUTS, a list of
- (DERIVATION) or (DERIVATION OUTPUT) tuples. When PURE? is #t, do not augment
+(define (show-search-paths profile search-paths pure?)
+ "Display SEARCH-PATHS applied to PROFILE. When PURE? is #t, do not augment
existing environment variables with additional search paths."
(for-each (match-lambda
((search-path . value)
@@ -110,12 +102,37 @@ existing environment variables with additional search
paths."
(search-path-definition search-path value
#:kind (if pure? 'exact 'prefix)))
(newline)))
- (evaluate-input-search-paths inputs search-paths)))
+ (evaluate-profile-search-paths profile search-paths)))
+
+(define (strip-input-name input)
+ "Remove the name element from the tuple INPUT."
+ (match input
+ ((_ package) package)
+ ((_ package output)
+ (list package output))))
(define (package+propagated-inputs package output)
"Return the union of PACKAGE's OUTPUT and its transitive propagated inputs."
- `((,(package-name package) ,package ,output)
- ,@(package-transitive-propagated-inputs package)))
+ (cons (list package output)
+ (map strip-input-name
+ (package-transitive-propagated-inputs package))))
+
+(define (package-or-package+output? expr)
+ "Return #t if EXPR is a package or a 2 element list consisting of a package
+and an output string."
+ (match expr
+ ((or (? package?) ; bare package object
+ ((? package?) (? string?))) ; package+output tuple
+ #t)
+ (_ #f)))
+
+(define (package-environment-inputs package)
+ "Return a list of the transitive input packages for PACKAGE."
+ ;; Remove non-package inputs such as origin records.
+ (filter package-or-package+output?
+ (map strip-input-name
+ (bag-transitive-inputs
+ (package->bag package)))))
(define (show-help)
(display (_ "Usage: guix environment [OPTION]... PACKAGE... [-- COMMAND...]
@@ -252,17 +269,19 @@ COMMAND or an interactive shell in that environment.\n"))
(define (options/resolve-packages opts)
"Return OPTS with package specification strings replaced by actual
packages."
- (define (package->outputs package mode)
- (map (lambda (output)
- (list mode package output))
- (package-outputs package)))
+ (define (package->output package mode)
+ (match package
+ ((? package?)
+ (list mode package "out"))
+ (((? package? package) (? string? output))
+ (list mode package output))))
(define (packages->outputs packages mode)
(match packages
- ((? package? package)
- (package->outputs package mode))
- (((? package? packages) ...)
- (append-map (cut package->outputs <> mode) packages))))
+ ((? package-or-package+output? package) ; single package
+ (list (package->output package mode)))
+ (((? package-or-package+output?) ...) ; many packages
+ (map (cut package->output <> mode) packages))))
(compact
(append-map (match-lambda
@@ -280,22 +299,30 @@ packages."
(_ '(#f)))
opts)))
-(define (build-inputs inputs opts)
- "Build the derivations in INPUTS, a list of (DERIVATION) or (DERIVATION
-OUTPUT) tuples, using the build options in OPTS."
+(define* (build-environment derivations opts)
+ "Build the DERIVATIONS required by the environment using the build options
+in OPTS."
(let ((substitutes? (assoc-ref opts 'substitutes?))
(dry-run? (assoc-ref opts 'dry-run?)))
- (match inputs
- (((derivations _ ...) ...)
- (mbegin %store-monad
- (show-what-to-build* derivations
- #:use-substitutes? substitutes?
- #:dry-run? dry-run?)
- (if dry-run?
- (return #f)
- (mbegin %store-monad
- (built-derivations derivations)
- (return derivations))))))))
+ (mbegin %store-monad
+ (show-what-to-build* derivations
+ #:use-substitutes? substitutes?
+ #:dry-run? dry-run?)
+ (if dry-run?
+ (return #f)
+ (mbegin %store-monad
+ (set-build-options-from-command-line* opts)
+ (built-derivations derivations))))))
+
+(define (inputs->profile-derivation inputs system bootstrap?)
+ "Return the derivation for a profile consisting of INPUTS for SYSTEM.
+BOOTSTRAP? specifies whether to use the bootstrap Guile to build the
+profile."
+ (profile-derivation (packages->manifest inputs)
+ #:system system
+ #:hooks (if bootstrap?
+ '()
+ %default-profile-hooks)))
(define requisites* (store-lift requisites))
@@ -334,16 +361,15 @@ variables are cleared before setting the new ones."
(apply system* command))
(define* (launch-environment/container #:key command bash user-mappings
- inputs paths network?)
- "Run COMMAND within a Linux container. The environment features INPUTS, a
-list of derivations to be shared from the host system. Environment variables
-are set according to PATHS, a list of native search paths. The global shell
-is BASH, a file name for a GNU Bash binary in the store. When NETWORK?,
-access to the host system network is permitted. USER-MAPPINGS, a list of file
-system mappings, contains the user-specified host file systems to mount inside
-the container."
+ profile paths network?)
+ "Run COMMAND within a container that features the software in PROFILE.
+Environment variables are set according to PATHS, a list of native search
+paths. The global shell is BASH, a file name for a GNU Bash binary in the
+store. When NETWORK?, access to the host system network is permitted.
+USER-MAPPINGS, a list of file system mappings, contains the user-specified
+host file systems to mount inside the container."
(mlet %store-monad ((reqs (inputs->requisites
- (cons (direct-store-path bash) inputs))))
+ (list (direct-store-path bash) profile))))
(return
(let* ((cwd (getcwd))
;; Bind-mount all requisite store items, user-specified mappings,
@@ -408,7 +434,7 @@ the container."
(primitive-exit/status
;; A container's environment is already purified, so no need to
;; request it be purified again.
- (launch-environment command inputs paths #f)))
+ (launch-environment command profile paths #f)))
#:namespaces (if network?
(delq 'net %namespaces) ; share host network
%namespaces)))))))
@@ -482,64 +508,65 @@ message if any test fails."
(('ad-hoc-package package output)
(package+propagated-inputs package
output))
- (('package package output)
- (bag-transitive-inputs
- (package->bag package))))
+ (('package package _)
+ (package-environment-inputs package)))
packages)))
(paths (delete-duplicates
(cons $PATH
(append-map (match-lambda
- ((label (? package? p) _ ...)
- (package-native-search-paths p))
- (_
- '()))
+ ((or ((? package? p) _ ...)
+ (? package? p))
+ (package-native-search-paths p))
+ (_ '()))
inputs))
eq?)))
(when container? (assert-container-features))
(with-store store
- (set-build-options-from-command-line store opts)
- (run-with-store store
- (mlet* %store-monad ((inputs (lower-inputs
- (map (match-lambda
- ((label item)
- (list item))
- ((label item output)
- (list item output)))
- inputs)
- #:system system))
- ;; Containers need a Bourne shell at /bin/sh.
- (bash (environment-bash container?
- bootstrap?
- system)))
- (mbegin %store-monad
+ ;; Use the bootstrap Guile when requested.
+ (parameterize ((%guile-for-build
+ (package-derivation
+ store
+ (if bootstrap?
+ %bootstrap-guile
+ (canonical-package guile-2.0)))))
+ (set-build-options-from-command-line store opts)
+ (run-with-store store
+ ;; Containers need a Bourne shell at /bin/sh.
+ (mlet* %store-monad ((bash (environment-bash container?
+ bootstrap?
+ system))
+ (prof-drv (inputs->profile-derivation
+ inputs system bootstrap?))
+ (profile -> (derivation->output-path
prof-drv)))
;; First build the inputs. This is necessary even for
- ;; --search-paths. Additionally, we might need to build bash
- ;; for a container.
- (build-inputs (if (derivation? bash)
- `((,bash "out") ,@inputs)
- inputs)
- opts)
- (cond
- ((assoc-ref opts 'dry-run?)
- (return #t))
- ((assoc-ref opts 'search-paths)
- (show-search-paths inputs paths pure?)
- (return #t))
- (container?
- (let ((bash-binary
- (if bootstrap?
- bash
- (string-append (derivation->output-path bash)
- "/bin/sh"))))
- (launch-environment/container #:command command
- #:bash bash-binary
- #:user-mappings mappings
- #:inputs inputs
- #:paths paths
- #:network? network?)))
- (else
- (return
- (exit/status
- (launch-environment command inputs paths pure?))))))))))))
+ ;; --search-paths. Additionally, we might need to build bash for
+ ;; a container.
+ (mbegin %store-monad
+ (build-environment (if (derivation? bash)
+ (list prof-drv bash)
+ (list prof-drv))
+ opts)
+ (cond
+ ((assoc-ref opts 'dry-run?)
+ (return #t))
+ ((assoc-ref opts 'search-paths)
+ (show-search-paths profile paths pure?)
+ (return #t))
+ (container?
+ (let ((bash-binary
+ (if bootstrap?
+ bash
+ (string-append (derivation->output-path bash)
+ "/bin/sh"))))
+ (launch-environment/container #:command command
+ #:bash bash-binary
+ #:user-mappings mappings
+ #:profile profile
+ #:paths paths
+ #:network? network?)))
+ (else
+ (return
+ (exit/status
+ (launch-environment command profile paths
pure?)))))))))))))
diff --git a/tests/guix-environment-container.sh
b/tests/guix-environment-container.sh
index 703ab31..aba34a3 100644
--- a/tests/guix-environment-container.sh
+++ b/tests/guix-environment-container.sh
@@ -73,7 +73,7 @@ guix environment --container --ad-hoc --bootstrap
guile-bootstrap \
-- guile -c "$mount_test_code" > $tmpdir/mounts
cat "$tmpdir/mounts"
-test `wc -l < $tmpdir/mounts` -eq 3
+test `wc -l < $tmpdir/mounts` -eq 4
current_dir="`cd $PWD; pwd -P`"
grep -e "$current_dir$" $tmpdir/mounts # current directory
diff --git a/tests/guix-environment.sh b/tests/guix-environment.sh
index aed27c1..a1161a4 100644
--- a/tests/guix-environment.sh
+++ b/tests/guix-environment.sh
@@ -34,17 +34,23 @@ mkdir "$tmpdir"
export SHELL
# Check the environment variables for the bootstrap Guile.
-guix environment --ad-hoc guile-bootstrap --pure --search-paths > "$tmpdir/a"
-guix environment --ad-hoc guile-bootstrap:out --pure --search-paths >
"$tmpdir/b"
+guix environment --bootstrap --ad-hoc guile-bootstrap --pure \
+ --search-paths > "$tmpdir/a"
+guix environment --bootstrap --ad-hoc guile-bootstrap:out --pure \
+ --search-paths > "$tmpdir/b"
# $PATH must appear in the search paths, and nothing else.
-grep -E '^export PATH=.*guile-bootstrap-[0-9.]+/bin' "$tmpdir/a"
+grep -E '^export PATH=.*profile/bin' "$tmpdir/a"
test "`wc -l < "$tmpdir/a"`" = 1
+# Guile must be on $PATH.
+test -e $(sed -r 's/^export PATH="(.*)"/\1/' "$tmpdir/a")/guile
+
cmp "$tmpdir/a" "$tmpdir/b"
# Make sure the exit value is preserved.
-if guix environment --ad-hoc guile-bootstrap --pure -- guile -c '(exit 42)'
+if guix environment --bootstrap --ad-hoc guile-bootstrap --pure \
+ -- guile -c '(exit 42)'
then
false
else
@@ -52,7 +58,8 @@ else
fi
# Same as above, but with deprecated -E flag.
-if guix environment --ad-hoc guile-bootstrap --pure -E "guile -c '(exit 42)'"
+if guix environment --bootstrap --ad-hoc guile-bootstrap --pure \
+ -E "guile -c '(exit 42)'"
then
false
else
@@ -62,8 +69,25 @@ fi
if guile -c '(getaddrinfo "www.gnu.org" "80" AI_NUMERICSERV)' 2> /dev/null
then
# Compute the build environment for the initial GNU Make.
- guix environment -e '(@@ (gnu packages commencement) gnu-make-boot0)' \
- --no-substitutes --search-paths --pure > "$tmpdir/a"
+ guix environment --bootstrap --no-substitutes --search-paths --pure \
+ -e '(@@ (gnu packages commencement) gnu-make-boot0)' > "$tmpdir/a"
+
+ # Make sure bootstrap binaries are in the profile.
+ ls $(grep "^export PATH" "$tmpdir/a" | sed -r 's/^.*="(.*)"/\1/') \
+ > "$tmpdir/path"
+
+ grep gcc "$tmpdir/path"
+ grep cat "$tmpdir/path"
+ grep readelf "$tmpdir/path"
+
+ # Check for glibc and gcc headers.
+ ls $(grep "^export CPATH" "$tmpdir/a" | sed -r 's/^.*="(.*)"/\1/') \
+ > "$tmpdir/cpath"
+
+ grep "stdio.h" "$tmpdir/cpath" # glibc
+ grep "c++" "$tmpdir/cpath" # gcc c++ Includes directory
+
+ exit 0
# Make sure the bootstrap binaries are all listed where they belong.
grep -E '^export PATH=.*-bootstrap-binaries-0/bin' "$tmpdir/a"
@@ -76,8 +100,8 @@ then
# Make sure that the shell spawned with '--exec' sees the same environment
# as returned by '--search-paths'.
- guix environment -e '(@@ (gnu packages commencement) gnu-make-boot0)'
\
- --no-substitutes --pure
\
+ guix environment --bootstrap --no-substitutes --pure \
+ -e '(@@ (gnu packages commencement) gnu-make-boot0)' \
-- /bin/sh -c 'echo $PATH $CPATH $LIBRARY_PATH' > "$tmpdir/b"
( . "$tmpdir/a" ; echo $PATH $CPATH $LIBRARY_PATH ) > "$tmpdir/c"
cmp "$tmpdir/b" "$tmpdir/c"
@@ -85,8 +109,8 @@ then
rm "$tmpdir"/*
# Compute the build environment for the initial GNU Findutils.
- guix environment -e '(@@ (gnu packages commencement) findutils-boot0)' \
- --no-substitutes --search-paths --pure > "$tmpdir/a"
+ guix environment --bootstrap --no-substitutes --search-paths --pure \
+ -e '(@@ (gnu packages commencement) findutils-boot0)' > "$tmpdir/a"
# Make sure the bootstrap binaries are all listed where they belong.
grep -E '^export PATH=.*-bootstrap-binaries-0/bin' "$tmpdir/a"
@@ -104,9 +128,9 @@ then
# Compute the build environment for the initial GNU Make, but add in the
# bootstrap Guile as an ad-hoc addition.
- guix environment -e '(@@ (gnu packages commencement) gnu-make-boot0)' \
- --ad-hoc guile-bootstrap --no-substitutes --search-paths \
- --pure > "$tmpdir/a"
+ guix environment --bootstrap --ad-hoc guile-bootstrap --no-substitutes \
+ --search-paths --pure \
+ -e '(@@ (gnu packages commencement) gnu-make-boot0)' > "$tmpdir/a"
# Make sure the bootstrap binaries are all listed where they belong.
cat $tmpdir/a
@@ -116,13 +140,14 @@ then
grep -E '^export CPATH=.*-glibc-bootstrap-0/include' "$tmpdir/a"
grep -E '^export LIBRARY_PATH=.*-glibc-bootstrap-0/lib' "$tmpdir/a"
- # Make sure a package list can be used with -e.
+ # Make sure a package list with plain package objects and package+output
+ # tuples can be used with -e.
expr_list_test_code="
(list (@@ (gnu packages commencement) gnu-make-boot0)
- (@ (gnu packages bootstrap) %bootstrap-guile))"
+ (list (@ (gnu packages bootstrap) %bootstrap-guile) \"out\"))"
- guix environment --ad-hoc --no-substitutes --search-paths --pure \
- -e "$expr_list_test_code" > "$tmpdir/a"
+ guix environment --bootstrap --ad-hoc --no-substitutes --search-paths \
+ --pure -e "$expr_list_test_code" > "$tmpdir/a"
grep -E '^export PATH=.*-make-boot0-4.1/bin' "$tmpdir/a"
grep -E '^export PATH=.*-guile-bootstrap-2.0/bin' "$tmpdir/a"