[bug#30480] [PATCH] environment: Add --manifest option.

[bug#30480] [PATCH] environment: Add --manifest option.

[Thompson, David]

[-- Attachment #1: Type: text/plain, Size: 1003 bytes --]

In my lurkings I've seen people wondering why `guix environment`
doesn't work with manifests. The answer is simply: I never thought to
add it. This patch fixes that. The implementation is kind of
interesting and might seem a little silly to people that know how
manifests work.  In order to support manifests with minimal code and
make --manifest compose with other options I simply decompile the
manifest back into a list of package/output tuples.  That means in the
case of `guix environment --manifest=foo.scm` the manifest is created,
decompiled, and a new manifest created from that.  Seems redundant!
The advantage is that since --manifest composes with all the other
ways to specify packages we can do absolutely bonkers things like
`guix environment guile --ad-hoc ruby --manifest=foo.scm
--manifest=bar.scm --load=frob.scm --expression='(@ (gnu packages
python) python)'`.  More realistically you'd use it to throw in an
extra package or two with --ad-hoc.

Anyway, hope y'all like it.

- Dave

[-- Attachment #2: 0001-environment-Add-manifest-option.patch --]
[-- Type: text/x-patch, Size: 3986 bytes --]

From 47e0cf3bef26791c72222175899790a46c49af45 Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Thu, 15 Feb 2018 20:54:28 -0500
Subject: [PATCH] environment: Add --manifest option.

* guix/scripts/environment.scm (show-help, %options): Add -m/--manifest.
(options/resolve-packages): Handle manifests.
* doc/guix.texi (Invoking guix environment): Document it.
---
 doc/guix.texi                |  9 +++++++++
 guix/scripts/environment.scm | 22 +++++++++++++++++++++-
 2 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 7ed39ff13..16a352c8b 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -7231,6 +7231,15 @@ As an example, @var{file} might contain a definition like this
 @verbatiminclude environment-gdb.scm
 @end example
 
+@item --manifest=@var{file}
+@itemx -m @var{file}
+Create an environment for the packages contained in the manifest object
+returned by the Scheme code in @var{file}.
+
+This is similar to the same-named option in @command{guix package}
+(@pxref{profile-manifest, @option{--manifest}}) and uses the same
+manifest files.
+
 @item --ad-hoc
 Include all specified packages in the resulting environment, as if an
 @i{ad hoc} package were defined with them as inputs.  This option is
diff --git a/guix/scripts/environment.scm b/guix/scripts/environment.scm
index d2568e6a7..67da6fc3b 100644
--- a/guix/scripts/environment.scm
+++ b/guix/scripts/environment.scm
@@ -1,5 +1,5 @@
 ;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2014, 2015 David Thompson <davet@gnu.org>
+;;; Copyright © 2014, 2015, 2018 David Thompson <davet@gnu.org>
 ;;; Copyright © 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org>
 ;;;
 ;;; This file is part of GNU Guix.
@@ -141,6 +141,8 @@ COMMAND or an interactive shell in that environment.\n"))
   (display (G_ "
   -l, --load=FILE        create environment for the package that the code within
                          FILE evaluates to"))
+  (display (G_ "
+  -m, --manifest=FILE    create environment with the manifest from FILE"))
   (display (G_ "
       --ad-hoc           include all specified packages in the environment instead
                          of only their inputs"))
@@ -220,6 +222,11 @@ COMMAND or an interactive shell in that environment.\n"))
                    (alist-cons 'expression
                                (tag-package-arg result arg)
                                result)))
+         (option '(#\m "manifest") #t #f
+                 (lambda (opt name arg result)
+                   (alist-cons 'manifest
+                               arg
+                               result)))
          (option '("ad-hoc") #f #f
                  (lambda (opt name arg result)
                    (alist-cons 'ad-hoc? #t result)))
@@ -286,6 +293,16 @@ packages."
       (((? package-or-package+output?) ...) ; many packages
        (map (cut package->output <> mode) packages))))
 
+  (define (manifest->outputs manifest)
+    (map (lambda (entry)
+           (cons 'ad-hoc-package ; manifests are implicitly ad-hoc
+                 (if (package? (manifest-entry-item entry))
+                     (list (manifest-entry-item entry)
+                           (manifest-entry-output entry))
+                     ;; Direct store paths have no output.
+                     (list (manifest-entry-item entry)))))
+         (manifest-entries manifest)))
+
   (compact
    (append-map (match-lambda
                  (('package mode (? string? spec))
@@ -299,6 +316,9 @@ packages."
                   ;; Add all the outputs of the package defined in FILE.
                   (let ((module (make-user-module '())))
                     (packages->outputs (load* file module) mode)))
+                 (('manifest . file)
+                  (let ((module (make-user-module '())))
+                    (manifest->outputs (load* file module))))
                  (_ '(#f)))
                opts)))
 
-- 
2.16.1

[bug#30480] [PATCH] environment: Add --manifest option.

[Jan Nieuwenhuizen]

Thompson, David writes:

> In my lurkings I've seen people wondering why `guix environment`
> doesn't work with manifests. The answer is simply: I never thought to
> add it. This patch fixes that.

Ah :-)  I enjoyed reading your rationale and the elegant patch.

> Anyway, hope y'all like it.

Thank you, beautiful!
janneke

-- 
Jan Nieuwenhuizen <janneke@gnu.org> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | Avatar® http://AvatarAcademy.com

[bug#30480] [PATCH] environment: Add --manifest option.

[Ludovic Courtès]

Hi David!

"Thompson, David" <dthompson2@worcester.edu> skribis:

> In my lurkings I've seen people wondering why `guix environment`
> doesn't work with manifests. The answer is simply: I never thought to
> add it. This patch fixes that. The implementation is kind of
> interesting and might seem a little silly to people that know how
> manifests work.  In order to support manifests with minimal code and
> make --manifest compose with other options I simply decompile the
> manifest back into a list of package/output tuples.  That means in the
> case of `guix environment --manifest=foo.scm` the manifest is created,
> decompiled, and a new manifest created from that.  Seems redundant!
> The advantage is that since --manifest composes with all the other
> ways to specify packages we can do absolutely bonkers things like
> `guix environment guile --ad-hoc ruby --manifest=foo.scm
> --manifest=bar.scm --load=frob.scm --expression='(@ (gnu packages
> python) python)'`.  More realistically you'd use it to throw in an
> extra package or two with --ad-hoc.

Indeed, that makes a lot of sense.  I wondered about doing that for
‘guix pack’ as well, it turns out to be more shenanigans than we’d like.

> From 47e0cf3bef26791c72222175899790a46c49af45 Mon Sep 17 00:00:00 2001
> From: David Thompson <dthompson2@worcester.edu>
> Date: Thu, 15 Feb 2018 20:54:28 -0500
> Subject: [PATCH] environment: Add --manifest option.
>
> * guix/scripts/environment.scm (show-help, %options): Add -m/--manifest.
> (options/resolve-packages): Handle manifests.
> * doc/guix.texi (Invoking guix environment): Document it.

Could you add an example in tests/guix-environment.sh that uses a
manifest with the “guile-bootstrap” package for instance?

OK with this change!  :-)

Thank you,
Ludo’.

[bug#30480] [PATCH] environment: Add --manifest option.

[Thompson, David]

[-- Attachment #1: Type: text/plain, Size: 1978 bytes --]

Hey Ludo,

On Mon, Feb 19, 2018 at 4:21 PM, Ludovic Courtès <ludo@gnu.org> wrote:
> Hi David!
>
> "Thompson, David" <dthompson2@worcester.edu> skribis:
>
>> In my lurkings I've seen people wondering why `guix environment`
>> doesn't work with manifests. The answer is simply: I never thought to
>> add it. This patch fixes that. The implementation is kind of
>> interesting and might seem a little silly to people that know how
>> manifests work.  In order to support manifests with minimal code and
>> make --manifest compose with other options I simply decompile the
>> manifest back into a list of package/output tuples.  That means in the
>> case of `guix environment --manifest=foo.scm` the manifest is created,
>> decompiled, and a new manifest created from that.  Seems redundant!
>> The advantage is that since --manifest composes with all the other
>> ways to specify packages we can do absolutely bonkers things like
>> `guix environment guile --ad-hoc ruby --manifest=foo.scm
>> --manifest=bar.scm --load=frob.scm --expression='(@ (gnu packages
>> python) python)'`.  More realistically you'd use it to throw in an
>> extra package or two with --ad-hoc.
>
> Indeed, that makes a lot of sense.  I wondered about doing that for
> ‘guix pack’ as well, it turns out to be more shenanigans than we’d like.
>
>> From 47e0cf3bef26791c72222175899790a46c49af45 Mon Sep 17 00:00:00 2001
>> From: David Thompson <dthompson2@worcester.edu>
>> Date: Thu, 15 Feb 2018 20:54:28 -0500
>> Subject: [PATCH] environment: Add --manifest option.
>>
>> * guix/scripts/environment.scm (show-help, %options): Add -m/--manifest.
>> (options/resolve-packages): Handle manifests.
>> * doc/guix.texi (Invoking guix environment): Document it.
>
> Could you add an example in tests/guix-environment.sh that uses a
> manifest with the “guile-bootstrap” package for instance?
>
> OK with this change!  :-)

Is this what you had in mind?

- Dave

[-- Attachment #2: 0001-environment-Add-manifest-option.patch --]
[-- Type: text/x-patch, Size: 4825 bytes --]

From e6d0a82e5250d51e50cd05241261a460a71dbd37 Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Thu, 15 Feb 2018 20:54:28 -0500
Subject: [PATCH] environment: Add --manifest option.

* guix/scripts/environment.scm (show-help, %options): Add -m/--manifest.
(options/resolve-packages): Handle manifests.
* doc/guix.texi (Invoking guix environment): Document it.
---
 doc/guix.texi                |  9 +++++++++
 guix/scripts/environment.scm | 22 +++++++++++++++++++++-
 tests/guix-environment.sh    |  9 +++++++++
 3 files changed, 39 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 7ed39ff13..16a352c8b 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -7231,6 +7231,15 @@ As an example, @var{file} might contain a definition like this
 @verbatiminclude environment-gdb.scm
 @end example
 
+@item --manifest=@var{file}
+@itemx -m @var{file}
+Create an environment for the packages contained in the manifest object
+returned by the Scheme code in @var{file}.
+
+This is similar to the same-named option in @command{guix package}
+(@pxref{profile-manifest, @option{--manifest}}) and uses the same
+manifest files.
+
 @item --ad-hoc
 Include all specified packages in the resulting environment, as if an
 @i{ad hoc} package were defined with them as inputs.  This option is
diff --git a/guix/scripts/environment.scm b/guix/scripts/environment.scm
index d2568e6a7..67da6fc3b 100644
--- a/guix/scripts/environment.scm
+++ b/guix/scripts/environment.scm
@@ -1,5 +1,5 @@
 ;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2014, 2015 David Thompson <davet@gnu.org>
+;;; Copyright © 2014, 2015, 2018 David Thompson <davet@gnu.org>
 ;;; Copyright © 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org>
 ;;;
 ;;; This file is part of GNU Guix.
@@ -141,6 +141,8 @@ COMMAND or an interactive shell in that environment.\n"))
   (display (G_ "
   -l, --load=FILE        create environment for the package that the code within
                          FILE evaluates to"))
+  (display (G_ "
+  -m, --manifest=FILE    create environment with the manifest from FILE"))
   (display (G_ "
       --ad-hoc           include all specified packages in the environment instead
                          of only their inputs"))
@@ -220,6 +222,11 @@ COMMAND or an interactive shell in that environment.\n"))
                    (alist-cons 'expression
                                (tag-package-arg result arg)
                                result)))
+         (option '(#\m "manifest") #t #f
+                 (lambda (opt name arg result)
+                   (alist-cons 'manifest
+                               arg
+                               result)))
          (option '("ad-hoc") #f #f
                  (lambda (opt name arg result)
                    (alist-cons 'ad-hoc? #t result)))
@@ -286,6 +293,16 @@ packages."
       (((? package-or-package+output?) ...) ; many packages
        (map (cut package->output <> mode) packages))))
 
+  (define (manifest->outputs manifest)
+    (map (lambda (entry)
+           (cons 'ad-hoc-package ; manifests are implicitly ad-hoc
+                 (if (package? (manifest-entry-item entry))
+                     (list (manifest-entry-item entry)
+                           (manifest-entry-output entry))
+                     ;; Direct store paths have no output.
+                     (list (manifest-entry-item entry)))))
+         (manifest-entries manifest)))
+
   (compact
    (append-map (match-lambda
                  (('package mode (? string? spec))
@@ -299,6 +316,9 @@ packages."
                   ;; Add all the outputs of the package defined in FILE.
                   (let ((module (make-user-module '())))
                     (packages->outputs (load* file module) mode)))
+                 (('manifest . file)
+                  (let ((module (make-user-module '())))
+                    (manifest->outputs (load* file module))))
                  (_ '(#f)))
                opts)))
 
diff --git a/tests/guix-environment.sh b/tests/guix-environment.sh
index bf5ca17fa..b44aca099 100644
--- a/tests/guix-environment.sh
+++ b/tests/guix-environment.sh
@@ -62,6 +62,15 @@ fi
 guix environment --bootstrap --ad-hoc guile-bootstrap --pure \
      -- "$SHELL" -c 'test -f "$GUIX_ENVIRONMENT/bin/guile"'
 
+# Make sure 'GUIX_ENVIRONMENT' points to the profile when building from a
+# manifest.
+echo "(use-modules (guix profiles) (gnu packages bootstrap))
+
+(packages->manifest (list %bootstrap-guile))
+" > $tmpdir/manifest.scm
+guix environment --bootstrap --manifest=$tmpdir/manifest.scm --pure \
+     -- "$SHELL" -c 'test -f "$GUIX_ENVIRONMENT/bin/guile"'
+
 # Make sure '-r' works as expected.
 rm -f "$gcroot"
 expected="`guix environment --bootstrap --ad-hoc guile-bootstrap \
-- 
2.16.1

[bug#30480] [PATCH] environment: Add --manifest option.

[Ludovic Courtès]

Hi Dave,

"Thompson, David" <dthompson2@worcester.edu> skribis:

> On Mon, Feb 19, 2018 at 4:21 PM, Ludovic Courtès <ludo@gnu.org> wrote:
>> Hi David!

[...]

>>> From 47e0cf3bef26791c72222175899790a46c49af45 Mon Sep 17 00:00:00 2001
>>> From: David Thompson <dthompson2@worcester.edu>
>>> Date: Thu, 15 Feb 2018 20:54:28 -0500
>>> Subject: [PATCH] environment: Add --manifest option.
>>>
>>> * guix/scripts/environment.scm (show-help, %options): Add -m/--manifest.
>>> (options/resolve-packages): Handle manifests.
>>> * doc/guix.texi (Invoking guix environment): Document it.
>>
>> Could you add an example in tests/guix-environment.sh that uses a
>> manifest with the “guile-bootstrap” package for instance?
>>
>> OK with this change!  :-)
>
> Is this what you had in mind?

Yes, perfect.  Thank you!

Ludo’.

[bug#30480] [PATCH] environment: Add --manifest option.

[Thompson, David]

On Wed, Feb 21, 2018 at 5:10 PM, Ludovic Courtès <ludo@gnu.org> wrote:
> Hi Dave,
>
> "Thompson, David" <dthompson2@worcester.edu> skribis:
>
>> On Mon, Feb 19, 2018 at 4:21 PM, Ludovic Courtès <ludo@gnu.org> wrote:
>>> Hi David!
>
> [...]
>
>>>> From 47e0cf3bef26791c72222175899790a46c49af45 Mon Sep 17 00:00:00 2001
>>>> From: David Thompson <dthompson2@worcester.edu>
>>>> Date: Thu, 15 Feb 2018 20:54:28 -0500
>>>> Subject: [PATCH] environment: Add --manifest option.
>>>>
>>>> * guix/scripts/environment.scm (show-help, %options): Add -m/--manifest.
>>>> (options/resolve-packages): Handle manifests.
>>>> * doc/guix.texi (Invoking guix environment): Document it.
>>>
>>> Could you add an example in tests/guix-environment.sh that uses a
>>> manifest with the “guile-bootstrap” package for instance?
>>>
>>> OK with this change!  :-)
>>
>> Is this what you had in mind?
>
> Yes, perfect.  Thank you!

Pushed.  Do I have to do something special to close this ticket?

- Dave

bug#30480: [PATCH] environment: Add --manifest option.

[Leo Famulari]

[-- Attachment #1: Type: text/plain, Size: 207 bytes --]

On Wed, Feb 21, 2018 at 10:17:33PM -0500, Thompson, David wrote:
> Pushed.  Do I have to do something special to close this ticket?

I'm closing it by appending -done to the bug number in the email
address.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[bug#30480] [PATCH] environment: Add --manifest option.

[Andreas Enge]

On Wed, Feb 21, 2018 at 10:17:33PM -0500, Thompson, David wrote:
> Pushed.  Do I have to do something special to close this ticket?

One just needs to send an e-mail to BUGNUMBER-done@debbugs.gnu.org,
as I am doing with this message.

Andreas