From patchwork Sat Jun 22 14:28:56 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ludovic_Court=C3=A8s?= X-Patchwork-Id: 28623 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 86D9F27BBE9; Sat, 22 Jun 2024 15:30:26 +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=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,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 7931E27BBE2 for ; Sat, 22 Jun 2024 15:30:24 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sL1km-0002w8-Kw; Sat, 22 Jun 2024 10:30:08 -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 1sL1kl-0002vw-A1 for guix-patches@gnu.org; Sat, 22 Jun 2024 10:30:07 -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 1sL1kl-0000N5-1h; Sat, 22 Jun 2024 10:30:07 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sL1kg-0007QF-ED; Sat, 22 Jun 2024 10:30:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#69591] [PATCH] services: shepherd: Support =?utf-8?b?4oCcZnJl?= =?utf-8?b?ZS1mb3Jt4oCd?= services. References: <20240306193725.17463-1-david.elsing@posteo.net> In-Reply-To: <20240306193725.17463-1-david.elsing@posteo.net> Resent-From: Ludovic =?utf-8?q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: david.elsing@posteo.net, ludovic.courtes@inria.fr, pelzflorian@pelzflorian.de, ludo@gnu.org, matt@excalamus.com, maxim.cournoyer@gmail.com, guix-patches@gnu.org Resent-Date: Sat, 22 Jun 2024 14:30:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 69591 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 69591@debbugs.gnu.org Cc: Ludovic =?utf-8?q?Court=C3=A8s?= , David Elsing , Ludovic =?utf-8?q?Court=C3=A8s?= , Florian Pelz , Ludovic =?utf-8?q?Court=C3=A8s?= , Matthew Trzcinski , Maxim Cournoyer X-Debbugs-Original-Xcc: David Elsing , Ludovic =?utf-8?q?Court=C3=A8s?= , Florian Pelz , Ludovic =?utf-8?q?Court=C3=A8s?= , Matthew Trzcinski , Maxim Cournoyer Received: via spool by 69591-submit@debbugs.gnu.org id=B69591.171906656528418 (code B ref 69591); Sat, 22 Jun 2024 14:30:02 +0000 Received: (at 69591) by debbugs.gnu.org; 22 Jun 2024 14:29:25 +0000 Received: from localhost ([127.0.0.1]:47984 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sL1k4-0007OG-Vf for submit@debbugs.gnu.org; Sat, 22 Jun 2024 10:29:25 -0400 Received: from eggs.gnu.org ([209.51.188.92]:50234) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sL1k2-0007Nv-Ue for 69591@debbugs.gnu.org; Sat, 22 Jun 2024 10:29:23 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sL1jx-0008Vl-FZ; Sat, 22 Jun 2024 10:29:17 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:Subject:To:From:in-reply-to: references; bh=nLRi1sleptdKRENL8H/eVhUC8arre3b/oXNR+s4lKFs=; b=C+7bPxgARgmuyk mhOnoLI+qlrigiQp1wwK/sTP+tlEqt/fBtM2cZlwWgWDWvazHOUI2/wVMLb6Uje7Ix8q7JFClXYO+ BXWrxrs4Jq0MPbL/4RcurEZ3tW7NEp48ic+a47Y3c5ZwFxd3XV+PFLEQfaXDhyXMeodfny9f+4ufE WR3yOOirBobqb5DtJOTL1ySU+VwiffRA7UHbg0UtwkQK+QlWu+rXnvXLmFAEJFCcghUKzu0tkqLzR nJsE1u7sMB2/R3usnm0ZHDv3SGNIzDp4+GosO82vne3rif5UUCbxcjNpKrMg88GGa1VXJWZWKsmei xgx2g0mj0z/qjE2lfjFg==; From: Ludovic =?utf-8?q?Court=C3=A8s?= Date: Sat, 22 Jun 2024 16:28:56 +0200 Message-ID: <7501182c5831ba86d4e600967fb944e9e1124352.1719066498.git.ludo@gnu.org> X-Mailer: git-send-email 2.45.1 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 * gnu/services/shepherd.scm ()[free-form]: New field. [start]: Add default value. (shepherd-service-file): Rename to… (shepherd-service-file/regular): … this. (shepherd-service-file/free-form): New procedure. (shepherd-service-file): Dispatch to one of the two procedures above. * doc/guix.texi (Shepherd Services): Document the ‘free-form’ field. Change-Id: I206374e950ef6d1e4a996c0f507fb5fcd9cadde3 Reviewed-by: Maxim Cournoyer --- doc/guix.texi | 26 +++++++++++++++++++++++++- gnu/services/shepherd.scm | 25 ++++++++++++++++++++++--- 2 files changed, 47 insertions(+), 4 deletions(-) Hi! This patch fixes a limitation that became apparent with Shepherd 0.10, where users could not instantiate services from the built-in service collection for which they do not explicitly specify the ‘start’ and ‘stop’ methods (see REPL service example below). Thoughts? Ludo’. base-commit: 2aeb37def258ad4dd23aaf57ed32f0be44d1bea5 diff --git a/doc/guix.texi b/doc/guix.texi index 0102fd0fad3..4d9145445cc 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -43909,7 +43909,7 @@ Shepherd Services When true, this is the delay in seconds before restarting a failed service. -@item @code{start} +@item @code{start} (default: @code{#~(const #t)}) @itemx @code{stop} (default: @code{#~(const #f)}) The @code{start} and @code{stop} fields refer to the Shepherd's facilities to start and stop processes (@pxref{Service De- and @@ -43928,6 +43928,30 @@ Shepherd Services herd @var{action} @var{service} [@var{arguments}@dots{}] @end example +@item @code{free-form} (default: @code{#f}) +When set, this field replaces the @code{start}, @code{stop}, and +@code{actions} fields. It is meant to be used when the service +definition comes from some other source, typically the service +collection provided by the Shepherd proper (@pxref{Service Collection,,, +shepherd, The GNU Shepherd Manual}). + +@cindex REPL service, for shepherd +For example, the snippet below defines a service for the Shepherd's +built-in @acronym{REPL, read-eval-print loop} service (@pxref{REPL +Service,,, shepherd, The GNU Shepherd Manual}): + +@lisp +(shepherd-service + (provision '(repl)) + (modules '((shepherd service repl))) + (free-form #~(repl-service))) +@end lisp + +In this case, the service object is returned by the @code{repl-service} +procedure of the Shepherd, so all the @code{free-form} G-expression does +is call that procedure. Note that the @code{provision} field must be +consistent with the actual service provision. + @item @code{auto-start?} (default: @code{#t}) Whether this service should be started automatically by the Shepherd. If it is @code{#f} the service has to be started manually with @code{herd start}. diff --git a/gnu/services/shepherd.scm b/gnu/services/shepherd.scm index ccc8e61a33c..05534ab3173 100644 --- a/gnu/services/shepherd.scm +++ b/gnu/services/shepherd.scm @@ -60,6 +60,7 @@ (define-module (gnu services shepherd) shepherd-service-respawn? shepherd-service-start shepherd-service-stop + shepherd-service-free-form shepherd-service-auto-start? shepherd-service-modules @@ -217,7 +218,10 @@ (define-record-type* (default #f)) (respawn-delay shepherd-service-respawn-delay (default #f)) - (start shepherd-service-start) ;g-expression (procedure) + (free-form shepherd-service-free-form ;#f | g-expression (service) + (default #f)) + (start shepherd-service-start ;g-expression (procedure) + (default #~(const #t))) (stop shepherd-service-stop ;g-expression (procedure) (default #~(const #f))) (actions shepherd-service-actions ;list of @@ -298,8 +302,8 @@ (define (shepherd-service-file-name service) provisions) ".scm"))) -(define (shepherd-service-file service) - "Return a file defining SERVICE." +(define (shepherd-service-file/regular service) + "Return a file defining SERVICE, a service whose 'free-form' field is #f." (scheme-file (shepherd-service-file-name service) (with-imported-modules %default-imported-modules #~(begin @@ -332,6 +336,21 @@ (define (shepherd-service-file service) #~(#$name #$doc #$proc))) (shepherd-service-actions service)))))))) +(define (shepherd-service-file/free-form service) + "Return a file defining SERVICE, a service whose 'free-form' field is set." + (scheme-file (shepherd-service-file-name service) + (with-imported-modules %default-imported-modules + #~(begin + (use-modules #$@(shepherd-service-modules service)) + + #$(shepherd-service-free-form service))))) + +(define (shepherd-service-file service) + "Return a file defining SERVICE." + (if (shepherd-service-free-form service) + (shepherd-service-file/free-form service) + (shepherd-service-file/regular service))) + (define (scm->go file shepherd) "Compile FILE, which contains code to be loaded by shepherd's config file, and return the resulting '.go' file. SHEPHERD is used as shepherd package."