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 <http://www.gnu.org/licenses/>.
21 ;; Authors: Dmitry Kurochkin <dmitry.kurochkin@gmail.com>
23 (require 'cl) ;; This code is generally used uncompiled.
25 ;; `read-file-name' by default uses `completing-read' function to read
26 ;; user input. It does not respect `standard-input' variable which we
27 ;; use in tests to provide user input. So replace it with a plain
29 (setq read-file-name-function (lambda (&rest _) (read)))
31 ;; Work around a bug in emacs 23.1 and emacs 23.2 which prevents
32 ;; noninteractive (kill-emacs) from emacsclient.
33 (if (and (= emacs-major-version 23) (< emacs-minor-version 3))
34 (defadvice kill-emacs (before disable-yes-or-no-p activate)
35 "Disable yes-or-no-p before executing kill-emacs"
36 (defun yes-or-no-p (prompt) t)))
39 ;; 23.0.92; `accept-process-output' and `sleep-for' do not run sentinels
40 ;; seems to be present in Emacs 23.1.
41 ;; Running `list-processes' after `accept-process-output' seems to work
42 ;; around this problem.
43 (if (and (= emacs-major-version 23) (= emacs-minor-version 1))
44 (defadvice accept-process-output (after run-list-processes activate)
45 "run list-processes after executing accept-process-output"
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 (write-region (point-min) (point-max) (or filename "OUTPUT")))
57 (defun test-visible-output (&optional filename)
58 "Save visible text in current buffer to file FILENAME. Default
60 (let ((text (visible-buffer-string)))
61 (with-temp-file (or filename "OUTPUT") (insert text))))
63 (defun visible-buffer-string ()
64 "Same as `buffer-string', but excludes invisible text and
65 removes any text properties."
66 (visible-buffer-substring (point-min) (point-max)))
68 (defun visible-buffer-substring (start end)
69 "Same as `buffer-substring-no-properties', but excludes
73 (let ((next-pos (next-char-property-change start end)))
74 (when (not (invisible-p start))
75 (setq str (concat str (buffer-substring-no-properties
77 (setq start next-pos)))
80 (defun orphan-watchdog-check (pid)
81 "Periodically check that the process with id PID is still
82 running, quit if it terminated."
83 (if (not (process-attributes pid))
86 (defun orphan-watchdog (pid)
87 "Initiate orphan watchdog check."
88 ; If process-attributes returns nil right away, that probably means
89 ; it is unimplimented. So we delay two minutes before killing emacs.
90 (if (process-attributes pid)
91 (run-at-time 60 60 'orphan-watchdog-check pid)
92 (run-at-time 120 60 'orphan-watchdog-check pid)))
94 (defun hook-counter (hook)
95 "Count how many times a hook is called. Increments
96 `hook'-counter variable value if it is bound, otherwise does
98 (let ((counter (intern (concat (symbol-name hook) "-counter"))))
100 (set counter (1+ (symbol-value counter))))))
102 (defun add-hook-counter (hook)
103 "Add hook to count how many times `hook' is called."
104 (add-hook hook (apply-partially 'hook-counter hook)))
106 (add-hook-counter 'notmuch-hello-mode-hook)
107 (add-hook-counter 'notmuch-hello-refresh-hook)
109 (defadvice notmuch-search-process-filter (around pessimal activate disable)
110 "Feed notmuch-search-process-filter one character at a time."
111 (let ((string (ad-get-arg 1)))
112 (loop for char across string
114 (ad-set-arg 1 (char-to-string char))
117 (defun notmuch-test-mark-links ()
118 "Enclose links in the current buffer with << and >>."
119 ;; Links are often created by jit-lock functions
120 (jit-lock-fontify-now)
122 (let ((inhibit-read-only t))
123 (goto-char (point-min))
125 (while (setq button (next-button (point)))
126 (goto-char (button-start button))
128 (goto-char (button-end button))
131 (defmacro notmuch-test-run (&rest body)
132 "Evaluate a BODY of test expressions and output the result."
134 (let ((buffer (current-buffer))
135 (result (progn ,@body)))
136 (switch-to-buffer buffer)
137 (insert (if (stringp result)
139 (prin1-to-string result)))
142 (defun notmuch-test-report-unexpected (output expected)
143 "Report that the OUTPUT does not match the EXPECTED result."
144 (concat "Expect:\t" (prin1-to-string expected) "\n"
145 "Output:\t" (prin1-to-string output) "\n"))
147 (defun notmuch-test-expect-equal (output expected)
148 "Compare OUTPUT with EXPECTED. Report any discrepencies."
149 (if (equal output expected)
154 ;; Reporting the difference between two lists is done by
155 ;; reporting differing elements of OUTPUT and EXPECTED
156 ;; pairwise. This is expected to make analysis of failures
158 (apply #'concat (loop for o in output
161 collect (notmuch-test-report-unexpected o e))))
164 (notmuch-test-report-unexpected output expected)))))