From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id fOeMNkU6O2G9IgEAgWs5BA (envelope-from ) for ; Fri, 10 Sep 2021 12:58:13 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id WAhpMUU6O2F4cwAAbx9fmQ (envelope-from ) for ; Fri, 10 Sep 2021 10:58:13 +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 7685A9972 for ; Fri, 10 Sep 2021 12:58:13 +0200 (CEST) Received: from localhost ([::1]:50318 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mOeEW-0008K4-Er for larch@yhetil.org; Fri, 10 Sep 2021 06:58:12 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42636) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mOeEM-0008Jc-L9 for guix-patches@gnu.org; Fri, 10 Sep 2021 06:58:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:53679) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mOeEM-0001Ry-5G for guix-patches@gnu.org; Fri, 10 Sep 2021 06:58:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mOeEM-0002jT-42 for guix-patches@gnu.org; Fri, 10 Sep 2021 06:58: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: Fri, 10 Sep 2021 10:58:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 50504 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 50504@debbugs.gnu.org Cc: Oleg Pykhalov , Ludovic =?UTF-8?Q?Court=C3=A8s?= , Xinglu Chen X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.163127142410410 (code B ref -1); Fri, 10 Sep 2021 10:58:01 +0000 Received: (at submit) by debbugs.gnu.org; 10 Sep 2021 10:57:04 +0000 Received: from localhost ([127.0.0.1]:36986 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mOeDE-0002hK-D2 for submit@debbugs.gnu.org; Fri, 10 Sep 2021 06:57:04 -0400 Received: from lists.gnu.org ([209.51.188.17]:52714) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mOeDD-0002hD-29 for submit@debbugs.gnu.org; Fri, 10 Sep 2021 06:56:51 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42262) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mOeDC-0007Yi-Me for guix-patches@gnu.org; Fri, 10 Sep 2021 06:56:50 -0400 Received: from mail-lj1-x230.google.com ([2a00:1450:4864:20::230]:47052) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mOeDA-0000ND-F0 for guix-patches@gnu.org; Fri, 10 Sep 2021 06:56:50 -0400 Received: by mail-lj1-x230.google.com with SMTP id w4so2498042ljh.13 for ; Fri, 10 Sep 2021 03:56:47 -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:date:message-id:mime-version :content-transfer-encoding; bh=VbWLr9x6y5tAe0KtS4cpVT23xL+MvFmNjv7AwiwvX1I=; b=EsF3ZO2rutLsNwHclvUXu+kHBGOr9emdCbIZ8GVjMqMF+UvymvCN8D0F6IhWpr1ZpA KkmsRsXWp5v8Z3OsBtzdMus94D31kGDpmklG00Zr0MCB7KPTm5suhAAzYN8LPKRMS+yY mry4/0pE+CKFz2xCwOpvMnvUzc7SUplTrH051yEDt+zo/sVh2s1pN9V8WuykYIKJVuNl 1sSNbVkAZs+hMTVC+fzUbm2NGoK0e9jskWBNhFyndawgOr1F1/BMmp/ydM6CzV22pmZw sVwx8bgxI56cSQuqKF2PgbJW6OFjYfcritxZhZ+AAB1UwLqTR8dJ5SmKWRqou2FxhN7P y8Dw== 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:date:message-id:mime-version :content-transfer-encoding; bh=VbWLr9x6y5tAe0KtS4cpVT23xL+MvFmNjv7AwiwvX1I=; b=5WxWPL8iN3qgytdFC5EYqGmx82mwEs3JBBxIN3Dlrct97qBtKWBjSirs55zhFM6Gpr VZpOR8lrQidMsCOiukneKZH1ELVfSl8SPgbRyAMpWj0Oe3kDO/hnpw8qFYTzh+7aaasM em5VlzEtjCUlwLTJ8GB0xdOm0TWDEFbyrr+rK5AJIIuvbC34xb+hGmC5TunHVF1zeWsb LOyvRHXWhl7dbYusjauPGJNdAvbdCMqptdSUcXxCTPWmy+/ECtHbhGmAB5OuRMAtAgs9 dmaMtHaIGTYCv7a0yUWtMb5aTJZgJnvzTdU2T61p1ZYcqupsFvdJVpKmEPoXbSRH4bkl o/tQ== X-Gm-Message-State: AOAM533s/8VvCCJuyU2ChZxiijB+YKc+yCku9xyoTlGaQS+yg1u4GHFV +Y/pKiqA478Vv3PHaddZShEuEYfZhsUTOQ== X-Google-Smtp-Source: ABdhPJw1lNnhYS5br7uRYfUQN0J8MppA488VGEnCtN3Os3WNpDnKfWCavcC+Fql6dHPME5kzpMT7Vg== X-Received: by 2002:a2e:bc26:: with SMTP id b38mr3682953ljf.497.1631271405510; Fri, 10 Sep 2021 03:56:45 -0700 (PDT) Received: from localhost ([109.252.93.92]) by smtp.gmail.com with ESMTPSA id t12sm539338lfr.190.2021.09.10.03.56.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 10 Sep 2021 03:56:45 -0700 (PDT) From: Andrew Tropin Date: Fri, 10 Sep 2021 09:26:33 +0300 Message-ID: <8735qc66mt.fsf@trop.in> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Received-SPF: none client-ip=2a00:1450:4864:20::230; envelope-from=andrew@trop.in; helo=mail-lj1-x230.google.com X-Spam_score_int: -2 X-Spam_score: -0.3 X-Spam_bar: / X-Spam_report: (-0.3 / 5.0 requ) BAYES_00=-1.9, DATE_IN_PAST_03_06=1.592, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=no 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: , 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=1631271493; 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: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=VbWLr9x6y5tAe0KtS4cpVT23xL+MvFmNjv7AwiwvX1I=; b=f50nflIPoRDBMwjtH2VvYhuTh+YMO3xxoZqj0O6B4XVrU0v8qSZQ9uhfq7UQ5D9W4os6KH yyCT4v24/v3egcVH0R6KE7+VmTQllITVWyTW/ZzbARZMdd0M1BIVe4/Ne95KZpib77ZgrQ MvWZ2QyqRebT6gAnyTsav5fE84EL8PMnpjhuFykoL7DanYX6oBDFRxhff3ZTgNuV7v1cNR q99/5B86qyAIBjKaeWyR6MWpZrn1eYrMFyDzlSf7qh2s1/zYDEFmEC/+EW+hrvOVrZouKo v9QXZmOdrCPYPV7X8uQ+eH0IFj3aDZLSDqnlRdbgQXg3zQelh1L0+pkLCCMx3Q== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1631271493; a=rsa-sha256; cv=none; b=kUIU/sBT/31m6ALsKO3GCVxKsQpDSGOCHVgHsJzguq1A1iit0Cohdmww/hYZO3+uPtmgx2 NvQSwh0eSMLnbj0WcXWp8D3Ddaeq4V2um7WRsDCmpLcHmKMQqUmcxTAAGmRQLGaLwt/N3O ouq2ljO6ILK9HuvJ2xOUeMa6X37exhB05CuORO3mHRs8UmDdyOYCDrAm4VEwqQA/oKTIxU zV4DRNGb3wUVAetUjSMtzUyaEqrBznrZ+4bzoo8fuTStKz2UhYP+rIypDpzTedpJjCcNfX L16JjavB2Xq+QPUoN3brGIWpG91h37/Clra5FB4/nUtxDzK2CRu4qFCDC/O13A== 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=EsF3ZO2r; 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.09 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=trop-in.20150623.gappssmtp.com header.s=20150623 header.b=EsF3ZO2r; 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: 7685A9972 X-Spam-Score: 0.09 X-Migadu-Scanner: scn0.migadu.com X-TUID: u7KUGdn0//Ik * 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-home. It reuses two functions from (gnu services mcron) via @@, which can be considered as a hack, the alternative solution is to expose those functions 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. 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 system 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 Guix Home in the separate patch. 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 -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}. + +@defvr {Scheme Variable} home-mcron-service-type +This is the type of the @code{mcron} home service, whose value is an +@code{home-mcron-configuration} object. It allows to manage tasks + +This service type can be the target of a service extension that provides +it additional job specifications (@pxref{Service Composition}). In +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 @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-append = (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' act= ion + (ice-9 rdelim) + (ice-9 match) + ,@%default-modules)) + (start #~(make-forkexec-constructor + (list #$(file-append mcron "/bin/mcron") #$@files) + #: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-package)) + +(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