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 ;; minimize impact of native compilation on the test suite.
26 ;; These are the Emacs 29.1 version of the variables.
27 ;; Leave trampolines enabled per Emacs upstream recommendations.
28 ;; It is important to set these variables before loading any
30 (setq native-comp-jit-compilation nil)
31 (setq native-comp-speed -1)
32 (setq native-comp-async-jobs-number 1)
36 ;; Ensure that the dynamic variables that are defined by this library
37 ;; are defined by the time that we let-bind them. This is needed
38 ;; because starting with Emacs 27 undeclared variables in evaluated
39 ;; interactive code (such as our tests) use lexical scope.
42 ;; `read-file-name' by default uses `completing-read' function to read
43 ;; user input. It does not respect `standard-input' variable which we
44 ;; use in tests to provide user input. So replace it with a plain
46 (setq read-file-name-function (lambda (&rest _) (read)))
48 (defun notmuch-test-wait ()
49 "Wait for process completion."
50 (while (get-buffer-process (current-buffer))
51 (accept-process-output nil 0.1)))
53 (defun test-output (&optional filename)
54 "Save current buffer to file FILENAME. Default FILENAME is OUTPUT."
55 (notmuch-post-command)
56 (write-region (point-min) (point-max) (or filename "OUTPUT")))
58 (defun test-visible-output (&optional filename)
59 "Save visible text in current buffer to file FILENAME. Default
61 (notmuch-post-command)
62 (let ((text (visible-buffer-string))
63 ;; Tests expect output in UTF-8 encoding
64 (coding-system-for-write 'utf-8))
65 (with-temp-file (or filename "OUTPUT") (insert text))))
67 (defun visible-buffer-string ()
68 "Same as `buffer-string', but excludes invisible text and
69 removes any text properties."
70 (visible-buffer-substring (point-min) (point-max)))
72 (defun visible-buffer-substring (start end)
73 "Same as `buffer-substring-no-properties', but excludes
77 (let ((next-pos (next-char-property-change start end)))
78 (unless (invisible-p start)
79 (setq str (concat str (buffer-substring-no-properties
81 (setq start next-pos)))
84 ;; process-attributes is not defined everywhere, so define an
85 ;; alternate way to test if a process still exists.
87 (defun test-process-running (pid)
89 (signal-process pid 0)))
91 (defun orphan-watchdog-check (pid)
92 "Periodically check that the process with id PID is still
93 running, quit if it terminated."
94 (unless (test-process-running pid)
97 (defun orphan-watchdog (pid)
98 "Initiate orphan watchdog check."
99 (run-at-time 60 60 'orphan-watchdog-check pid))
101 (defvar notmuch-hello-mode-hook-counter -100
102 "Tests that care about this counter must let-bind it to 0.")
103 (add-hook 'notmuch-hello-mode-hook
104 (lambda () (cl-incf notmuch-hello-mode-hook-counter)))
106 (defvar notmuch-hello-refresh-hook-counter -100
107 "Tests that care about this counter must let-bind it to 0.")
108 (add-hook 'notmuch-hello-refresh-hook
109 (lambda () (cl-incf notmuch-hello-refresh-hook-counter)))
111 (defvar notmuch-test-tag-hook-output nil)
112 (defun notmuch-test-tag-hook () (push (cons query tag-changes) notmuch-test-tag-hook-output))
114 (defun notmuch-test-mark-links ()
115 "Enclose links in the current buffer with << and >>."
116 ;; Links are often created by jit-lock functions
117 (jit-lock-fontify-now)
119 (let ((inhibit-read-only t))
120 (goto-char (point-min))
122 (while (setq button (next-button (point)))
123 (goto-char (button-start button))
125 (goto-char (button-end button))
128 (defmacro notmuch-test-run (&rest body)
129 "Evaluate a BODY of test expressions and output the result."
131 (let ((buffer (current-buffer))
132 (result (progn ,@body)))
133 (switch-to-buffer buffer)
134 (insert (if (stringp result)
136 (prin1-to-string result)))
139 (defun notmuch-test-report-unexpected (output expected)
140 "Report that the OUTPUT does not match the EXPECTED result."
141 (concat "Expect:\t" (prin1-to-string expected) "\n"
142 "Output:\t" (prin1-to-string output) "\n"))
144 (defun notmuch-test-expect-equal (output expected)
145 "Compare OUTPUT with EXPECTED. Report any discrepancies."
147 ((equal output expected)
151 ;; Reporting the difference between two lists is done by
152 ;; reporting differing elements of OUTPUT and EXPECTED
153 ;; pairwise. This is expected to make analysis of failures
155 (apply #'concat (cl-loop for o in output
158 collect (notmuch-test-report-unexpected o e))))
160 (notmuch-test-report-unexpected output expected))))
162 (defun notmuch-post-command ()
163 (run-hooks 'post-command-hook))
165 (defmacro notmuch-test-progn (&rest body)
168 (lambda (x) `(prog1 ,x (notmuch-post-command)))
171 ;; For testing functions in
172 ;; notmuch-{search,tree,unsorted}-result-format
173 (defun notmuch-test-result-flags (format-string result)
174 (let ((tags-to-letters (quote (("attachment" . "&")
178 (tags (plist-get result :tags)))
179 (format format-string
180 (mapconcat (lambda (t2l)
181 (if (member (car t2l) tags)
184 tags-to-letters ""))))
186 ;; Log any signalled error (and other messages) to MESSAGES
187 ;; Log "COMPLETE" if forms complete without error.
188 (defmacro test-log-error (&rest body)
190 (with-current-buffer "*Messages*"
191 (let ((inhibit-read-only t)) (erase-buffer)))
194 (message "COMPLETE"))
195 (t (message "%s" err)))
196 (with-current-buffer "*Messages*" (test-output "MESSAGES"))))
198 (defmacro test-time (&rest body)
199 `(let ((results (mapcar (lambda (x) (/ x 5.0)) (benchmark-run 5 ,@body))))
200 (message "\t\t%0.2f\t%0.2f\t%0.2f" (nth 0 results) (nth 1 results) (nth 2 results))
201 (with-current-buffer "*Messages*" (test-output "MESSAGES"))))
203 ;; For historical reasons, we hide deleted tags by default in the test
205 (setq notmuch-tag-deleted-formats
208 ;; Also for historical reasons, we set the fcc handler to file not
211 (setq notmuch-maildir-use-notmuch-insert nil)
213 ;; force a common html renderer, to avoid test variations between
216 (setq mm-text-html-renderer 'html2text)
218 ;; Set our own default for message-hidden-headers, to avoid tests
219 ;; breaking when the Emacs default changes.
220 (setq message-hidden-headers
221 '("^References:" "^Face:" "^X-Face:" "^X-Draft-From:"))