Commit 299a96c7 authored by Stephen Berman's avatar Stephen Berman
Browse files

Add initial tests for todo-mode.el

*test/lisp/calendar/todo-mode-resources/todo-test-1.todo: New files.

* .gitattributes: Ignore trailing whitespace in todo-mode test
data files, since it is part of the todo-mode file format.
parent ed222c50
......@@ -29,6 +29,11 @@ test/etags/c-src/dostorture.c whitespace=cr-at-eol
test/etags/cp-src/c.C whitespace=cr-at-eol
test/etags/html-src/algrthms.html whitespace=cr-at-eol
# The todo-mode file format includes trailing whitespace, so the test
# data files cannot avoid it.
test/lisp/calendar/todo-mode-resources/todo-test-1.toda -whitespace=blank-at-eol
test/lisp/calendar/todo-mode-resources/todo-test-1.todo -whitespace=blank-at-eol
# The upstream maintainer does not want to remove trailing whitespace.
doc/misc/texinfo.tex -whitespace=blank-at-eol
(("testcat1" . [0 0 1 0]) ("testcat2" . [0 0 1 0]) ("testcat3" . [0 0 1 0]))
--==-- testcat1
==--== DONE
[DONE May 26, 2017] [May 26, 2017] testcat1 item1
--==-- testcat2
==--== DONE
[DONE May 28, 2017] [May 28, 2017] testcat2 item1
--==-- testcat3
==--== DONE
[DONE May 28, 2017] [May 28, 2017] testcat3 item1
(("testcat1" . [2 0 0 1]) ("testcat2" . [1 0 0 1]))
--==-- testcat1
[May 29, 2017] testcat1 item3
has more than one line
to test item highlighting
[May 26, 2017] testcat1 item2
==--== DONE
--==-- testcat2
[May 28, 2017] testcat2 item2
==--== DONE
;;; todo-mode-tests.el --- tests for todo-mode.el -*- lexical-binding: t; -*-
;; Copyright (C) 2017 Free Software Foundation, Inc.
;; Author: Stephen Berman <>
;; Keywords: calendar
;; This program 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.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <>.
;;; Commentary:
;; In its current form this file changes global variables defined in
;; todo-mode.el, so to avoid problems, these tests should not be run
;; if todo-mode.el is already loaded.
;;; Code:
(require 'ert)
(require 'todo-mode)
(defvar todo-test-data-dir
(expand-file-name "todo-mode-resources/"
(file-name-directory (or load-file-name
"Base directory of todo-mode.el test data files.")
(defvar todo-test-file-1 (expand-file-name "todo-test-1.todo"
"Todo mode test file.")
(defvar todo-test-archive-1 (expand-file-name "todo-test-1.toda"
"Todo Archive mode test file.")
;; (setq todo-directory-orig todo-directory)
(setq todo-directory todo-test-data-dir)
(defun todo-test-get-archive (num)
"Make buffer displaying archive category NUM current."
(let ((archive-buf (find-file-noselect todo-test-archive-1)))
(set-buffer archive-buf)
(setq todo-category-number num)
(defun todo-test-is-current-buffer (filename)
"Return non-nil if FILENAME's buffer is current."
(let ((bufname (buffer-file-name (current-buffer))))
(and bufname (equal (file-truename bufname) filename))))
(ert-deftest todo-test-todo-quit01 ()
"Test the behavior of todo-quit with archive and todo files.
Invoking todo-quit in todo-archive-mode should make the
corresponding todo-mode category current, if it exits, otherwise
the current todo-mode category. Quitting todo-mode without an
intermediate buffer switch should not make the archive buffer
current again."
(todo-test-get-archive 2)
(let ((cat-name (todo-current-category)))
(should (todo-test-is-current-buffer todo-test-file-1))
(should (equal (todo-current-category) cat-name))
(todo-test-get-archive 1)
(setq cat-name (todo-current-category))
(should (todo-test-is-current-buffer todo-test-file-1))
(should (equal todo-category-number 1))
(todo-forward-category) ; Category 2 in todo file now current.
(todo-test-get-archive 3) ; No corresponding category in todo file.
(setq cat-name (todo-current-category))
(should (todo-test-is-current-buffer todo-test-file-1))
(should (equal todo-category-number 2))
(should-not (todo-test-is-current-buffer todo-test-archive-1))))
(ert-deftest todo-test-todo-quit02 () ; bug#27121
"Test the behavior of todo-quit with todo and non-todo buffers.
If the buffer made current by invoking todo-quit in a todo-mode
buffer is buried by quit-window, the todo-mode buffer should not
become current."
(should (todo-test-is-current-buffer todo-test-file-1))
(let ((dir (dired default-directory)))
(should (equal (current-buffer) dir))
(should-not (todo-test-is-current-buffer todo-test-file-1))))
(ert-deftest todo-test-item-highlighting () ; bug#27133
"Test whether `todo-toggle-item-highlighting' highlights whole item.
In particular, all lines of a multiline item should be highlighted."
(todo-jump-to-category nil "testcat1") ; For test rerun.
(let ((end (1- (todo-item-end)))
(beg (todo-item-start)))
(should (eq (get-char-property beg 'face) 'hl-line))
(should (eq (get-char-property end 'face) 'hl-line))
(should (> (count-lines beg end) 1))
(should (eq (next-single-char-property-change beg 'face) (1+ end))))
(todo-toggle-item-highlighting)) ; Turn off highlighting (for test rerun).
;; FIXME: must do this only after running all tests!
;; (setq todo-directory todo-directory-orig)
(provide 'todo-mode-tests)
;;; todo-mode-tests.el ends here
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment