;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2016 Mathieu Lirzin <mthl@gnu.org>
;;; Copyright © 2016-2024 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2017, 2020 Mathieu Othacehe <m.othacehe@gmail.com>
;;; Copyright © 2017 Jan Nieuwenhuizen <janneke@gnu.org>
;;; Copyright © 2018, 2019 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2018 Clément Lassieur <clement@lassieur.org>
;;;
;;; 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 <http://www.gnu.org/licenses/>.
(define-module (gnu services cuirass)
#:use-module (guix channels)
#:use-module (guix gexp)
#:use-module (guix records)
#:use-module (guix store)
#:use-module (guix utils)
#:use-module (gnu packages admin)
#:use-module (gnu packages ci)
#:use-module (gnu packages databases)
#:use-module (gnu packages version-control)
#:use-module (gnu services)
#:use-module (gnu services base)
#:use-module (gnu services databases)
#:use-module (gnu services shepherd)
#:use-module (gnu services admin)
#:use-module (gnu system shadow)
#:use-module (srfi srfi-1)
#:use-module (ice-9 match)
#:export (cuirass-remote-server-configuration
cuirass-remote-server-configuration?
cuirass-configuration
cuirass-configuration?
cuirass-service-type
cuirass-remote-worker-configuration
cuirass-remote-worker-configuration?
cuirass-remote-worker-service-type))
;;;; Commentary:
;;;
;;; This module implements a service that to run instances of Cuirass, a
;;; continuous integration tool.
;;;
;;;; Code:
(define %cuirass-default-database
"dbname=cuirass")
(define-record-type* <cuirass-remote-server-configuration>
cuirass-remote-server-configuration make-cuirass-remote-server-configuration
cuirass-remote-server-configuration?
(backend-port cuirass-remote-server-configuration-backend-port ;int
(default 5555))
(log-port cuirass-remote-server-configuration-log-port ;int
(default 5556))
(publish-port cuirass-remote-server-configuration-publish-port ;int
(default 5557))
(log-file cuirass-remote-server-log-file ;string
(default "/var/log/cuirass-remote-server.log"))
(cache cuirass-remote-server-configuration-cache ;string
(default "/var/cache/cuirass/remote/"))
(log-expiry cuirass-remote-server-configuration-log-expiry
(default (* 6 30 24 3600))) ;6 months
(publish? cuirass-remote-server-configuration-publish? ;boolean
(default #t))
(trigger-url cuirass-remote-server-trigger-url ;string
(default #f))
(public-key cuirass-remote-server-configuration-public-key ;string
(default #f))
(private-key cuirass-remote-server-configuration-private-key ;string
(default #f)))
(define-record-type* <cuirass-configuration>
cuirass-configuration make-cuirass-configuration
cuirass-configuration?
(cuirass cuirass-configuration-cuirass ;file-like
(default cuirass))
(log-file cuirass-configuration-log-file ;string
(default "/var/log/cuirass.log"))
(web-log-file cuirass-configuration-web-log-file ;string
(default "/var/log/cuirass-web.log"))
(cache-directory cuirass-configuration-cache-directory ;string (dir-name)
(default "/var/cache/cuirass"))
(user cuirass-configuration-user ;string
(default "cuirass"))
(group cuirass-configuration-group ;string
(default "cuirass"))
(interval cuirass-configuration-interval ;integer (seconds)
(default 60))
(ttl cuirass-configuration-ttl ;integer
(default 2592000))
(threads cuirass-configuration-threads ;integer
(default #f))
(parameters cuirass-configuration-parameters ;string
(default #f))
(remote-server cuirass-configuration-remote-server
(default #f))
(database cuirass-configuration-database ;string
(default %cuirass-default-database))
(port cuirass-configuration-port ;integer (port)
(default 8081))
(host cuirass-configuration-host ;string
(default "localhost"))
(specifications cuirass-configuration-specifications)
;gexp that evaluates to specification-alist
(one-shot? cuirass-configuration-one-shot? ;boolean
(default #f))
(fallback? cuirass-configuration-fallback? ;boolean
(default #f))
(extra-options cuirass-configuration-extra-options
(default '()))
(web-extra-options cuirass-configuration-web-extra-options
(default '())))
(define (cuirass-shepherd-service config)
"Return a <shepherd-service> for the Cuirass service with CONFIG."
(let ((cuirass (cuirass-configuration-cuirass config))
(cache-directory (cuirass-configuration-cache-directory config))
(web-log-file (cuirass-configuration-web-log-file config))
(main-log-file (cuirass-configuration-log-file config))
(user (cuirass-configuration-user config))
(group (cuirass-configuration-group config))
(interval (cuirass-configuration-interval config))
(ttl (cuirass-configuration-ttl config))
(threads (cuirass-configuration-threads config))
(parameters (cuirass-configuration-parameters config))
(remote-server (cuirass-configuration-remote-server config))
(database (cuirass-configuration-database config))
(port (cuirass-configuration-port config))
(host (cuirass-configuration-host config))
(config-file (scheme-file
"cuirass-specs.scm"
(cuirass-configuration-specifications config)))
(one-shot? (cuirass-configuration-one-shot? config))
(fallback? (cuirass-configuration-fallback? config))
(extra-options (cuirass-configuration-extra-options config))
(web-extra-options (cuirass-configuration-web-extra-options config)))
`(,(shepherd-service
(documentation "Run Cuirass.")
(provision '(cuirass))
(requirement '(user-processes
guix-daemon
postgres postgres-roles networking))
(start #~(make-forkexec-constructor
(list (string-append #$cuirass "/bin/cuirass")
"register"
"--cache-directory" #$cache-directory
"--specifications" #$config-file
"--database" #$database
"--interval" #$(number->string interval)
#$@(if ttl
(list (string-append
"--ttl="
(number->string ttl)
"s"))
'())
#$@(if threads
(list (string-append
"--threads="
(number->string threads)))
'())
#$@(if parameters
(list (string-append
"--parameters="
parameters))
'())
#$@(if remote-server '("--build-remote") '())
#$@(if one-shot? '("--one-shot") '())
#$@(if fallback? '("--fallback") '())
#$@extra-options)
#:environment-variables
(list "GIT_SSL_CAINFO=/etc/ssl/certs/ca-certificates.crt"
(string-append "GIT_EXEC_PATH=" #$git
"/libexec/git-core"))
#:user #$user
#:group #$group
#:log-file #$main-log-file))
(stop #~(make-kill-destructor))
(actions (list (shepherd-configuration-action config-file))))
,(shepherd-service
(documentation "Run Cuirass web interface.")
(provision '(cuirass-web))
(requirement '(user-processes cuirass))
(start #~(make-forkexec-constructor
(list (string-append #$cuirass "/bin/cuirass")
"web"
"--database" #$database
"--listen" #$host
"--port" #$(number->string port)
#$@(if parameters
(list (string-append
"--parameters="
parameters))
'())
#$@web-extra-options)
#:user #$user
#:group #$group
#:log-file #$web-log-file))
(stop #~(make-kill-destructor)))
,@(if remote-server
(match-record remote-server <cuirass-remote-server-configuration>
(backend-port publish-port log-file log-expiry cache publish?
trigger-url public-key private-key)
(list
(shepherd-service
(documentation "Run Cuirass remote build server.")
(provision '(cuirass-remote-server))
(requirement '(user-processes avahi-daemon cuirass))
(start #~(make-forkexec-constructor
(list (string-append #$cuirass "/bin/cuirass")
"remote-server"
(string-append "--database=" #$database)
(string-append "--cache=" #$cache)
(string-append "--user=" #$user)
(string-append "--log-expiry="
#$(number->string log-expiry)
"s")
#$@(if backend-port
(list (string-append
"--backend-port="
(number->string backend-port)))
'())
#$@(if publish-port
(list (string-append
"--publish-port="
(number->string publish-port)))
'())
#$@(if parameters
(list (string-append
"--parameters="
parameters))
'())
#$@(if trigger-url
(list
(string-append
"--trigger-substitute-url="
trigger-url))
'())
#$@(if publish?
'()
(list "--no-publish"))
#$@(if public-key
(list
(string-append "--public-key="
public-key))
'())
#$@(if private-key
(list
(string-append "--private-key="
private-key))
'()))
#:log-file #$log-file))
(stop #~(make-kill-destructor)))))
'()))))
(define (cuirass-account config)
"Return the user accounts and user groups for CONFIG."
(let ((cuirass-user (cuirass-configuration-user config))
(cuirass-group (cuirass-configuration-group config)))
(list (user-group
(name cuirass-group)
(system? #t))
(user-account
(name cuirass-user)
(group cuirass-group)
(system? #t)
(comment "Cuirass privilege separation user")
(home-directory (string-append "/var/lib/" cuirass-user))
(shell (file-append shadow "/sbin/nologin"))))))
(define (cuirass-postgresql-role config)
(let ((user (cuirass-configuration-user config)))
(list (postgresql-role
(name user)
(create-database? #t)))))
(define (cuirass-activation config)
"Return the activation code for CONFIG."
(let* ((cache (cuirass-configuration-cache-directory config))
(remote-server (cuirass-configuration-remote-server config))
(remote-cache (and remote-server
(cuirass-remote-server-configuration-cache
remote-server)))
(user (cuirass-configuration-user config))
;; RUNSTATEDIR contains the "bridge" Unix-domain socket that 'cuirass
;; web' connects to to communicate with 'cuirass register'.
(runstatedir "/var/run/cuirass")
(log "/var/log/cuirass")
(profile (string-append "/var/guix/profiles/per-user/" user))
(roots (string-append profile "/cuirass"))
(group (cuirass-configuration-group config)))
(with-imported-modules '((guix build utils))
#~(begin
(use-modules (guix build utils))
(mkdir-p #$cache)
(mkdir-p #$log)
(mkdir-p #$roots)
(mkdir-p #$runstatedir)
(when #$remote-cache
(mkdir-p #$remote-cache))
(let ((uid (passwd:uid (getpw #$user)))
(gid (group:gid (getgr #$group))))
(chown #$cache uid gid)
(chown #$log uid gid)
(chown #$roots uid gid)
(chown #$profile uid gid)
(chown #$runstatedir uid gid)
(chmod #$runstatedir #o700)
(when #$remote-cache
(chown #$remote-cache uid gid)))))))
(define (cuirass-log-rotations config)
"Return the list of log rotations that corresponds to CONFIG."
(list (log-rotation
(files (append (list (cuirass-configuration-log-file config)
(cuirass-configuration-web-log-file config))
(let ((server
(cuirass-configuration-remote-server config)))
(if server
(list (cuirass-remote-server-log-file server))
'()))))
(frequency 'weekly)
(options `("rotate 40" ;worth keeping
,@%default-log-rotation-options)))))
(define cuirass-service-type
(service-type
(name 'cuirass)
(extensions
(list
(service-extension profile-service-type ;for 'info cuirass'
(compose list cuirass-configuration-cuirass))
(service-extension rottlog-service-type cuirass-log-rotations)
(service-extension activation-service-type cuirass-activation)
(service-extension shepherd-root-service-type cuirass-shepherd-service)
(service-extension account-service-type cuirass-account)
;; Make sure postgresql and postgresql-role are instantiated.
(service-extension postgresql-service-type (const #t))
(service-extension postgresql-role-service-type
cuirass-postgresql-role)))
(description
"Run the Cuirass continuous integration service.")))
(define-record-type* <cuirass-remote-worker-configuration>
cuirass-remote-worker-configuration make-cuirass-remote-worker-configuration
cuirass-remote-worker-configuration?
(cuirass cuirass-remote-worker-configuration-cuirass ;file-like
(default cuirass))
(workers cuirass-remote-worker-workers ;int
(default 1))
(server cuirass-remote-worker-server ;string
(default #f))
(systems cuirass-remote-worker-systems ;list
(default (list (%current-system))))
(log-file cuirass-remote-worker-log-file ;string
(default "/var/log/cuirass-remote-worker.log"))
(publish-port cuirass-remote-worker-configuration-publish-port ;int
(default 5558))
(substitute-urls cuirass-remote-worker-configuration-substitute-urls
(default %default-substitute-urls)) ;list of strings
(public-key cuirass-remote-worker-configuration-public-key ;string
(default #f))
(private-key cuirass-remote-worker-configuration-private-key ;string
(default #f)))
(define (cuirass-remote-worker-shepherd-service config)
"Return a <shepherd-service> for the Cuirass remote worker service with
CONFIG."
(match-record config <cuirass-remote-worker-configuration>
(cuirass workers server systems log-file publish-port
substitute-urls public-key private-key)
(list (shepherd-service
(documentation "Run Cuirass remote build worker.")
(provision '(cuirass-remote-worker))
(requirement '(user-processes avahi-daemon guix-daemon networking))
(start #~(make-forkexec-constructor
(list (string-append #$cuirass "/bin/cuirass")
"remote-worker"
(string-append "--workers="
#$(number->string workers))
#$@(if server
(list (string-append "--server=" server))
'())
#$@(if systems
(list (string-append
"--systems="
(string-join systems ",")))
'())
#$@(if publish-port
(list (string-append
"--publish-port="
(number->string publish-port)))
'())
#$@(if substitute-urls
(list (string-append
"--substitute-urls="
(string-join substitute-urls)))
'())
#$@(if public-key
(list
(string-append "--public-key="
public-key))
'())
#$@(if private-key
(list
(string-append "--private-key="
private-key))
'()))
#:log-file #$log-file))
(stop #~(make-kill-destructor))))))
(define (cuirass-remote-worker-log-rotations config)
"Return the list of log rotations that corresponds to CONFIG."
(list (log-rotation
(files (list (cuirass-remote-worker-log-file config)))
(frequency 'weekly)
(options `("rotate 4" ;don't keep too many of them
,@%default-log-rotation-options)))))
(define cuirass-remote-worker-service-type
(service-type
(name 'cuirass-remote-worker)
(extensions
(list (service-extension shepherd-root-service-type
cuirass-remote-worker-shepherd-service)
(service-extension rottlog-service-type
cuirass-remote-worker-log-rotations)))
(description
"Run the Cuirass remote build worker service.")))
