From 7a811fae4f44c279f773a9ad8201f61edab100f6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Miguel=20=C3=81ngel=20Arruga=20Vivas?=
Date: Mon, 21 Oct 2019 12:23:40 +0200
Subject: [PATCH 1/3] system: Add locale to boot-parameters.
* gnu/system.scm (define-module)[export]: Add boot-parameters-locale.
()[locale]: New field.
[boot-parameters-locale]: New accessor.
(read-boot-parameters): Read locale field.
(operating-system-boot-parameters): Provide operating-system locale to
boot-parameters record.
(opeating-system-boot-parameters-file): Likewise.
* Makefile.am (SCM_TESTS): Add tests/boot-parameters.scm.
* tests/boot-parameters.scm: New test file.
---
Makefile.am | 1 +
gnu/system.scm | 19 ++-
tests/boot-parameters.scm | 250 ++++++++++++++++++++++++++++++++++++++
3 files changed, 266 insertions(+), 4 deletions(-)
create mode 100644 tests/boot-parameters.scm
diff --git a/Makefile.am b/Makefile.am
index 36767c2f47..6784ecea81 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -384,6 +384,7 @@ SCM_TESTS = \
tests/build-utils.scm \
tests/cache.scm \
tests/challenge.scm \
+ tests/boot-parameters.scm \
tests/channels.scm \
tests/combinators.scm \
tests/containers.scm \
diff --git a/gnu/system.scm b/gnu/system.scm
index a353b1a5c8..be49724bc3 100644
--- a/gnu/system.scm
+++ b/gnu/system.scm
@@ -5,6 +5,7 @@
;;; Copyright © 2016 Chris Marusich
;;; Copyright © 2017 Mathieu Othacehe
;;; Copyright © 2019 Meiyo Peng
+;;; Copyright © 2019 Miguel Ãngel Arruga Vivas
;;;
;;; This file is part of GNU Guix.
;;;
@@ -122,6 +123,7 @@
boot-parameters-kernel
boot-parameters-kernel-arguments
boot-parameters-initrd
+ boot-parameters-locale
read-boot-parameters
read-boot-parameters-file
boot-parameters->menu-entry
@@ -258,7 +260,8 @@ directly by the user."
(store-mount-point boot-parameters-store-mount-point)
(kernel boot-parameters-kernel)
(kernel-arguments boot-parameters-kernel-arguments)
- (initrd boot-parameters-initrd))
+ (initrd boot-parameters-initrd)
+ (locale boot-parameters-locale))
(define (ensure-not-/dev device)
"If DEVICE starts with a slash, return #f. This is meant to filter out
@@ -341,7 +344,12 @@ file system labels."
(('store ('device _) ('mount-point mount-point) _ ...)
mount-point)
(_ ;the old format
- "/")))))
+ "/")))
+
+ (locale
+ (match (assq 'locale rest)
+ ((_ locale) locale)
+ (#f #f)))))
(x ;unsupported format
(warning (G_ "unrecognized boot parameters at '~a'~%")
(port-filename port))
@@ -1008,6 +1016,7 @@ parameters of OS. When SYSTEM-KERNEL-ARGUMENTS? is true, add kernel arguments
such as '--root' and '--load' to ."
(let* ((initrd (operating-system-initrd-file os))
(store (operating-system-store-file-system os))
+ (locale (operating-system-locale os))
(bootloader (bootloader-configuration-bootloader
(operating-system-bootloader os)))
(bootloader-name (bootloader-name bootloader))
@@ -1025,7 +1034,8 @@ such as '--root' and '--load' to ."
(bootloader-menu-entries
(bootloader-configuration-menu-entries (operating-system-bootloader os)))
(store-device (ensure-not-/dev (file-system-device store)))
- (store-mount-point (file-system-mount-point store)))))
+ (store-mount-point (file-system-mount-point store))
+ (locale locale))))
(define (device->sexp device)
"Serialize DEVICE as an sexp (really, as an object with a read syntax.)"
@@ -1073,7 +1083,8 @@ being stored into the \"parameters\" file)."
(store
(device
#$(device->sexp (boot-parameters-store-device params)))
- (mount-point #$(boot-parameters-store-mount-point params))))
+ (mount-point #$(boot-parameters-store-mount-point params)))
+ (locale #$(boot-parameters-locale params)))
#:set-load-path? #f)))
(define-gexp-compiler (operating-system-compiler (os )
diff --git a/tests/boot-parameters.scm b/tests/boot-parameters.scm
new file mode 100644
index 0000000000..3746502498
--- /dev/null
+++ b/tests/boot-parameters.scm
@@ -0,0 +1,250 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2019 Miguel Ãngel Arruga Vivas
+;;;
+;;; 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-boot-parameters)
+ #:use-module (gnu bootloader)
+ #:use-module (gnu bootloader grub)
+ #:use-module (gnu system)
+ #:use-module (gnu system file-systems)
+ #:use-module (gnu system uuid)
+ #:use-module (guix gexp)
+ #:use-module (guix store)
+ #:use-module (guix tests)
+ #:use-module (srfi srfi-64)
+ #:use-module (rnrs bytevectors))
+
+(define %default-label "GNU with Linux-libre 99.1.2")
+(define %default-kernel-path
+ (string-append (%store-prefix)
+ "/zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz-linux-libre-99.1.2"))
+(define %default-kernel
+ (string-append %default-kernel-path "/" (system-linux-image-file-name)))
+(define %default-kernel-arguments '())
+(define %default-initrd-path
+ (string-append (%store-prefix) "/wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww-initrd"))
+(define %default-initrd (string-append %default-initrd-path "/initrd.cpio.gz"))
+(define %default-root-device (uuid "abcdef12-3456-7890-abcd-ef1234567890"))
+(define %default-store-device (uuid "01234567-89ab-cdef-0123-456789abcdef"))
+(define %default-store-mount-point (%store-prefix))
+(define %default-locale "es_ES.utf8")
+(define %root-path "/")
+
+(define %grub-boot-parameters
+ (boot-parameters
+ (bootloader-name 'grub)
+ (bootloader-menu-entries '())
+ (label %default-label)
+ (root-device %default-root-device)
+ (kernel %default-kernel)
+ (kernel-arguments %default-kernel-arguments)
+ (initrd %default-initrd)
+ (store-device %default-store-device)
+ (store-mount-point %default-store-mount-point)
+ (locale %default-locale)))
+
+(define %default-operating-system
+ (operating-system
+ (host-name "host")
+ (timezone "Europe/Berlin")
+ (locale %default-locale)
+
+ (bootloader (bootloader-configuration
+ (bootloader grub-bootloader)
+ (target "/dev/sda")))
+ (file-systems (cons* (file-system
+ (device %default-root-device)
+ (mount-point %root-path)
+ (type "ext4"))
+ (file-system
+ (device %default-store-device)
+ (mount-point %default-store-mount-point)
+ (type "btrfs"))
+ %base-file-systems))))
+
+(define (quote-uuid uuid)
+ (list 'uuid (uuid-type uuid) (uuid-bytevector uuid)))
+
+;; Call read-boot-parameters with the desired string as input.
+(define* (test-read-boot-parameters
+ #:key
+ (version 0)
+ (bootloader-name 'grub)
+ (bootloader-menu-entries '())
+ (label %default-label)
+ (root-device (quote-uuid %default-root-device))
+ (kernel %default-kernel)
+ (kernel-arguments %default-kernel-arguments)
+ (initrd %default-initrd)
+ (with-store #t)
+ (store-device
+ (quote-uuid %default-store-device))
+ (store-mount-point %default-store-mount-point)
+ (locale %default-locale))
+ (define (generate-boot-parameters)
+ (define (sexp-or-nothing fmt val)
+ (cond ((eq? 'false val) (format #f fmt #f))
+ (val (format #f fmt val))
+ (else "")))
+ (format #f "(boot-parameters~a~a~a~a~a~a~a~a~a~a)"
+ (sexp-or-nothing " (version ~S)" version)
+ (sexp-or-nothing " (label ~S)" label)
+ (sexp-or-nothing " (root-device ~S)" root-device)
+ (sexp-or-nothing " (kernel ~S)" kernel)
+ (sexp-or-nothing " (kernel-arguments ~S)" kernel-arguments)
+ (sexp-or-nothing " (initrd ~S)" initrd)
+ (if with-store
+ (format #f " (store~a~a)"
+ (sexp-or-nothing " (device ~S)" store-device)
+ (sexp-or-nothing " (mount-point ~S)"
+ store-mount-point))
+ "")
+ (sexp-or-nothing " (locale ~S)" locale)
+ (sexp-or-nothing " (bootloader-name ~a)" bootloader-name)
+ (sexp-or-nothing " (bootloader-menu-entries ~S)"
+ bootloader-menu-entries)))
+ (let ((str (generate-boot-parameters)))
+ (call-with-input-string str read-boot-parameters)))
+
+(test-begin "boot-parameters")
+
+;; XXX:
+(test-assert "read, construction, mandatory fields"
+ (not (or (test-read-boot-parameters #:version #f)
+ (test-read-boot-parameters #:version 'false)
+ (test-read-boot-parameters #:version -1)
+ (test-read-boot-parameters #:version "0")
+ (test-read-boot-parameters #:root-device #f)
+ (test-read-boot-parameters #:kernel #f)
+ (test-read-boot-parameters #:label #f))))
+
+(test-assert "read, construction, optional fields"
+ (and (test-read-boot-parameters #:bootloader-name #f)
+ (test-read-boot-parameters #:bootloader-menu-entries #f)
+ (test-read-boot-parameters #:kernel-arguments #f)
+ (test-read-boot-parameters #:with-store #f)
+ (test-read-boot-parameters #:store-device #f)
+ (test-read-boot-parameters #:store-device 'false)
+ (test-read-boot-parameters #:store-mount-point #f)
+ (test-read-boot-parameters #:locale #f)
+ (test-read-boot-parameters #:bootloader-name #f #:kernel-arguments #f
+ #:with-store #f #:locale #f)))
+
+(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)))
+
+;; XXX: No default case, match error.
+(test-error "read, construction, missing initrd" #t
+ (test-read-boot-parameters #:initrd #f))
+
+(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 #f)))
+
+(test-eq "read, bootloader-menu-entries, default value"
+ '()
+ (boot-parameters-bootloader-menu-entries
+ (test-read-boot-parameters #:bootloader-menu-entries #f)))
+
+(test-eq "read, kernel-arguments, default value"
+ '()
+ (boot-parameters-kernel-arguments
+ (test-read-boot-parameters #:kernel-arguments #f)))
+
+(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 #f))))
+
+(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 #f))))
+
+(test-assert "read, store-device #f, 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 #f)))
+
+(test-equal "read, no store-mount-point, default"
+ %root-path
+ (boot-parameters-store-mount-point
+ (test-read-boot-parameters #:store-mount-point #f)))
+
+(test-equal "read, no store, default store-mount-point"
+ %root-path
+ (boot-parameters-store-mount-point
+ (test-read-boot-parameters #:with-store #f)))
+
+;; 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-end "boot-parameters")
--
2.23.0