#!/bin/sh # -*- mode: scheme; -*- # Extra care is taken here to ensure this script can run in most environments, # since it is invoked by 'git send-email'. pre_inst_env_maybe= command -v guix > /dev/null || pre_inst_env_maybe=./pre-inst-env exec $pre_inst_env_maybe guix repl -- "$0" "$@" !# ;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2022, 2023 Ricardo Wurmus ;;; Copyright © 2022 Mathieu Othacehe ;;; Copyright © 2022, 2023 Maxim Cournoyer ;;; Copyright © 2022 Simon Tournier ;;; ;;; 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 PARTI
aboutsummaryrefslogtreecommitdiff
blob: 69cb013267017dcfc9bf9e64949380224d56d23a (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2019 Jakob L. Kreuze <zerodaysfordays@sdf.org>
;;; Copyright © 2020 Danny Milosavljevic <dannym@scratchpost.org>
;;; Copyright © 2020, 2021 Brice Waegeneire <brice@waegenei.re>
;;; Copyright © 2021 raid5atemyhomework <raid5atemyhomework@protonmail.com>
;;;
;;; 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 tests linux-modules)
  #:use-module (gnu packages linux)
  #:use-module (gnu services)
  #:use-module (gnu services linux)
  #:use-module (gnu system)
  #:use-module (gnu system vm)
  #:use-module (gnu tests)
  #:use-module (guix derivations)
  #:use-module (guix gexp)
  #:use-module (guix modules)
  #:use-module (guix packages)
  #:use-module (guix monads)
  #:use-module (guix store)
  #:use-module (guix utils)
  #:export (%test-loadable-kernel-modules-0
            %test-loadable-kernel-modules-1
            %test-loadable-kernel-modules-2
            %test-loadable-kernel-modules-service-0
            %test-loadable-kernel-modules-service-1
            %test-loadable-kernel-modules-service-2))

;;; Commentary:
;;;
;;; Test <operating-system> kernel-loadable-modules.
;;;
;;; Code:

