Fixes <https://issues.guix.gnu.org/63921>.
The regression was introduced in
dbbc7e9461, which changed the order of
services.  As a result, someone using 'modify-services' could find
themselves with incorrect ordering of expressions in the "boot" script,
whereby the cleanup expressions would come after (execl ".../shepherd").
This, in turn, would lead shepherd to error out at boot with EADDRINUSE
on /var/run/shepherd/socket.
* gnu/services.scm (%delete-service, %apply-clauses): Remove.
(clause-alist): New macro.
(apply-clauses): New procedure.
(modify-services): Use it.  Adjust docstring.
* tests/services.scm ("modify-services: do nothing"): Remove 'sort' call.
("modify-services: delete service"): Likewise, and add 't4' service.
("modify-services: change value"): Remove 'sort' call and fix expected value.
		
	
			
		
			
				
	
	
		
			373 lines
		
	
	
	
		
			16 KiB
		
	
	
	
		
			Scheme
		
	
	
	
	
	
			
		
		
	
	
			373 lines
		
	
	
	
		
			16 KiB
		
	
	
	
		
			Scheme
		
	
	
	
	
	
;;; GNU Guix --- Functional package management for GNU
 | 
						||
;;; Copyright © 2015-2019, 2022, 2023 Ludovic Courtès <ludo@gnu.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 (test-services)
 | 
						||
  #:use-module (gnu services)
 | 
						||
  #:use-module (gnu services herd)
 | 
						||
  #:use-module (gnu services shepherd)
 | 
						||
  #:use-module (srfi srfi-1)
 | 
						||
  #:use-module (srfi srfi-26)
 | 
						||
  #:use-module (srfi srfi-34)
 | 
						||
  #:use-module (srfi srfi-64)
 | 
						||
  #:use-module (ice-9 match))
 | 
						||
 | 
						||
(test-begin "services")
 | 
						||
 | 
						||
