From patchwork Sat Oct 26 17:28:10 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?No=C3=A9_Lopez?= X-Patchwork-Id: 69472 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 6F17F27BBE2; Sat, 26 Oct 2024 18:49:32 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-6.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_BLOCKED, RCVD_IN_VALIDITY_CERTIFIED,RCVD_IN_VALIDITY_RPBL,RCVD_IN_VALIDITY_SAFE, SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 8130A27BBE9 for ; Sat, 26 Oct 2024 18:49:31 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1t4ku3-0007G7-FH; Sat, 26 Oct 2024 13:48:43 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1t4ktr-0007Au-HK for guix-patches@gnu.org; Sat, 26 Oct 2024 13:48:34 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1t4ktq-000333-VW; Sat, 26 Oct 2024 13:48:31 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:References:In-Reply-To:Date:From:To:Subject; bh=jsXShJKKSyOBUBmWbxgJwe6QafXk+ILaVxVj3N1Xjjw=; b=RDHFa+fkOn6Fi55Ateld5G185co6cMqu+aoSYZ8HoUIOa15I7UDZRxY9wrAGW8dWleZXI/crPcjMwsTXNOY4agSBxL9ZMadDoTM55iT0Gl5KNE4eSmihQx+gM8CuWQmE2N1CLfi3FeduhW0eIAxW5Tf/qAatFa4XoaUAd0LsDrKvu/KFcGHCIV2DdczAzIwgMgjRDKbPLCrYjcWMGdQcAVh55kvisicOy4/pKExTygUKKE0q/Ji5R5AU/vKOQxVRWWlwQ/94+w/7+8XkDlP/0NKgBY08aqpAmTthKhJtzUYOtaqIt1za3eN4uc3HM5mLnPZRHAKjgfGkflEMXZEeag==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1t4kuM-0001Qy-Kb; Sat, 26 Oct 2024 13:49:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#73842] [PATCH v2 2/3] pack: Add support for AppImage pack format. Resent-From: =?utf-8?q?No=C3=A9?= Lopez Original-Sender: "Debbugs-submit" Resent-CC: guix@cbaines.net, dev@jpoiret.xyz, ludo@gnu.org, othacehe@gnu.org, maxim.cournoyer@gmail.com, zimon.toutoune@gmail.com, me@tobias.gr, guix-patches@gnu.org Resent-Date: Sat, 26 Oct 2024 17:49:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 73842 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 73842@debbugs.gnu.org Cc: =?utf-8?q?No=C3=A9?= Lopez , Sebastian =?utf-8?q?D?= =?utf-8?q?=C3=BCmcke?= , Christopher Baines , Josselin Poiret , Ludovic =?utf-8?q?Court=C3=A8s?= , Mathieu Othacehe , Maxim Cournoyer , Simon Tournier , Tobias Geerinckx-Rice X-Debbugs-Original-Xcc: Christopher Baines , Josselin Poiret , Ludovic =?utf-8?q?Court=C3=A8s?= , Mathieu Othacehe , Maxim Cournoyer , Simon Tournier , Tobias Geerinckx-Rice Received: via spool by 73842-submit@debbugs.gnu.org id=B73842.17299648935402 (code B ref 73842); Sat, 26 Oct 2024 17:49:02 +0000 Received: (at 73842) by debbugs.gnu.org; 26 Oct 2024 17:48:13 +0000 Received: from localhost ([127.0.0.1]:42492 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1t4ktY-0001P0-Qv for submit@debbugs.gnu.org; Sat, 26 Oct 2024 13:48:13 -0400 Received: from smtp1-g21.free.fr ([212.27.42.1]:38392) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1t4ktV-0001Oo-W4 for 73842@debbugs.gnu.org; Sat, 26 Oct 2024 13:48:11 -0400 Received: from localhost.localdomain (unknown [IPv6:2a01:e0a:990:a960:b4f3:8f44:ec4:5af5]) by smtp1-g21.free.fr (Postfix) with ESMTP id E5429B00572; Sat, 26 Oct 2024 19:47:31 +0200 (CEST) From: =?utf-8?q?No=C3=A9?= Lopez Date: Sat, 26 Oct 2024 19:28:10 +0200 Message-ID: X-Mailer: git-send-email 2.46.0 In-Reply-To: References: MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches From: Sebastian Dümcke * guix/scripts/pack.scm: Add Appimage format. * doc/guix.texi: Document AppImage pack. Co-authored-by: Noé Lopez Change-Id: I33ebfec623cff1cfcd6f029d2d3054c23ab1949a --- doc/guix.texi | 55 +++++++++++++++++++++- guix/scripts/pack.scm | 104 +++++++++++++++++++++++++++++++++++++++++- tests/pack.scm | 41 ++++++++++++++++- 3 files changed, 197 insertions(+), 3 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index ac3a7adef0..18edf8e550 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -6949,6 +6949,18 @@ Invoking guix pack environment}, using commands like @command{singularity shell} or @command{singularity exec}. +@cindex AppImage, create an AppImage file with @command{guix pack} +Another format internally based on SquashFS is +@uref{https://appimage.org/, AppImage}. An AppImage file can be made +executable and run without any special privileges: + +@example +guix pack -f appimage --entry-point=bin/guile guile +cp @var{file} . && chmod u+x $(basename @var{file}) +./$(basename @var{file}) --help +@end example +where @var{file} is the image returned by @command{guix pack}. + Several command-line options allow you to customize your pack: @table @code @@ -7065,6 +7077,47 @@ Invoking guix pack installation or other, non-rpm packs. @end quotation +@item appimage +@cindex AppImage, create an AppImage file with @command{guix pack} +This produces an AppImage file with the @samp{.AppImage} extension. +AppImage is a SquashFS volume prefixed with a runtime that mounts the +SquashFS file system and executes the binary provided with +@option{--entry-point}. This results in a self-contained archive that +bundles the software and all its requirements into a single file. When +the file is made executable it runs the packaged software. + +@example +guix pack -f appimage --entry-point=bin/vlc vlc +@end example + +The runtime used by AppImages makes use of libfuse to mount the image +quickly. If libfuse is not available, the AppImage can still be started +using the @option{--appimage-extract-and-run} flag. + +@quotation Warning + When building an AppImage, always @emph{pass} the +@option{--relocatable} option (or @option{-R}, or @option{-RR}) to make +sure the image can be used on systems where Guix is not installed. A +warning is printed when this option is not used. +@end quotation + +@example +guix pack -f appimage --entry-point=bin/hello --relocatable hello +@end example + +@quotation Note +The resulting AppImage does not conform to the complete standard as it +currently does not contain a @file{.DirIcon} file. This does not impact +functionality of the AppImage itself, but possibly that of software used +to manage AppImages. +@end quotation + +@quotation Note +As the generated AppImage packages the complete dependency graph, it +will be larger than comparable AppImage files found online, which depend +on host system libraries. +@end quotation + @end table @cindex relocatable binaries @@ -7155,7 +7208,7 @@ Invoking guix pack @cindex entry point, for Docker and Singularity images @item --entry-point=@var{command} Use @var{command} as the @dfn{entry point} of the resulting pack, if the pack -format supports it---currently @code{docker} and @code{squashfs} (Singularity) +format supports it---currently @code{docker}, @code{appimage} and @code{squashfs} (Singularity) support it. @var{command} must be relative to the profile contained in the pack. diff --git a/guix/scripts/pack.scm b/guix/scripts/pack.scm index 7c5fe76fe0..95b40a743b 100644 --- a/guix/scripts/pack.scm +++ b/guix/scripts/pack.scm @@ -10,6 +10,8 @@ ;;; Copyright © 2022 Alex Griffin ;;; Copyright © 2023 Graham James Addis ;;; Copyright © 2023 Oleg Pykhalov +;;; Copyright © 2024 Sebastian Dümcke +;;; Copyright © 2024 Noé Lopez ;;; ;;; This file is part of GNU Guix. ;;; @@ -56,6 +58,7 @@ (define-module (guix scripts pack) #:use-module ((gnu packages compression) #:hide (zip)) #:use-module (gnu packages guile) #:use-module (gnu packages base) + #:autoload (gnu packages appimage) (appimage-type2-runtime) #:autoload (gnu packages gnupg) (guile-gcrypt) #:autoload (gnu packages guile) (guile2.0-json guile-json) #:use-module (srfi srfi-1) @@ -64,6 +67,7 @@ (define-module (guix scripts pack) #:use-module (srfi srfi-35) #:use-module (srfi srfi-37) #:use-module (ice-9 match) + #:use-module (ice-9 optargs) #:export (symlink-spec-option-parser self-contained-tarball @@ -71,6 +75,7 @@ (define-module (guix scripts pack) rpm-archive docker-image squashfs-image + self-contained-appimage %formats guix-pack)) @@ -974,8 +979,100 @@ (define* (rpm-archive name profile (gexp->derivation (string-append name ".rpm") build #:target target #:references-graphs `(("profile" ,profile)))) + +;;; +;;; AppImage format +;;; +(define* (self-contained-appimage name profile + #:key target + (profile-name "guix-profile") + entry-point + (compressor (lookup-compressor "zstd")) + localstatedir? + (symlinks '()) + (archiver tar) + (extra-options '())) + "Return a self-contained AppImage containing a store initialized with the +closure of PROFILE, a derivation. The AppImage contains /gnu/store unless +RELOCATABLE option is used; if LOCALSTATEDIR? is true, it also contains +/var/guix, including /var/guix/db with a properly initialized store database. + +SYMLINKS must be a list of (SOURCE -> TARGET) tuples denoting symlinks to be +added to the pack." + (unless entry-point + (leave (G_ "entry-point must be provided in the '~a' format~%") + 'appimage)) + (let-keywords extra-options #f ((relocatable? #f)) + (unless relocatable? + (warning (G_ "AppImages should be built with the --relocatable flag~%")))) + + (define runtime-package appimage-type2-runtime) + (define runtime-path "bin/runtime-fuse3") + (define %valid-compressors '("gzip" "zstd")) + + (let ((compressor-name (compressor-name compressor))) + (unless (member compressor-name %valid-compressors) + (leave (G_ "~a is not a valid squashfs archive compressor used in +generating the AppImage. Valid compressors are: ~a~%") + compressor-name + %valid-compressors))) - + (define builder + (with-extensions (list guile-gcrypt) + (with-imported-modules (source-module-closure + '((guix build store-copy) + (guix build utils)) + #:select? not-config?) + #~(begin + (use-modules (guix build utils) + (guix build store-copy) + (rnrs io ports) + (srfi srfi-1) + (srfi srfi-26)) + + (define (concatenate-files result file1 file2) + "Creates a new file RESULT containing FILE1 followed by FILE2." + (call-with-output-file result + (lambda (output) + (call-with-input-file file1 + (lambda (input) + (dump-port input output))) + (call-with-input-file file2 + (lambda (input) + (dump-port input output)))))) + + (let* ((appdir "AppDir") + (squashfs "squashfs") + (profile-items (map store-info-item + (call-with-input-file "profile" read-reference-graph))) + (profile (find (lambda (item) + (string-suffix? "-profile" item)) + profile-items))) + (mkdir-p appdir) + ;; copy all store items from the profile to the AppDir + (populate-store '("profile") appdir) + ;; symlink the provided entry-point to AppDir/AppRun + (symlink (string-append "." profile "/" #$entry-point) + (string-append appdir "/AppRun")) + ;; create .desktop file as required by the spec + (make-desktop-entry-file + (string-append appdir "/" #$name ".desktop") + #:name #$name + #:exec #$entry-point) + ;; compress the AppDir + (invoke #+(file-append squashfs-tools "/bin/mksquashfs") appdir + squashfs "-root-owned" "-noappend" + "-comp" #+(compressor-name compressor)) + ;; append runtime and squashFS into file AppImage + (concatenate-files #$output + #$(file-append runtime-package "/" runtime-path) + squashfs) + ;; add execution permission + (chmod #$output #o555)))))) + (gexp->derivation (string-append name ".AppImage") builder + #:target target + #:references-graphs `(("profile" ,profile)))) + ;;; ;;; Compiling C programs. ;;; @@ -1311,6 +1408,7 @@ (define %formats (squashfs . ,squashfs-image) (docker . ,docker-image) (deb . ,debian-archive) + (appimage . ,self-contained-appimage) (rpm . ,rpm-archive))) (define (show-formats) @@ -1327,6 +1425,8 @@ (define (show-formats) deb Debian archive installable via dpkg/apt")) (display (G_ " rpm RPM archive installable via rpm/yum")) + (display (G_ " + appimage AppImage self-contained and executable format")) (newline)) (define (required-option symbol) @@ -1694,6 +1794,8 @@ (define-command (guix-pack . args) (process-file-arg opts 'preun-file) #:postun-file (process-file-arg opts 'postun-file))) + ('appimage + (list #:relocatable? relocatable?)) (_ '()))) (target (assoc-ref opts 'target)) (bootstrap? (assoc-ref opts 'bootstrap?)) diff --git a/tests/pack.scm b/tests/pack.scm index f8a9e09c28..6ac9a966af 100644 --- a/tests/pack.scm +++ b/tests/pack.scm @@ -3,6 +3,7 @@ ;;; Copyright © 2018 Ricardo Wurmus ;;; Copyright © 2021, 2023 Maxim Cournoyer ;;; Copyright © 2023 Oleg Pykhalov +;;; Copyright © 2024 Noé Lopez ;;; ;;; This file is part of GNU Guix. ;;; @@ -32,7 +33,8 @@ (define-module (test-pack) #:use-module (guix utils) #:use-module ((guix build utils) #:select (%store-directory)) #:use-module (gnu packages) - #:use-module ((gnu packages base) #:select (libc-utf8-locales-for-target)) + #:use-module ((gnu packages base) #:select (libc-utf8-locales-for-target + hello)) #:use-module (gnu packages bootstrap) #:use-module ((gnu packages package-management) #:select (rpm)) #:use-module ((gnu packages compression) #:select (squashfs-tools)) @@ -340,6 +342,43 @@ (define rpm-for-tests (mkdir #$output)))))))) (built-derivations (list check)))) + (unless store (test-skip 1)) + (test-assertm "appimage" + (mlet* %store-monad + ((guile (set-guile-for-build (default-guile))) + (profile -> (profile + (content (packages->manifest (list %bootstrap-guile hello))) + (hooks '()) + (locales? #f))) + (image (self-contained-appimage "hello-appimage" profile + #:entry-point "bin/hello" + #:extra-options + (list #:relocatable? #t))) + (check (gexp->derivation + "check-appimage" + #~(begin + (invoke #$image))))) + (built-derivations (list check)))) + + (unless store (test-skip 1)) + (test-assertm "appimage + localstatedir" + (mlet* %store-monad + ((guile (set-guile-for-build (default-guile))) + (profile -> (profile + (content (packages->manifest (list %bootstrap-guile hello))) + (hooks '()) + (locales? #f))) + (image (self-contained-appimage "hello-appimage" profile + #:entry-point "bin/hello" + #:localstatedir? #t + #:extra-options + (list #:relocatable? #t))) + (check (gexp->derivation + "check-appimage" + #~(begin + (invoke #$image))))) + (built-derivations (list check)))) + (unless store (test-skip 1)) (test-assertm "deb archive with symlinks and control files" (mlet* %store-monad