From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id QPN3CXXzPmGT5wAAgWs5BA (envelope-from ) for ; Mon, 13 Sep 2021 08:45:09 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id GAUfBXXzPmFvXAAAB5/wlQ (envelope-from ) for ; Mon, 13 Sep 2021 06:45:09 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 4824D202C4 for ; Mon, 13 Sep 2021 08:45:08 +0200 (CEST) Received: from localhost ([::1]:38616 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mPfiF-00080N-9K for larch@yhetil.org; Mon, 13 Sep 2021 02:45:07 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:35190) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mPfiA-00080A-Pw for guix-patches@gnu.org; Mon, 13 Sep 2021 02:45:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:60647) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mPfiA-00006p-Hd for guix-patches@gnu.org; Mon, 13 Sep 2021 02:45:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mPfiA-0007Iu-F2 for guix-patches@gnu.org; Mon, 13 Sep 2021 02:45:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#50504] [PATCH] home-services: Add Mcron. Resent-From: Andrew Tropin Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 13 Sep 2021 06:45:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50504 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Xinglu Chen , 50504@debbugs.gnu.org Cc: Oleg Pykhalov , Ludovic =?UTF-8?Q?Court=C3=A8s?= Received: via spool by 50504-submit@debbugs.gnu.org id=B50504.163151547828029 (code B ref 50504); Mon, 13 Sep 2021 06:45:02 +0000 Received: (at 50504) by debbugs.gnu.org; 13 Sep 2021 06:44:38 +0000 Received: from localhost ([127.0.0.1]:43960 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mPfhg-0007Hu-Oe for submit@debbugs.gnu.org; Mon, 13 Sep 2021 02:44:38 -0400 Received: from mail-lj1-f174.google.com ([209.85.208.174]:38501) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mPfhc-0007Hf-WD for 50504@debbugs.gnu.org; Mon, 13 Sep 2021 02:44:31 -0400 Received: by mail-lj1-f174.google.com with SMTP id g14so15337549ljk.5 for <50504@debbugs.gnu.org>; Sun, 12 Sep 2021 23:44:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=trop-in.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:in-reply-to:references:date:message-id :mime-version; bh=W+4gAmqxttlVpAv0/usoYQJW7PwfgyXzypcz5BcRn0k=; b=xtOu/f3Ar8bsNjFTHCCkn45nXdtzxY/QY3LFlv1yqa6eh8x4qqsZIyQB94joFve8L4 wlSjLiKzLZtVY7zoUYBMU8l3ODTqFRsDMPsvoW0J91aXsO+lFgwXnsEPtbtoG5gyklXT jRnRzS1dX5bOhMpLFbC5TrIIH0u42wn4zOdFi8BfLbvm3r2q75DVHm9quuAjSirsGBtd XMegwgUrk2zS8SKxcY0nVEkndP7n2fc2edw9X/V1jAnlHRBYl5F3xwhz9nxVKuPPXLiR Mb2zfhHo0/qzTKkxWGU+i7HnV7SGmu/kUcFfTGukXXBzVoWytvysqD8ZFs4SeV8uEzt0 5vTw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:in-reply-to:references:date :message-id:mime-version; bh=W+4gAmqxttlVpAv0/usoYQJW7PwfgyXzypcz5BcRn0k=; b=tWx8OYb9kNgbz5m6SHeDywK1qJUVvntiPKh8ObBhvJIGFzzPM2oA7I7okLr/Y4Pq6S NyDln+JBszOmK2Ii/MAnvFD8j6+290hdLleV8Gk6kllJApkVU+DLr9809Gi9OmakSSvg i34x0Un6UI4yTAiN3U1MNEzbReHOTtpbNi+YviVMo+Z2nRJ+YxraNJ1emNSk1HLiLj9I QHoL+4crTGssgoRerzhouj3WBKVPsMBhQCBrZUeCrDtLRWeGFMlT4B+d3dn/k03naGq/ 4WKf6HpGggDC+l9ffWB6yosesNMkw1dlk2piMBE/HwkUy81O0rOcNF9Trs1RfpnpMdav PULw== X-Gm-Message-State: AOAM530ZeJS0XHCFxzdq1uSfHMEkPx/lymmbqrjAMGuaH0XUcgCphLF+ lzRMKpO8D0OiBWSLkansbdGFzQ== X-Google-Smtp-Source: ABdhPJyBiWKC7Tlxagmx37DXePRplUy9O8GO055JyeV5MBee6N59KLiJ4Zo4LBxDMtD6PDiD3bHtMQ== X-Received: by 2002:a2e:97cf:: with SMTP id m15mr9085935ljj.125.1631515462424; Sun, 12 Sep 2021 23:44:22 -0700 (PDT) Received: from localhost (109-252-93-92.nat.spd-mgts.ru. [109.252.93.92]) by smtp.gmail.com with ESMTPSA id u19sm723972lfl.66.2021.09.12.23.44.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 12 Sep 2021 23:44:21 -0700 (PDT) From: Andrew Tropin In-Reply-To: <87a6kkxpcp.fsf@yoctocell.xyz> References: <8735qc66mt.fsf@trop.in> <87a6kkxpcp.fsf@yoctocell.xyz> Date: Mon, 13 Sep 2021 09:44:18 +0300 Message-ID: <87a6khrn3x.fsf@trop.in> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha512; protocol="application/pgp-signature" 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+larch=yhetil.org@gnu.org Sender: "Guix-patches" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1631515508; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:resent-cc:resent-from:resent-sender: resent-message-id:in-reply-to:in-reply-to:references:references: list-id:list-help:list-unsubscribe:list-subscribe:list-post: dkim-signature; bh=W+4gAmqxttlVpAv0/usoYQJW7PwfgyXzypcz5BcRn0k=; b=Xp/ku9koRYJUOmKmijkBW58ZkGsM7edCK5wl0JrmNBUQ9vUls5bkcIroSBWHWKit+b7Jwu LErTJJRug9KptvwbwgoyY1dSyT3RqxP+dNKTlmU7svtiTsgV9b11DF1z8uLoL6QaEl0brH 5W/LhpqUxvfkL1CIuB0TrVBEpOTlFUDxyiAr3ZiC/l/uG2K7NYZcK2sJNjxyorLEU1IGgb rLdQWjn9M9rfu7vVWr8AWX2dpLZqQI/neYG3oLRa8vxR77kG0DeoaG1/7rjV1usCO0iV17 x6GU5r/dR6JDNzVKjdYFk/zjDYkXj17fJolDgPvhm3XwrzK7HN/BJHrqgb/pPw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1631515508; a=rsa-sha256; cv=none; b=AI+NAKupVu5coadA4+peQTiB5n8xmtm7AIVZzdl6oZ9rmLSFQDxzhvpYr7QsQXlDX8jfWx HmRJI3Q4JtAP0uqu8qwpjZeXz3/sWk2OWbQTQWBqHWGJE3wBkTBdXmTGuMqwjsj/fQsamg 6AHYTDs0rrEWEPWfIWREkVbmWUjOhwTLJTzeXc3L/UbzeHy7UUH8KyM/UlUYO6+Bxki+oP 9JZpI8Ni4LYYTPaqhXvCgBtHdkDVZk69meCtcklEs/gercP4SYc5GGlCmBhEMEHG8LAtai zCjxvarR2GpUmmkbhBb/LVJZsn63gZqvXSoFDbePAtfNmuJVCzQHPR3rLWvqbg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=trop-in.20150623.gappssmtp.com header.s=20150623 header.b="xtOu/f3A"; dmarc=none; spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Spam-Score: -0.51 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=trop-in.20150623.gappssmtp.com header.s=20150623 header.b="xtOu/f3A"; dmarc=none; spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Queue-Id: 4824D202C4 X-Spam-Score: -0.51 X-Migadu-Scanner: scn0.migadu.com X-TUID: HgYOQ7VnEcIE --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable On 2021-09-10 20:22, Xinglu Chen wrote: > On Fri, Sep 10 2021, Andrew Tropin wrote: > >> * gnu/home-services/mcron.scm: New file. >> * gnu/local.mk: Add this. >> * doc/guix.texi: Add documentation about Mcron Home Service. >> --- >> >> This is the last of home services I consider "must-have" for wip-guix-ho= me. >> >> It reuses two functions from (gnu services mcron) via @@, which can be >> considered as a hack, the alternative solution is to expose those functi= ons >> via #:export, I can do it if it's a preffered way or suggest other ideas, >> please. The discussion on this topic: https://issues.guix.gnu.org/47238 >> Included Ludovic and Xinglu in CC. > > An alternative would be put it the (gnu service mcron) to share more > code between system service and home service. This was discussed > briefly on rde-devel[1]. It might be worth discussing this issue on > guix-devel before we add too many home service. > I'll make a thread on possible modules naming for home services later this week and will discuss this thing too. > >> I took a brief look at the testing approach, seems the most relevant is >> guix-system.sh and it is just a shell script, which runs a few guix syst= em >> subcommand and check if they fail or succeed. Please let me know, what = is a >> preferred way for writing tests and I'll try to provide some tests for G= uix >> Home in the separate patch. > > The =E2=80=98guix-system.sh=E2=80=99 script seems to only test the =E2=80= =98guix system=E2=80=99 > command, which doesn=E2=80=99t seem that related to the home services. I= guess > we could check the contents of the generated config files. There is > (gnu build marionette) which creates a VM; we could then check that the > relevant process is running. Maybe there is a better approach, though. > It was a general question about tests for Guix Home, not Mcron home service, sorry for the confusion. >=20 > [1]: > > >> doc/guix.texi | 31 +++++++++- >> gnu/home-services/mcron.scm | 115 ++++++++++++++++++++++++++++++++++++ >> gnu/local.mk | 1 + >> 3 files changed, 146 insertions(+), 1 deletion(-) >> create mode 100644 gnu/home-services/mcron.scm >> >> diff --git a/doc/guix.texi b/doc/guix.texi >> index e546fcc0d2..a7eacad762 100644 >> --- a/doc/guix.texi >> +++ b/doc/guix.texi >> @@ -35685,7 +35685,36 @@ for example). >> @cindex mcron >> @cindex scheduling jobs >>=20=20 >> -mcron info here >> +The @code{(gnu home-services mcron)} module provides an interface to >> +GNU@tie{}mcron, a daemon to run jobs at scheduled times (@pxref{Top,,, >> +mcron, GNU@tie{}mcron}). The information about system's mcron is >> +applicable here (@pxref{Scheduled Job Execution}), the only difference >> +for home services is that they have to be declared in >> +@code{home-envirnoment} record instead of @code{operating-system}. > > =E2=80=9Cdeclared in a @code{home-environemnt} record instead of a > @code{operating-system} record.=E2=80=9D > >> +@defvr {Scheme Variable} home-mcron-service-type >> +This is the type of the @code{mcron} home service, whose value is an > > Why @code{mcron}? I would use =E2=80=9CMcron=E2=80=9D instead. > Good idea, but I sticked with the way it's done in a description of system mcron service. > >> +@code{home-mcron-configuration} object. It allows one to manage tasks > > =E2=80=9CIt allows one to manage scheduled tasks.=E2=80=9D > >> +This service type can be the target of a service extension that provides >> +it additional job specifications (@pxref{Service Composition}). In > > s/it// > >> +other words, it is possible to define services that provide additional >> +mcron jobs to run. >> +@end defvr >> + >> +@deftp {Data Type} home-mcron-configuration >> +Data type representing the configuration of mcron. >> + >> +@table @asis >> +@item @code{mcron} (default: @var{mcron}) >> +The mcron package to use. >> + >> +@item @code{jobs} >> +This is a list of gexps (@pxref{G-Expressions}), where each gexp >> +corresponds to an mcron job specification (@pxref{Syntax, mcron job >> +specifications,, mcron, GNU@tie{}mcron}). >> +@end table >> +@end deftp >>=20=20 >> @node Shepherd Home Service >> @subsection Managing User's Daemons >> diff --git a/gnu/home-services/mcron.scm b/gnu/home-services/mcron.scm >> new file mode 100644 >> index 0000000000..fdfde179a5 >> --- /dev/null >> +++ b/gnu/home-services/mcron.scm >> @@ -0,0 +1,115 @@ >> +;;; GNU Guix --- Functional package management for GNU >> +;;; Copyright =C2=A9 2021 Andrew Tropin >> +;;; Copyright =C2=A9 2021 Xinglu Chen >> +;;; >> +;;; This file is part of GNU Guix. >> +;;; >> +;;; GNU Guix is free software; you can redistribute it and/or modify it >> +;;; under the terms of the GNU General Public License as published by >> +;;; the Free Software Foundation; either version 3 of the License, or (= at >> +;;; your option) any later version. >> +;;; >> +;;; GNU Guix is distributed in the hope that it will be useful, but >> +;;; WITHOUT ANY WARRANTY; without even the implied warranty of >> +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the >> +;;; GNU General Public License for more details. >> +;;; >> +;;; You should have received a copy of the GNU General Public License >> +;;; along with GNU Guix. If not, see . >> + >> +(define-module (gnu home-services mcron) >> + #:use-module (gnu packages guile-xyz) >> + #:use-module (gnu home-services) >> + #:use-module (gnu home-services shepherd) >> + #:use-module (gnu services shepherd) >> + #:use-module (guix records) >> + #:use-module (guix gexp) >> + #:use-module (srfi srfi-1) >> + #:use-module (ice-9 match) >> + >> + #:export (home-mcron-configuration >> + home-mcron-service-type)) >> + >> +;;; Commentary: >> +;; >> +;; Service for the GNU mcron cron job manager. >> +;; >> +;; Example configuration, the first job runs mbsync once every ten >> +;; minutes, the second one writes "Mcron service" to ~/mcron-file once >> +;; every minute. >> +;; >> +;; (service home-mcron-service-type >> +;; (home-mcron-configuration >> +;; (jobs (list #~(job '(next-minute >> +;; (range 0 60 10)) >> +;; (lambda () >> +;; (system* "mbsync" "--all"))) >> +;; #~(job next-minute-from >> +;; (lambda () >> +;; (call-with-output-file (string-appe= nd (getenv "HOME") >> +;; = "/mcron-file") >> +;; (lambda (port) >> +;; (display "Mcron service" port))= ))))))) >> +;; >> +;;; Code: >> + >> +(define-record-type* home-mcron-configuration >> + make-home-mcron-configuration >> + home-mcron-configuration? >> + (package home-mcron-configuration-package ; package >> + (default mcron)) >> + (jobs home-mcron-configuration-jobs ; list of jobs >> + (default '()))) >> + >> +(define job-files (@@ (gnu services mcron) job-files)) >> +(define shepherd-schedule-action >> + (@@ (gnu services mcron) shepherd-schedule-action)) >> + >> +(define home-mcron-shepherd-services >> + (match-lambda >> + (($ mcron '()) ; no jobs to run >> + '()) >> + (($ mcron jobs) >> + (let ((files (job-files mcron jobs))) >> + (list (shepherd-service >> + (documentation "User cron jobs.") >> + (provision '(mcron)) >> + (modules `((srfi srfi-1) >> + (srfi srfi-26) >> + (ice-9 popen) ; for the 'schedule' = action >> + (ice-9 rdelim) >> + (ice-9 match) >> + ,@%default-modules)) >> + (start #~(make-forkexec-constructor >> + (list #$(file-append mcron "/bin/mcron") #$@fil= es) >> + #:log-file (string-append >> + (or (getenv "XDG_LOG_HOME") >> + (format #f "~a/.local/var/log" >> + (getenv "HOME"))) >> + "/mcron.log"))) >> + (stop #~(make-kill-destructor)) >> + (actions >> + (list (shepherd-schedule-action mcron files))))))))) >> + >> +(define home-mcron-profile (compose list home-mcron-configuration-packa= ge)) >> + >> +(define (home-mcron-extend config jobs) >> + (home-mcron-configuration >> + (inherit config) >> + (jobs (append (home-mcron-configuration-jobs config) >> + jobs)))) >> + >> +(define home-mcron-service-type >> + (service-type (name 'home-mcron) >> + (extensions >> + (list (service-extension >> + home-shepherd-service-type >> + home-mcron-shepherd-services) >> + (service-extension >> + home-profile-service-type >> + home-mcron-profile))) >> + (compose concatenate) >> + (extend home-mcron-extend) >> + (default-value (home-mcron-configuration)) >> + (description >> + "Install and configure the GNU mcron cron job manager.= "))) >> diff --git a/gnu/local.mk b/gnu/local.mk >> index 31ad1a43db..8212bc5391 100644 >> --- a/gnu/local.mk >> +++ b/gnu/local.mk >> @@ -80,6 +80,7 @@ GNU_SYSTEM_MODULES =3D \ >> %D%/home-services/configuration.scm \ >> %D%/home-services/shells.scm \ >> %D%/home-services/shepherd.scm \ >> + %D%/home-services/mcron.scm \ >> %D%/home-services/utils.scm \ >> %D%/home-services/xdg.scm \ >> %D%/image.scm \ >> --=20 >> 2.33.0 --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEEKEGaxlA4dEDH6S/6IgjSCVjB3rAFAmE+80IACgkQIgjSCVjB 3rDC8w/+MCgrTMUPOoiYlCS52jGJ7K9kWO6oBUoTz2e9dp0sJwpcTAL9jlHBtt09 d2It3/gZcpotC6dVz1xiaPLXO1OGfLYK+JmxquasTDNHI+/38eTDSkQIEu0reKYc +9jiA6nsBfqmriHHI7Ra0X+nWweHJtQ7O4m1jn8w12oHuU7PmxRQN6EJfi4Ibkfw k12IeFDc1gVUhZaYjj5EwsfK5tPCEKVDgV8knxGcT1io10q86cHZKyGwkzHq/7mT b2zcLhTTrBPBNDD0CRpfbPo2RImrra+tcsoIVXmS5vQaCTB2haY0G6cUZlgLCTCj ovXbnihu0qYk68l2BolYqxTfBtAgO8Guwl6Ib6tG4senGHD70aYLRtTbZvq48nBi PY6kp8aM5bIoK5beipY0es5eirImqoaF7WibrxOKbHef8xFCr/HGwevik9CnnN4/ bFKDm2qhTBnJHES/OE9fIg9nIPYusu0s8+EDiScfM95W6XDFoHfMPDARwHAOQRvA DIFdWxcNsh4p3A4hVIfQrs6mHMMy7XF6F8QLpVp/q0Av6BJP4VhUJasWOWSu/eSO HgedEkj95gjUZRmmPvejkkK8QILxRYe1lPpYt5d/wGofL3J4hCxc281I0l3n8Sek F+QKjwN2xi/WwwcKpqrCSZHzWUkbIha6jMtdEnfNIBnWsxbcyis= =H28z -----END PGP SIGNATURE----- --=-=-=--