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
| | ;; test-lib.el --- auxiliary stuff for Notmuch Emacs tests.
;;
;; Copyright © Carl Worth
;; Copyright © David Edmondson
;;
;; This file is part of Notmuch test suit.
;;
;; Notmuch 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.
;;
;; Notmuch 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 Notmuch. If not, see <http://www.gnu.org/licenses/>.
;;
;; Authors: Dmitry Kurochkin <dmitry.kurochkin@gmail.com>
(require 'cl) ;; This code is generally used uncompiled.
;; `read-file-name' by default uses `completing-read' function to read
;; user input. It does not respect `standard-input' variable which we
;; use in tests to provide user input. So replace it with a plain
;; `read' call.
(setq read-file-name-function (lambda (&rest _) (read)))
(defun notmuch-test-wait ()
"Wait for process completion."
(while (get-buffer-process (current-buffer))
(sleep-for 0.1)))
(defun test-output (&optional filename)
"Save current buffer to file FILENAME. Default FILENAME is OUTPUT."
(write-region (point-min) (point-max) (or filename "OUTPUT")))
(defun test-visible-output (&optional filename)
"Save visible text in current buffer to file FILENAME. Default
FILENAME is OUTPUT."
(let ((text (visible-buffer-string)))
(with-temp-file (or filename "OUTPUT") (insert text))))
(defun visible-buffer-string ()
"Same as `buffer-string', but excludes invisible text."
(visible-buffer-substring (point-min) (point-max)))
(defun visible-buffer-substring (start end)
"Same as `buffer-substring', but excludes invisible text."
(let (str)
(while (< start end)
(let ((next-pos (next-char-property-change start end)))
(when (not (invisible-p start))
(setq str (concat str (buffer-substring start next-pos))))
(setq start next-pos)))
str))
(defun orphan-watchdog (pid)
"Periodically check that the process with id PID is still
running, quit if it terminated."
(if (not (process-attributes pid))
(kill-emacs)
(run-at-time "1 min" nil 'orphan-watchdog pid)))
(defun hook-counter (hook)
"Count how many times a hook is called. Increments
`hook'-counter variable value if it is bound, otherwise does
nothing."
(let ((counter (intern (concat (symbol-name hook) "-counter"))))
(if (boundp counter)
(set counter (1+ (symbol-value counter))))))
(defun add-hook-counter (hook)
"Add hook to count how many times `hook' is called."
(add-hook hook (apply-partially 'hook-counter hook)))
(add-hook-counter 'notmuch-hello-mode-hook)
(add-hook-counter 'notmuch-hello-refresh-hook)
(defmacro notmuch-test-run-test (&rest body)
"Evaluate a BODY of test expressions and output the result."
`(with-temp-buffer
(let ((result (progn ,@body)))
(insert (if (stringp result)
result
(prin1-to-string result)))
(test-output))))
;; Functions to help when writing tests:
(defun notmuch-test-reporter (output expected)
"Report that the `output' does not match the `expected' result."
(concat "Expect:\t" (prin1-to-string expected) "\n"
"Output:\t" (prin1-to-string output) "\n"))
(defun notmuch-test-unsimilar (output expected)
"`output' and `expected' are dissimilar. Show a summary of
the differences, ignoring similarities."
(cond ((and (listp output)
(listp expected))
(apply #'concat (loop for o in output
for e in expected
if (not (equal o e))
collect (notmuch-test-reporter o e))))
(t
;; Catch all case.
(notmuch-test-reporter output expected))))
(defun notmuch-test-compare (output expected)
"Compare `output' with `expected'. Report any discrepencies."
(if (equal output expected)
t
(notmuch-test-unsimilar output expected)))
|