aboutsummaryrefslogtreecommitdiff
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021-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 (tests-style)
  #:use-module (guix read-print)
  #:use-module (guix gexp)                        ;for the reader extensions
  #:use-module (srfi srfi-34)
  #:use-module (srfi srfi-35)
  #:use-module (srfi srfi-64)
  #:use-module (ice-9 match))

(define-syntax-rule (test-pretty-print str args ...)
  "Test equality after a round-trip where STR is passed to
'read-with-comments' and the resulting sexp is then passed to
'pretty-print-with-comments'."
  (test-equal str
    (call-with-output-string
      (lambda (port)
        (let ((exp (call-with-input-string str
                     read-with-comments)))
         (pretty-print-with-comments port exp args ...))))))

(define-syntax-rule (test-pretty-print/sequence str args ...)
  "Likewise, but read and print entire sequences rather than individual
expressions."
  (test-equal str
    (call-with-output-string
      (lambda (port)
        (let ((lst (call-with-input-string str
                     read-with-comments/sequence)))
         (pretty-print-with-comments/splice port lst args ...))))))


(test-begin "read-print")

(test-assert "read-with-comments: missing closing paren"
  (guard (c ((error? c) #t))
    (call-with-input-string "(what is going on?"
      read-with-comments)))

(test-equal "read-with-comments: dot notation"
  (cons 'a 'b)
  (call-with-input-string "(a . b)"
    read-with-comments))

(test-equal "read-with-comments: half dot notation"
  '(lambda x x)
  (call-with-input-string "(lambda (. x) x)"
    read-with-comments))

(test-equal "read-with-comments: list with blank line"
  `(list with ,(vertical-space 1) blank line)
  (call-with-input-string "\
(list with

      blank line)\n"
    read-with-comments))

(test-equal "read-with-comments: list with multiple blank lines"
  `(list with ,(comment ";multiple\n" #t)
         ,(vertical-space 3) blank lines)
  (call-with-input-string "\
(list with ;multiple



      blank lines)\n"
    read-with-comments))

(test-equal "read-with-comments: top-level blank lines"
  (list (vertical-space 2) '(a b c) (vertical-space 2))
  (call-with-input-string "

(a b c)\n\n"
    (lambda (port)
      (list (read-with-comments port)
            (read-with-comments port)
            (read-with-comments port)))))

(test-equal "read-with-comments: top-level page break"
  (list (comment ";; Begin.\n") (vertical-space 1)
        (page-break)
        (comment ";; End.\n"))
  (call-with-input-string "\
;; Begin.


;; End.\n"
    (lambda (port)
      (list (read-with-comments port)
            (read-with-comments port)
            (read-with-comments port)
            (read-with-comments port)))))

(test-pretty-print "(list 1 2 3 4)")
(test-pretty-print "((a . 1) (b . 2))")
(test-pretty-print "(a b c . boom)")
(test-pretty-print "(list 1
                          2
                          3
                          4)"
                   #:long-list 3
                   #:indent 20)
(test-pretty-print "\
(list abc
      def)"
                   #:max-width 11)
(test-pretty-print "\
(#:foo
 #:bar)"
                   #:max-width 10)

(test-pretty-print "\
(#:first 1
 #:second 2
 #:third 3)")

(test-pretty-print "\
((x
  1)
 (y
  2)
 (z
  3))"
                   #:max-width 3)

(test-pretty-print "\
(let ((x 1)
      (y 2)
      (z 3)
      (p 4))
  (+ x y))"
                   #:max-width 11)

(test-pretty-print "\
(begin
  1+ 1- 123/ 456*
  (1+ 41))")

(test-pretty-print "\
(lambda (x y)
  ;; This is a procedure.
  (let ((z (+ x y)))
    (* z z)))")

(test-pretty-print "\
(case x
  ((1)
   'one)
  ((2)
   'two))")

(test-pretty-print "\
(cond
  ((zero? x)
   'zero)
  ((odd? x)
   'odd)
  (else #f))")

(test-pretty-print "\
(parameterize ((a 1)
               (b 2))
  (call f g h))")

(test-pretty-print "\
#~(string-append #$coreutils \"/bin/uname\")")

(test-pretty-print "\
(package
  (inherit coreutils)
  (version \"42\"))")

(test-pretty-print "\
(modify-phases %standard-phases
  (add-after 'unpack 'post-unpack
    (lambda _
      #t))
  (add-before 'check 'pre-check
    (lambda* (#:key inputs #:allow-other-keys)
      do things ...)))")

(test-pretty-print "\
(#:phases (modify-phases sdfsdf
            (add-before 'x 'y
              (lambda _
                xyz))))")

(test-pretty-print "\
(string-append \"a\\tb\" \"\\n\")")

(test-pretty-print "\
(display \"This is a very long string.
It contains line breaks, which are preserved,
because it's a long string.\")")

(test-pretty-print "\
(description \"abcdefghijkl
mnopqrstuvwxyz.\")"
                   #:max-width 30)

(test-pretty-print "\
(description
 \"abcdefghijkl
mnopqrstuvwxyz.\")"
                   #:max-width 12)

(test-pretty-print "\
(description
 \"abcdefghijklmnopqrstuvwxyz\")"
                   #:max-width 33)

(test-pretty-print "\
(list ;margin comment
      a b c)")

(test-pretty-print "\
(list
 ;; This is a line comment immediately following the list head.
 #:test-flags #~(list \"-m\" \"not external and not samples\"))")

(test-pretty-print "\
(modify-phases %standard-phases
  (replace 'build
    ;; Nicely indented in 'modify-phases' context.
    (lambda _
      #t)))")

(test-pretty-print "\
(modify-inputs inputs
  ;; Regular indentation for 'replace' here.
  (replace \"gmp\" gmp))")

(test-pretty-print "\
#~(modify-phases phases
    (add-after 'whatever 'something-else
      (lambda _
        ;; This comment appears inside a gexp.
        42)))")

(test-pretty-print "\
#~(list #$@(list coreutils ;yup
                 grep) ;margin comment
        #+sed

        ;; Line comment.
        #$grep)")

(test-pretty-print "\
(package
  ;; Here 'source', 'sha256', and 'arguments' must be
  ;; immediately followed by a newline.
  (source
   (origin
     (method url-fetch)
     (sha256
      (base32 \"not a real base32 string\"))))
  (arguments
   '(#:phases %standard-phases
     #:tests? #f)))")

;; '#:key value' is kept on the same line.
(test-pretty-print "\
(package
  (name \"keyword-value-same-line\")
  (arguments
   (list
    #:phases #~(modify-phases %standard-phases
                 (add-before 'x 'y
                   (lambda* (#:key inputs #:allow-other-keys)
                     (foo bar baz))))
    #:make-flags #~'(\"ANSWER=42\")
    #:tests? #f)))")

(test-pretty-print "\
(let ((x 1)
      (y 2)
      (z (let* ((a 3)
                (b 4))
           (+ a b))))
  (list x y z))")

(test-pretty-print "\
(begin
  (chmod \"foo\" #o750)
  (chmod port
         (logand #o644
                 (lognot (umask))))
  (logand #x7f xyz))")

(test-pretty-print "\
(substitute-keyword-arguments (package-arguments x)
  ((#:phases phases)
   `(modify-phases ,phases
      (add-before 'build 'do-things
        (lambda _
          #t))))
  ((#:configure-flags flags)
   `(cons \"--without-any-problem\"
          ,flags)))")

(test-pretty-print "\
(vertical-space one:

                two:


                three:



                end)")

(test-pretty-print "\
(vertical-space one

                ;; Comment after blank line.
                two)")

(test-pretty-print "\
(begin
  break

  ;; page break above
  end)")

(test-pretty-print "\
(home-environment
  (services
   (list (service-type home-bash-service-type))))")

(test-pretty-print/sequence "\
;;; This is a top-level comment.


;; Above is a page break.
(this is an sexp
      ;; with a comment
      !!)

;; The end.\n")

(test-pretty-print/sequence "
;;; Hello!
;;; Notice that there are three semicolons here.

(define-module (foo bar)
  #:use-module (guix)
  #:use-module (gnu))


;; And now, the OS.
(operating-system
  (host-name \"komputilo\")
  (locale \"eo_EO.UTF-8\")

  (services
   (cons (service mcron-service-type) %base-services)))\n"
                            #:format-comment canonicalize-comment)

(test-equal "pretty-print-with-comments, canonicalize-comment"
  "\
(list abc
      ;; Not a margin comment.
      ;; Ditto.
      ;;
      ;; There's a blank line above.
      def ;margin comment
      ghi)"
  (let ((sexp (call-with-input-string
                  "\
(list abc
  ;Not a margin comment.
  ;;;  Ditto.
  ;;;;;
  ; There's a blank line above.
  def  ;; margin comment
  ghi)"
                read-with-comments)))
    (call-with-output-string
      (lambda (port)
        (pretty-print-with-comments port sexp
                                    #:format-comment
                                    canonicalize-comment)))))

(test-equal "pretty-print-with-comments, canonicalize-vertical-space"
  "\
(list abc

      def

      ;; last one
      ghi)"
  (let ((sexp (call-with-input-string
                  "\
(list abc



  def


;; last one
  ghi)"
                read-with-comments)))
    (call-with-output-string
      (lambda (port)
        (pretty-print-with-comments port sexp
                                    #:format-vertical-space
                                    canonicalize-vertical-space)))))

(test-equal "pretty-print-with-comments, multi-line comment"
  "\
(list abc
      ;; This comment spans
      ;; two lines.
      def)"
  (call-with-output-string
    (lambda (port)
      (pretty-print-with-comments port
                                  `(list abc ,(comment "\
;; This comment spans\n
;; two lines.\n")
                                         def)))))

(test-end)
generated by cgit
rification options.") (password maybe-string "Password for encrypted private keys.")) (define (serialize-ssl-configuration field-name val) #~(format #f "ssl = {\n~a};\n" #$(serialize-configuration val ssl-configuration-fields))) (define-maybe ssl-configuration) (define %default-modules-enabled '("roster" "saslauth" "tls" "dialback" "disco" "carbons" "private" "blocklist" "vcard" "version" "uptime" "time" "ping" "pep" "register" "admin_adhoc")) ;; Guile bug. Use begin wrapper, because otherwise virtualhost-configuration ;; is assumed to be a function. See ;; https://www.gnu.org/software/guile/manual/html_node/R6RS-Incompatibilities.html (begin (define (virtualhost-configuration-list? val) (and (list? val) (and-map virtualhost-configuration? val))) (define (serialize-virtualhost-configuration-list l) #~(string-append #$@(map (lambda (val) (serialize-virtualhost-configuration val)) l))) (define (int-component-configuration-list? val) (and (list? val) (and-map int-component-configuration? val))) (define (serialize-int-component-configuration-list l) #~(string-append #$@(map (lambda (val) (serialize-int-component-configuration val)) l))) (define (ext-component-configuration-list? val) (and (list? val) (and-map ext-component-configuration? val))) (define (serialize-ext-component-configuration-list l) #~(string-append #$@(map (lambda (val) (serialize-ext-component-configuration val)) l))) (define-all-configurations prosody-configuration (prosody (file-like prosody) "The Prosody package." global) (data-path (file-name "/var/lib/prosody") "Location of the Prosody data storage directory. See @url{https://prosody.im/doc/configure}." global) (plugin-paths (file-object-list '()) "Additional plugin directories. They are searched in all the specified paths in order. See @url{https://prosody.im/doc/plugins_directory}." global) (certificates (file-name "/etc/prosody/certs") "Every virtual host and component needs a certificate so that clients and servers can securely verify its identity. Prosody will automatically load certificates/keys from the directory specified here." global) (admins (string-list '()) "This is a list of accounts that are admins for the server. Note that you must create the accounts separately. See @url{https://prosody.im/doc/admins} and @url{https://prosody.im/doc/creating_accounts}. Example: @code{(admins '(\"user1@@example.com\" \"user2@@example.net\"))}" common) (use-libevent? (boolean #f) "Enable use of libevent for better performance under high load. See @url{https://prosody.im/doc/libevent}." common) (modules-enabled (module-list %default-modules-enabled) "This is the list of modules Prosody will load on startup. It looks for @code{mod_modulename.lua} in the plugins folder, so make sure that exists too. Documentation on modules can be found at: @url{https://prosody.im/doc/modules}." common) (modules-disabled (string-list '()) "@samp{\"offline\"}, @samp{\"c2s\"} and @samp{\"s2s\"} are auto-loaded, but should you want to disable them then add them to this list." common) (groups-file (file-object "/var/lib/prosody/sharedgroups.txt") "Path to a text file where the shared groups are defined. If this path is empty then @samp{mod_groups} does nothing. See @url{https://prosody.im/doc/modules/mod_groups}." common) (allow-registration? (boolean #f) "Disable account creation by default, for security. See @url{https://prosody.im/doc/creating_accounts}." common) (ssl (maybe-ssl-configuration (ssl-configuration)) "These are the SSL/TLS-related settings. Most of them are disabled so to use Prosody's defaults. If you do not completely understand these options, do not add them to your config, it is easy to lower the security of your server using them. See @url{https://prosody.im/doc/advanced_ssl_config}." common) (c2s-require-encryption? (boolean #f) "Whether to force all client-to-server connections to be encrypted or not. See @url{https://prosody.im/doc/modules/mod_tls}." common) (disable-sasl-mechanisms (string-list '("DIGEST-MD5")) "Set of mechanisms that will never be offered. See @url{https://prosody.im/doc/modules/mod_saslauth}." common) (insecure-sasl-mechanisms (string-list '("PLAIN" "LOGIN")) "Set of mechanisms that will not be offered on unencrypted connections. See @url{https://prosody.im/doc/modules/mod_saslauth}." common) (s2s-require-encryption? (boolean #f) "Whether to force all server-to-server connections to be encrypted or not. See @url{https://prosody.im/doc/modules/mod_tls}." common) (s2s-secure-auth? (boolean #f) "Whether to require encryption and certificate authentication. This provides ideal security, but requires servers you communicate with to support encryption AND present valid, trusted certificates. See @url{https://prosody.im/doc/s2s#security}." common) (s2s-insecure-domains (string-list '()) "Many servers don't support encryption or have invalid or self-signed certificates. You can list domains here that will not be required to authenticate using certificates. They will be authenticated using DNS. See @url{https://prosody.im/doc/s2s#security}." common) (s2s-secure-domains (string-list '()) "Even if you leave @code{s2s-secure-auth?} disabled, you can still require valid certificates for some domains by specifying a list here. See @url{https://prosody.im/doc/s2s#security}." common) (authentication (string "internal_plain") "Select the authentication backend to use. The default provider stores passwords in plaintext and uses Prosody's configured data storage to store the authentication data. If you do not trust your server please see @url{https://prosody.im/doc/modules/mod_auth_internal_hashed} for information about using the hashed backend. See also @url{https://prosody.im/doc/authentication}" common) ;; TODO: Handle more complicated log structures. (log (maybe-string "*syslog") "Set logging options. Advanced logging configuration is not yet supported by the Prosody service. See @url{https://prosody.im/doc/logging}." common) (pidfile (file-name "/var/run/prosody/prosody.pid") "File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}." global) (http-max-content-size (maybe-non-negative-integer %unset-value) "Maximum allowed size of the HTTP body (in bytes)." common) (http-external-url (maybe-string %unset-value) "Some modules expose their own URL in various ways. This URL is built from the protocol, host and port used. If Prosody sits behind a proxy, the public URL will be @code{http-external-url} instead. See @url{https://prosody.im/doc/http#external_url}." common) (virtualhosts (virtualhost-configuration-list (list (virtualhost-configuration (domain "localhost")))) "A host in Prosody is a domain on which user accounts can be created. For example if you want your users to have addresses like @samp{\"john.smith@@example.com\"} then you need to add a host @samp{\"example.com\"}. All options in this list will apply only to this host. Note: the name \"virtual\" host is used in configuration to avoid confusion with the actual physical host that Prosody is installed on. A single Prosody instance can serve many domains, each one defined as a VirtualHost entry in Prosody's configuration. Conversely a server that hosts a single domain would have just one VirtualHost entry. See @url{https://prosody.im/doc/configure#virtual_host_settings}." global) (int-components (int-component-configuration-list '()) "Components are extra services on a server which are available to clients, usually on a subdomain of the main server (such as @samp{\"mycomponent.example.com\"}). Example components might be chatroom servers, user directories, or gateways to other protocols. Internal components are implemented with Prosody-specific plugins. To add an internal component, you simply fill the hostname field, and the plugin you wish to use for the component. See @url{https://prosody.im/doc/components}." global) (ext-components (ext-component-configuration-list '()) "External components use XEP-0114, which most standalone components support. To add an external component, you simply fill the hostname field. See @url{https://prosody.im/doc/components}." global) (component-secret (string (configuration-missing-field 'ext-component 'component-secret)) "Password which the component will use to log in." ext-component) (component-ports (non-negative-integer-list '(5347)) "Port(s) Prosody listens on for component connections." global) (component-interface (string "127.0.0.1") "Interface Prosody listens on for component connections." global) (domain (string (configuration-missing-field 'virtualhost 'domain)) "Domain you wish Prosody to serve." virtualhost) (hostname (string (configuration-missing-field 'int-component 'hostname)) "Hostname of the component." int-component) (plugin (string (configuration-missing-field 'int-component 'plugin)) "Plugin you wish to use for the component." int-component) (mod-muc (maybe-mod-muc-configuration %unset-value) "Multi-user chat (MUC) is Prosody's module for allowing you to create hosted chatrooms/conferences for XMPP users. General information on setting up and using multi-user chatrooms can be found in the \"Chatrooms\" documentation (@url{https://prosody.im/doc/chatrooms}), which you should read if you are new to XMPP chatrooms. See also @url{https://prosody.im/doc/modules/mod_muc}." int-component) (hostname (string (configuration-missing-field 'ext-component 'hostname)) "Hostname of the component." ext-component) (raw-content (maybe-raw-content %unset-value) "Raw content that will be added to the configuration file." common))) ;; Serialize Virtualhost line first. (define (serialize-virtualhost-configuration config) (define (rest? field) (not (memq (configuration-field-name field) '(domain)))) (let ((domain (virtualhost-configuration-domain config)) (rest (filter rest? virtualhost-configuration-fields))) #~(string-append #$(format #f "VirtualHost \"~a\"\n" domain) #$(serialize-configuration config rest)))) ;; Serialize Component line first. (define (serialize-int-component-configuration config) (define (rest? field) (not (memq (configuration-field-name field) '(hostname plugin)))) (let ((hostname (int-component-configuration-hostname config)) (plugin (int-component-configuration-plugin config)) (rest (filter rest? int-component-configuration-fields))) #~(string-append #$(format #f "Component \"~a\" \"~a\"\n" hostname plugin) #$(serialize-configuration config rest)))) ;; Serialize Component line first. (define (serialize-ext-component-configuration config) (define (rest? field) (not (memq (configuration-field-name field) '(hostname)))) (let ((hostname (ext-component-configuration-hostname config)) (rest (filter rest? ext-component-configuration-fields))) #~(string-append #$(format #f "Component \"~a\"\n" hostname) #$(serialize-configuration config rest)))) ;; Serialize virtualhosts and components last. (define (serialize-prosody-configuration config) (define (rest? field) (not (memq (configuration-field-name field) '(virtualhosts int-components ext-components)))) #~(string-append #$(let ((rest (filter rest? prosody-configuration-fields))) (serialize-configuration config rest)) #$(serialize-virtualhost-configuration-list (prosody-configuration-virtualhosts config)) #$(serialize-int-component-configuration-list (prosody-configuration-int-components config)) #$(serialize-ext-component-configuration-list (prosody-configuration-ext-components config)))) (define-configuration opaque-prosody-configuration (prosody (file-like prosody) "The prosody package.") (prosody.cfg.lua (string (configuration-missing-field 'opaque-prosody-configuration 'prosody.cfg.lua)) "The contents of the @code{prosody.cfg.lua} to use.")) (define (prosody-shepherd-service config) "Return a <shepherd-service> for Prosody with CONFIG." (let* ((prosody (if (opaque-prosody-configuration? config) (opaque-prosody-configuration-prosody config) (prosody-configuration-prosody config))) (prosodyctl-bin (file-append prosody "/bin/prosodyctl")) (pid-file (prosody-configuration-pidfile config)) (prosodyctl-action (lambda args #~(lambda _ (invoke #$prosodyctl-bin #$@args) (match '#$args (("start") (call-with-input-file #$pid-file read)) (_ #t)))))) (list (shepherd-service (documentation "Run the Prosody XMPP server") (provision '(prosody xmpp-daemon)) (requirement '(networking syslogd user-processes)) (modules `((ice-9 match) ,@%default-modules)) (start (prosodyctl-action "start")) (stop (prosodyctl-action "stop")))))) (define %prosody-accounts (list (user-group (name "prosody") (system? #t)) (user-account (name "prosody") (group "prosody") (system? #t) (comment "Prosody daemon user") (home-directory "/var/empty") (shell (file-append shadow "/sbin/nologin"))))) (define (prosody-activation config) "Return the activation gexp for CONFIG." (let* ((config-dir "/etc/prosody") (default-certs-dir "/etc/prosody/certs") (data-path (prosody-configuration-data-path config)) (pidfile-dir (dirname (prosody-configuration-pidfile config))) (config-str (if (opaque-prosody-configuration? config) (opaque-prosody-configuration-prosody.cfg.lua config) #~(begin (use-modules (ice-9 format)) #$(serialize-prosody-configuration config)))) (config-file (mixed-text-file "prosody.cfg.lua" config-str))) #~(begin (use-modules (guix build utils)) (define %user (getpw "prosody")) (mkdir-p #$config-dir) (chown #$config-dir (passwd:uid %user) (passwd:gid %user)) (copy-file #$config-file (string-append #$config-dir "/prosody.cfg.lua")) (mkdir-p #$default-certs-dir) (chown #$default-certs-dir (passwd:uid %user) (passwd:gid %user)) (chmod #$default-certs-dir #o750) (mkdir-p #$data-path) (chown #$data-path (passwd:uid %user) (passwd:gid %user)) (chmod #$data-path #o750) (mkdir-p #$pidfile-dir) (chown #$pidfile-dir (passwd:uid %user) (passwd:gid %user))))) (define prosody-service-type (service-type (name 'prosody) (extensions (list (service-extension shepherd-root-service-type prosody-shepherd-service) (service-extension account-service-type (const %prosody-accounts)) (service-extension activation-service-type prosody-activation))) (default-value (prosody-configuration (virtualhosts (list (virtualhost-configuration (domain "localhost")))))) (description "Run Prosody, a modern XMPP communication server."))) ;; A little helper to make it easier to document all those fields. (define (generate-documentation) (define documentation `((prosody-configuration ,prosody-configuration-fields (ssl ssl-configuration) (virtualhosts virtualhost-configuration) (int-components int-component-configuration) (ext-components ext-component-configuration)) (ssl-configuration ,ssl-configuration-fields) (int-component-configuration ,int-component-configuration-fields (mod-muc mod-muc-configuration)) (ext-component-configuration ,ext-component-configuration-fields) (mod-muc-configuration ,mod-muc-configuration-fields) (virtualhost-configuration ,virtualhost-configuration-fields) (opaque-prosody-configuration ,opaque-prosody-configuration-fields))) (define (generate configuration-name) (match (assq-ref documentation configuration-name) ((fields . sub-documentation) (format #t "\nAvailable @code{~a} fields are:\n\n" configuration-name) (when (memq configuration-name '(virtualhost-configuration int-component-configuration ext-component-configuration)) (format #t "all these @code{prosody-configuration} fields: ~a, plus:\n" (string-join (map (lambda (s) (format #f "@code{~a}" s)) common-fields) ", "))) (for-each (lambda (f) (let ((field-name (configuration-field-name f)) (field-type (configuration-field-type f)) (field-docs (string-trim-both (configuration-field-documentation f))) (default (catch #t (configuration-field-default-value-thunk f) (lambda _ 'nope)))) (define (escape-chars str chars escape) (with-output-to-string (lambda () (string-for-each (lambda (c) (when (char-set-contains? chars c) (display escape)) (display c)) str)))) (define (show-default? val) (or (string? val) (number? val) (boolean? val) (and (list? val) (and-map show-default? val)))) (format #t "@deftypevr {@code{~a} parameter} ~a ~a\n~a\n" configuration-name field-type field-name field-docs) (when (show-default? default) (format #t "Defaults to @samp{~a}.\n" (escape-chars (format #f "~s" default) (char-set #\@ #\{ #\}) #\@))) (for-each generate (or (assq-ref sub-documentation field-name) '())) (format #t "@end deftypevr\n\n"))) (filter (lambda (f) (not (string=? "" (configuration-field-documentation f)))) fields))))) (generate 'prosody-configuration) (format #t "It could be that you just want to get a @code{prosody.cfg.lua} up and running. In that case, you can pass an @code{opaque-prosody-configuration} record as the value of @code{prosody-service-type}. As its name indicates, an opaque configuration does not have easy reflective capabilities.") (generate 'opaque-prosody-configuration) (format #t "For example, if your @code{prosody.cfg.lua} is just the empty string, you could instantiate a prosody service like this: @example (service prosody-service-type (opaque-prosody-configuration (prosody.cfg.lua \"\"))) @end example")) ;;; ;;; BitlBee. ;;; (define-record-type* <bitlbee-configuration> bitlbee-configuration make-bitlbee-configuration bitlbee-configuration? (bitlbee bitlbee-configuration-bitlbee (default bitlbee)) (interface bitlbee-configuration-interface (default "127.0.0.1")) (port bitlbee-configuration-port (default 6667)) (plugins bitlbee-plugins (default '())) (extra-settings bitlbee-configuration-extra-settings (default ""))) (define bitlbee-shepherd-service (match-lambda (($ <bitlbee-configuration> bitlbee interface port plugins extra-settings) (let* ((plugins (directory-union "bitlbee-plugins" plugins)) (conf (mixed-text-file "bitlbee.conf" " [settings] User = bitlbee ConfigDir = /var/lib/bitlbee DaemonInterface = " interface " DaemonPort = " (number->string port) " PluginDir = " plugins "/lib/bitlbee " extra-settings)) (bitlbee* (least-authority-wrapper (file-append bitlbee "/sbin/bitlbee") #:name "bitlbee" #:preserved-environment-variables '("PURPLE_PLUGIN_PATH" "GUIX_LOCPATH" "LC_ALL") #:mappings (list (file-system-mapping (source "/var/lib/bitlbee") (target source) (writable? #t)) (file-system-mapping (source "/run/current-system/locale") (target source)) (file-system-mapping (source conf) (target conf))) #:namespaces (delq 'net %namespaces)))) (list (shepherd-service (provision '(bitlbee)) ;; Note: If networking is not up, then /etc/resolv.conf ;; doesn't get mapped in the container, hence the dependency ;; on 'networking'. (requirement '(user-processes networking)) (start #~(make-inetd-constructor (list #$bitlbee* "-I" "-c" #$conf) (list (endpoint (addrinfo:addr (car (getaddrinfo #$interface #$(number->string port) (logior AI_NUMERICHOST AI_NUMERICSERV)))))) #:requirements '#$requirement #:service-name-stem "bitlbee" #:user "bitlbee" #:group "bitlbee" ;; Allow 'bitlbee-purple' to use libpurple plugins. #:environment-variables (list (string-append "PURPLE_PLUGIN_PATH=" #$plugins "/lib/purple-2") "GUIX_LOCPATH=/run/current-system/locale"))) (stop #~(make-inetd-destructor)))))))) (define %bitlbee-accounts ;; User group and account to run BitlBee. (list (user-group (name "bitlbee") (system? #t)) (user-account (name "bitlbee") (group "bitlbee") (system? #t) (comment "BitlBee daemon user") (home-directory "/var/empty") (shell (file-append shadow "/sbin/nologin"))))) (define %bitlbee-activation ;; Activation gexp for BitlBee. #~(begin (use-modules (guix build utils)) ;; This directory is used to store OTR data. (mkdir-p "/var/lib/bitlbee") (let ((user (getpwnam "bitlbee"))) (chown "/var/lib/bitlbee" (passwd:uid user) (passwd:gid user))))) (define bitlbee-service-type (service-type (name 'bitlbee) (extensions (list (service-extension shepherd-root-service-type bitlbee-shepherd-service) (service-extension account-service-type (const %bitlbee-accounts)) (service-extension activation-service-type (const %bitlbee-activation)))) (default-value (bitlbee-configuration)) (description "Run @url{http://bitlbee.org,BitlBee}, a daemon that acts as a gateway between IRC and chat networks."))) ;;; ;;; Quassel. ;;; (define-record-type* <quassel-configuration> quassel-configuration make-quassel-configuration quassel-configuration? (quassel quassel-configuration-quassel (default quassel)) (interface quassel-configuration-interface (default "::,0.0.0.0")) (port quassel-configuration-port (default 4242)) (loglevel quassel-configuration-loglevel (default "Info"))) (define quassel-shepherd-service (match-lambda (($ <quassel-configuration> quassel interface port loglevel) (let ((quassel (least-authority-wrapper (file-append quassel "/bin/quasselcore") #:name "quasselcore" #:mappings (list (file-system-mapping (source "/var/lib/quassel") (target source) (writable? #t)) (file-system-mapping (source "/var/log/quassel") (target source) (writable? #t))) ;; XXX: The daemon needs to live in the main user ;; namespace, as root, so it can access /var/lib/quassel ;; owned by "quasselcore". #:namespaces (fold delq %namespaces '(net user))))) (list (shepherd-service (provision '(quassel)) (requirement '(user-processes networking)) (start #~(make-forkexec-constructor (list #$quassel "--configdir=/var/lib/quassel" "--logfile=/var/log/quassel/core.log" (string-append "--loglevel=" #$loglevel) (string-append "--port=" (number->string #$port)) (string-append "--listen=" #$interface)))) (stop #~(make-kill-destructor)))))))) (define %quassel-account (list (user-group (name "quassel") (system? #t)) (user-account (name "quasselcore") (group "quassel") (system? #t) (comment "Quassel daemon user") (home-directory "/var/lib/quassel") (shell (file-append shadow "/sbin/nologin"))))) (define %quassel-activation #~(begin (use-modules (guix build utils)) (mkdir-p "/var/lib/quassel") (mkdir-p "/var/log/quassel") (let ((cert "/var/lib/quassel/quasselCert.pem")) (unless (file-exists? cert) (invoke #$(file-append openssl "/bin/openssl") "req" "-x509" "-nodes" "-batch" "-days" "680" "-newkey" "rsa" "-keyout" cert "-out" cert))))) (define quassel-service-type (service-type (name 'quassel) (extensions (list (service-extension shepherd-root-service-type quassel-shepherd-service) (service-extension profile-service-type (compose list quassel-configuration-quassel)) (service-extension account-service-type (const %quassel-account)) (service-extension activation-service-type (const %quassel-activation)))) (default-value (quassel-configuration)) (description "Run @url{https://quassel-irc.org/,quasselcore}, the backend for the distributed IRC client quassel, which allows you to connect from multiple machines simultaneously.")))
generated by cgit