1 ;; test-lib.el --- auxiliary stuff for Notmuch Emacs tests.
3 ;; Copyright © Carl Worth
4 ;; Copyright © David Edmondson
6 ;; This file is part of Notmuch test suit.
8 ;; Notmuch is free software: you can redistribute it and/or modify it
9 ;; under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; Notmuch is distributed in the hope that it will be useful, but
14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 ;; General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with Notmuch. If not, see <https://www.gnu.org/licenses/>.
21 ;; Authors: Dmitry Kurochkin <dmitry.kurochkin@gmail.com>
25 ;; Ensure that the dynamic variables that are defined by this library
26 ;; are defined by the time that we let-bind them. This is needed
27 ;; because starting with Emacs 27 undeclared variables in evaluated
28 ;; interactive code (such as our tests) use lexical scope.
31 ;; `read-file-name' by default uses `completing-read' function to read
32 ;; user input. It does not respect `standard-input' variable which we
33 ;; use in tests to provide user input. So replace it with a plain
35 (setq read-file-name-function (lambda (&rest _) (read)))
37 ;; Work around a bug in emacs 23.1 and emacs 23.2 which prevents
38 ;; noninteractive (kill-emacs) from emacsclient.
39 (if (and (= emacs-major-version 23) (< emacs-minor-version 3))
40 (defadvice kill-emacs (before disable-yes-or-no-p activate)
41 "Disable yes-or-no-p before executing kill-emacs"
42 (defun yes-or-no-p (prompt) t)))
45 ;; 23.0.92; `accept-process-output' and `sleep-for' do not run sentinels
46 ;; seems to be present in Emacs 23.1.
47 ;; Running `list-processes' after `accept-process-output' seems to work
48 ;; around this problem.
49 (if (and (= emacs-major-version 23) (= emacs-minor-version 1))
50 (defadvice accept-process-output (after run-list-processes activate)
51 "run list-processes after executing accept-process-output"
54 (defun notmuch-test-wait ()
55 "Wait for process completion."
56 (while (get-buffer-process (current-buffer))
57 (accept-process-output nil 0.1)))
59 (defun test-output (&optional filename)
60 "Save current buffer to file FILENAME. Default FILENAME is OUTPUT."
61 (notmuch-post-command)
62 (write-region (point-min) (point-max) (or filename "OUTPUT")))
64 (defun test-visible-output (&optional filename)
65 "Save visible text in current buffer to file FILENAME. Default
67 (notmuch-post-command)
68 (let ((text (visible-buffer-string))
69 ;; Tests expect output in UTF-8 encoding
70 (coding-system-for-write 'utf-8))
71 (with-temp-file (or filename "OUTPUT") (insert text))))
73 (defun visible-buffer-string ()
74 "Same as `buffer-string', but excludes invisible text and
75 removes any text properties."
76 (visible-buffer-substring (point-min) (point-max)))
78 (defun visible-buffer-substring (start end)
79 "Same as `buffer-substring-no-properties', but excludes
83 (let ((next-pos (next-char-property-change start end)))
84 (when (not (invisible-p start))
85 (setq str (concat str (buffer-substring-no-properties
87 (setq start next-pos)))
90 ;; process-attributes is not defined everywhere, so define an
91 ;; alternate way to test if a process still exists.
93 (defun test-process-running (pid)
95 (signal-process pid 0)))
97 (defun orphan-watchdog-check (pid)
98 "Periodically check that the process with id PID is still
99 running, quit if it terminated."
100 (if (not (test-process-running pid))
103 (defun orphan-watchdog (pid)
104 "Initiate orphan watchdog check."
105 (run-at-time 60 60 'orphan-watchdog-check pid))
107 (defun hook-counter (hook)
108 "Count how many times a hook is called. Increments
109 `hook'-counter variable value if it is bound, otherwise does
111 (let ((counter (intern (concat (symbol-name hook) "-counter"))))
113 (set counter (1+ (symbol-value counter))))))
115 (defun add-hook-counter (hook)
116 "Add hook to count how many times `hook' is called."
117 (add-hook hook (apply-partially 'hook-counter hook)))
119 (add-hook-counter 'notmuch-hello-mode-hook)
120 (add-hook-counter 'notmuch-hello-refresh-hook)
122 (defvar notmuch-hello-mode-hook-counter -100
123 "Tests that care about this counter must let-bind it to 0.")
125 (defvar notmuch-hello-refresh-hook-counter -100
126 "Tests that care about this counter must let-bind it to 0.")
128 (defadvice notmuch-search-process-filter (around pessimal activate disable)
129 "Feed notmuch-search-process-filter one character at a time."
130 (let ((string (ad-get-arg 1)))
131 (cl-loop for char across string
133 (ad-set-arg 1 (char-to-string char))
136 (defun notmuch-test-mark-links ()
137 "Enclose links in the current buffer with << and >>."
138 ;; Links are often created by jit-lock functions
139 (jit-lock-fontify-now)
141 (let ((inhibit-read-only t))
142 (goto-char (point-min))
144 (while (setq button (next-button (point)))
145 (goto-char (button-start button))
147 (goto-char (button-end button))
150 (defmacro notmuch-test-run (&rest body)
151 "Evaluate a BODY of test expressions and output the result."
153 (let ((buffer (current-buffer))
154 (result (progn ,@body)))
155 (switch-to-buffer buffer)
156 (insert (if (stringp result)
158 (prin1-to-string result)))
161 (defun notmuch-test-report-unexpected (output expected)
162 "Report that the OUTPUT does not match the EXPECTED result."
163 (concat "Expect:\t" (prin1-to-string expected) "\n"
164 "Output:\t" (prin1-to-string output) "\n"))
166 (defun notmuch-test-expect-equal (output expected)
167 "Compare OUTPUT with EXPECTED. Report any discrepencies."
168 (if (equal output expected)
173 ;; Reporting the difference between two lists is done by
174 ;; reporting differing elements of OUTPUT and EXPECTED
175 ;; pairwise. This is expected to make analysis of failures
177 (apply #'concat (cl-loop for o in output
180 collect (notmuch-test-report-unexpected o e))))
183 (notmuch-test-report-unexpected output expected)))))
185 (defun notmuch-post-command ()
186 (run-hooks 'post-command-hook))
188 (defmacro notmuch-test-progn (&rest body)
191 (lambda (x) `(prog1 ,x (notmuch-post-command)))
194 ;; For historical reasons, we hide deleted tags by default in the test
196 (setq notmuch-tag-deleted-formats
199 ;; Also for historical reasons, we set the fcc handler to file not
202 (setq notmuch-maildir-use-notmuch-insert nil)
204 ;; force a common html renderer, to avoid test variations between
207 (setq mm-text-html-renderer 'html2text)