-;; test-lib.el --- auxiliary stuff for Notmuch Emacs tests.
+;;; test-lib.el --- auxiliary stuff for Notmuch Emacs tests
;;
;; Copyright © Carl Worth
;; Copyright © David Edmondson
;; 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/>.
+;; along with Notmuch. If not, see <https://www.gnu.org/licenses/>.
;;
;; Authors: Dmitry Kurochkin <dmitry.kurochkin@gmail.com>
-(require 'cl) ;; This code is generally used uncompiled.
+;;; Code:
+
+(require 'cl-lib)
+
+;; Ensure that the dynamic variables that are defined by this library
+;; are defined by the time that we let-bind them. This is needed
+;; because starting with Emacs 27 undeclared variables in evaluated
+;; interactive code (such as our tests) use lexical scope.
+(require 'smtpmail)
;; `read-file-name' by default uses `completing-read' function to read
;; user input. It does not respect `standard-input' variable which we
;; `read' call.
(setq read-file-name-function (lambda (&rest _) (read)))
-;; Work around a bug in emacs 23.1 and emacs 23.2 which prevents
-;; noninteractive (kill-emacs) from emacsclient.
-(if (and (= emacs-major-version 23) (< emacs-minor-version 3))
- (defadvice kill-emacs (before disable-yes-or-no-p activate)
- "Disable yes-or-no-p before executing kill-emacs"
- (defun yes-or-no-p (prompt) t)))
-
-;; Emacs bug #2930:
-;; 23.0.92; `accept-process-output' and `sleep-for' do not run sentinels
-;; seems to be present in Emacs 23.1.
-;; Running `list-processes' after `accept-process-output' seems to work
-;; around this problem.
-(if (and (= emacs-major-version 23) (= emacs-minor-version 1))
- (defadvice accept-process-output (after run-list-processes activate)
- "run list-processes after executing accept-process-output"
- (list-processes)))
-
(defun notmuch-test-wait ()
"Wait for process completion."
(while (get-buffer-process (current-buffer))
(let (str)
(while (< start end)
(let ((next-pos (next-char-property-change start end)))
- (when (not (invisible-p start))
+ (unless (invisible-p start)
(setq str (concat str (buffer-substring-no-properties
start next-pos))))
(setq start next-pos)))
(defun orphan-watchdog-check (pid)
"Periodically check that the process with id PID is still
running, quit if it terminated."
- (if (not (test-process-running pid))
- (kill-emacs)))
+ (unless (test-process-running pid)
+ (kill-emacs)))
(defun orphan-watchdog (pid)
"Initiate orphan watchdog check."
(run-at-time 60 60 'orphan-watchdog-check 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)
-
-(defadvice notmuch-search-process-filter (around pessimal activate disable)
- "Feed notmuch-search-process-filter one character at a time."
- (let ((string (ad-get-arg 1)))
- (loop for char across string
- do (progn
- (ad-set-arg 1 (char-to-string char))
- ad-do-it))))
+(defvar notmuch-hello-mode-hook-counter -100
+ "Tests that care about this counter must let-bind it to 0.")
+(add-hook 'notmuch-hello-mode-hook
+ (lambda () (cl-incf notmuch-hello-mode-hook-counter)))
+
+(defvar notmuch-hello-refresh-hook-counter -100
+ "Tests that care about this counter must let-bind it to 0.")
+(add-hook 'notmuch-hello-refresh-hook
+ (lambda () (cl-incf notmuch-hello-refresh-hook-counter)))
+
+(defvar notmuch-test-tag-hook-output nil)
+(defun notmuch-test-tag-hook () (push (cons query tag-changes) notmuch-test-tag-hook-output))
(defun notmuch-test-mark-links ()
"Enclose links in the current buffer with << and >>."
"Output:\t" (prin1-to-string output) "\n"))
(defun notmuch-test-expect-equal (output expected)
- "Compare OUTPUT with EXPECTED. Report any discrepencies."
- (if (equal output expected)
- t
- (cond
- ((and (listp output)
- (listp expected))
- ;; Reporting the difference between two lists is done by
- ;; reporting differing elements of OUTPUT and EXPECTED
- ;; pairwise. This is expected to make analysis of failures
- ;; simpler.
- (apply #'concat (loop for o in output
- for e in expected
- if (not (equal o e))
- collect (notmuch-test-report-unexpected o e))))
-
- (t
- (notmuch-test-report-unexpected output expected)))))
+ "Compare OUTPUT with EXPECTED. Report any discrepancies."
+ (cond
+ ((equal output expected)
+ t)
+ ((and (listp output)
+ (listp expected))
+ ;; Reporting the difference between two lists is done by
+ ;; reporting differing elements of OUTPUT and EXPECTED
+ ;; pairwise. This is expected to make analysis of failures
+ ;; simpler.
+ (apply #'concat (cl-loop for o in output
+ for e in expected
+ if (not (equal o e))
+ collect (notmuch-test-report-unexpected o e))))
+ (t
+ (notmuch-test-report-unexpected output expected))))
(defun notmuch-post-command ()
(run-hooks 'post-command-hook))
(lambda (x) `(prog1 ,x (notmuch-post-command)))
body)))
+;; For testing functions in
+;; notmuch-{search,tree,unsorted}-result-format
+(defun notmuch-test-result-flags (format-string result)
+ (let ((tags-to-letters (quote (("attachment" . "&")
+ ("signed" . "=")
+ ("unread" . "u")
+ ("inbox" . "i"))))
+ (tags (plist-get result :tags)))
+ (format format-string
+ (mapconcat (lambda (t2l)
+ (if (member (car t2l) tags)
+ (cdr t2l)
+ " "))
+ tags-to-letters ""))))
+
+;; Log any signalled error (and other messages) to MESSAGES
+;; Log "COMPLETE" if forms complete without error.
+(defmacro test-log-error (&rest body)
+ `(progn
+ (with-current-buffer "*Messages*"
+ (let ((inhibit-read-only t)) (erase-buffer)))
+ (condition-case err
+ (progn ,@body
+ (message "COMPLETE"))
+ (t (message "%s" err)))
+ (with-current-buffer "*Messages*" (test-output "MESSAGES"))))
+
+(defmacro test-time (&rest body)
+ `(let ((results (mapcar (lambda (x) (/ x 5.0)) (benchmark-run 5 ,@body))))
+ (message "\t\t%0.2f\t%0.2f\t%0.2f" (nth 0 results) (nth 1 results) (nth 2 results))
+ (with-current-buffer "*Messages*" (test-output "MESSAGES"))))
+
;; For historical reasons, we hide deleted tags by default in the test
;; suite
(setq notmuch-tag-deleted-formats
'((".*" nil)))
+;; Also for historical reasons, we set the fcc handler to file not
+;; insert.
+
+(setq notmuch-maildir-use-notmuch-insert nil)
+
;; force a common html renderer, to avoid test variations between
;; environments