;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2019, 2020 Miguel Ángel Arruga Vivas ;;; Copyright © 2022 Josselin Poiret ;;; ;;; 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 . ;;; Commentary: ;;; ;;; Test boot parameters value storage and compatibility. ;;; ;;; Code: (define-module (test-
aboutsummaryrefslogtreecommitdiff
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
;;; Copyright © 2021 Andrew Tropin <andrew@trop.in>
;;;
;;; 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 home services utils)
  #:use-module (ice-9 string-fun)
  #:use-module (srfi srfi-1)
  #:use-module (srfi srfi-26)

  #:export (maybe-object->string
            object->snake-case-string
            object->camel-case-string
            list->human-readable-list))

(define (maybe-object->string object)
  "Like @code{object->string} but don't do anything if OBJECT already is
a string."
  (if (string? object)
      object
      (object->string object)))

;; Snake case: <https://en.wikipedia.org/wiki/Snake_case>
(define* (object->snake-case-string object #:optional (style 'lower))
  "Convert the object OBJECT to the equivalent string in ``snake
case''.  STYLE can be three `@code{lower}', `@code{upper}', or
`@code{capitalize}', defaults to `@code{lower}'.

@example
(object->snake-case-string 'variable-name 'upper)
@result{} \"VARIABLE_NAME\" @end example"
  (if (not (member style '(lower upper capitalize)))
      (error 'invalid-style (format #f "~a is not a valid style" style))
      (let ((stringified (maybe-object->string object)))
        (string-replace-substring
         (cond
          ((equal? style 'lower) stringified)
          ((equal? style 'upper) (string-upcase stringified))
          (else (string-capitalize stringified)))
         "-" "_"))))

(define* (object->camel-case-string object #:optional (style 'lower))
  "Convert the object OBJECT to the equivalent string in ``camel case''.
STYLE can be three `@code{lower}', `@code{upper}', defaults to
`@code{lower}'.

@example
(object->camel-case-string 'variable-name 'upper)
@result{} \"VariableName\"
@end example"
  (if (not (member style '(lower upper)))
      (error 'invalid-style (format #f "~a is not a valid style" style))
      (let ((stringified (maybe-object->string object)))
        (cond
         ((eq? style 'upper)
          (string-concatenate
           (map string-capitalize
                (string-split stringified (cut eqv? <> #\-)))))
         ((eq? style 'lower)
          (let ((splitted-string (string-split stringified (cut eqv? <> #\-))))
            (string-concatenate
             (cons (first splitted-string)
                   (map string-capitalize
                        (cdr splitted-string))))))))))

(define* (list->human-readable-list lst
                                    #:key
                                    (cumulative? #f)
                                    (proc identity))
  "Turn a list LST into a sequence of terms readable by humans.
If CUMULATIVE? is @code{#t}, use ``and'', otherwise use ``or'' before
the last term.

PROC is a procedure to apply to each of the elements of a list before
turning them into a single human readable string.

@example
(list->human-readable-list '(1 4 9) #:cumulative? #t #:proc sqrt)
@result{} \"1, 2, and 3\"
@end example

yields:"
  (let* ((word (if cumulative? "and " "or "))
         (init (append (drop-right lst 1))))
    (format #f "~a" (string-append
                     (string-join
                      (map (compose maybe-object->string proc) init)
                      ", " 'suffix)
                     word
                     (maybe-object->string (proc (last lst)))))))
generated by cgit
t-parameters args ...)))))) (not (or (test-read-boot-parameters #:version #false) (test-read-boot-parameters #:version 'false) (test-read-boot-parameters #:version -1) (test-read-boot-parameters #:version "0") (test-read-boot-parameters #:root-device #false) (test-read-boot-parameters #:kernel #false) (test-read-boot-parameters #:label #false))))) (test-assert "read, construction, optional fields" (and (test-read-boot-parameters #:bootloader-name #false) (test-read-boot-parameters #:bootloader-menu-entries #false) (test-read-boot-parameters #:kernel-arguments #false) (test-read-boot-parameters #:with-store #false) (test-read-boot-parameters #:store-device #false) (test-read-boot-parameters #:store-device 'false) (test-read-boot-parameters #:store-crypto-devices #false) (test-read-boot-parameters #:store-mount-point #false) (test-read-boot-parameters #:store-directory-prefix #false) (test-read-boot-parameters #:multiboot-modules #false) (test-read-boot-parameters #:locale #false) (test-read-boot-parameters #:bootloader-name #false #:kernel-arguments #false #:with-store #false #:locale #false))) (test-equal "read, default equality" %grub-boot-parameters (test-read-boot-parameters)) (test-equal "read, root-device, label" (file-system-label "my-root") (boot-parameters-root-device (test-read-boot-parameters #:root-device '(file-system-label "my-root")))) (test-equal "read, root-device, /dev node" "/dev/sda2" (boot-parameters-root-device (test-read-boot-parameters #:root-device "/dev/sda2"))) (test-equal "read, kernel, only store path" %default-kernel (boot-parameters-kernel (test-read-boot-parameters #:kernel %default-kernel-path))) (test-equal "read, kernel, full-path" %default-kernel (boot-parameters-kernel (test-read-boot-parameters #:kernel %default-kernel))) (test-assert "read, construction, missing initrd" (not (boot-parameters-initrd (test-read-boot-parameters #:initrd #false)))) (test-equal "read, initrd, old format" "/a/b" (boot-parameters-initrd (test-read-boot-parameters #:initrd (list 'string-append "/a" "/b")))) ;; Compatibility reasons specified in gnu/system.scm. (test-eq "read, bootloader-name, default value" 'grub (boot-parameters-bootloader-name (test-read-boot-parameters #:bootloader-name #false))) (test-eq "read, bootloader-menu-entries, default value" '() (boot-parameters-bootloader-menu-entries (test-read-boot-parameters #:bootloader-menu-entries #false))) (test-eq "read, kernel-arguments, default value" '() (boot-parameters-kernel-arguments (test-read-boot-parameters #:kernel-arguments #false))) (test-assert "read, store-device, filter /dev" (not (boot-parameters-store-device (test-read-boot-parameters #:store-device "/dev/sda3")))) (test-assert "read, no-store, filter /dev from root" (not (boot-parameters-store-device (test-read-boot-parameters #:root-device "/dev/sda3" #:with-store #false)))) (test-assert "read, no store-device, filter /dev from root" (not (boot-parameters-store-device (test-read-boot-parameters #:root-device "/dev/sda3" #:store-device #false)))) (test-assert "read, store-device #false, filter /dev from root" (not (boot-parameters-store-device (test-read-boot-parameters #:root-device "/dev/sda3" #:store-device 'false)))) (test-equal "read, store-device, label (legacy)" (file-system-label "my-store") (boot-parameters-store-device (test-read-boot-parameters #:store-device "my-store"))) (test-equal "read, store-device, from root" %default-root-device (boot-parameters-store-device (test-read-boot-parameters #:with-store #false))) (test-equal "read, no store-mount-point, default" %root-path (boot-parameters-store-mount-point (test-read-boot-parameters #:store-mount-point #false))) (test-equal "read, no store, default store-mount-point" %root-path (boot-parameters-store-mount-point (test-read-boot-parameters #:with-store #false))) (test-equal "read, store-crypto-devices, default" '() (boot-parameters-store-crypto-devices (test-read-boot-parameters #:store-crypto-devices #false))) ;; XXX: (test-equal "read, store-crypto-devices, false" '() (boot-parameters-store-crypto-devices (test-read-boot-parameters #:store-crypto-devices 'false))) ;; XXX: (test-equal "read, store-crypto-devices, string" '() (boot-parameters-store-crypto-devices (test-read-boot-parameters #:store-crypto-devices "bad"))) ;; For whitebox testing (define operating-system-boot-parameters (@@ (gnu system) operating-system-boot-parameters)) (test-equal "from os, locale" %default-locale (boot-parameters-locale (operating-system-boot-parameters %default-operating-system %default-root-device))) (test-equal "from os, store-directory-prefix" %default-store-directory-prefix (boot-parameters-store-directory-prefix (operating-system-boot-parameters %default-operating-system %default-root-device))) (define %uuid-menu-entry (menu-entry (label "test") (device (uuid "6d5b13d4-6092-46d0-8be4-073dc07413cc")) (linux "/boot/bzImage") (initrd "/boot/initrd.cpio.gz"))) (define %file-system-label-menu-entry (menu-entry (label "test") (device (file-system-label "test-label")) (linux "/boot/bzImage") (initrd "/boot/initrd.cpio.gz"))) (test-equal "menu-entry roundtrip, uuid" %uuid-menu-entry (sexp->menu-entry (menu-entry->sexp %uuid-menu-entry))) (test-equal "menu-entry roundtrip, file-system-label" %file-system-label-menu-entry (sexp->menu-entry (menu-entry->sexp %file-system-label-menu-entry))) (test-end "boot-parameters")