(define* (modules-loaded?-program os modules)
  "Return an executable store item that, upon being evaluated, will verify
that MODULES are actually loaded."
  (program-file
   "verify-kernel-modules-loaded.scm"
   #~(begin
     (use-modules (ice-9 rdelim)
                  (ice-9 popen)
                  (srfi srfi-1)
                  (srfi srfi-13))
     (let* ((port (open-input-pipe (string-append #$kmod "/bin/lsmod")))
            (lines (string-split (read-string port) #\newline))
            (separators (char-set #\space #\tab))
            (modules (map (lambda (line)
                            (string-take line
                                         (or (string-index line separators)
                                             0)))
                          lines))
            (status (close-pipe port)))
       (and (= status 0)
            (and-map (lambda (module)
                       (member module modules string=?))
                     '#$modules))))))

(define* (run-loadable-kernel-modules-test-base base-os module-names)
  "Run a test of BASE-OS, verifying that MODULE-NAMES are loaded in memory."
  (define os
    (marionette-operating-system
     base-os
     #:imported-modules '((guix combinators))))

  (define vm (virtual-machine os))

  (define (test script)
    (with-imported-modules '((gnu build marionette))
      #~(begin
          (use-modules (gnu build marionette)
                       (srfi srfi-64))

          (define marionette
            (make-marionette (list #$vm)))

          (test-runner-current (system-test-runner #$output))
          (test-begin "loadable-kernel-modules")
          (test-assert "script successfully evaluated"
            (marionette-eval
             '(primitive-load #$script)
             marionette))
          (test-end))))

  (gexp->derivation "loadable-kernel-modules"
                    (test (modules-loaded?-program os module-names))))

(define* (run-loadable-kernel-modules-test module-packages module-names)
  "Run a test of an OS having MODULE-PACKAGES, and verify that MODULE-NAMES
are loaded in memory."
  (run-loadable-kernel-modules-test-base
    (operating-system
      (inherit (simple-operating-system))
      (services (cons (service kernel-module-loader-service-type module-names)
                      (operating-system-user-services
                       (simple-operating-system))))
      (kernel-loadable-modules module-packages))
    module-names))

(define* (run-loadable-kernel-modules-service-test module-packages module-names)
  "Run a test of an OS having MODULE-PACKAGES, which are loaded by creating a
service that extends LINUXL-LOADABLE-MODULE-SERVICE-TYPE. Then verify that
MODULE-NAMES are loaded in memory."
  (run-loadable-kernel-modules-test-base
    (operating-system
      (inherit (simple-operating-system))
      (services (cons* (simple-service 'installing-module
                                       linux-loadable-module-service-type
                                       module-packages)
                       (service kernel-module-loader-service-type module-names)
                       (operating-system-user-services
                        (simple-operating-system)))))
    module-names))

(define %test-loadable-kernel-modules-0
  (system-test
   (name "loadable-kernel-modules-0")
   (description "Tests loadable kernel modules facility of <operating-system>
with no extra modules.")
   (value (run-loadable-kernel-modules-test '() '()))))

(define %test-loadable-kernel-modules-1
  (system-test
   (name "loadable-kernel-modules-1")
   (description "Tests loadable kernel modules facility of <operating-system>
with one extra module.")
   (value (run-loadable-kernel-modules-test
           (list ddcci-driver-linux)
           '("ddcci")))))

(define %test-loadable-kernel-modules-2
  (system-test
   (name "loadable-kernel-modules-2")
   (description "Tests loadable kernel modules facility of <operating-system>
with two extra modules.")
   (value (run-loadable-kernel-modules-test
           (list acpi-call-linux-module
                 (package
                   (inherit ddcci-driver-linux)
                   (arguments
                    `(#:linux #f
                      ,@(strip-keyword-arguments '(#:linux)
                                                 (package-arguments
                                                  ddcci-driver-linux))))))
           '("acpi_call" "ddcci")))))

(define %test-loadable-kernel-modules-service-0
  (system-test
   (name "loadable-kernel-modules-service-0")
   (description "Tests loadable kernel modules extensible service with no
extra modules.")
   (value (run-loadable-kernel-modules-service-test '() '()))))

(define %test-loadable-kernel-modules-service-1
  (system-test
   (name "loadable-kernel-modules-service-1")
   (description "Tests loadable kernel modules extensible service with one
extra module.")
   (value (run-loadable-kernel-modules-service-test
           (list ddcci-driver-linux)
           '("ddcci")))))

(define %test-loadable-kernel-modules-service-2
  (system-test
   (name "loadable-kernel-modules-service-2")
   (description "Tests loadable kernel modules extensible service with two
extra modules.")
   (value (run-loadable-kernel-modules-service-test
           (list acpi-call-linux-module
                 (package
                   (inherit ddcci-driver-linux)
                   (arguments
                    `(#:linux #f
                      ,@(strip-keyword-arguments '(#:linux)
                                                 (package-arguments
                                                  ddcci-driver-linux))))))
           '("acpi_call" "ddcci")))))
stem and importer." #:scope (list "gnu/packages/chez.scm" "gnu/packages/racket.scm"))) (define-team reproduciblebuilds (team 'reproduciblebuilds #:name "Reproducible Builds team" #:description "Reproducible Builds tooling and issues that affect any guix packages." #:scope (list "gnu/packages/diffoscope.scm"))) (define-team gnome (team 'gnome #:name "Gnome team" #:description "The Gnome desktop environment, along with core technologies such as GLib/GIO, GTK, GStreamer and Webkit." #:scope (list "gnu/packages/glib.scm" "gnu/packages/gstreamer.scm" "gnu/packages/gtk.scm" "gnu/packages/gnome.scm" "gnu/packages/gnome-xyz.scm" "gnu/packages/webkit.scm" "guix/build/glib-or-gtk-build-system.scm" "guix/build/meson-build-system.scm"))) (define-team xfce (team 'xfce #:name "Xfce team" #:description "Xfce desktop environment." #:scope (list "gnu/packages/xfce.scm"))) (define-team lxqt (team 'lxqt #:name "LXQt team" #:description "LXQt desktop environment." #:scope (list "gnu/packages/lxqt.scm" "gnu/packages/qt.scm"))) (define-team audio (team 'audio #:name "Audio team" #:description "Audio related packages." #:scope (list "gnu/packages/audio.scm"))) (define-team zig (team 'zig #:name "Zig team" #:description "Zig, Zig packages, and the zig-build system" #:scope (list "gnu/packages/zig.scm" "gnu/packages/zig-xyz.scm" "guix/build/zig-build-system.scm" "guix/build-system/zig.scm"))) (define-member (person "Eric Bavier" "bavier@posteo.net") science) (define-member (person "Lars-Dominik Braun" "lars@6xq.net") python haskell) (define-member (person "Jonathan Brielmaier" "jonathan.brielmaier@web.de") mozilla) (define-member (person "Ludovic Courtès" "ludo@gnu.org") core home bootstrap installer mentors) (define-member (person "Andreas Enge" "andreas@enge.fr") lxqt science tex) (define-member (person "Tobias Geerinckx-Rice" "me@tobias.gr") core kernel mentors) (define-member (person "Björn Höfling" "bjoern.hoefling@bjoernhoefling.de") java) (define-member (person "Leo Famulari" "leo@famulari.name") kernel) (define-member (person "Efraim Flashner" "efraim@flashner.co.il") embedded bootstrap julia rust science) (define-member (person "jgart" "jgart@dismail.de") python lisp mentors) (define-member (person "Guillaume Le Vaillant" "glv@posteo.net") lisp) (define-member (person "Julien Lepiller" "julien@lepiller.eu") java ocaml translations) (define-member (person "Philip McGrath" "philip@philipmcgrath.com") racket) (define-member (person "Mathieu Othacehe" "othacehe@gnu.org") core installer mentors) (define-member (person "Florian Pelz" "pelzflorian@pelzflorian.de") translations) (define-member (person "Liliana Marie Prikler" "liliana.prikler@gmail.com") emacs games gnome) (define-member (person "Ricardo Wurmus" "rekado@elephly.net") r core mentors tex) (define-member (person "Christopher Baines" "guix@cbaines.net") core mentors ruby) (define-member (person "Andrew Tropin" "andrew@trop.in") home emacs) (define-member (person "pukkamustard" "pukkamustard@posteo.net") ocaml) (define-member (person "Josselin Poiret" "dev@jpoiret.xyz") core installer) (define-member (person "(" "paren@disroot.org") home mentors) (define-member (person "Simon Tournier" "zimon.toutoune@gmail.com") julia core mentors) (define-member (person "Raghav Gururajan" "rg@raghavgururajan.name") gnome mentors) (define-member (person "宋文武" "iyzsong@envs.net") games localization lxqt xfce) (define-member (person "Vagrant Cascadian" "vagrant@debian.org") embedded) (define-member (person "Vagrant Cascadian" "vagrant@reproducible-builds.org") reproduciblebuilds) (define-member (person "Zhu Zihao" "all_but_last@163.com") localization xfce) (define-member (person "Maxim Cournoyer" "maxim.cournoyer@gmail.com") gnome qt telephony) (define-member (person "Katherine Cox-Buday" "cox.katherine.e+guix@gmail.com") emacs go lisp) (define-member (person "Marius Bakke" "marius@gnu.org") python) (define-member (person "Munyoki Kilyungi" "me@bonfacemunyoki.com") python lisp) (define-member (person "Gabriel Wicki" "gabriel@erlikon.ch") audio) (define-member (person "Ekaitz Zarraga" "ekaitz@elenq.tech") bootstrap zig) (define (find-team name) (or (hash-ref %teams (string->symbol name)) (error (format #false "no such team: ~a~%" name)))) (define (find-team-by-scope files) "Return the team(s) which scope matches at least one of the FILES, as list of file names as string." (hash-fold (lambda (key team acc) (if (any (lambda (file) (any (match-lambda ((? string? scope) (string=? scope file)) ((? regexp*? scope) (regexp*-exec scope file))) (team-scope team))) files) (cons team acc) acc)) '() %teams)) (define (cc . teams) "Return arguments for `git send-email' to notify the members of the given TEAMS when a patch is received by Debbugs." (let ((members (append-map team-members teams))) (unless (null? members) (format #true "--add-header=\"X-Debbugs-Cc: ~{~a~^, ~}\"" (map person-email (sort-members members)))))) (define (sort-members members) "Deduplicate and sort MEMBERS alphabetically by their name." (sort (delete-duplicates members equal?) (lambda (m1 m2) (stringstring member) "Return the 'email ' string representation of MEMBER." (let* ((name (person-name member)) (quoted-name/maybe (if (string-contains name ",") (string-append "\"" name "\"") name))) (format #false "~a <~a>" quoted-name/maybe (person-email member)))) (define* (list-members team #:key (prefix "")) "Print the members of the given TEAM." (for-each (lambda (member) (format #t "~a~a~%" prefix (member->string member))) (sort-members (team-members team)))) (define (print-team team) "Print TEAM, a record object." (format #t "\ id: ~a name: ~a description: ~a ~amembers: " (team-id team) (team-name team) (or (and=> (team-description team) (lambda (text) (string->recutils (fill-paragraph text (%text-width) (string-length "description: "))))) "") (match (team-scope team) (() "") (scope (format #f "scope:~%~{+ ~a~^~%~}~%" (sort (map (match-lambda ((? regexp*? rx) (regexp*-pattern rx)) (item item)) scope) string record objects." (sort teams (lambda (team1 team2) (stringstring (team-id team1)) (symbol->string (team-id team2)))))) (define* (list-teams #:optional team-names) "Print all teams, their scope and their members." (for-each print-team (sort-teams (if team-names (map find-team team-names) (hash-map->list (lambda (_ value) value) %teams))))) (define (diff-revisions rev-start rev-end) "Return the list of added, modified or removed files between REV-START and REV-END, two git revision strings." (let* ((repository (repository-open (getcwd))) (commit1 (commit-lookup repository (object-id (revparse-single repository rev-start)))) (commit2 (commit-lookup repository (object-id (revparse-single repository rev-end)))) (diff (diff-tree-to-tree repository (commit-tree commit1) (commit-tree commit2))) (files '())) (diff-foreach diff (lambda (delta progress) (set! files (cons (diff-file-path (diff-delta-old-file delta)) files)) 0) (const 0) (const 0) (const 0)) files)) (define (git-patch->commit-id file) "Parse the commit ID from FILE, a patch produced with git." (call-with-input-file file (lambda (port) (let loop ((line (read-line port))) (when (eof-object? line) (error "could not find 'from' commit in patch" file)) (let ((m (string-match "^From ([0-9a-f]{40})" line))) (if m (match:substring m 1) (loop (read-line port)))))))) (define (git-patch->revisions file) "Return the start and end revisions of FILE, a patch file produced with git." (let* ((rev-end (git-patch->commit-id file)) (rev-start (string-append rev-end "^"))) (list rev-start rev-end))) (define (patch->teams patch-file) "Return the name of the teams in scope for the changes in PATCH-FILE." (map (compose symbol->string team-id) (find-team-by-scope (apply diff-revisions (git-patch->revisions patch-file))))) (define (main . args) (match args (("cc" . team-names) (apply cc (map find-team team-names))) (("cc-members" patch-file) (unless (file-exists? patch-file) (error "patch file does not exist:" patch-file)) (apply main "cc-members" (git-patch->revisions patch-file))) (("cc-members" rev-start rev-end) (apply cc (find-team-by-scope (diff-revisions rev-start rev-end)))) (("cc-members-header-cmd" patch-file) (let* ((teams (map find-team (patch->teams patch-file))) (members (sort-members (append-map team-members teams)))) (unless (null? members) (format #true "X-Debbugs-Cc: ~{~a~^, ~}" (map member->string members))))) (("cc-mentors-header-cmd" patch-file) (format #true "X-Debbugs-Cc: ~{~a~^, ~}" (map member->string (sort-members (team-members (find-team "mentors")))))) (("get-maintainer" patch-file) (apply main "list-members" (patch->teams patch-file))) (("list-teams" . args) (list-teams)) (("list-members" . team-names) (for-each (lambda (team-name) (list-members (find-team team-name))) team-names)) (("show" . team-names) (list-teams team-names)) (anything (format (current-error-port) "Usage: etc/teams.scm [] Commands: cc get git send-email flags for cc-ing cc-members | cc teams related to files changed between revisions or in a patch file cc-members-header-cmd cc-members variant for use with 'git send-email --header-cmd' cc-mentors-header-cmd command to use with 'git send-email --header-cmd' to notify mentors list-teams list teams and their members list-members list members belonging to get-maintainer compatibility mode with Linux get_maintainer.pl show display properties~%")))) (apply main (cdr (command-line)))