summaryrefslogtreecommitdiff
path: root/tests/test-video-audio-recording-validate-system-audio.el
blob: a8aaed123a64685266847c5e42c3ae189c0764f8 (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
;;; test-video-audio-recording-validate-system-audio.el --- Tests for cj/recording--validate-system-audio -*- lexical-binding: t; -*-

;;; Commentary:
;; Unit tests for cj/recording--validate-system-audio function.
;; Tests the pre-recording validation that catches stale/drifted system
;; audio devices before they cause silent recordings.

;;; Code:

(require 'ert)

;; Stub dependencies before loading the module
(defvar cj/custom-keymap (make-sparse-keymap)
  "Stub keymap for testing.")

(require 'video-audio-recording)

;;; Setup and Teardown

(defun test-validate-setup ()
  "Reset device variables before each test."
  (setq cj/recording-system-device nil))

(defun test-validate-teardown ()
  "Clean up device variables after each test."
  (setq cj/recording-system-device nil))

;;; Normal Cases

(ert-deftest test-validate-system-audio-normal-device-matches-default-no-change ()
  "Test that no change occurs when device matches current default and audio is active."
  (test-validate-setup)
  (unwind-protect
      (let ((cj/recording-system-device "alsa_output.usb-Jabra-00.analog-stereo.monitor"))
        (cl-letf (((symbol-function 'shell-command-to-string)
                   (lambda (cmd)
                     (cond
                      ((string-match-p "sources short" cmd)
                       "65\talsa_output.usb-Jabra-00.analog-stereo.monitor\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ((string-match-p "sinks short" cmd)
                       "65\talsa_output.usb-Jabra-00.analog-stereo\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ((string-match-p "sink-inputs" cmd) "Sink Input #1\n\tSink: 65\n")
                      ((string-match-p "get-default-sink" cmd) "alsa_output.usb-Jabra-00.analog-stereo")
                      (t "")))))
          (cj/recording--validate-system-audio)
          (should (equal "alsa_output.usb-Jabra-00.analog-stereo.monitor"
                         cj/recording-system-device))))
    (test-validate-teardown)))

(ert-deftest test-validate-system-audio-normal-stale-device-auto-updates ()
  "Test that a stale (non-existent) device is auto-updated to current default."
  (test-validate-setup)
  (unwind-protect
      (let ((cj/recording-system-device "old_disappeared_device.monitor")
            (messages nil))
        (cl-letf (((symbol-function 'shell-command-to-string)
                   (lambda (cmd)
                     (cond
                      ((string-match-p "sources short" cmd)
                       ;; Old device NOT in list
                       "65\talsa_output.usb-Jabra-00.analog-stereo.monitor\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ((string-match-p "sinks short" cmd)
                       "65\talsa_output.usb-Jabra-00.analog-stereo\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ((string-match-p "sink-inputs" cmd) "Sink Input #1\n\tSink: 65\n")
                      ((string-match-p "get-default-sink" cmd) "alsa_output.usb-Jabra-00.analog-stereo")
                      (t ""))))
                  ((symbol-function 'message)
                   (lambda (fmt &rest args)
                     (push (apply #'format fmt args) messages))))
          (cj/recording--validate-system-audio)
          (should (equal "alsa_output.usb-Jabra-00.analog-stereo.monitor"
                         cj/recording-system-device))
          (should (cl-some (lambda (m) (string-match-p "no longer exists" m)) messages))))
    (test-validate-teardown)))

(ert-deftest test-validate-system-audio-normal-drifted-default-auto-updates ()
  "Test that device is updated when default sink has drifted."
  (test-validate-setup)
  (unwind-protect
      (let ((cj/recording-system-device "alsa_output.pci-0000.hdmi-stereo.monitor")
            (messages nil))
        (cl-letf (((symbol-function 'shell-command-to-string)
                   (lambda (cmd)
                     (cond
                      ((string-match-p "sources short" cmd)
                       ;; Old device still exists
                       (concat "65\talsa_output.pci-0000.hdmi-stereo.monitor\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n"
                               "69\talsa_output.usb-Jabra-00.analog-stereo.monitor\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n"))
                      ((string-match-p "sinks short" cmd)
                       "69\talsa_output.usb-Jabra-00.analog-stereo\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ((string-match-p "sink-inputs" cmd) "Sink Input #1\n\tSink: 69\n")
                      ;; But default has changed to Jabra
                      ((string-match-p "get-default-sink" cmd) "alsa_output.usb-Jabra-00.analog-stereo")
                      (t ""))))
                  ((symbol-function 'message)
                   (lambda (fmt &rest args)
                     (push (apply #'format fmt args) messages))))
          (cj/recording--validate-system-audio)
          (should (equal "alsa_output.usb-Jabra-00.analog-stereo.monitor"
                         cj/recording-system-device))
          (should (cl-some (lambda (m) (string-match-p "default output changed" m)) messages))))
    (test-validate-teardown)))

(ert-deftest test-validate-system-audio-normal-no-audio-warns ()
  "Test that no active audio shows warning message and logs diagnostic steps."
  (test-validate-setup)
  (unwind-protect
      (let ((cj/recording-system-device "alsa_output.usb-Jabra-00.analog-stereo.monitor")
            (messages nil)
            (logged nil))
        (cl-letf (((symbol-function 'shell-command-to-string)
                   (lambda (cmd)
                     (cond
                      ((string-match-p "sources short" cmd)
                       "65\talsa_output.usb-Jabra-00.analog-stereo.monitor\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ((string-match-p "sinks short" cmd)
                       "65\talsa_output.usb-Jabra-00.analog-stereo\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ;; No sink inputs — nothing playing
                      ((string-match-p "sink-inputs" cmd) "")
                      ((string-match-p "get-default-sink" cmd) "alsa_output.usb-Jabra-00.analog-stereo")
                      (t ""))))
                  ((symbol-function 'message)
                   (lambda (fmt &rest args)
                     (push (apply #'format fmt args) messages)))
                  ((symbol-function 'cj/log-silently)
                   (lambda (fmt &rest args)
                     (setq logged (apply #'format fmt args)))))
          (cj/recording--validate-system-audio)
          ;; Echo area should show the warning
          (should (cl-some (lambda (m) (string-match-p "No audio connected" m)) messages))
          ;; Messages buffer should have diagnostic steps
          (should logged)
          (should (string-match-p "C-; r s" logged))))
    (test-validate-teardown)))

(ert-deftest test-validate-system-audio-normal-no-audio-does-not-block ()
  "Test that no active audio does not block — recording proceeds."
  (test-validate-setup)
  (unwind-protect
      (let ((cj/recording-system-device "alsa_output.usb-Jabra-00.analog-stereo.monitor"))
        (cl-letf (((symbol-function 'shell-command-to-string)
                   (lambda (cmd)
                     (cond
                      ((string-match-p "sources short" cmd)
                       "65\talsa_output.usb-Jabra-00.analog-stereo.monitor\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ((string-match-p "sinks short" cmd)
                       "65\talsa_output.usb-Jabra-00.analog-stereo\tPipeWire\ts32le 2ch 48000Hz\tSUSPENDED\n")
                      ((string-match-p "sink-inputs" cmd) "")
                      ((string-match-p "get-default-sink" cmd) "alsa_output.usb-Jabra-00.analog-stereo")
                      (t ""))))
                  ((symbol-function 'message) (lambda (_fmt &rest _args) nil))
                  ((symbol-function 'cj/log-silently) (lambda (_fmt &rest _args) nil)))
          ;; Should return normally, not signal an error or prompt
          (cj/recording--validate-system-audio)))
    (test-validate-teardown)))

;;; Boundary Cases

(ert-deftest test-validate-system-audio-boundary-nil-device-skips-validation ()
  "Test that nil system device skips all validation."
  (let ((cj/recording-system-device nil)
        (shell-called nil))
    (cl-letf (((symbol-function 'shell-command-to-string)
               (lambda (_cmd) (setq shell-called t) "")))
      (cj/recording--validate-system-audio)
      (should-not shell-called))))

(provide 'test-video-audio-recording-validate-system-audio)
;;; test-video-audio-recording-validate-system-audio.el ends here