;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2014, 2015 Sou Bunnbu ;;; Copyright © 2016 Ricardo Wurmus ;;; Copyright © 2016, 2017, 2018 Efraim Flashner ;;; Copyright © 2017, 2018, 2019 Rutger Helling ;;; Copyright © 2017 Nicolas Goaziou ;;; Copyright © 2018 Tobias Geerinckx-Rice ;;; ;;; 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 h
aboutsummaryrefslogtreecommitdiff
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2017, 2018 Clément Lassieur <clement@lassieur.org>
;;; Copyright © 2017-2018, 2021-2022 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2018 Efraim Flashner <efraim@flashner.co.il>
;;;
;;; 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 messaging)
  #:use-module (gnu tests)
  #:use-module (gnu system)
  #:use-module (gnu system vm)
  #:use-module (gnu services)
  #:use-module (gnu services messaging)
  #:use-module (gnu services networking)
  #:use-module (gnu packages messaging)
  #:use-module (guix gexp)
  #:use-module (guix store)
  #:use-module (guix modules)
  #:export (%test-prosody
            %test-bitlbee
            %test-quassel))

(define (run-xmpp-test name xmpp-service pid-file create-account)
  "Run a test of an OS running XMPP-SERVICE, which writes its PID to PID-FILE."
  (define os
    (marionette-operating-system
     (simple-operating-system (service dhcp-client-service-type)
                              xmpp-service)
     #:imported-modules '((gnu services herd))))

  (define port 15222)

  (define vm
    (virtual-machine
     (operating-system os)
     (port-forwardings `((,port . 5222)))))

  (define username "alice")
  (define server "localhost")
  (define jid (string-append username "@" server))
  (define password "correct horse battery staple")
  (define message "hello world")
  (define witness "/tmp/freetalk-witness")

  (define script.ft
    (scheme-file
     "script.ft"
     #~(begin
         (define (handle-received-message time from nickname message)
           (define (touch file-name)
             (call-with-output-file file-name (const #t)))
           (when (equal? message #$message)
             (touch #$witness)))
         (add-hook! ft-message-receive-hook handle-received-message)

         (ft-set-jid! #$jid)
         (ft-set-password! #$password)
         (ft-set-server! #$server)
         (ft-set-port! #$port)
         (ft-set-sslconn! #f)
         (ft-connect-blocking)
         (ft-send-message #$jid #$message)

         (ft-set-daemon)
         (ft-main-loop))))

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

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

          (define (host-wait-for-file file)
            ;; Wait until FILE exists in the host.
            (let loop ((i 60))
              (cond ((file-exists? file)
                     #t)
                    ((> i 0)
                     (begin
                       (sleep 1))
                     (loop (- i 1)))
                    (else
                     (error "file didn't show up" file)))))

          (test-runner-current (system-test-runner #$output))
          (test-begin "xmpp")

          ;; Wait for XMPP service to be up and running.
          (test-assert "service running"
            (marionette-eval
             '(begin
                (use-modules (gnu services herd))
                (start-service 'xmpp-daemon))
             marionette))

          ;; Check XMPP service's PID.
          (test-assert "service process id"
            (let ((pid (number->string (wait-for-file #$pid-file
                                                      marionette))))
              (marionette-eval `(file-exists? (string-append "/proc/" ,pid))
                               marionette)))

          ;; Alice sends an XMPP message to herself, with Freetalk.
          (test-assert "client-to-server communication"
            (let ((freetalk-bin (string-append #$freetalk "/bin/freetalk")))
              (marionette-eval '(system* #$create-account #$jid #$password)
                               marionette)
              ;; Freetalk requires write access to $HOME.
              (setenv "HOME" "/tmp")
              (system* freetalk-bin "-s" #$script.ft)
              (host-wait-for-file #$witness)))

          (test-end))))

  (gexp->derivation name test))

(define %create-prosody-account
  (program-file
   "create-account"
   #~(begin
       (use-modules (ice-9 match))
       (match (command-line)
         ((command jid password)
          (let ((password-input (format #f "\"~a~%~a\"" password password))
                (prosodyctl #$(file-append prosody "/bin/prosodyctl")))
            (system (string-join
                     `("echo" ,password-input "|" ,prosodyctl "adduser" ,jid)
                     " "))))))))

(define %test-prosody
  (let* ((config (prosody-configuration
                  (insecure-sasl-mechanisms '())
                  (virtualhosts
                   (list
                    (virtualhost-configuration
                     (domain "localhost")))))))
    (system-test
     (name "prosody")
     (description "Connect to a running Prosody daemon.")
     (value (run-xmpp-test name
                           (service prosody-service-type config)
                           (prosody-configuration-pidfile config)
                           %create-prosody-account)))))


;;;
;;; BitlBee.
;;;

(define (run-bitlbee-test)
  (define os
    (marionette-operating-system
     (simple-operating-system (service dhcp-client-service-type)
                              (service bitlbee-service-type
                                       (bitlbee-configuration
                                        (interface "0.0.0.0"))))
     #:imported-modules (source-module-closure
                         '((gnu services herd)))))

  (define vm
    (virtual-machine
     (operating-system os)
     (port-forwardings `((6667 . 6667)))))

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

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

          (test-runner-current (system-test-runner #$output))
          (test-begin "bitlbee")

          (test-assert "service started"
            (marionette-eval
             '(begin
                (use-modules (gnu services herd))
                (start-service 'bitlbee))
             marionette))

          (test-assert "connect"
            (let* ((address (make-socket-address AF_INET INADDR_LOOPBACK
                                                 6667))
                   (sock    (socket AF_INET SOCK_STREAM 0)))
              (connect sock address)
              ;; See <https://tools.ietf.org/html/rfc1459>.
              (->bool (string-contains (pk 'message (read-line sock))
                                       "BitlBee"))))

          (test-end))))

  (gexp->derivation "bitlbee-test" test))

(define %test-bitlbee
  (system-test
   (name "bitlbee")
   (description "Connect to a BitlBee IRC server.")
   (value (run-bitlbee-test))))

(define (run-quassel-test)
  (define os
    (marionette-operating-system
      (simple-operating-system (service dhcp-client-service-type)
                               (service quassel-service-type))
     #:imported-modules (source-module-closure
                         '((gnu services herd)))))

  (define vm
    (virtual-machine
      (operating-system os)
      (port-forwardings `((4242 . 4242)))))

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

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

          (test-runner-current (system-test-runner #$output))
          (test-begin "quassel")

          (test-assert "service started"
            (marionette-eval
             '(begin
                (use-modules (gnu services herd))
                (start-service 'quassel))
             marionette))

          (test-assert "certificate file"
            (marionette-eval
              '(file-exists? "/var/lib/quassel/quasselCert.pem")
              marionette))

          (test-end))))

  (gexp->derivation "quassel-test" test))

(define %test-quassel
  (system-test
   (name "quassel")
   (description "Connect to a quassel IRC server.")
   (value (run-quassel-test))))
(list "--enable-win64" (string-append "LDFLAGS=-Wl,-rpath=" %output "/lib/wine64")) ,@(strip-keyword-arguments '(#:configure-flags #:make-flags #:phases #:system) (package-arguments wine)))) (synopsis "Implementation of the Windows API (WoW64 version)") (supported-systems '("x86_64-linux" "aarch64-linux")))) ;; This minimal build of Wine is needed to prevent a circular dependency with ;; vkd3d. (define-public wine-minimal (package (inherit wine) (name "wine-minimal") (native-inputs (fold alist-delete (package-native-inputs wine) '("gettext" "perl" "pkg-config"))) (inputs `()) (arguments `(#:validate-runpath? #f #:phases (modify-phases %standard-phases (add-after 'configure 'patch-dlopen-paths ;; Hardcode dlopened sonames to absolute paths. (lambda _ (let* ((library-path (search-path-as-string->list (getenv "LIBRARY_PATH"))) (find-so (lambda (soname) (search-path library-path soname)))) (substitute* "include/config.h" (("(#define SONAME_.* )\"(.*)\"" _ defso soname) (format #f "~a\"~a\"" defso (find-so soname)))) #t)))) #:configure-flags (list "--without-freetype" "--without-x") ,@(strip-keyword-arguments '(#:configure-flags #:phases) (package-arguments wine)))))) (define-public wine-staging-patchset-data (package (name "wine-staging-patchset-data") (version "4.3") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/wine-staging/wine-staging") (commit (string-append "v" version)))) (file-name (git-file-name name version)) (sha256 (base32 "14plsw52s4w0wpm0rici8b7amb51krdrby03652isvzxqr4ndip6")))) (build-system trivial-build-system) (native-inputs `(("bash" ,bash) ("coreutils" ,coreutils))) (arguments `(#:modules ((guix build utils)) #:builder (begin (use-modules (guix build utils)) (let* ((build-directory ,(string-append name "-" version)) (source (assoc-ref %build-inputs "source")) (bash (assoc-ref %build-inputs "bash")) (coreutils (assoc-ref %build-inputs "coreutils")) (out (assoc-ref %outputs "out")) (wine-staging (string-append out "/share/wine-staging"))) (copy-recursively source build-directory) (with-directory-excursion build-directory (substitute* "patches/patchinstall.sh" (("/bin/sh") (string-append bash "/bin/sh"))) (substitute* "patches/gitapply.sh" (("/usr/bin/env") (string-append coreutils "/bin/env")))) (copy-recursively build-directory wine-staging) #t)))) (home-page "https://github.com/wine-staging") (synopsis "Patchset for Wine") (description "wine-staging-patchset-data contains the patchset to build Wine-Staging.") (license license:lgpl2.1+))) (define-public wine-staging (package (inherit wine) (name "wine-staging") (version (package-version wine-staging-patchset-data)) (source (origin (method url-fetch) (uri (string-append "https://dl.winehq.org/wine/source/" (version-major version) ".x" "/wine-" version ".tar.xz")) (file-name (string-append name "-" version ".tar.xz")) (sha256 (base32 "1d0gbwc8ll4mfxilw9j4vdzqlnracr6y8iss27nfg1qh0q7vbf9x")))) (inputs `(("autoconf" ,autoconf) ; for autoreconf ("faudio" ,faudio) ("ffmpeg" ,ffmpeg) ("gtk+" ,gtk+) ("libva" ,libva) ("mesa" ,mesa) ("python" ,python) ("util-linux" ,util-linux) ; for hexdump ("wine-staging-patchset-data" ,wine-staging-patchset-data) ,@(package-inputs wine))) (arguments `(#:phases (modify-phases %standard-phases ;; Explicitely set the 32-bit version of vulkan-loader when installing ;; to i686-linux or x86_64-linux. ;; TODO: Add more JSON files as they become available in Mesa. ,@(match (%current-system) ((or "i686-linux" "x86_64-linux") `((add-after 'install 'wrap-executable (lambda* (#:key inputs outputs #:allow-other-keys) (let* ((out (assoc-ref outputs "out")) (icd (string-append out "/share/vulkan/icd.d"))) (mkdir-p icd) (copy-file (string-append (assoc-ref inputs "mesa") "/share/vulkan/icd.d/radeon_icd.i686.json") (string-append icd "/radeon_icd.i686.json")) (wrap-program (string-append out "/bin/wine-preloader") `("VK_ICD_FILENAMES" ":" = (,(string-append icd "/radeon_icd.i686.json")))) #t))))) (_ `()) ) (add-before 'configure 'patch-source-wine-staging (lambda* (#:key outputs #:allow-other-keys) (let* ((source (assoc-ref %build-inputs "source")) (script (string-append (assoc-ref %build-inputs "wine-staging-patchset-data") "/share/wine-staging/patches/patchinstall.sh"))) ;; Exclude specific patches that conflict with FAudio. (invoke script (string-append "DESTDIR=" ".") "--all" "-W" "xaudio2-revert" "-W" "xaudio2_CommitChanges" "-W" "xaudio2_7-WMA_support" "-W" "xaudio2_7-CreateFX-FXEcho") #t))) (add-after 'configure 'patch-dlopen-paths ;; Hardcode dlopened sonames to absolute paths. (lambda _ (let* ((library-path (search-path-as-string->list (getenv "LIBRARY_PATH"))) (find-so (lambda (soname) (search-path library-path soname)))) (substitute* "include/config.h" (("(#define SONAME_.* )\"(.*)\"" _ defso soname) (format #f "~a\"~a\"" defso (find-so soname)))) #t)))) ,@(strip-keyword-arguments '(#:phases) (package-arguments wine)))) (synopsis "Implementation of the Windows API (staging branch, 32-bit only)") (description "Wine-Staging is the testing area of Wine. It contains bug fixes and features, which have not been integrated into the development branch yet. The idea of Wine-Staging is to provide experimental features faster to end users and to give developers the possibility to discuss and improve their patches before they are integrated into the main branch.") (home-page "https://github.com/wine-staging") ;; In addition to the regular Wine license (lgpl2.1+), Wine-Staging ;; provides Liberation and WenQuanYi Micro Hei fonts. Those use ;; different licenses. In particular, the latter is licensed under ;; both GPL3+ and Apache 2 License. (license (list license:lgpl2.1+ license:silofl1.1 license:gpl3+ license:asl2.0)))) (define-public wine64-staging (package (inherit wine-staging) (name "wine64-staging") (inputs `(("wine-staging" ,wine-staging) ,@(package-inputs wine-staging))) (arguments `(#:make-flags (list "SHELL=bash" (string-append "libdir=" %output "/lib/wine64")) #:phases (modify-phases %standard-phases ;; Explicitely set both the 64-bit and 32-bit versions of vulkan-loader ;; when installing to x86_64-linux so both are available. ;; TODO: Add more JSON files as they become available in Mesa. ,@(match (%current-system) ((or "x86_64-linux") `((add-after 'copy-wine32-binaries 'wrap-executable (lambda* (#:key inputs outputs #:allow-other-keys) (let* ((out (assoc-ref outputs "out"))) (wrap-program (string-append out "/bin/wine-preloader") `("VK_ICD_FILENAMES" ":" = (,(string-append (assoc-ref inputs "mesa") "/share/vulkan/icd.d/radeon_icd.x86_64.json" ":" (assoc-ref inputs "mesa") "/share/vulkan/icd.d/intel_icd.x86_64.json" ":" (assoc-ref inputs "wine-staging") "/share/vulkan/icd.d/radeon_icd.i686.json")))) (wrap-program (string-append out "/bin/wine64-preloader") `("VK_ICD_FILENAMES" ":" = (,(string-append (assoc-ref inputs "mesa") "/share/vulkan/icd.d/radeon_icd.x86_64.json" ":" (assoc-ref inputs "mesa") "/share/vulkan/icd.d/intel_icd.x86_64.json" ":" (assoc-ref inputs "wine-staging") "/share/vulkan/icd.d/radeon_icd.i686.json")))) #t))))) (_ `()) ) (add-before 'configure 'patch-source-wine-staging (lambda* (#:key outputs #:allow-other-keys) (let* ((source (assoc-ref %build-inputs "source")) (script (string-append (assoc-ref %build-inputs "wine-staging-patchset-data") "/share/wine-staging/patches/patchinstall.sh"))) ;; Exclude specific patches that conflict with FAudio. (invoke script (string-append "DESTDIR=" ".") "--all" "-W" "xaudio2-revert" "-W" "xaudio2_CommitChanges" "-W" "xaudio2_7-WMA_support" "-W" "xaudio2_7-CreateFX-FXEcho") #t))) (add-after 'install 'copy-wine32-binaries (lambda* (#:key outputs #:allow-other-keys) (let* ((wine32 (assoc-ref %build-inputs "wine-staging")) (out (assoc-ref %outputs "out"))) ;; Copy the 32-bit binaries needed for WoW64. (copy-file (string-append wine32 "/bin/wine") (string-append out "/bin/wine")) ;; Copy the real 32-bit wine-preloader instead of the wrapped ;; version. (copy-file (string-append wine32 "/bin/.wine-preloader-real") (string-append out "/bin/wine-preloader")) #t))) (add-after 'compress-documentation 'copy-wine32-manpage (lambda* (#:key outputs #:allow-other-keys) (let* ((wine32 (assoc-ref %build-inputs "wine-staging")) (out (assoc-ref %outputs "out"))) ;; Copy the missing man file for the wine binary from ;; wine-staging. (copy-file (string-append wine32 "/share/man/man1/wine.1.gz") (string-append out "/share/man/man1/wine.1.gz")) #t))) (add-after 'configure 'patch-dlopen-paths ;; Hardcode dlopened sonames to absolute paths. (lambda _ (let* ((library-path (search-path-as-string->list (getenv "LIBRARY_PATH"))) (find-so (lambda (soname) (search-path library-path soname)))) (substitute* "include/config.h" (("(#define SONAME_.* )\"(.*)\"" _ defso soname) (format #f "~a\"~a\"" defso (find-so soname)))) #t)))) #:configure-flags (list "--enable-win64" (string-append "LDFLAGS=-Wl,-rpath=" %output "/lib/wine64")) ,@(strip-keyword-arguments '(#:configure-flags #:make-flags #:phases #:system) (package-arguments wine-staging)))) (synopsis "Implementation of the Windows API (staging branch, WoW64 version)") (supported-systems '("x86_64-linux" "aarch64-linux"))))