From patchwork Fri Nov 1 17:34:14 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: tusharhero--- via Guix-patches via X-Patchwork-Id: 32793 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 82C8527BBE9; Fri, 1 Nov 2024 17:34:39 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-6.4 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,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 9383427BBE2 for ; Fri, 1 Nov 2024 17:34:38 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1t6vXJ-0008Ke-85; Fri, 01 Nov 2024 13:34:13 -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 1t6vXF-0008K4-TY for guix-patches@gnu.org; Fri, 01 Nov 2024 13:34:10 -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 1t6vXD-0000Si-Vu; Fri, 01 Nov 2024 13:34:08 -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=1YmN/FFKjYJuJkAECpzuoyo28QjM4rIvPKnB7m2HzDE=; b=bxYqOhT0nTpeSJhGPz7Pn21b7Zh7rBEM9m1uCn/tPzGIl0nfIADcVzJFEk6o2fD+WEJtNXa6hm0QuT3+WeUVwiCOacUurF5sq9G7hxhO/sW/I70Dfw1sr7XTtc0PXdNAnzBC4M2gd9HbMQ2+SepYPxSeE2TmKAs3ggHvxRkyX5hM735N6OcJeAP+zeI5e440XpdEOHNw6wv3JJs0+peaLswCc1BJ+IFz4E2oYzyKsfv/6DZfydTRMbiYIQY4lWaL/5IaPanOtyOBkE33v9JhBrL+waOBhlr7jHJAPAkwaGWo9JQojYuU9NnuWhS0yCW+I7qjqzQlTCFn1afli2iKHg==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1t6vX9-00009W-DN; Fri, 01 Nov 2024 13:34:03 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#74164] [PATCH v3 2/3] pack: Add support for AppImage pack format. Resent-From: noe@xn--no-cja.eu 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: Fri, 01 Nov 2024 17:34:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 74164 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 74164@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-To: guix-patches@gnu.org 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 submit@debbugs.gnu.org id=B.1730482412552 (code B ref -1); Fri, 01 Nov 2024 17:34:03 +0000 Received: (at submit) by debbugs.gnu.org; 1 Nov 2024 17:33:32 +0000 Received: from localhost ([127.0.0.1]:50834 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1t6vWd-00008p-7z for submit@debbugs.gnu.org; Fri, 01 Nov 2024 13:33:32 -0400 Received: from lists.gnu.org ([209.51.188.17]:54432) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1t6vWW-00008O-NT for submit@debbugs.gnu.org; Fri, 01 Nov 2024 13:33:28 -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 1t6vWW-0008DW-E8 for guix-patches@gnu.org; Fri, 01 Nov 2024 13:33:24 -0400 Received: from smtp.domeneshop.no ([2a01:5b40:0:3006::1]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1t6vWT-0000PP-HN for guix-patches@gnu.org; Fri, 01 Nov 2024 13:33:24 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=xn--no-cja.eu; s=ds202402; h=Content-Transfer-Encoding:Content-Type: MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:Cc:To:From:From: Sender:Reply-To:Subject:Date:Message-ID:To:Cc:MIME-Version:Content-Type: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To: References:List-Id:List-Help:List-Unsubscribe:List-Subscribe:List-Post: List-Owner:List-Archive; bh=1YmN/FFKjYJuJkAECpzuoyo28QjM4rIvPKnB7m2HzDE=; b=q FVp3iG8N2bDKfCA3JnxLjPe+us5pF/Nq/zSSMzfr7c0JoMKqDyQoLDPNQG5LCqX0IZJ4cvuGXq48H JVsohevVNeZud3HYcUmBG4e9bbMfGf+zxxMvrO28ZexS43xXh4t7I7Qm4S9VybrY8mM3KqfWwHQWn 919a2WvbA3Z2OjTTMbpENupstZGmCm/up842ZjgAAGuhNdfIUY0QFpyPJXAJC+MHVbO13Qu3hj4md XED/s1Qx2kF+gL0DKv0cX+D3PKe13tRD59MUZ0JthDol7TI29Nffe0/+pK0Mf7wDQtVPo+nCsBwJv VYm1y5Ah1wd4lBHLc+FJYGhbZxhiqjf1w==; Received: from [2a01:e0a:990:a960:b4f3:8f44:ec4:5af5] (port=60906 helo=localhost.localdomain) by smtp.domeneshop.no with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1t6vWR-004a05-PK; Fri, 01 Nov 2024 18:33:19 +0100 Date: Fri, 1 Nov 2024 18:34:14 +0100 Message-ID: In-Reply-To: References: MIME-Version: 1.0 Received-SPF: pass client-ip=2a01:5b40:0:3006::1; envelope-from=noe@xn--no-cja.eu; helo=smtp.domeneshop.no X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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: , Reply-to: noe@xn--no-cja.eu X-ACL-Warn: , noe--- via Guix-patches X-Patchwork-Original-From: noe--- via Guix-patches via From: tusharhero--- via Guix-patches via 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 | 53 ++++++++++++++++++++- guix/scripts/pack.scm | 104 +++++++++++++++++++++++++++++++++++++++++- tests/pack.scm | 41 ++++++++++++++++- 3 files changed, 195 insertions(+), 3 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 187bae6898..46108dc3f1 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -6949,6 +6949,16 @@ 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 created +and executed without any special privileges: + +@example +file=$(guix pack -f appimage --entry-point=bin/guile guile) +$file --help +@end example + Several command-line options allow you to customize your pack: @table @code @@ -7065,6 +7075,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 +7206,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..26ba80b80d 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