(test-equal "services, default value"
 | 
						||
  '(42 123 234 error)
 | 
						||
  (let* ((t1 (service-type (name 't1) (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t2 (service-type (name 't2) (extensions '())
 | 
						||
                           (description "")
 | 
						||
                           (default-value 42))))
 | 
						||
    (list (service-value (service t2))
 | 
						||
          (service-value (service t2 123))
 | 
						||
          (service-value (service t1 234))
 | 
						||
          (guard (c ((missing-value-service-error? c) 'error))
 | 
						||
            (service t1)))))
 | 
						||
 | 
						||
(test-assert "service-back-edges"
 | 
						||
  (let* ((t1 (service-type (name 't1) (extensions '()) (description "")
 | 
						||
                           (compose +) (extend *)))
 | 
						||
         (t2 (service-type (name 't2) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t1 (const '()))))
 | 
						||
                           (compose +) (extend *)))
 | 
						||
         (t3 (service-type (name 't3) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t2 identity)
 | 
						||
                                  (service-extension t1 list)))))
 | 
						||
         (s1 (service t1 #t))
 | 
						||
         (s2 (service t2 #t))
 | 
						||
         (s3 (service t3 #t))
 | 
						||
         (e  (service-back-edges (list s1 s2 s3))))
 | 
						||
    (and (lset= eq? (e s1) (list s2 s3))
 | 
						||
         (lset= eq? (e s2) (list s3))
 | 
						||
         (null? (e s3)))))
 | 
						||
 | 
						||
(test-equal "fold-services"
 | 
						||
  ;; Make sure 'fold-services' returns the right result.  The numbers come
 | 
						||
  ;; from services of type T3; 'xyz 60' comes from the service of type T2,
 | 
						||
  ;; where 60 = 15 × 4 = (1 + 2 + 3 + 4 + 5) × 4.
 | 
						||
  '(initial-value 5 4 3 2 1 xyz 60)
 | 
						||
  (let* ((t1 (service-type (name 't1) (extensions '()) (description "")
 | 
						||
                           (compose concatenate)
 | 
						||
                           (extend cons)))
 | 
						||
         (t2 (service-type (name 't2) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t1
 | 
						||
                                                     (cut list 'xyz <>))))
 | 
						||
                           (compose (cut reduce + 0 <>))
 | 
						||
                           (extend *)))
 | 
						||
         (t3 (service-type (name 't3) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t2 identity)
 | 
						||
                                  (service-extension t1 list)))))
 | 
						||
         (r  (fold-services (cons* (service t1 'initial-value)
 | 
						||
                                   (service t2 4)
 | 
						||
                                   (map (lambda (x)
 | 
						||
                                          (service t3 x))
 | 
						||
                                        (iota 5 1)))
 | 
						||
                            #:target-type t1)))
 | 
						||
    (and (eq? (service-kind r) t1)
 | 
						||
         (service-value r))))
 | 
						||
 | 
						||
(test-assert "fold-services, ambiguity"
 | 
						||
  (let* ((t1 (service-type (name 't1) (extensions '()) (description "")
 | 
						||
                           (compose concatenate)
 | 
						||
                           (extend cons)))
 | 
						||
         (t2 (service-type (name 't2) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t1 list)))))
 | 
						||
         (s  (service t2 42)))
 | 
						||
    (guard (c ((ambiguous-target-service-error? c)
 | 
						||
               (and (eq? (ambiguous-target-service-error-target-type c)
 | 
						||
                         t1)
 | 
						||
                    (eq? (ambiguous-target-service-error-service c)
 | 
						||
                         s))))
 | 
						||
      (fold-services (list (service t1 'first)
 | 
						||
                           (service t1 'second)
 | 
						||
                           s)
 | 
						||
                     #:target-type t1)
 | 
						||
      #f)))
 | 
						||
 | 
						||
(test-assert "fold-services, missing target"
 | 
						||
  (let* ((t1 (service-type (name 't1) (extensions '()) (description "")))
 | 
						||
         (t2 (service-type (name 't2) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t1 list)))))
 | 
						||
         (s  (service t2 42)))
 | 
						||
    (guard (c ((missing-target-service-error? c)
 | 
						||
               (and (eq? (missing-target-service-error-target-type c)
 | 
						||
                         t1)
 | 
						||
                    (eq? (missing-target-service-error-service c)
 | 
						||
                         s))))
 | 
						||
      (fold-services (list s) #:target-type t1)
 | 
						||
      #f)))
 | 
						||
 | 
						||
(test-assert "instantiate-missing-services"
 | 
						||
  (let* ((t1 (service-type (name 't1) (extensions '()) (description "")
 | 
						||
                           (default-value 'dflt)
 | 
						||
                           (compose concatenate)
 | 
						||
                           (extend cons)))
 | 
						||
         (t2 (service-type (name 't2) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t1 list)))))
 | 
						||
         (s1 (service t1 'hey!))
 | 
						||
         (s2 (service t2 42)))
 | 
						||
    (and (lset= equal?
 | 
						||
                (list (service t1) s2)
 | 
						||
                (instantiate-missing-services (list s2)))
 | 
						||
         (equal? (list s1 s2)
 | 
						||
                 (instantiate-missing-services (list s1 s2))))))
 | 
						||
 | 
						||
(test-assert "instantiate-missing-services, indirect"
 | 
						||
  (let* ((t1 (service-type (name 't1) (extensions '()) (description "")
 | 
						||
                           (default-value 'dflt)
 | 
						||
                           (compose concatenate)
 | 
						||
                           (extend cons)))
 | 
						||
         (t2 (service-type (name 't2) (description "")
 | 
						||
                           (default-value 'dflt2)
 | 
						||
                           (compose concatenate)
 | 
						||
                           (extend cons)
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t1 list)))))
 | 
						||
         (t3 (service-type (name 't3) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t2 list)))))
 | 
						||
         (s1 (service t1))
 | 
						||
         (s2 (service t2))
 | 
						||
         (s3 (service t3 42))
 | 
						||
         (== (cut lset= equal? <...>)))
 | 
						||
    (and (== (list s1 s2 s3)
 | 
						||
             (instantiate-missing-services (list s3)))
 | 
						||
         (== (list s1 s2 s3)
 | 
						||
             (instantiate-missing-services (list s1 s3)))
 | 
						||
         (== (list s1 s2 s3)
 | 
						||
             (instantiate-missing-services (list s2 s3))))))
 | 
						||
 | 
						||
(test-assert "instantiate-missing-services, no default value"
 | 
						||
  (let* ((t1 (service-type (name 't1) (extensions '()) (description "")))
 | 
						||
         (t2 (service-type (name 't2) (description "")
 | 
						||
                           (extensions
 | 
						||
                            (list (service-extension t1 list)))))
 | 
						||
         (s  (service t2 42)))
 | 
						||
    (guard (c ((missing-target-service-error? c)
 | 
						||
               (and (eq? (missing-target-service-error-target-type c)
 | 
						||
                         t1)
 | 
						||
                    (eq? (missing-target-service-error-service c)
 | 
						||
                         s))))
 | 
						||
      (instantiate-missing-services (list s))
 | 
						||
      #f)))
 | 
						||
 | 
						||
(test-assert "shepherd-service-lookup-procedure"
 | 
						||
  (let* ((s1 (shepherd-service (provision '(s1 s1b)) (start #f)))
 | 
						||
         (s2 (shepherd-service (provision '(s2 s2b)) (start #f)))
 | 
						||
         (s3 (shepherd-service (provision '(s3 s3b s3c)) (start #f)))
 | 
						||
         (lookup (shepherd-service-lookup-procedure (list s1 s2 s3))))
 | 
						||
    (and (eq? (lookup 's1) (lookup 's1b) s1)
 | 
						||
         (eq? (lookup 's2) (lookup 's2b) s2)
 | 
						||
         (eq? (lookup 's3) (lookup 's3b) s3))))
 | 
						||
 | 
						||
(test-assert "shepherd-service-back-edges"
 | 
						||
  (let* ((s1 (shepherd-service (provision '(s1)) (start #f)))
 | 
						||
         (s2 (shepherd-service (provision '(s2))
 | 
						||
                               (requirement '(s1))
 | 
						||
                               (start #f)))
 | 
						||
         (s3 (shepherd-service (provision '(s3))
 | 
						||
                               (requirement '(s1 s2))
 | 
						||
                               (start #f)))
 | 
						||
         (e  (shepherd-service-back-edges (list s1 s2 s3))))
 | 
						||
    (and (lset= eq? (e s1) (list s2 s3))
 | 
						||
         (lset= eq? (e s2) (list s3))
 | 
						||
         (null? (e s3)))))
 | 
						||
 | 
						||
(test-equal "shepherd-service-upgrade: nothing to do"
 | 
						||
  '(() ())
 | 
						||
  (call-with-values
 | 
						||
      (lambda ()
 | 
						||
        (shepherd-service-upgrade '() '()))
 | 
						||
    list))
 | 
						||
 | 
						||
(test-equal "shepherd-service-upgrade: one unchanged, one upgraded, one new"
 | 
						||
  '(()                                            ;unload
 | 
						||
    ((foo)))                                      ;restart
 | 
						||
  (call-with-values
 | 
						||
      (lambda ()
 | 
						||
        ;; Here 'foo' is replaced and must be explicitly restarted later
 | 
						||
        ;; because it is still running, whereas 'bar' is upgraded right away
 | 
						||
        ;; because it is not currently running.  'baz' is loaded because it's
 | 
						||
        ;; a new service.
 | 
						||
        (shepherd-service-upgrade
 | 
						||
         (list (live-service '(foo) '() #f #t)
 | 
						||
               (live-service '(bar) '() #f #f)
 | 
						||
               (live-service '(root) '() #f #t))     ;essential!
 | 
						||
         (list (shepherd-service (provision '(foo))
 | 
						||
                                 (start #t))
 | 
						||
               (shepherd-service (provision '(bar))
 | 
						||
                                 (start #t))
 | 
						||
               (shepherd-service (provision '(baz))
 | 
						||
                                 (start #t)))))
 | 
						||
    (lambda (unload restart)
 | 
						||
      (list (map live-service-provision unload)
 | 
						||
            (map shepherd-service-provision restart)))))
 | 
						||
 | 
						||
(test-equal "shepherd-service-upgrade: service depended on is not unloaded"
 | 
						||
  '(((baz))                                       ;unload
 | 
						||
    ((foo)))                                      ;restart
 | 
						||
  (call-with-values
 | 
						||
      (lambda ()
 | 
						||
        ;; Service 'bar' is not among the target services; yet, it must not be
 | 
						||
        ;; unloaded because 'foo' depends on it.  'foo' gets replaced but it
 | 
						||
        ;; must be restarted manually.
 | 
						||
        (shepherd-service-upgrade
 | 
						||
         (list (live-service '(foo) '(bar) #f #t)
 | 
						||
               (live-service '(bar) '() #f #t)    ;still used!
 | 
						||
               (live-service '(baz) '() #f #t))
 | 
						||
         (list (shepherd-service (provision '(foo))
 | 
						||
                                 (start #t)))))
 | 
						||
    (lambda (unload restart)
 | 
						||
      (list (map live-service-provision unload)
 | 
						||
            (map shepherd-service-provision restart)))))
 | 
						||
 | 
						||
(test-equal "shepherd-service-upgrade: obsolete services that depend on each other"
 | 
						||
  '(((foo) (bar) (baz))                           ;unload
 | 
						||
    ())                                           ;restart
 | 
						||
  (call-with-values
 | 
						||
      (lambda ()
 | 
						||
        ;; 'foo', 'bar', and 'baz' depend on each other, but all of them are
 | 
						||
        ;; obsolete, and thus should be unloaded.
 | 
						||
        (shepherd-service-upgrade
 | 
						||
         (list (live-service '(foo) '(bar) #f #t) ;obsolete
 | 
						||
               (live-service '(bar) '(baz) #f #t) ;obsolete
 | 
						||
               (live-service '(baz) '() #f #t))   ;obsolete
 | 
						||
         (list (shepherd-service (provision '(qux))
 | 
						||
                                 (start #t)))))
 | 
						||
    (lambda (unload restart)
 | 
						||
      (list (map live-service-provision unload)
 | 
						||
            (map shepherd-service-provision restart)))))
 | 
						||
 | 
						||
(test-equal "shepherd-service-upgrade: transient service"
 | 
						||
  ;; Transient service must not be unloaded:
 | 
						||
  ;; <https://issues.guix.gnu.org/54812>.
 | 
						||
  '(((foo))                                       ;unload
 | 
						||
    ((qux)))                                      ;restart
 | 
						||
  (call-with-values
 | 
						||
      (lambda ()
 | 
						||
        (shepherd-service-upgrade
 | 
						||
         (list (live-service '(sshd-42) '() #t 42) ;transient
 | 
						||
               (live-service '(foo) '() #f #t)     ;obsolete
 | 
						||
               (live-service '(qux) '() #f #t))    ;running
 | 
						||
         (list (shepherd-service (provision '(qux))
 | 
						||
                                 (start #t)))))
 | 
						||
    (lambda (unload restart)
 | 
						||
      (list (map live-service-provision unload)
 | 
						||
            (map shepherd-service-provision restart)))))
 | 
						||
 | 
						||
(test-eq "lookup-service-types"
 | 
						||
  system-service-type
 | 
						||
  (and (null? (lookup-service-types 'does-not-exist-at-all))
 | 
						||
       (match (lookup-service-types 'system)
 | 
						||
         ((one) one)
 | 
						||
         (x x))))
 | 
						||
 | 
						||
(test-equal "modify-services: do nothing"
 | 
						||
  '(1 2 3)                              ;note: service order must be preserved
 | 
						||
  (let* ((t1 (service-type (name 't1)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t2 (service-type (name 't2)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t3 (service-type (name 't3)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (services (list (service t1 1) (service t2 2) (service t3 3))))
 | 
						||
    (map service-value
 | 
						||
         (modify-services services))))
 | 
						||
 | 
						||
(test-equal "modify-services: delete service"
 | 
						||
  '(1 4)                                ;note: service order must be preserved
 | 
						||
  (let* ((t1 (service-type (name 't1)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t2 (service-type (name 't2)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t3 (service-type (name 't3)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t4 (service-type (name 't4)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (services (list (service t1 1) (service t2 2)
 | 
						||
                         (service t3 3) (service t4 4))))
 | 
						||
    (map service-value
 | 
						||
         (modify-services services
 | 
						||
           (delete t3)
 | 
						||
           (delete t2)))))
 | 
						||
 | 
						||
(test-error "modify-services: delete non-existing service"
 | 
						||
  #t
 | 
						||
  (let* ((t1 (service-type (name 't1)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t2 (service-type (name 't2)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t3 (service-type (name 't2)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (services (list (service t1 1) (service t2 2))))
 | 
						||
    (modify-services services
 | 
						||
      (delete t3))))
 | 
						||
 | 
						||
(test-equal "modify-services: change value"
 | 
						||
  '(11 2 33)                            ;note: service order must be preserved
 | 
						||
  (let* ((t1 (service-type (name 't1)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t2 (service-type (name 't2)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t3 (service-type (name 't3)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (services (list (service t1 1) (service t2 2) (service t3 3))))
 | 
						||
    (map service-value
 | 
						||
         (modify-services services
 | 
						||
           (t1 value => 11)
 | 
						||
           (t3 value => 33)))))
 | 
						||
 | 
						||
(test-error "modify-services: change value for non-existing service"
 | 
						||
  #t
 | 
						||
  (let* ((t1 (service-type (name 't1)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t2 (service-type (name 't2)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (t3 (service-type (name 't3)
 | 
						||
                           (extensions '())
 | 
						||
                           (description "")))
 | 
						||
         (services (list (service t1 1) (service t3 3))))
 | 
						||
    (map service-value
 | 
						||
         (modify-services services
 | 
						||
           (t2 value => 22)))))
 | 
						||
 | 
						||
(test-end)
 |