X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/3c8f8426ce83d162ee096775f28bba48417c9649..57e87f0e48af2e2f0447cd2f128a1846fe808e33:/test/context-coloring-test.el diff --git a/test/context-coloring-test.el b/test/context-coloring-test.el index 64cbd9d22..743aee46e 100644 --- a/test/context-coloring-test.el +++ b/test/context-coloring-test.el @@ -1,115 +1,975 @@ -;; -*- lexical-binding: t; -*- +;;; context-coloring-test.el --- Tests for context coloring -*- lexical-binding: t; -*- -(defconst context-coloring-test-path - (file-name-directory (or load-file-name buffer-file-name))) +;; Copyright (C) 2014-2015 Free Software Foundation, Inc. + +;; This file is part of GNU Emacs. + +;; 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 +;; 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 this program. If not, see . + +;;; Commentary: + +;; Tests for context coloring. + +;; Use with `make test'. + +;;; Code: -(defun context-coloring-test-resolve-path (path) - (expand-file-name path context-coloring-test-path)) +(require 'context-coloring) +(require 'ert-async) +(require 'js2-mode) -(defun get-string-from-file (path) + +;;; Test running utilities + +(defconst context-coloring-test-path + (file-name-directory (or load-file-name buffer-file-name)) + "This file's directory.") + +(defun context-coloring-test-read-file (path) + "Return the file's contents from PATH as a string." (with-temp-buffer - (insert-file-contents path) + (insert-file-contents (expand-file-name path context-coloring-test-path)) (buffer-string))) -(defun context-coloring-test-read-file (path) - (get-string-from-file (context-coloring-test-resolve-path path))) +(defun context-coloring-test-before-all () + "Prepare before all tests." + (setq context-coloring-syntactic-comments nil) + (setq context-coloring-syntactic-strings nil)) -(defun context-coloring-test-cleanup () - (setq context-coloring-after-colorize-hook nil) - (setq context-coloring-js-block-scopes nil)) +(defun context-coloring-test-after-all () + "Cleanup after all tests." + (setq context-coloring-colorize-hook nil) + (setq context-coloring-check-scopifier-version-hook nil) + (setq context-coloring-maximum-face 7) + (setq context-coloring-original-maximum-face + context-coloring-maximum-face)) (defmacro context-coloring-test-with-fixture (fixture &rest body) - "Evaluate BODY in a temporary buffer with the relative -FIXTURE." + "With the relative FIXTURE, evaluate BODY in a temporary +buffer." `(with-temp-buffer (unwind-protect (progn + (context-coloring-test-before-all) (insert (context-coloring-test-read-file ,fixture)) ,@body) - (context-coloring-test-cleanup)))) + (context-coloring-test-after-all)))) (defun context-coloring-test-with-temp-buffer-async (callback) - "Create a temporary buffer, and evaluate CALLBACK there. A + "Create a temporary buffer, and evaluate CALLBACK there. A teardown callback is passed to CALLBACK for it to invoke when it is done." - (let ((temp-buffer (make-symbol "temp-buffer"))) - (let ((previous-buffer (current-buffer)) - (temp-buffer (generate-new-buffer " *temp*"))) - (set-buffer temp-buffer) - (funcall - callback - (lambda () - (and (buffer-name temp-buffer) - (kill-buffer temp-buffer)) - (set-buffer previous-buffer)))))) + (let ((previous-buffer (current-buffer)) + (temp-buffer (generate-new-buffer " *temp*"))) + (set-buffer temp-buffer) + (funcall + callback + (lambda () + (and (buffer-name temp-buffer) + (kill-buffer temp-buffer)) + (set-buffer previous-buffer))))) (defun context-coloring-test-with-fixture-async (fixture callback) - "Evaluate CALLBACK in a temporary buffer with the relative -FIXTURE. A teardown callback is passed to CALLBACK for it to + "With the relative FIXTURE, evaluate CALLBACK in a temporary +buffer. A teardown callback is passed to CALLBACK for it to invoke when it is done." (context-coloring-test-with-temp-buffer-async (lambda (done-with-temp-buffer) + (context-coloring-test-before-all) (insert (context-coloring-test-read-file fixture)) (funcall callback (lambda () - (context-coloring-test-cleanup) + (context-coloring-test-after-all) (funcall done-with-temp-buffer)))))) -(defun context-coloring-test-js-mode (fixture callback) + +;;; Test defining utilities + +(cl-defmacro context-coloring-test-define-deftest (name + &key mode + &key extension + &key async) + "Define a deftest defmacro for tests prefixed with NAME. MODE +is called to set up the test's environment. EXTENSION denotes +the suffix for tests' fixture files." + (declare (indent defun)) + (let ((macro-name (intern (format "context-coloring-test-deftest-%s" name)))) + `(cl-defmacro ,macro-name (name + body + &key fixture + &key before + &key after) + ,(format "Define a test for `%s' suffixed with NAME. +Function BODY makes assertions. The default fixture has a +filename matching NAME (plus the filetype extension, \"%s\"), +unless FIXTURE is specified to override it. Functions BEFORE +and AFTER run before and after the test, even if an error is +signaled. + +BODY is run after `context-coloring-mode' is activated, or after +initial colorization if colorization should occur." + (cadr mode) extension) + (declare (indent defun)) + ;; Commas in nested backquotes are not evaluated. Binding the mode here + ;; is probably the cleanest workaround. + (let ((mode ,mode) + (test-name (intern (format ,(format "%s-%%s" name) name))) + (fixture (cond + (fixture (format "./fixtures/%s" fixture)) + (t (format ,(format "./fixtures/%%s.%s" extension) name))))) + ,@(cond + (async + `(`(ert-deftest-async ,test-name (done) + (context-coloring-test-with-fixture-async + ,fixture + (lambda (done-with-fixture) + (,mode) + (when ,before (funcall ,before)) + (context-coloring-mode) + ;; TODO: Rigid expectations, should be looser. + (context-coloring-colorize + (lambda () + (unwind-protect + (progn + (funcall ,body)) + (when ,after (funcall ,after)) + (funcall done-with-fixture)) + (funcall done)))))))) + (t + `(`(ert-deftest ,test-name () + (context-coloring-test-with-fixture + ,fixture + (,mode) + (when ,before (funcall ,before)) + (context-coloring-mode) + (unwind-protect + (progn + (funcall ,body)) + (when ,after (funcall ,after)))))))))))) + +(context-coloring-test-define-deftest js + :mode 'js-mode + :extension "js" + :async t) + +;; TODO: Do we need some way to do +;; (setq js2-mode-show-parse-errors nil) +;; (setq js2-mode-show-strict-warnings nil) +;; ? +(context-coloring-test-define-deftest js2 + :mode 'js2-mode + :extension "js") + +(context-coloring-test-define-deftest emacs-lisp + :mode 'emacs-lisp-mode + :extension "el") + + +;;; Assertion functions + +(defun context-coloring-test-assert-position-level (position level) + "Assert that POSITION has LEVEL." + (let ((face (get-text-property position 'face)) + actual-level) + (when (not (and face + (let* ((face-string (symbol-name face)) + (matches (string-match + context-coloring-level-face-regexp + face-string))) + (when matches + (setq actual-level (string-to-number + (substring face-string + (match-beginning 1) + (match-end 1)))) + (= level actual-level))))) + (ert-fail (format (concat "Expected level at position %s, " + "which is \"%s\", to be %s; " + "but it was %s") + position + (buffer-substring-no-properties position (1+ position)) level + actual-level))))) + +(defun context-coloring-test-assert-position-face (position face-regexp) + "Assert that the face at POSITION satisfies FACE-REGEXP." + (let ((face (get-text-property position 'face))) + (when (or + ;; Pass a non-string to do an `equal' check (against a symbol or nil). + (unless (stringp face-regexp) + (not (equal face-regexp face))) + ;; Otherwise do the matching. + (when (stringp face-regexp) + (not (string-match-p face-regexp (symbol-name face))))) + (ert-fail (format (concat "Expected face at position %s, " + "which is \"%s\", to be %s; " + "but it was %s") + position + (buffer-substring-no-properties position (1+ position)) face-regexp + face))))) + +(defun context-coloring-test-assert-position-comment (position) + (context-coloring-test-assert-position-face + position "\\`font-lock-comment\\(-delimiter\\)?-face\\'")) + +(defun context-coloring-test-assert-position-constant-comment (position) + (context-coloring-test-assert-position-face position '(font-lock-constant-face + font-lock-comment-face))) + +(defun context-coloring-test-assert-position-string (position) + (context-coloring-test-assert-position-face position 'font-lock-string-face)) + +(defun context-coloring-test-assert-position-nil (position) + (context-coloring-test-assert-position-face position nil)) + +(defun context-coloring-test-assert-coloring (map) + "Assert that the current buffer's coloring matches MAP." + ;; Omit the superfluous, formatting-related leading newline. Can't use + ;; `save-excursion' here because if an assertion fails it will cause future + ;; tests to get messed up. + (goto-char (point-min)) + (let* ((map (substring map 1)) + (index 0) + char-string + char) + (while (< index (length map)) + (setq char-string (substring map index (1+ index))) + (setq char (string-to-char char-string)) + (cond + ;; Newline + ((= char 10) + (next-logical-line) + (beginning-of-line)) + ;; Number + ((and (>= char 48) + (<= char 57)) + (context-coloring-test-assert-position-level + (point) (string-to-number char-string)) + (forward-char)) + ;; ';' = Comment + ((= char 59) + (context-coloring-test-assert-position-comment (point)) + (forward-char)) + ;; 'c' = Constant comment + ((= char 99) + (context-coloring-test-assert-position-constant-comment (point)) + (forward-char)) + ;; 'n' = nil + ((= char 110) + (context-coloring-test-assert-position-nil (point)) + (forward-char)) + ;; 's' = String + ((= char 115) + (context-coloring-test-assert-position-string (point)) + (forward-char)) + (t + (forward-char))) + (setq index (1+ index))))) + +(defmacro context-coloring-test-assert-region (&rest body) + "Assert something about the face of points in a region. +Provides the free variables `i', `length', `point', `face' and +`actual-level' to the code in BODY." + `(let ((i 0) + (length (- end start))) + (while (< i length) + (let* ((point (+ i start)) + (face (get-text-property point 'face))) + ,@body) + (setq i (+ i 1))))) + +(defun context-coloring-test-assert-region-level (start end level) + "Assert that all points in the range [START, END) are of level +LEVEL." + (context-coloring-test-assert-region + (let (actual-level) + (when (not (when face + (let* ((face-string (symbol-name face)) + (matches (string-match + context-coloring-level-face-regexp + face-string))) + (when matches + (setq actual-level (string-to-number + (substring face-string + (match-beginning 1) + (match-end 1)))) + (= level actual-level))))) + (ert-fail (format (concat "Expected level in region [%s, %s), " + "which is \"%s\", to be %s; " + "but at point %s, it was %s") + start end + (buffer-substring-no-properties start end) level + point actual-level)))))) + +(defun context-coloring-test-assert-region-face (start end expected-face) + "Assert that all points in the range [START, END) have the face +EXPECTED-FACE." + (context-coloring-test-assert-region + (when (not (eq face expected-face)) + (ert-fail (format (concat "Expected face in region [%s, %s), " + "which is \"%s\", to be %s; " + "but at point %s, it was %s") + start end + (buffer-substring-no-properties start end) expected-face + point face))))) + +(defun context-coloring-test-assert-region-comment-delimiter (start end) + "Assert that all points in the range [START, END) have +`font-lock-comment-delimiter-face'." + (context-coloring-test-assert-region-face + start end 'font-lock-comment-delimiter-face)) + +(defun context-coloring-test-assert-region-comment (start end) + "Assert that all points in the range [START, END) have +`font-lock-comment-face'." + (context-coloring-test-assert-region-face + start end 'font-lock-comment-face)) + +(defun context-coloring-test-assert-region-string (start end) + "Assert that all points in the range [START, END) have +`font-lock-string-face'." + (context-coloring-test-assert-region-face + start end 'font-lock-string-face)) + +(defun context-coloring-test-get-last-message () + (let ((messages (split-string + (buffer-substring-no-properties + (point-min) + (point-max)) + "\n"))) + (car (nthcdr (- (length messages) 2) messages)))) + +(defun context-coloring-test-assert-message (expected buffer) + "Assert that message EXPECTED is at the end of BUFFER." + (when (null (get-buffer buffer)) + (ert-fail + (format + (concat + "Expected buffer `%s' to have message \"%s\", " + "but the buffer did not have any messages.") + buffer expected))) + (with-current-buffer buffer + (let ((message (context-coloring-test-get-last-message))) + (when (not (equal message expected)) + (ert-fail + (format + (concat + "Expected buffer `%s' to have message \"%s\", " + "but instead it was \"%s\"") + buffer expected + message)))))) + +(defun context-coloring-test-assert-not-message (expected buffer) + "Assert that message EXPECTED is not at the end of BUFFER." + (when (get-buffer buffer) + (with-current-buffer buffer + (let ((message (context-coloring-test-get-last-message))) + (when (equal message expected) + (ert-fail + (format + (concat + "Expected buffer `%s' not to have message \"%s\", " + "but it did") + buffer expected))))))) + +(defun context-coloring-test-assert-no-message (buffer) + "Assert that BUFFER has no message." + (when (get-buffer buffer) + (ert-fail (format (concat "Expected buffer `%s' to have no messages, " + "but it did: `%s'") + buffer + (with-current-buffer buffer + (buffer-string)))))) + +(defun context-coloring-test-kill-buffer (buffer) + "Kill BUFFER if it exists." + (when (get-buffer buffer) (kill-buffer buffer))) + +(defun context-coloring-test-assert-face (level foreground &optional negate) + "Assert that a face for LEVEL exists and that its `:foreground' +is FOREGROUND, or the inverse if NEGATE is non-nil." + (let* ((face (context-coloring-level-face level)) + actual-foreground) + (when (not (or negate + face)) + (ert-fail (format (concat "Expected face for level `%s' to exist; " + "but it didn't") + level))) + (setq actual-foreground (face-attribute face :foreground)) + (when (funcall (if negate 'identity 'not) + (string-equal foreground actual-foreground)) + (ert-fail (format (concat "Expected face for level `%s' " + "%sto have foreground `%s'; " + "but it %s.") + level + (if negate "not " "") foreground + (if negate + "did" (format "was `%s'" actual-foreground))))))) + +(defun context-coloring-test-assert-not-face (&rest arguments) + "Assert that LEVEL does not have a face with `:foreground' +FOREGROUND. Apply ARGUMENTS to +`context-coloring-test-assert-face', see that function." + (apply 'context-coloring-test-assert-face + (append arguments '(t)))) + +(defun context-coloring-test-assert-error (body error-message) + "Assert that BODY signals ERROR-MESSAGE." + (let ((error-signaled-p nil)) + (condition-case err + (progn + (funcall body)) + (error + (setq error-signaled-p t) + (when (not (string-equal (cadr err) error-message)) + (ert-fail (format (concat "Expected the error \"%s\" to be thrown, " + "but instead it was \"%s\".") + error-message + (cadr err)))))) + (when (not error-signaled-p) + (ert-fail "Expected an error to be thrown, but there wasn't.")))) + +(defun context-coloring-test-assert-trimmed (result expected) + (when (not (string-equal result expected)) + (ert-fail "Expected string to be trimmed, but it wasn't."))) + + +;;; The tests + +(ert-deftest context-coloring-test-trim () + (context-coloring-test-assert-trimmed (context-coloring-trim "") "") + (context-coloring-test-assert-trimmed (context-coloring-trim " ") "") + (context-coloring-test-assert-trimmed (context-coloring-trim "a") "a") + (context-coloring-test-assert-trimmed (context-coloring-trim " a") "a") + (context-coloring-test-assert-trimmed (context-coloring-trim "a ") "a") + (context-coloring-test-assert-trimmed (context-coloring-trim " a ") "a")) + +(ert-deftest-async context-coloring-test-async-mode-startup (done) (context-coloring-test-with-fixture-async - fixture - (lambda (done-with-test) + "./fixtures/empty" + (lambda (teardown) (js-mode) - (context-coloring-mode) - (context-coloring-colorize + (add-hook + 'context-coloring-colorize-hook (lambda () - (funcall callback done-with-test)))))) - -(defmacro context-coloring-test-js2-mode (fixture &rest body) - `(context-coloring-test-with-fixture - ,fixture - (require 'js2-mode) - (setq js2-mode-show-parse-errors nil) - (setq js2-mode-show-strict-warnings nil) - (js2-mode) - (context-coloring-mode) - ,@body)) + ;; If this runs we are implicitly successful; this test only confirms + ;; that colorization occurs on mode startup. + (funcall teardown) + (funcall done))) + (context-coloring-mode)))) -(defconst context-coloring-test-level-regexp - "context-coloring-level-\\([[:digit:]]+\\)-face") +(define-derived-mode + context-coloring-change-detection-mode + fundamental-mode + "Testing" + "Prevent `context-coloring-test-change-detection' from + having any unintentional side-effects on mode support.") -(defun context-coloring-test-assert-region-level (start end level) - (let ((i 0) - (length (- end start))) - (while (< i length) - (let* ((point (+ i start)) - (face (get-text-property point 'face)) - actual-level) - (when (not (when face - (let* ((face-string (symbol-name face)) - (matches (string-match context-coloring-test-level-regexp face-string))) - (when matches - (setq actual-level (string-to-number (substring face-string - (match-beginning 1) - (match-end 1)))) - (= level actual-level))))) - (ert-fail (format "Expected level at point %s to be %s; was %s" - point level actual-level)))) - (setq i (+ i 1))))) - -(defun context-coloring-test-assert-message (expected) - (with-current-buffer "*Messages*" - (let ((messages (split-string (buffer-substring-no-properties (point-min) (point-max)) "\n"))) - (let ((message (car (nthcdr (- (length messages) 2) messages)))) - (should (equal message expected)))))) +;; Simply cannot figure out how to trigger an idle timer; would much rather test +;; that. But (current-idle-time) always returns nil in these tests. +(ert-deftest-async context-coloring-test-change-detection (done) + (context-coloring-define-dispatch + 'idle-change + :modes '(context-coloring-change-detection-mode) + :executable "node" + :command "node test/binaries/noop") + (context-coloring-test-with-fixture-async + "./fixtures/empty" + (lambda (teardown) + (context-coloring-change-detection-mode) + (add-hook + 'context-coloring-colorize-hook + (lambda () + (setq context-coloring-colorize-hook nil) + (add-hook + 'context-coloring-colorize-hook + (lambda () + (funcall teardown) + (funcall done))) + (insert " ") + (set-window-buffer (selected-window) (current-buffer)) + (context-coloring-maybe-colorize (current-buffer)))) + (context-coloring-mode)))) + +(ert-deftest context-coloring-test-check-version () + (when (not (context-coloring-check-version "2.1.3" "3.0.1")) + (ert-fail "Expected version 3.0.1 to satisfy 2.1.3, but it didn't.")) + (when (context-coloring-check-version "3.0.1" "2.1.3") + (ert-fail "Expected version 2.1.3 not to satisfy 3.0.1, but it did."))) (ert-deftest context-coloring-test-unsupported-mode () (context-coloring-test-with-fixture - "./fixtures/function-scopes.js" + "./fixtures/empty" (context-coloring-mode) (context-coloring-test-assert-message - "Context coloring is not available for this major mode"))) + "Context coloring is not available for this major mode" + "*Messages*"))) + +(ert-deftest context-coloring-test-derived-mode () + (context-coloring-test-with-fixture + "./fixtures/empty" + (lisp-interaction-mode) + (context-coloring-mode) + (context-coloring-test-assert-not-message + "Context coloring is not available for this major mode" + "*Messages*"))) + +(define-derived-mode + context-coloring-test-define-dispatch-error-mode + fundamental-mode + "Testing" + "Prevent `context-coloring-test-define-dispatch-error' from + having any unintentional side-effects on mode support.") + +(ert-deftest context-coloring-test-define-dispatch-error () + (context-coloring-test-assert-error + (lambda () + (context-coloring-define-dispatch + 'define-dispatch-no-modes)) + "No mode defined for dispatch") + (context-coloring-test-assert-error + (lambda () + (context-coloring-define-dispatch + 'define-dispatch-no-strategy + :modes '(context-coloring-test-define-dispatch-error-mode))) + "No colorizer, scopifier or command defined for dispatch")) + +(define-derived-mode + context-coloring-test-define-dispatch-scopifier-mode + fundamental-mode + "Testing" + "Prevent `context-coloring-test-define-dispatch-scopifier' from + having any unintentional side-effects on mode support.") + +(ert-deftest context-coloring-test-define-dispatch-scopifier () + (context-coloring-define-dispatch + 'define-dispatch-scopifier + :modes '(context-coloring-test-define-dispatch-scopifier-mode) + :scopifier (lambda () (vector))) + (with-temp-buffer + (context-coloring-test-define-dispatch-scopifier-mode) + (context-coloring-mode) + (context-coloring-colorize))) + +(define-derived-mode + context-coloring-test-missing-executable-mode + fundamental-mode + "Testing" + "Prevent `context-coloring-test-define-dispatch-scopifier' from + having any unintentional side-effects on mode support.") + +(ert-deftest context-coloring-test-missing-executable () + (context-coloring-define-dispatch + 'scopifier + :modes '(context-coloring-test-missing-executable-mode) + :command "" + :executable "__should_not_exist__") + (with-temp-buffer + (context-coloring-test-missing-executable-mode) + (context-coloring-mode))) + +(define-derived-mode + context-coloring-test-unsupported-version-mode + fundamental-mode + "Testing" + "Prevent `context-coloring-test-unsupported-version' from + having any unintentional side-effects on mode support.") + +(ert-deftest-async context-coloring-test-unsupported-version (done) + (context-coloring-define-dispatch + 'outta-date + :modes '(context-coloring-test-unsupported-version-mode) + :executable "node" + :command "node test/binaries/outta-date" + :version "v2.1.3") + (context-coloring-test-with-fixture-async + "./fixtures/empty" + (lambda (teardown) + (context-coloring-test-unsupported-version-mode) + (add-hook + 'context-coloring-check-scopifier-version-hook + (lambda () + (unwind-protect + (progn + ;; Normally the executable would be something like "outta-date" + ;; rather than "node". + (context-coloring-test-assert-message + "Update to the minimum version of \"node\" (v2.1.3)" + "*Messages*")) + (funcall teardown)) + (funcall done))) + (context-coloring-mode)))) + +(define-derived-mode + context-coloring-test-disable-mode-mode + fundamental-mode + "Testing" + "Prevent `context-coloring-test-disable-mode' from having any + unintentional side-effects on mode support.") + +(ert-deftest-async context-coloring-test-disable-mode (done) + (let (torn-down) + (context-coloring-define-dispatch + 'disable-mode + :modes '(context-coloring-test-disable-mode-mode) + :executable "node" + :command "node test/binaries/noop" + :teardown (lambda () + (setq torn-down t))) + (context-coloring-test-with-fixture-async + "./fixtures/empty" + (lambda (teardown) + (unwind-protect + (progn + (context-coloring-test-disable-mode-mode) + (context-coloring-mode) + (context-coloring-mode -1) + (when (not torn-down) + (ert-fail "Expected teardown function to have been called, but it wasn't."))) + (funcall teardown)) + (funcall done))))) + +(defvar context-coloring-test-theme-index 0 + "Unique index for unique theme names.") + +(defun context-coloring-test-get-next-theme () + "Return a unique symbol for a throwaway theme." + (prog1 + (intern (format "context-coloring-test-theme-%s" + context-coloring-test-theme-index)) + (setq context-coloring-test-theme-index + (+ context-coloring-test-theme-index 1)))) + +(defun context-coloring-test-assert-theme-originally-set-p + (settings &optional negate) + "Assert that `context-coloring-theme-originally-set-p' returns +t for a theme with SETTINGS, or the inverse if NEGATE is +non-nil." + (let ((theme (context-coloring-test-get-next-theme))) + (put theme 'theme-settings settings) + (when (funcall (if negate 'identity 'not) + (context-coloring-theme-originally-set-p theme)) + (ert-fail (format (concat "Expected theme `%s' with settings `%s' " + "%sto be considered to have defined a level, " + "but it %s.") + theme settings + (if negate "not " "") + (if negate "was" "wasn't")))))) + +(defun context-coloring-test-assert-not-theme-originally-set-p (&rest arguments) + "Assert that `context-coloring-theme-originally-set-p' does not +return t for a theme with SETTINGS. Apply ARGUMENTS to +`context-coloring-test-assert-theme-originally-set-p', see that +function." + (apply 'context-coloring-test-assert-theme-originally-set-p + (append arguments '(t)))) + +(ert-deftest context-coloring-test-theme-originally-set-p () + (context-coloring-test-assert-theme-originally-set-p + '((theme-face context-coloring-level-0-face))) + (context-coloring-test-assert-theme-originally-set-p + '((theme-face face) + (theme-face context-coloring-level-0-face))) + (context-coloring-test-assert-theme-originally-set-p + '((theme-face context-coloring-level-0-face) + (theme-face face))) + (context-coloring-test-assert-not-theme-originally-set-p + '((theme-face face))) + ) + +(defun context-coloring-test-assert-theme-settings-highest-level + (settings expected-level) + "Assert that a theme with SETTINGS has the highest level +EXPECTED-LEVEL." + (let ((theme (context-coloring-test-get-next-theme))) + (put theme 'theme-settings settings) + (context-coloring-test-assert-theme-highest-level theme expected-level))) + +(defun context-coloring-test-assert-theme-highest-level + (theme expected-level &optional negate) + "Assert that THEME has the highest level EXPECTED-LEVEL, or the +inverse if NEGATE is non-nil." + (let ((highest-level (context-coloring-theme-highest-level theme))) + (when (funcall (if negate 'identity 'not) (eq highest-level expected-level)) + (ert-fail (format (concat "Expected theme with settings `%s' " + "%sto have a highest level of `%s', " + "but it %s.") + (get theme 'theme-settings) + (if negate "not " "") expected-level + (if negate "did" (format "was %s" highest-level))))))) + +(defun context-coloring-test-assert-theme-not-highest-level (&rest arguments) + "Assert that THEME's highest level is not EXPECTED-LEVEL. +Apply ARGUMENTS to +`context-coloring-test-assert-theme-highest-level', see that +function." + (apply 'context-coloring-test-assert-theme-highest-level + (append arguments '(t)))) + +(ert-deftest context-coloring-test-theme-highest-level () + (context-coloring-test-assert-theme-settings-highest-level + '((theme-face foo)) + -1) + (context-coloring-test-assert-theme-settings-highest-level + '((theme-face context-coloring-level-0-face)) + 0) + (context-coloring-test-assert-theme-settings-highest-level + '((theme-face context-coloring-level-1-face)) + 1) + (context-coloring-test-assert-theme-settings-highest-level + '((theme-face context-coloring-level-1-face) + (theme-face context-coloring-level-0-face)) + 1) + (context-coloring-test-assert-theme-settings-highest-level + '((theme-face context-coloring-level-0-face) + (theme-face context-coloring-level-1-face)) + 1) + ) + +(defmacro context-coloring-test-deftest-define-theme (name &rest body) + "Define a test with name NAME and an automatically-generated +theme symbol available as a free variable `theme'. Side-effects +from enabling themes are reversed after BODY is executed and the +test completes." + (declare (indent defun)) + (let ((deftest-name (intern + (format "context-coloring-test-define-theme-%s" name)))) + `(ert-deftest ,deftest-name () + (context-coloring-test-kill-buffer "*Warnings*") + (context-coloring-test-before-all) + (let ((theme (context-coloring-test-get-next-theme))) + (unwind-protect + (progn + ,@body) + ;; Always cleanup. + (disable-theme theme) + (context-coloring-test-after-all)))))) + +(defun context-coloring-test-deftheme (theme) + "Dynamically define theme THEME." + (eval (macroexpand `(deftheme ,theme)))) + +(context-coloring-test-deftest-define-theme additive + (context-coloring-test-deftheme theme) + (context-coloring-define-theme + theme + :colors '("#aaaaaa" + "#bbbbbb")) + (context-coloring-test-assert-no-message "*Warnings*") + (enable-theme theme) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb")) + +(defun context-coloring-test-assert-defined-warning (theme) + "Assert that a warning about colors already being defined for +theme THEME is signaled." + (context-coloring-test-assert-message + (format (concat "Warning (emacs): Context coloring colors for theme " + "`%s' are already defined") + theme) + "*Warnings*")) + +(context-coloring-test-deftest-define-theme unintentional-override + (context-coloring-test-deftheme theme) + (custom-theme-set-faces + theme + '(context-coloring-level-0-face ((t (:foreground "#aaaaaa")))) + '(context-coloring-level-1-face ((t (:foreground "#bbbbbb"))))) + (context-coloring-define-theme + theme + :colors '("#cccccc" + "#dddddd")) + (context-coloring-test-assert-defined-warning theme) + (context-coloring-test-kill-buffer "*Warnings*") + (enable-theme theme) + (context-coloring-test-assert-defined-warning theme) + (context-coloring-test-assert-face 0 "#cccccc") + (context-coloring-test-assert-face 1 "#dddddd")) + +(context-coloring-test-deftest-define-theme intentional-override + (context-coloring-test-deftheme theme) + (custom-theme-set-faces + theme + '(context-coloring-level-0-face ((t (:foreground "#aaaaaa")))) + '(context-coloring-level-1-face ((t (:foreground "#bbbbbb"))))) + (context-coloring-define-theme + theme + :override t + :colors '("#cccccc" + "#dddddd")) + (context-coloring-test-assert-no-message "*Warnings*") + (enable-theme theme) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#cccccc") + (context-coloring-test-assert-face 1 "#dddddd")) + +(context-coloring-test-deftest-define-theme pre-recede + (context-coloring-define-theme + theme + :recede t + :colors '("#aaaaaa" + "#bbbbbb")) + (context-coloring-test-deftheme theme) + (custom-theme-set-faces + theme + '(context-coloring-level-0-face ((t (:foreground "#cccccc")))) + '(context-coloring-level-1-face ((t (:foreground "#dddddd"))))) + (enable-theme theme) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#cccccc") + (context-coloring-test-assert-face 1 "#dddddd")) + +(context-coloring-test-deftest-define-theme pre-recede-delayed-application + (context-coloring-define-theme + theme + :recede t + :colors '("#aaaaaa" + "#bbbbbb")) + (context-coloring-test-deftheme theme) + (enable-theme theme) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb")) + +(context-coloring-test-deftest-define-theme post-recede + (context-coloring-test-deftheme theme) + (custom-theme-set-faces + theme + '(context-coloring-level-0-face ((t (:foreground "#aaaaaa")))) + '(context-coloring-level-1-face ((t (:foreground "#bbbbbb"))))) + (context-coloring-define-theme + theme + :recede t + :colors '("#cccccc" + "#dddddd")) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb") + (enable-theme theme) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb")) + +(context-coloring-test-deftest-define-theme recede-not-defined + (context-coloring-test-deftheme theme) + (custom-theme-set-faces + theme + '(foo-face ((t (:foreground "#ffffff"))))) + (context-coloring-define-theme + theme + :recede t + :colors '("#aaaaaa" + "#bbbbbb")) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb") + (enable-theme theme) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb")) + +(context-coloring-test-deftest-define-theme unintentional-obstinance + (context-coloring-define-theme + theme + :colors '("#aaaaaa" + "#bbbbbb")) + (context-coloring-test-deftheme theme) + (custom-theme-set-faces + theme + '(context-coloring-level-0-face ((t (:foreground "#cccccc")))) + '(context-coloring-level-1-face ((t (:foreground "#dddddd"))))) + (enable-theme theme) + (context-coloring-test-assert-defined-warning theme) + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb")) + +(context-coloring-test-deftest-define-theme intentional-obstinance + (context-coloring-define-theme + theme + :override t + :colors '("#aaaaaa" + "#bbbbbb")) + (context-coloring-test-deftheme theme) + (custom-theme-set-faces + theme + '(context-coloring-level-0-face ((t (:foreground "#cccccc")))) + '(context-coloring-level-1-face ((t (:foreground "#dddddd"))))) + (enable-theme theme) + (context-coloring-test-assert-no-message "*Warnings*") + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb")) + +(defun context-coloring-test-assert-maximum-face (maximum &optional negate) + "Assert that `context-coloring-maximum-face' is MAXIMUM, or the +inverse if NEGATE is non-nil." + (when (funcall (if negate 'identity 'not) + (eq context-coloring-maximum-face maximum)) + (ert-fail (format (concat "Expected `context-coloring-maximum-face' " + "%sto be `%s', " + "but it %s.") + (if negate "not " "") maximum + (if negate + "was" + (format "was `%s'" context-coloring-maximum-face)))))) + +(defun context-coloring-test-assert-not-maximum-face (&rest arguments) + "Assert that `context-coloring-maximum-face' is not MAXIMUM. +Apply ARGUMENTS to `context-coloring-test-assert-maximum-face', +see that function." + (apply 'context-coloring-test-assert-maximum-face + (append arguments '(t)))) + +(context-coloring-test-deftest-define-theme disable-cascade + (let ((maximum-face-value 9999)) + (setq context-coloring-maximum-face maximum-face-value) + (context-coloring-test-deftheme theme) + (context-coloring-define-theme + theme + :colors '("#aaaaaa" + "#bbbbbb")) + (let ((second-theme (context-coloring-test-get-next-theme))) + (context-coloring-test-deftheme second-theme) + (context-coloring-define-theme + second-theme + :colors '("#cccccc" + "#dddddd" + "#eeeeee")) + (let ((third-theme (context-coloring-test-get-next-theme))) + (context-coloring-test-deftheme third-theme) + (context-coloring-define-theme + third-theme + :colors '("#111111" + "#222222" + "#333333" + "#444444")) + (enable-theme theme) + (enable-theme second-theme) + (enable-theme third-theme) + (disable-theme third-theme) + (context-coloring-test-assert-face 0 "#cccccc") + (context-coloring-test-assert-face 1 "#dddddd") + (context-coloring-test-assert-face 2 "#eeeeee") + (context-coloring-test-assert-maximum-face 2)) + (disable-theme second-theme) + (context-coloring-test-assert-face 0 "#aaaaaa") + (context-coloring-test-assert-face 1 "#bbbbbb") + (context-coloring-test-assert-maximum-face 1)) + (disable-theme theme) + (context-coloring-test-assert-not-face 0 "#aaaaaa") + (context-coloring-test-assert-not-face 1 "#bbbbbb") + (context-coloring-test-assert-maximum-face + maximum-face-value))) (defun context-coloring-test-js-function-scopes () (context-coloring-test-assert-region-level 1 9 0) @@ -125,52 +985,34 @@ invoke when it is done." (context-coloring-test-assert-region-level 82 87 2) (context-coloring-test-assert-region-level 87 89 1)) -(ert-deftest-async context-coloring-test-js-mode-function-scopes (done) - (context-coloring-test-js-mode - "./fixtures/function-scopes.js" - (lambda (teardown) - (unwind-protect - (context-coloring-test-js-function-scopes) - (funcall teardown)) - (funcall done)))) - -(ert-deftest context-coloring-test-js2-mode-function-scopes () - (context-coloring-test-js2-mode - "./fixtures/function-scopes.js" - (context-coloring-test-js-function-scopes))) +(context-coloring-test-deftest-js function-scopes + 'context-coloring-test-js-function-scopes) +(context-coloring-test-deftest-js2 function-scopes + 'context-coloring-test-js-function-scopes) (defun context-coloring-test-js-global () (context-coloring-test-assert-region-level 20 28 1) (context-coloring-test-assert-region-level 28 35 0) (context-coloring-test-assert-region-level 35 41 1)) -(ert-deftest-async context-coloring-test-js-mode-global (done) - (context-coloring-test-js-mode - "./fixtures/global.js" - (lambda (teardown) - (unwind-protect - (context-coloring-test-js-global) - (funcall teardown)) - (funcall done)))) - -(ert-deftest context-coloring-test-js2-mode-global () - (context-coloring-test-js2-mode - "./fixtures/global.js" - (context-coloring-test-js-global))) +(context-coloring-test-deftest-js global + 'context-coloring-test-js-global) +(context-coloring-test-deftest-js2 global + 'context-coloring-test-js-global) (defun context-coloring-test-js-block-scopes () - (context-coloring-test-assert-region-level 20 64 1) - (setq context-coloring-js-block-scopes t) - (context-coloring-colorize) - (context-coloring-test-assert-region-level 20 27 1) - (context-coloring-test-assert-region-level 27 41 2) - (context-coloring-test-assert-region-level 41 42 1) - (context-coloring-test-assert-region-level 42 64 2)) - -(ert-deftest context-coloring-test-js2-mode-block-scopes () - (context-coloring-test-js2-mode - "./fixtures/block-scopes.js" - (context-coloring-test-js-block-scopes))) + (context-coloring-colorize) + (context-coloring-test-assert-region-level 20 27 1) + (context-coloring-test-assert-region-level 27 41 2) + (context-coloring-test-assert-region-level 41 42 1) + (context-coloring-test-assert-region-level 42 64 2)) + +(context-coloring-test-deftest-js2 block-scopes + 'context-coloring-test-js-block-scopes + :before (lambda () + (setq context-coloring-js-block-scopes t)) + :after (lambda () + (setq context-coloring-js-block-scopes nil))) (defun context-coloring-test-js-catch () (context-coloring-test-assert-region-level 20 27 1) @@ -182,55 +1024,206 @@ invoke when it is done." (context-coloring-test-assert-region-level 102 117 3) (context-coloring-test-assert-region-level 117 123 2)) -(ert-deftest-async context-coloring-test-js-mode-catch (done) - (context-coloring-test-js-mode - "./fixtures/catch.js" - (lambda (teardown) - (unwind-protect - (context-coloring-test-js-catch) - (funcall teardown)) - (funcall done)))) - -(ert-deftest context-coloring-test-js2-mode-catch () - (context-coloring-test-js2-mode - "./fixtures/catch.js" - (context-coloring-test-js-catch))) +(context-coloring-test-deftest-js catch + 'context-coloring-test-js-catch) +(context-coloring-test-deftest-js2 catch + 'context-coloring-test-js-catch) (defun context-coloring-test-js-key-names () (context-coloring-test-assert-region-level 20 63 1)) -(ert-deftest-async context-coloring-test-js-mode-key-names (done) - (context-coloring-test-js-mode - "./fixtures/key-names.js" - (lambda (teardown) - (unwind-protect - (context-coloring-test-js-key-names) - (funcall teardown)) - (funcall done)))) - -(ert-deftest context-coloring-test-js2-mode-key-names () - (context-coloring-test-js2-mode - "./fixtures/key-names.js" - (context-coloring-test-js-key-names))) +(context-coloring-test-deftest-js key-names + 'context-coloring-test-js-key-names) +(context-coloring-test-deftest-js2 key-names + 'context-coloring-test-js-key-names) (defun context-coloring-test-js-property-lookup () (context-coloring-test-assert-region-level 20 26 0) (context-coloring-test-assert-region-level 26 38 1) (context-coloring-test-assert-region-level 38 44 0) - (context-coloring-test-assert-region-level 44 52 1)) + (context-coloring-test-assert-region-level 44 52 1) + (context-coloring-test-assert-region-level 57 63 0) + (context-coloring-test-assert-region-level 63 74 1)) -(ert-deftest-async context-coloring-test-js-mode-property-lookup (done) - (context-coloring-test-js-mode - "./fixtures/property-lookup.js" - (lambda (teardown) - (unwind-protect - (context-coloring-test-js-property-lookup) - (funcall teardown)) - (funcall done)))) +(context-coloring-test-deftest-js property-lookup + 'context-coloring-test-js-property-lookup) +(context-coloring-test-deftest-js2 property-lookup + 'context-coloring-test-js-property-lookup) + +(defun context-coloring-test-js-key-values () + (context-coloring-test-assert-region-level 78 79 1)) + +(context-coloring-test-deftest-js key-values + 'context-coloring-test-js-key-values) +(context-coloring-test-deftest-js2 key-values + 'context-coloring-test-js-key-values) + +(defun context-coloring-test-js-syntactic-comments-and-strings () + (context-coloring-test-assert-region-level 1 8 0) + (context-coloring-test-assert-region-comment-delimiter 9 12) + (context-coloring-test-assert-region-comment 12 16) + (context-coloring-test-assert-region-comment-delimiter 17 20) + (context-coloring-test-assert-region-comment 20 27) + (context-coloring-test-assert-region-string 28 40) + (context-coloring-test-assert-region-level 40 41 0)) + +(defun context-coloring-test-js-syntactic-comments-and-strings-setup () + (setq context-coloring-syntactic-comments t) + (setq context-coloring-syntactic-strings t)) + +(context-coloring-test-deftest-js syntactic-comments-and-strings + 'context-coloring-test-js-syntactic-comments-and-strings + :fixture "comments-and-strings.js" + :before 'context-coloring-test-js-syntactic-comments-and-strings-setup) +(context-coloring-test-deftest-js2 syntactic-comments-and-strings + 'context-coloring-test-js-syntactic-comments-and-strings + :fixture "comments-and-strings.js" + :before 'context-coloring-test-js-syntactic-comments-and-strings-setup) + +(defun context-coloring-test-js-syntactic-comments () + (context-coloring-test-assert-region-level 1 8 0) + (context-coloring-test-assert-region-comment-delimiter 9 12) + (context-coloring-test-assert-region-comment 12 16) + (context-coloring-test-assert-region-comment-delimiter 17 20) + (context-coloring-test-assert-region-comment 20 27) + (context-coloring-test-assert-region-level 28 41 0)) + +(defun context-coloring-test-js-syntactic-comments-setup () + (setq context-coloring-syntactic-comments t)) + +(context-coloring-test-deftest-js syntactic-comments + 'context-coloring-test-js-syntactic-comments + :fixture "comments-and-strings.js" + :before 'context-coloring-test-js-syntactic-comments-setup) +(context-coloring-test-deftest-js2 syntactic-comments + 'context-coloring-test-js-syntactic-comments + :fixture "comments-and-strings.js" + :before 'context-coloring-test-js-syntactic-comments-setup) -(ert-deftest context-coloring-test-js2-mode-property-lookup () - (context-coloring-test-js2-mode - "./fixtures/property-lookup.js" - (context-coloring-test-js-property-lookup))) +(defun context-coloring-test-js-syntactic-strings () + (context-coloring-test-assert-region-level 1 28 0) + (context-coloring-test-assert-region-string 28 40) + (context-coloring-test-assert-region-level 40 41 0)) + +(defun context-coloring-test-js-syntactic-strings-setup () + (setq context-coloring-syntactic-strings t)) + +(context-coloring-test-deftest-js syntactic-strings + 'context-coloring-test-js-syntactic-strings + :fixture "comments-and-strings.js" + :before 'context-coloring-test-js-syntactic-strings-setup) +(context-coloring-test-deftest-js2 syntactic-strings + 'context-coloring-test-js-syntactic-strings + :fixture "comments-and-strings.js" + :before 'context-coloring-test-js-syntactic-strings-setup) + +(context-coloring-test-deftest-js2 unterminated-comment + ;; As long as `add-text-properties' doesn't signal an error, this test passes. + (lambda ())) + +(context-coloring-test-deftest-emacs-lisp defun + (lambda () + (context-coloring-test-assert-coloring " +111111 000 1111 111 111111111 1111 + 11 111 111 111 000011 + +0000 0 0 00 + +111111 01 +111111 111"))) + +(context-coloring-test-deftest-emacs-lisp lambda + (lambda () + (context-coloring-test-assert-coloring " +00000000 1111111 1111 + 11111111 11 2222222 2222 + 222 22 12 2221 111 0 00"))) + +(context-coloring-test-deftest-emacs-lisp quote + (lambda () + (context-coloring-test-assert-coloring " +(xxxxx x (x) + (xx (xx x 111 + 111111 1 111 111 + 111111 1 1111111111 11 111 1 111 1 00001 10000 11 00001 1 100001111"))) + +(context-coloring-test-deftest-emacs-lisp comment + (lambda () + ;; Just check that the comment isn't parsed syntactically. + (context-coloring-test-assert-coloring " +(xxxxx x () + (xx (x xxxxx-xxxx xx) ;;;;;;;;;; + 11 00000-0000 11))) ;;;;;;;;;;")) + :before (lambda () + (setq context-coloring-syntactic-comments t))) + +(context-coloring-test-deftest-emacs-lisp string + (lambda () + (context-coloring-test-assert-coloring " +(xxxxx x (x) + (xxxxxx x x sss 1 0 sssss 0 1 sssssss11")) + :before (lambda () + (setq context-coloring-syntactic-strings t))) + +(context-coloring-test-deftest-emacs-lisp ignored + (lambda () + (context-coloring-test-assert-coloring " +(xxxxx x () + (x x 1 11 11 111 11 1 111 (1 1 1)))"))) + +(context-coloring-test-deftest-emacs-lisp let + (lambda () + (context-coloring-test-assert-coloring " +1111 11 + 11 01 + 11 00001 + 11 2222 22 + 22 02 + 22 000022 + 2222 2 2 2 00002211 + 1111 1 1 1 000011"))) + +(context-coloring-test-deftest-emacs-lisp let* + (lambda () + (context-coloring-test-assert-coloring " +11111 11 + 11 11 + 11 000011 + 1111 1 1 1 0 0 00001 + 22222 22 + 22 12 + 22 00002 + 22 02 + 22 222 + 2222 1 1 2 2 2 000022 + 1111 1 1 1 0 0 000011"))) + +(defun context-coloring-test-insert-unread-space () + (setq unread-command-events (cons '(t . 32) + unread-command-events))) + +(defun context-coloring-test-remove-faces () + (remove-text-properties (point-min) (point-max) '(face nil))) + +(context-coloring-test-deftest-emacs-lisp iteration + (lambda () + (let ((context-coloring-emacs-lisp-iterations-per-pause 1)) + (context-coloring-colorize) + (context-coloring-test-assert-coloring " +;; `cc' `cc' +(xxxxx x ())") + (context-coloring-test-remove-faces) + (context-coloring-test-insert-unread-space) + (context-coloring-colorize) + ;; The first iteration will color the first part of the comment, but + ;; that's it. Then it will be interrupted. + (context-coloring-test-assert-coloring " +;; nnnn nnnn +nnnnnn n nnn"))) + :before (lambda () + (setq context-coloring-syntactic-comments t) + (setq context-coloring-syntactic-strings t))) (provide 'context-coloring-test) + +;;; context-coloring-test.el ends here