1 ;;; context-coloring-test.el --- Tests for context coloring -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2014-2015 Free Software Foundation, Inc.
5 ;; This file is part of GNU Emacs.
7 ;; This program is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; This program is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
22 ;; Tests for context coloring.
24 ;; Use with `make test'.
29 (require 'context-coloring)
34 ;;; Test running utilities
36 (defconst context-coloring-test-path
37 (file-name-directory (or load-file-name buffer-file-name))
38 "This file's directory.")
40 (defun context-coloring-test-read-file (path)
41 "Return the file's contents from PATH as a string."
43 (insert-file-contents (expand-file-name path context-coloring-test-path))
46 (defmacro context-coloring-test-with-fixture (fixture &rest body)
47 "With relative FIXTURE, evaluate BODY in a temporary buffer."
50 (insert (context-coloring-test-read-file ,fixture))
54 ;;; Test defining utilities
56 (cl-defmacro context-coloring-test-define-deftest (name
60 &key enable-context-coloring-mode
63 "Define a deftest defmacro for tests prefixed with NAME. MODE
64 is called to set up tests' environments. EXTENSION denotes the
65 suffix for tests' fixture files. If NO-FIXTURE is non-nil, don't
66 use a fixture. If ENABLE-CONTEXT-COLORING-MODE is non-nil,
67 `context-coloring-mode' is activated before tests. Functions
68 BEFORE-EACH and AFTER-EACH run before the major mode is activated
69 before each test, and after each test, even if an error is
71 (declare (indent defun))
72 (let ((macro-name (intern (format "context-coloring-test-deftest%s"
74 ;; No name means no dash.
76 (t (format "-%s" name)))))))
77 `(cl-defmacro ,macro-name (name
82 (declare (indent defun))
83 ;; Commas in nested backquotes are not evaluated. Binding the variables
84 ;; here is probably the cleanest workaround.
86 (before-each ',before-each)
87 (after-each ',after-each)
88 (test-name (intern (format ,(format "%s-%%s"
91 (t "generic"))) name)))
93 (fixture (format "./fixtures/%s" fixture))
94 (,no-fixture "./fixtures/empty")
95 (t (format ,(format "./fixtures/%%s.%s" extension) name)))))
96 ,@`((let ((enable-context-coloring-mode ,enable-context-coloring-mode))
97 `(ert-deftest ,test-name ()
98 (context-coloring-test-with-fixture
100 (when ,before-each (funcall ,before-each))
102 (when ,before (funcall ,before))
103 (when ,enable-context-coloring-mode (context-coloring-mode))
107 (when ,after (funcall ,after))
108 (when ,after-each (funcall ,after-each)))))))))))
110 (context-coloring-test-define-deftest nil
111 :mode #'fundamental-mode
114 (context-coloring-test-define-deftest javascript
117 :enable-context-coloring-mode t
118 :before-each (lambda ()
119 (setq js2-mode-show-parse-errors nil)
120 (setq js2-mode-show-strict-warnings nil)))
122 (context-coloring-test-define-deftest emacs-lisp
123 :mode #'emacs-lisp-mode
125 :enable-context-coloring-mode t)
127 (context-coloring-test-define-deftest eval-expression
128 :mode #'fundamental-mode
132 ;;; Assertion functions
134 (defun context-coloring-test-get-last-message ()
135 "Get the last message in the current messages bufffer."
136 (let ((messages (split-string
137 (buffer-substring-no-properties
141 (car (nthcdr (- (length messages) 2) messages))))
143 (defun context-coloring-test-assert-message (expected buffer)
144 "Assert that message EXPECTED is at the end of BUFFER."
145 (when (null (get-buffer buffer))
149 "Expected buffer `%s' to have message \"%s\", "
150 "but the buffer did not have any messages.")
152 (with-current-buffer buffer
153 (let ((message (context-coloring-test-get-last-message)))
154 (when (not (equal message expected))
158 "Expected buffer `%s' to have message \"%s\", "
159 "but instead it was \"%s\"")
163 (defun context-coloring-test-assert-not-message (expected buffer)
164 "Assert that message EXPECTED is not at the end of BUFFER."
165 (when (get-buffer buffer)
166 (with-current-buffer buffer
167 (let ((message (context-coloring-test-get-last-message)))
168 (when (equal message expected)
172 "Expected buffer `%s' not to have message \"%s\", "
174 buffer expected)))))))
176 (defun context-coloring-test-assert-error (body error-message)
177 "Assert that BODY signals ERROR-MESSAGE."
178 (let ((error-signaled-p nil))
183 (setq error-signaled-p t)
184 (when (not (string-equal (cadr err) error-message))
185 (ert-fail (format (concat "Expected the error \"%s\" to be thrown, "
186 "but instead it was \"%s\".")
189 (when (not error-signaled-p)
190 (ert-fail "Expected an error to be thrown, but there wasn't."))))
193 ;;; Miscellaneous tests
195 (defmacro context-coloring-test-define-derived-mode (name)
196 "Define a derived mode exclusively for any test with NAME."
197 (let ((name (intern (format "context-coloring-test-%s-mode" name))))
198 `(define-derived-mode ,name fundamental-mode "Testing")))
200 (defvar context-coloring-test-caused-p nil
201 "If non-nil, coloring was caused.")
203 (defmacro context-coloring-test-assert-causes-coloring (&rest body)
204 "Assert that BODY causes coloring."
206 ;; Gross, but I want this to pass on 24.3.
207 (ad-add-advice #'context-coloring-colorize
208 '(assert-causes-coloring
211 (setq context-coloring-test-caused-p t))))
214 (ad-activate #'context-coloring-colorize)
216 (when (not context-coloring-test-caused-p)
217 (ert-fail "Expected to have colorized, but it didn't."))))
219 (defun context-coloring-test-cleanup-assert-causes-coloring ()
220 "Undo `context-coloring-test-assert-causes-coloring'."
221 (ad-unadvise #'context-coloring-colorize)
222 (setq context-coloring-test-caused-p nil))
224 (context-coloring-test-define-derived-mode mode-startup)
226 (context-coloring-test-deftest mode-startup
228 (context-coloring-define-dispatch
230 :modes '(context-coloring-test-mode-startup-mode)
232 (context-coloring-test-mode-startup-mode)
233 (context-coloring-test-assert-causes-coloring
234 (context-coloring-mode)))
236 (context-coloring-test-cleanup-assert-causes-coloring)))
238 (context-coloring-test-define-derived-mode change-detection)
240 (context-coloring-test-deftest change-detection
242 (context-coloring-define-dispatch
244 :modes '(context-coloring-test-change-detection-mode)
246 :setup #'context-coloring-setup-idle-change-detection
247 :teardown #'context-coloring-teardown-idle-change-detection)
248 (context-coloring-test-change-detection-mode)
249 (context-coloring-mode)
250 (context-coloring-test-assert-causes-coloring
252 ;; Simply cannot figure out how to trigger an idle timer; would much rather
253 ;; test that. But (current-idle-time) always returns nil in these tests.
254 (context-coloring-maybe-colorize-with-buffer (current-buffer))))
256 (context-coloring-test-cleanup-assert-causes-coloring)))
258 (context-coloring-test-deftest unsupported-mode
260 (context-coloring-mode)
261 (context-coloring-test-assert-message
262 "Context coloring is not available for this major mode"
265 (context-coloring-test-deftest derived-mode
267 (lisp-interaction-mode)
268 (context-coloring-mode)
269 (context-coloring-test-assert-not-message
270 "Context coloring is not available for this major mode"
273 (context-coloring-test-define-derived-mode define-dispatch-error)
275 (context-coloring-test-deftest define-dispatch-error
277 (context-coloring-test-assert-error
279 (context-coloring-define-dispatch
280 'define-dispatch-no-modes))
281 "No mode or predicate defined for dispatch")
282 (context-coloring-test-assert-error
284 (context-coloring-define-dispatch
285 'define-dispatch-no-strategy
286 :modes '(context-coloring-test-define-dispatch-error-mode)))
287 "No colorizer defined for dispatch")))
289 (context-coloring-test-define-derived-mode disable-mode)
291 (context-coloring-test-deftest disable-mode
294 (context-coloring-define-dispatch
296 :modes '(context-coloring-test-disable-mode-mode)
300 (context-coloring-test-disable-mode-mode)
301 (context-coloring-mode)
302 (context-coloring-mode -1)
303 (when (not torn-down)
304 (ert-fail "Expected teardown function to have been called, but it wasn't.")))))
306 (defun context-coloring-test-assert-maximum-face (expected)
307 "Assert that `context-coloring-maximum-face' is EXPECTED."
308 (when (not (= context-coloring-maximum-face expected))
309 (ert-fail (format "Expected maximum face to be %s, but it was %s"
310 expected context-coloring-maximum-face))))
312 (deftheme context-coloring-test-custom-theme)
314 (context-coloring-test-define-derived-mode custom-theme)
316 (context-coloring-test-deftest custom-theme
318 (custom-theme-set-faces
319 'context-coloring-test-custom-theme
320 '(context-coloring-level-0-face ((t :foreground "#aaaaaa")))
321 '(context-coloring-level-1-face ((t :foreground "#bbbbbb"))))
323 '(context-coloring-level-0-face ((t :foreground "#aaaaaa"))))
324 (enable-theme 'context-coloring-test-custom-theme)
325 (context-coloring-define-dispatch
327 :modes '(context-coloring-test-custom-theme-mode)
329 (context-coloring-test-custom-theme-mode)
330 (context-coloring-colorize)
331 (context-coloring-test-assert-maximum-face 1)
332 ;; This theme should now be ignored in favor of the `user' theme.
333 (custom-theme-reset-faces
334 'context-coloring-test-custom-theme
335 '(context-coloring-level-0-face nil)
336 '(context-coloring-level-1-face nil))
337 (context-coloring-colorize)
338 ;; Maximum face for `user'.
339 (context-coloring-test-assert-maximum-face 0)
340 ;; Now `user' should be ignored too.
342 '(context-coloring-level-0-face nil))
343 (context-coloring-colorize)
344 ;; Expect the package's defaults.
345 (context-coloring-test-assert-maximum-face
346 context-coloring-default-maximum-face))
349 '(context-coloring-level-0-face nil))
350 (disable-theme 'context-coloring-test-custom-theme)))
355 (defun context-coloring-test-assert-position-level (position level)
356 "Assert that POSITION has LEVEL."
357 (let ((face (get-text-property position 'face))
360 (let* ((face-string (symbol-name face))
361 (matches (string-match
362 context-coloring-level-face-regexp
365 (setq actual-level (string-to-number
366 (substring face-string
369 (= level actual-level)))))
370 (ert-fail (format (concat "Expected level at position %s, "
371 "which is \"%s\", to be %s; "
374 (buffer-substring-no-properties position (1+ position)) level
377 (defun context-coloring-test-assert-position-face (position face-regexp)
378 "Assert that the face at POSITION satisfies FACE-REGEXP."
379 (let ((face (get-text-property position 'face)))
381 ;; Pass a non-string to do an `equal' check (against a symbol or nil).
382 (unless (stringp face-regexp)
383 (not (equal face-regexp face)))
384 ;; Otherwise do the matching.
385 (when (stringp face-regexp)
386 (not (string-match-p face-regexp (symbol-name face)))))
387 (ert-fail (format (concat "Expected face at position %s, "
388 "which is \"%s\", to be %s; "
391 (buffer-substring-no-properties position (1+ position)) face-regexp
394 (defun context-coloring-test-assert-position-comment (position)
395 "Assert that the face at POSITION is a comment."
396 (context-coloring-test-assert-position-face
397 position "\\`font-lock-comment\\(-delimiter\\)?-face\\'"))
399 (defun context-coloring-test-assert-position-constant-comment (position)
400 "Assert that the face at POSITION is a constant comment."
401 (context-coloring-test-assert-position-face position '(font-lock-constant-face
402 font-lock-comment-face)))
404 (defun context-coloring-test-assert-position-string (position)
405 "Assert that the face at POSITION is a string."
406 (context-coloring-test-assert-position-face position 'font-lock-string-face))
408 (defun context-coloring-test-assert-position-nil (position)
409 "Assert that the face at POSITION is nil."
410 (context-coloring-test-assert-position-face position nil))
412 (defun context-coloring-test-assert-coloring (map)
413 "Assert that the current buffer's coloring will match MAP.
415 MAP's newlines should correspond to the current fixture.
417 The following characters appearing in MAP assert coloring for
418 corresponding points in the fixture:
420 0-9: Level equals number.
421 C: Face is constant comment.
426 Any other characters are discarded. Characters \"x\" and any
427 other non-letters are guaranteed to always be discarded."
428 ;; Omit the superfluous, formatting-related leading newline. Can't use
429 ;; `save-excursion' here because if an assertion fails it will cause future
430 ;; tests to get messed up.
431 (goto-char (point-min))
432 (let* ((map (substring map 1))
436 (while (< index (length map))
437 (setq char-string (substring map index (1+ index)))
438 (setq char (string-to-char char-string))
447 (context-coloring-test-assert-position-level
448 (point) (string-to-number char-string))
450 ;; 'C' = Constant comment
452 (context-coloring-test-assert-position-constant-comment (point))
456 (context-coloring-test-assert-position-comment (point))
460 (context-coloring-test-assert-position-nil (point))
464 (context-coloring-test-assert-position-string (point))
468 (setq index (1+ index)))))
470 (context-coloring-test-deftest-javascript function-scopes
472 (context-coloring-test-assert-coloring "
473 000 0 0 11111111 11 110
475 111 1 1 22222222 22 221
479 (context-coloring-test-deftest-javascript global
481 (context-coloring-test-assert-coloring "
483 111 1 1 00000001xxx11
486 (context-coloring-test-deftest-javascript block-scopes
488 (context-coloring-test-assert-coloring "
496 (setq context-coloring-javascript-block-scopes t))
498 (setq context-coloring-javascript-block-scopes nil)))
500 (context-coloring-test-deftest-javascript catch
502 (context-coloring-test-assert-coloring "
512 (context-coloring-test-deftest-javascript key-names
514 (context-coloring-test-assert-coloring "
522 (context-coloring-test-deftest-javascript property-lookup
524 (context-coloring-test-assert-coloring "
531 (context-coloring-test-deftest-javascript key-values
533 (context-coloring-test-assert-coloring "
543 (context-coloring-test-deftest-javascript syntactic-comments-and-strings
545 (context-coloring-test-assert-coloring "
550 :fixture "comments-and-strings.js")
552 (context-coloring-test-deftest-javascript syntactic-comments
554 (context-coloring-test-assert-coloring "
559 :fixture "comments-and-strings.js"
561 (setq context-coloring-syntactic-strings nil))
563 (setq context-coloring-syntactic-strings t)))
565 (context-coloring-test-deftest-javascript syntactic-strings
567 (context-coloring-test-assert-coloring "
572 :fixture "comments-and-strings.js"
574 (setq context-coloring-syntactic-comments nil))
576 (setq context-coloring-syntactic-comments t)))
578 (context-coloring-test-deftest-javascript unterminated-comment
579 ;; As long as `add-text-properties' doesn't signal an error, this test passes.
582 (context-coloring-test-deftest-emacs-lisp defun
584 (context-coloring-test-assert-coloring "
585 111111 000 1111 111 111111111 1111
586 11 111 111 111 000011
594 (context-coloring-test-deftest-emacs-lisp defadvice
596 (context-coloring-test-assert-coloring "
597 1111111111 0 1111111 111111 11111 111 111111111
601 (context-coloring-test-deftest-emacs-lisp lambda
603 (context-coloring-test-assert-coloring "
604 00000000 1111111 1111
605 11111111 11 2222222 2222
606 222 22 12 2221 111 0 00")))
608 (context-coloring-test-deftest-emacs-lisp quote
610 (context-coloring-test-assert-coloring "
611 (xxxxx 0000000 00 00000)
612 (xxx () (xxxxxxxxx (,0000)))
617 111111 1 1111111111 11 111 1 111 1 00001 10000 11 00001 1 10000
625 (xxxxxx () 111111 11111)")))
627 (context-coloring-test-deftest-emacs-lisp splice
629 (context-coloring-test-assert-coloring "
631 111111 00001 100001)")))
633 (context-coloring-test-deftest-emacs-lisp comment
635 ;; Just check that the comment isn't parsed syntactically.
636 (context-coloring-test-assert-coloring "
638 (xx (x xxxxx-xxxx xx) cccccccccc
639 11 00000-0000 11))) cccccccccc")))
641 (context-coloring-test-deftest-emacs-lisp string
643 (context-coloring-test-assert-coloring "
645 (xxxxxx x x sss 1 0 sssss 0 1 sssssss11")))
647 (context-coloring-test-deftest-emacs-lisp ignored
649 (context-coloring-test-assert-coloring "
651 (x x 1 11 11 111 111 11 11 11 1 111 (1 1 1)))")))
653 (context-coloring-test-deftest-emacs-lisp sexp
655 (context-coloring-test-assert-coloring "
661 (context-coloring-test-deftest-emacs-lisp let
663 (context-coloring-test-assert-coloring "
676 (context-coloring-test-deftest-emacs-lisp let*
678 (context-coloring-test-assert-coloring "
688 2222 1 1 2 2 2 000022
689 1111 1 1 1 0 0 000011")))
691 (context-coloring-test-deftest-emacs-lisp cond
693 (context-coloring-test-assert-coloring "
703 (context-coloring-test-deftest-emacs-lisp condition-case
705 (context-coloring-test-assert-coloring "
709 1111111 111111 111 000011
711 (111111111-1111-111111-11111 111
717 (context-coloring-test-deftest-emacs-lisp dolist
719 (context-coloring-test-assert-coloring "
721 2222222 2222 1111 2222222
722 3333333 33 33 222 1111 2222223321")))
724 (defun context-coloring-test-insert-unread-space ()
725 "Simulate the insertion of a space as if by a user."
726 (setq unread-command-events (cons '(t . 32)
727 unread-command-events)))
729 (defun context-coloring-test-remove-faces ()
730 "Remove all faces in the current buffer."
731 (remove-text-properties (point-min) (point-max) '(face nil)))
733 (context-coloring-test-deftest-emacs-lisp iteration
735 (let ((context-coloring-elisp-sexps-per-pause 2))
736 (context-coloring-colorize)
737 (context-coloring-test-assert-coloring "
740 (context-coloring-test-remove-faces)
741 (context-coloring-test-insert-unread-space)
742 (context-coloring-colorize)
743 ;; Coloring is interrupted after the first "sexp" (the comment in this
745 (context-coloring-test-assert-coloring "
749 (context-coloring-test-deftest-emacs-lisp changed
751 (context-coloring-test-remove-faces)
753 (goto-char (point-min))
754 (forward-line (1- 3))
756 ;; Mock `pos-visible-in-window-p' because in batch mode `get-buffer-window'
757 ;; returns nil. Emacs must not have a window in that environment.
758 (cl-letf (((symbol-function 'pos-visible-in-window-p)
762 ;; First and third calls start from center. Second and
763 ;; fourth calls are made immediately after moving past
764 ;; the first defun in either direction "off screen".
770 (setq calls (1+ calls)))))))
771 (context-coloring-colorize))
772 (context-coloring-test-assert-coloring "
777 nnnnn n nnn nnnnnnnn")))
779 (context-coloring-test-deftest-emacs-lisp unbalanced-parenthesis
781 (context-coloring-test-assert-coloring "
785 (context-coloring-test-deftest-eval-expression let
787 (minibuffer-with-setup-hook
789 ;; Perform the test in a hook as it's the only way I know of examining
790 ;; the minibuffer's contents. The contents are implicitly submitted,
791 ;; so we have to ignore the errors in the arbitrary test subject code.
792 (insert "(ignore-errors (let (a) (message a free)))")
793 (context-coloring-colorize)
794 (context-coloring-test-assert-coloring "
795 xxxx: 0000000-000000 1111 111 11111111 1 0000110"))
796 ;; Simulate user input because `call-interactively' is blocking and
797 ;; doesn't seem to run the hook.
800 [?\C-u] ;; Don't output the result of the arbitrary test subject code.
803 (provide 'context-coloring-test)
805 ;;; context-coloring-test.el ends here