From patchwork Thu Mar 21 18:36:43 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Richard Sent X-Patchwork-Id: 62113 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 9EF9C27BBEA; Thu, 21 Mar 2024 19:44:26 +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=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,SPF_HELO_PASS,URIBL_BLOCKED autolearn=ham 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 2E54527BBE2 for ; Thu, 21 Mar 2024 19:44:25 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rnOKY-0002Gx-59; Thu, 21 Mar 2024 15:44:02 -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 1rnNJ0-0001yd-UG for guix-patches@gnu.org; Thu, 21 Mar 2024 14:38:22 -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 1rnNIz-0005qE-Tj for guix-patches@gnu.org; Thu, 21 Mar 2024 14:38:21 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rnNJd-0006SH-UI for guix-patches@gnu.org; Thu, 21 Mar 2024 14:39:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#69781] [PATCH v2] services: Add the Guix Home Service References: <05fd930c91838ce9640720ce68e3379f10154590.1710355300.git.richard@freakingpenguin.com> In-Reply-To: <05fd930c91838ce9640720ce68e3379f10154590.1710355300.git.richard@freakingpenguin.com> Resent-From: Richard Sent Original-Sender: "Debbugs-submit" Resent-CC: , guix-patches@gnu.org Resent-Date: Thu, 21 Mar 2024 18:39:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 69781 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 69781@debbugs.gnu.org Cc: ludo@gnu.org, rustand.lars@gmail.com, Richard Sent , ( , Andrew Tropin , Ludovic =?utf-8?q?Court=C3=A8s?= , Tanguy Le Carrour X-Debbugs-Original-Xcc: ( , Andrew Tropin , Ludovic =?utf-8?q?Court=C3=A8s?= , Tanguy Le Carrour Received: via spool by 69781-submit@debbugs.gnu.org id=B69781.171104630424705 (code B ref 69781); Thu, 21 Mar 2024 18:39:01 +0000 Received: (at 69781) by debbugs.gnu.org; 21 Mar 2024 18:38:24 +0000 Received: from localhost ([127.0.0.1]:51749 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rnNJ1-0006QI-0N for submit@debbugs.gnu.org; Thu, 21 Mar 2024 14:38:24 -0400 Received: from mail-108-mta78.mxroute.com ([136.175.108.78]:40071) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rnNIy-0006Q3-0f for 69781@debbugs.gnu.org; Thu, 21 Mar 2024 14:38:21 -0400 Received: from filter006.mxroute.com ([136.175.111.2] filter006.mxroute.com) (Authenticated sender: mN4UYu2MZsgR) by mail-108-mta78.mxroute.com (ZoneMTA) with ESMTPSA id 18e624de1920003bea.001 for <69781@debbugs.gnu.org> (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384); Thu, 21 Mar 2024 18:37:34 +0000 X-Zone-Loop: 854cffd14b96ab4f6e682477e348d8c7947850a56376 X-Originating-IP: [136.175.111.2] DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=freakingpenguin.com; s=x; h=Content-Transfer-Encoding:Content-Type: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To: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=qugKhG0sU7r+TpcwDRzj1J9iOD2EtYKMzzoGVHEKwik=; b=i+aYaAtzB4meNVi3osT+qopl1u m+rukTlDzTgZz1MV/zgRbygfVyD3yoLxHG0xlClfvHGyx3KGIR8gGdsFn/BE3p4UVb1gAT44iwR/v h++WPaZSWmurYuC7Laia+wflEMzrFPAuGsbijhk9TGuVbLRIgrf5DkevPQ1BsyMWgcYnZyKy8W3zM EtmDqZt3tNWMON3RteMdanFGOtCW2WpHzz0hNbJ4ZB7se8gAHL7O4tu1xSKq4Rel2B6wNM3JeSeOl MeZA6Uiq3FMzFQj7IjPcHC7M7eczsYhC7pltK8bz6Lq4eta9a5VGX/zQzVqOve6Ax7rteBdojSZ3i 8h9SxQQA==; From: Richard Sent Date: Thu, 21 Mar 2024 14:36:43 -0400 Message-ID: <3394b0b51f6a5a608ebcfb7a63fdc34e52fe928e.1711046203.git.richard@freakingpenguin.com> MIME-Version: 1.0 X-Authenticated-Id: richard@freakingpenguin.com X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-Mailman-Approved-At: Thu, 21 Mar 2024 15:44:00 -0400 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 This patch adds a Guix Home Service, which allows for configuring/deploying an operating-system declaration with an associated home-environment. * gnu/services/guix.scm: Add guix-home-service and guix-home-shepherd-service * gnu/home/services/shepherd.scm: Don't attempt to launch user shepherd when the system shepherd runs guix-home- * doc/guix.texi: Add documentation for guix-home-service * gnu/tests/guix.scm: Add a test to verify guix-home-service-type is able to activate a home environment Change-Id: Ifbcc0878d934aa4abe34bb2123b5081fb432aa8e --- Resubmitting based on feedback on a similar patch that I missed earlier, https://issues.guix.gnu.org/68589. Not sure how to merge patches, but figured best to submit V2 to this issue. Sorry! doc/guix.texi | 32 +++++++++++++++ gnu/home/services/shepherd.scm | 7 +++- gnu/services/guix.scm | 38 ++++++++++++++++++ gnu/tests/guix.scm | 73 ++++++++++++++++++++++++++++++++++ 4 files changed, 149 insertions(+), 1 deletion(-) base-commit: 9b84b362963770d7a21ceb4e711a5a389db5b02d diff --git a/doc/guix.texi b/doc/guix.texi index 20f007b1c0..3a5f1289fa 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -125,6 +125,7 @@ Copyright @copyright{} 2023 Graham James Addis@* Copyright @copyright{} 2023 Tomas Volf@* Copyright @copyright{} 2024 Herman Rimm@* +Copyright @copyright{} 2024 Richard Sent@* Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -39576,6 +39577,37 @@ Guix Services @end table @end deftp +@subsubheading Guix Home Service +The Guix Home Service allows for associating Guix @ref{Declaring the +Home Environment, home-environment} declarations with a Guix +@ref{operating-system Reference, operating-system}. + +@defvar guix-home-service-type +Service type for the Guix Home Service. Its value must be a list of +lists containing user and home environment pairs. The key of each pair +is a string representing the user to deploy the configuration under and +the value is a home-environment configuration. + +@lisp +(define my-home + (home-environment + ...)) + +(operating-system + (services (list + (service guix-home-service-type + `(("alice" ,my-home)))))) +@end lisp + +This service can be extended by other services to add additional home +environments, as in this example: + +@lisp +(simple-service 'my-extra-home home-service-type + `(("bob" ,my-extra-home)))) +@end lisp +@end defvar + @subsubheading Nar Herder The @uref{https://git.cbaines.net/guix/nar-herder/about/,Nar Herder} is a utility for managing a collection of nars. diff --git a/gnu/home/services/shepherd.scm b/gnu/home/services/shepherd.scm index 176f4575cb..e68dea6954 100644 --- a/gnu/home/services/shepherd.scm +++ b/gnu/home/services/shepherd.scm @@ -132,7 +132,12 @@ (define (ensure-shepherd-gexp config) (format #f "/run/user/~a" (getuid))) "/shepherd/socket")) #$(reload-configuration-gexp config) - #$(launch-shepherd-gexp config))) + ;; Don't attempt to start user shepherd if the system is running the + ;; activation script. /run/user/ may not have been created + ;; yet. But do otherwise so if the runtime dir does not exist an error + ;; is logged. + (unless (getenv "GUIX_SYSTEM_IS_RUNNING_HOME_ACTIVATE") + #$(launch-shepherd-gexp config)))) (define (shepherd-xdg-configuration-files config) `(("shepherd/init.scm" ,(home-shepherd-configuration-file config)))) diff --git a/gnu/services/guix.scm b/gnu/services/guix.scm index c438da531c..05ff9f1ba4 100644 --- a/gnu/services/guix.scm +++ b/gnu/services/guix.scm @@ -1,5 +1,6 @@ ;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2019, 2020, 2021, 2022 Christopher Baines +;;; Copyright © 2024 Andrew Tropin ;;; ;;; This file is part of GNU Guix. ;;; @@ -101,6 +102,8 @@ (define-module (gnu services guix) guix-data-service-type + guix-home-service-type + nar-herder-service-type nar-herder-configuration nar-herder-configuration? @@ -686,6 +689,41 @@ (define guix-data-service-type (description "Run an instance of the Guix Data Service."))) + +;;; +;;; Guix Home Service +;;; + +(define (guix-home-shepherd-service config) + (map (match-lambda + ((user he) + (shepherd-service + (documentation "Activate Guix Home.") + (requirement '(user-processes)) + (provision (list (symbol-append 'guix-home- (string->symbol user)))) + (one-shot? #t) + (auto-start? #t) + (start #~(make-forkexec-constructor + '(#$(file-append he "/activate")) + #:user #$user + #:environment-variables + (list (string-append "HOME=" (passwd:dir (getpw #$user))) + "GUIX_SYSTEM_IS_RUNNING_HOME_ACTIVATE=t") + #:group (group:name (getgrgid (passwd:gid (getpw #$user)))))) + (stop #~(make-kill-destructor))))) + config)) + +(define guix-home-service-type + (service-type + (name 'guix-home) + (description "Sets up Guix Home for the specified user accounts.") + (extensions (list (service-extension + shepherd-root-service-type + guix-home-shepherd-service))) + (compose concatenate) + (extend append) + (default-value '()))) + ;;; ;;; Nar Herder diff --git a/gnu/tests/guix.scm b/gnu/tests/guix.scm index 240ded4825..12ad1bf255 100644 --- a/gnu/tests/guix.scm +++ b/gnu/tests/guix.scm @@ -17,6 +17,8 @@ ;;; along with GNU Guix. If not, see . (define-module (gnu tests guix) + #:use-module (gnu home) + #:use-module (gnu home services) #:use-module (gnu tests) #:use-module (gnu system) #:use-module (gnu system file-systems) @@ -37,6 +39,7 @@ (define-module (gnu tests guix) #:use-module (ice-9 match) #:export (%test-guix-build-coordinator %test-guix-data-service + %test-guix-home-service %test-nar-herder %test-bffe)) @@ -251,6 +254,76 @@ (define %test-guix-data-service (description "Connect to a running Guix Data Service.") (value (run-guix-data-service-test)))) + +;;; +;;; Guix Home +;;; + +(define %guix-home-service-he + (home-environment + (services + (list (simple-service 'guix-home-service-test + home-files-service-type + `(("guix-home-service-activated" + ,(plain-file "guix-home-service-activated" + "Guix Home service activated")))))))) + +(define %guix-home-service-os + (simple-operating-system + (service guix-home-service-type + `(("alice" ,%guix-home-service-he))))) + +(define (run-guix-home-service-test) + (define os + (marionette-operating-system + %guix-home-service-os + #:imported-modules '((gnu services herd)))) + + (define vm + (virtual-machine + (operating-system os) + (memory-size 1024))) + + (define test + (with-imported-modules '((gnu build marionette)) + #~(begin + (use-modules (srfi srfi-64) + (gnu build marionette)) + + (define marionette + (make-marionette (list #$vm))) + + (test-runner-current (system-test-runner #$output)) + (test-begin "guix-home-service") + + (test-assert "service started" + (marionette-eval + '(begin + (use-modules (gnu services herd)) + (match (start-service 'guix-home-alice) + (#f #f) + ;; herd returns (running #f), likely because of one shot, + ;; so consider any non-error a success. + (('service response-parts ...) #t))) + marionette)) + + (test-assert "file-exists" + (marionette-eval + '(begin + (sleep 3) ;make sure service has time to symlink files + (file-exists? "/home/alice/guix-home-service-activated")) + marionette)) + + (test-end)))) + + (gexp->derivation "guix-home-service-test" test)) + +(define %test-guix-home-service + (system-test + (name "guix-home-service") + (description "Activate a Guix home environment.") + (value (run-guix-home-service-test)))) + ;;; ;;; Nar Herder