aboutsummaryrefslogtreecommitdiff
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2015, 2017, 2022, 2023, 2024 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2016 Ben Woodcroft <donttrustben@gmail.com>
;;; Copyright © 2020 Martin Becze <mjbecze@riseup.net>
;;; Copyright © 2021 Sarah Morgensen <iskarian@mgsn.dev>
;;;
;;; 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-import-utils)
  #:use-module (guix tests)
  #:use-module (guix import utils)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix packages)
  #:use-module (guix build-system)
  #:use-module (gnu packages)
  #:use-module (srfi srfi-64)
  #:use-module (ice-9 match))

(test-begin "import-utils")

(test-equal "beautify-description: use double spacing"
  "\
Trust me Mr. Hendrix, M. Night Shyamalan et al.  \
Differences are hard to spot,
e.g. in CLOS vs. GOOPS."
  (beautify-description
   "
Trust me Mr. Hendrix, M. Night Shyamalan et al. \
Differences are hard to spot, e.g. in CLOS vs. GOOPS."))

(test-equal "beautify-description: transform fragment into sentence"
  "This package provides a function to establish world peace."
  (beautify-description "A function to establish world peace"))

(test-equal "beautify-description: remove single quotes"
  "CRAN likes to quote acronyms and function names."
  (beautify-description "CRAN likes to 'quote' acronyms and 'function' names."))

(test-equal "beautify-description: escape @"
  "This @@ is not Texinfo syntax.  Neither is this %@@>%."
  (beautify-description "This @ is not Texinfo syntax.  Neither is this %@>%."))

(test-equal "beautify-description: wrap PascalCase words in @code"
  "The term @code{DelayedMatrix} refers to a class."
  (beautify-description "The term DelayedMatrix refers to a class."))

(test-equal "beautify-description: do not wrap acronyms in @code"
  "The term API is not code, but @code{myAPI} might be."
  (beautify-description "The term API is not code, but myAPI might be."))

(test-equal "beautify-description: do not include punctuation when wrapping in @code"
  "Code (@code{DelayedMatrix}, @code{MaMa}, or @code{MeMe}) should be wrapped."
  (beautify-description "Code (DelayedMatrix, MaMa, or MeMe) should be wrapped."))

(test-equal "beautify-description: wrap function names in @code"
  "The main functions are: @code{haplo.em()} and @code{haplo.power()}; FYI."
  (beautify-description "The main functions are: haplo.em() and haplo.power(); FYI."))

(test-equal "license->symbol"
  'license:lgpl2.0
  (license->symbol license:lgpl2.0))

(test-equal "recursive-import"
  '((package                         ;package expressions in topological order
      (name "bar"))
    (package
      (name "foo")
      (inputs `(("bar" ,bar)))))
  (recursive-import "foo"
                    #:repo 'repo
                    #:repo->guix-package
                    (match-lambda*
                      (("foo" #:repo 'repo . rest)
                       (values '(package
                                  (name "foo")
                                  (inputs `(("bar" ,bar))))
                               '("bar")))
                      (("bar" #:repo 'repo . rest)
                       (values '(package
                                  (name "bar"))
                               '())))
                    #:guix-name identity))

(test-equal "recursive-import: skip false packages (toplevel)"
  '()
  (recursive-import "foo"
                    #:repo 'repo
                    #:repo->guix-package
                    (match-lambda*
                      (("foo" #:repo 'repo . rest)
                       (values #f '())))
                    #:guix-name identity))

(test-equal "recursive-import: skip false packages (dependency)"
  '((package
      (name "foo")
      (inputs `(("bar" ,bar)))))
  (recursive-import "foo"
                    #:repo 'repo
                    #:repo->guix-package
                    (match-lambda*
                      (("foo" #:repo 'repo . rest)
                       (values '(package
                                  (name "foo")
                                  (inputs `(("bar" ,bar))))
                               '("bar")))
                      (("bar" #:repo 'repo . rest)
                       (values #f '())))
                    #:guix-name identity))

(test-assert "alist->package with simple source"
  (let* ((meta '(("name" . "hello")
                 ("version" . "2.10")
                 ("source" .
                  ;; Use a 'file://' URI so that we don't cause a download.
                  ,(string-append "file://"
                                  (search-path %load-path "guix.scm")))
                 ("build-system" . "gnu")
                 ("home-page" . "https://gnu.org")
                 ("synopsis" . "Say hi")
                 ("description" . "This package says hi.")
                 ("license" . "GPL-3.0+")))
         (pkg (alist->package meta)))
    (and (package? pkg)
         (license:license? (package-license pkg))
         (build-system? (package-build-system pkg))
         (origin? (package-source pkg)))))

(test-assert "alist->package with explicit source"
  (let* ((meta '(("name" . "hello")
                 ("version" . "2.10")
                 ("source" . (("method" . "url-fetch")
                              ("uri"    . "mirror://gnu/hello/hello-2.10.tar.gz")
                              ("sha256" .
                               (("base32" .
                                 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))))
                 ("build-system" . "gnu")
                 ("home-page" . "https://gnu.org")
                 ("synopsis" . "Say hi")
                 ("description" . "This package says hi.")
                 ("license" . "GPL-3.0+")))
         (pkg (alist->package meta)))
    (and (package? pkg)
         (license:license? (package-license pkg))
         (build-system? (package-build-system pkg))
         (origin? (package-source pkg))
         (equal? (content-hash-value (origin-hash (package-source pkg)))
                 (base32 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))))

(test-equal "alist->package with false license"  ;<https://bugs.gnu.org/30470>
  'license-is-false
  (let* ((meta '(("name" . "hello")
                 ("version" . "2.10")
                 ("source" . (("method" . "url-fetch")
                              ("uri"    . "mirror://gnu/hello/hello-2.10.tar.gz")
                              ("sha256" .
                               (("base32" .
                                 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))))
                 ("build-system" . "gnu")
                 ("home-page" . "https://gnu.org")
                 ("synopsis" . "Say hi")
                 ("description" . "This package says hi.")
                 ("license" . #f))))
    ;; Note: Use 'or' because comparing with #f otherwise succeeds when
    ;; there's an exception instead of an actual #f.
    (or (package-license (alist->package meta))
        'license-is-false)))

(test-equal "alist->package with SPDX license name 1/2"  ;<https://bugs.gnu.org/45453>
  license:expat
  (let* ((meta '(("name" . "hello")
                 ("version" . "2.10")
                 ("source" . (("method" . "url-fetch")
                              ("uri"    . "mirror://gnu/hello/hello-2.10.tar.gz")
                              ("sha256" .
                               (("base32" .
                                 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))))
                 ("build-system" . "gnu")
                 ("home-page" . "https://gnu.org")
                 ("synopsis" . "Say hi")
                 ("description" . "This package says hi.")
                 ("license" . "expat"))))
    (package-license (alist->package meta))))

(test-equal "alist->package with SPDX license name 2/2"  ;<https://bugs.gnu.org/45453>
  license:expat
  (let* ((meta '(("name" . "hello")
                 ("version" . "2.10")
                 ("source" . (("method" . "url-fetch")
                              ("uri"    . "mirror://gnu/hello/hello-2.10.tar.gz")
                              ("sha256" .
                               (("base32" .
                                 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))))
                 ("build-system" . "gnu")
                 ("home-page" . "https://gnu.org")
                 ("synopsis" . "Say hi")
                 ("description" . "This package says hi.")
                 ("license" . "MIT"))))
    (package-license (alist->package meta))))

(test-equal "alist->package with dependencies"
  `(("gettext" ,(specification->package "gettext")))
  (let* ((meta '(("name" . "hello")
                 ("version" . "2.10")
                 ("source" . (("method" . "url-fetch")
                              ("uri"    . "mirror://gnu/hello/hello-2.10.tar.gz")
                              ("sha256" .
                               (("base32" .
                                 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))))
                 ("build-system" . "gnu")
                 ("home-page" . "https://gnu.org")
                 ("synopsis" . "Say hi")
                 ("description" . "This package says hi.")
                                                  ;
                 ;; Note: As with Guile-JSON 3.x, JSON arrays are represented
                 ;; by vectors.
                 ("native-inputs" . #("gettext"))

                 ("license" . #f))))
    (package-native-inputs (alist->package meta))))

(test-assert "alist->package with properties"
  (let* ((meta '(("name" . "hello")
                 ("version" . "2.10")
                 ("source" .
                  ;; Use a 'file://' URI so that we don't cause a download.
                  ,(string-append "file://"
                                  (search-path %load-path "guix.scm")))
                 ("build-system" . "gnu")
                 ("properties" . (("hidden?" . #t)
                                  ("upstream-name" . "hello-upstream")))
                 ("home-page" . "https://gnu.org")
                 ("synopsis" . "Say hi")
                 ("description" . "This package says hi.")
                 ("license" . "GPL-3.0+")))
         (pkg (alist->package meta)))
    (and (package? pkg)
         (equal? (package-upstream-name pkg) "hello-upstream")
         (hidden-package? pkg))))

(test-equal "spdx-string->license"
  '(license:gpl3+ license:agpl3 license:gpl2+)
  (map spdx-string->license
       '("GPL-3.0-oR-LaTeR" "AGPL-3.0" "GPL-2.0+")))

(test-end "import-utils")
#f))) (test-assert "fold-services, missing target" (let* ((t1 (service-type (name 't1) (extensions '()))) (t2 (service-type (name 't2) (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 '()) (default-value 'dflt) (compose concatenate) (extend cons))) (t2 (service-type (name 't2) (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 '()) (default-value 'dflt) (compose concatenate) (extend cons))) (t2 (service-type (name 't2) (default-value 'dflt2) (compose concatenate) (extend cons) (extensions (list (service-extension t1 list))))) (t3 (service-type (name 't3) (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 '()))) (t2 (service-type (name 't2) (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) '() #t) (live-service '(bar) '() #f) (live-service '(root) '() #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) #t) (live-service '(bar) '() #t) ;still used! (live-service '(baz) '() #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) #t) ;obsolete (live-service '(bar) '(baz) #t) ;obsolete (live-service '(baz) '() #t)) ;obsolete (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-end)