mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-07 15:00:34 -08:00
Code Issues Projects Releases Wiki Activity

Fix ert-font-lock macro signatures

Browse source 
* doc/misc/ert.texi (Syntax Highlighting Tests):
* test/lisp/emacs-lisp/ert-font-lock-tests.el
(test-line-comment-p--emacs-lisp, test-line-comment-p--shell-script)
(test-line-comment-p--javascript, test-line-comment-p--python)
(test-line-comment-p--c, test-macro-test--correct-highlighting)
(test-macro-test--docstring, test-macro-test--failing)
(test-macro-test--file, test-macro-test--file-no-asserts)
(test-macro-test--file-failing): Reindent macro calls.
(with-temp-buffer-str-mode): Evaluate macro arguments left-to-right.
(ert-font-lock--wrap-begin-end): Use rx for more robust composition.
(test-line-comment-p--php): Require that php-mode is callable, not
already loaded.

* lisp/emacs-lisp/ert-font-lock.el (ert-font-lock-deftest)
(ert-font-lock-deftest-file): NAME is not followed by an empty list
like in ert-deftest, so the optional DOCSTRING is actually the
second argument.  Adapt calling convention in docstring, and debug,
doc-string, and indent properties accordingly (bug#76372).  Fix
docstring grammar, document MAJOR-MODE, and avoid referring to a
file name as a path.
This commit is contained in:
Basil L. Contovounesios 2025-02-20 10:29:54 +01:00
parent 0c6b8643ae
commit 02c830ba22
3 changed files with 73 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/misc/ert.texi
View file

@ -955,7 +955,7 @@ checking face assignment. Test assertions are included in code-level
comments directly and can be read either from inline strings or files. comments directly and can be read either from inline strings or files.
The parser expects the input string to contain at least one assertion. The parser expects the input string to contain at least one assertion.
Test assertion parser extracts tests from comment-only lines. Every The test assertion parser extracts tests from comment-only lines. Every
comment assertion line starts either with a caret (@samp{^}) or an arrow comment assertion line starts either with a caret (@samp{^}) or an arrow
(@samp{<-}). A single caret/arrow or carets should be followed (@samp{<-}). A single caret/arrow or carets should be followed
immediately by the name of a face or a list of faces to be checked immediately by the name of a face or a list of faces to be checked
@ -977,7 +977,7 @@ var variable = 11;
@end example @end example
Both symbol-only @code{:face} property values and assertion face values Both symbol-only @code{:face} property values and assertion face values
are normalized to single element lists so assertions below are are normalized to single element lists so the assertions below are
equivalent: equivalent:
@example @example
@ -1054,7 +1054,7 @@ definition:
@lisp @lisp
(ert-font-lock-deftest test-macro-test--inline (ert-font-lock-deftest test-macro-test--inline
emacs-lisp-mode emacs-lisp-mode
" "
(defun fun ()) (defun fun ())
;; ^ font-lock-keyword-face ;; ^ font-lock-keyword-face
@ -1068,13 +1068,13 @@ file:
@lisp @lisp
(ert-font-lock-deftest-file test-macro-test--file (ert-font-lock-deftest-file test-macro-test--file
"Test reading correct assertions from a file" "Test reading correct assertions from a file."
javascript-mode javascript-mode
"correct.js") "correct.js")
@end lisp @end lisp
The @code{ert-font-lock-deftest} and @code{ert-font-lock-deftest-file} The @code{ert-font-lock-deftest} and @code{ert-font-lock-deftest-file}
macros accept the same keyword parameters as @code{ert-deftest} i.e., macros accept the same keyword arguments as @code{ert-deftest}, i.e.,
@code{:tag} and @code{:expected-result}. @code{:tag} and @code{:expected-result}.
@node How to Debug Tests @node How to Debug Tests

39
lisp/emacs-lisp/ert-font-lock.el
View file

@ -27,8 +27,8 @@
;; highlighting provided by font-lock. ;; highlighting provided by font-lock.
;; ;;
;; ert-font-lock entry points are functions ;; ert-font-lock entry points are functions
;; `ert-font-lock-test-string' and `ert-font-lock-test-file' and ;; `ert-font-lock-test-string' and `ert-font-lock-test-file', and
;; convenience macros: `ert-font-lock-deftest' and ;; convenience macros `ert-font-lock-deftest' and
;; `ert-font-lock-deftest-file'. ;; `ert-font-lock-deftest-file'.
;; ;;
;; See unit tests in ert-font-lock-tests.el for usage examples. ;; See unit tests in ert-font-lock-tests.el for usage examples.
@ -124,19 +124,21 @@ Argument TEST-NAME - name of the currently running ert test."
(defmacro ert-font-lock-deftest (name &rest docstring-keys-mode-and-str) (defmacro ert-font-lock-deftest (name &rest docstring-keys-mode-and-str)
"Define test NAME (a symbol) using assertions from TEST-STR. "Define test NAME (a symbol) using assertions from TEST-STR.
Other than MAJOR-MODE and TEST-STR parameters, this macro accepts The MAJOR-MODE symbol determines the syntax and font lock of TEST-STR.
the same parameters and keywords as `ert-deftest' and is intended
to be used through `ert'.
\(fn NAME () [DOCSTRING] [:expected-result RESULT-TYPE] \ Except for the MAJOR-MODE and TEST-STR parameters, this macro accepts
the same arguments and keywords as `ert-deftest' and is intended to be
used through `ert'.
\(fn NAME [DOCSTRING] [:expected-result RESULT-TYPE] \
[:tags \\='(TAG...)] MAJOR-MODE TEST-STR)" [:tags \\='(TAG...)] MAJOR-MODE TEST-STR)"
(declare (debug (&define [&name "test@" symbolp] (declare (debug (&define [&name "test@" symbolp]
sexp [&optional stringp] [&optional stringp]
[&rest keywordp sexp] [&rest keywordp sexp]
symbolp symbolp
stringp)) stringp))
(doc-string 3) (doc-string 2)
(indent 2)) (indent 1))
(pcase-let ((`(,documentation (pcase-let ((`(,documentation
,documentation-supplied-p ,documentation-supplied-p
,keys ,mode ,arg) ,keys ,mode ,arg)
@ -159,22 +161,23 @@ to be used through `ert'.
(defmacro ert-font-lock-deftest-file (name &rest docstring-keys-mode-and-file) (defmacro ert-font-lock-deftest-file (name &rest docstring-keys-mode-and-file)
"Define test NAME (a symbol) using assertions from FILE. "Define test NAME (a symbol) using assertions from FILE.
FILE - path to a file with assertions in ERT resource director as FILE names a file with assertions in the ERT resource directory, as
return by `ert-resource-directory'. returned by `ert-resource-directory'. The MAJOR-MODE symbol determines
the syntax and font lock of FILE's contents.
Other than MAJOR-MODE and FILE parameters, this macro accepts the Except for the MAJOR-MODE and FILE parameters, this macro accepts the
same parameters and keywords as `ert-deftest' and is intended to same arguments and keywords as `ert-deftest' and is intended to be used
be used through `ert'. through `ert'.
\(fn NAME () [DOCSTRING] [:expected-result RESULT-TYPE] \ \(fn NAME [DOCSTRING] [:expected-result RESULT-TYPE] \
[:tags \\='(TAG...)] MAJOR-MODE FILE)" [:tags \\='(TAG...)] MAJOR-MODE FILE)"
(declare (debug (&define [&name "test@" symbolp] (declare (debug (&define [&name "test@" symbolp]
sexp [&optional stringp] [&optional stringp]
[&rest keywordp sexp] [&rest keywordp sexp]
symbolp symbolp
stringp)) stringp))
(doc-string 3) (doc-string 2)
(indent 2)) (indent 1))
(pcase-let ((`(,documentation (pcase-let ((`(,documentation
,documentation-supplied-p ,documentation-supplied-p

94
test/lisp/emacs-lisp/ert-font-lock-tests.el
View file

@ -39,13 +39,13 @@
"Create a buffer with STR contents and MODE. " "Create a buffer with STR contents and MODE. "
(declare (indent 1) (debug t)) (declare (indent 1) (debug t))
`(with-temp-buffer `(with-temp-buffer
(insert ,str)
(,mode) (,mode)
(insert ,str)
(goto-char (point-min)) (goto-char (point-min))
,@body)) ,@body))
(defun ert-font-lock--wrap-begin-end (re) (defun ert-font-lock--wrap-begin-end (re)
(concat "^" re "$")) (rx bol (regexp re) eol))
;;; Regexp tests ;;; Regexp tests
;;; ;;;
@ -97,89 +97,89 @@
(ert-deftest test-line-comment-p--emacs-lisp () (ert-deftest test-line-comment-p--emacs-lisp ()
(with-temp-buffer-str-mode emacs-lisp-mode (with-temp-buffer-str-mode emacs-lisp-mode
"not comment "not comment
;; comment ;; comment
" "
(should-not (ert-font-lock--line-comment-p)) (should-not (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should (ert-font-lock--line-comment-p)) (should (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should-not (ert-font-lock--line-comment-p)))) (should-not (ert-font-lock--line-comment-p))))
(ert-deftest test-line-comment-p--shell-script () (ert-deftest test-line-comment-p--shell-script ()
(with-temp-buffer-str-mode shell-script-mode (with-temp-buffer-str-mode shell-script-mode
"echo Not a comment "echo Not a comment
# comment # comment
" "
(should-not (ert-font-lock--line-comment-p)) (should-not (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should (ert-font-lock--line-comment-p)))) (should (ert-font-lock--line-comment-p))))
(declare-function php-mode "php-mode") (declare-function php-mode "php-mode")
(ert-deftest test-line-comment-p--php () (ert-deftest test-line-comment-p--php ()
(skip-unless (featurep 'php-mode)) (skip-unless (fboundp 'php-mode))
(with-temp-buffer-str-mode php-mode (with-temp-buffer-str-mode php-mode
"echo 'Not a comment' "echo 'Not a comment'
// comment // comment
/* comment */ /* comment */
" "
(should-not (ert-font-lock--line-comment-p)) (should-not (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should (ert-font-lock--line-comment-p)) (should (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should (ert-font-lock--line-comment-p)))) (should (ert-font-lock--line-comment-p))))
(ert-deftest test-line-comment-p--javascript () (ert-deftest test-line-comment-p--javascript ()
(with-temp-buffer-str-mode javascript-mode (with-temp-buffer-str-mode javascript-mode
"// comment "// comment
// comment, after a blank line // comment, after a blank line
var abc = function(d) {}; var abc = function(d) {};
" "
(should (ert-font-lock--line-comment-p)) (should (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should-not (ert-font-lock--line-comment-p)) (should-not (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should (ert-font-lock--line-comment-p)) (should (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should-not (ert-font-lock--line-comment-p)) (should-not (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should-not (ert-font-lock--line-comment-p)))) (should-not (ert-font-lock--line-comment-p))))
(ert-deftest test-line-comment-p--python () (ert-deftest test-line-comment-p--python ()
(with-temp-buffer-str-mode python-mode (with-temp-buffer-str-mode python-mode
"# comment "# comment
# comment # comment
print(\"Hello, world!\")" print(\"Hello, world!\")"
(should (ert-font-lock--line-comment-p)) (should (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should-not (ert-font-lock--line-comment-p)) (should-not (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should (ert-font-lock--line-comment-p)) (should (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should-not (ert-font-lock--line-comment-p)))) (should-not (ert-font-lock--line-comment-p))))
(ert-deftest test-line-comment-p--c () (ert-deftest test-line-comment-p--c ()
(with-temp-buffer-str-mode c-mode (with-temp-buffer-str-mode c-mode
"// comment "// comment
/* also comment */" /* also comment */"
(should (ert-font-lock--line-comment-p)) (should (ert-font-lock--line-comment-p))
(forward-line) (forward-line)
(should (ert-font-lock--line-comment-p)))) (should (ert-font-lock--line-comment-p))))
(ert-deftest test-parse-comments--no-assertion-error () (ert-deftest test-parse-comments--no-assertion-error ()
(let* ((str " (let* ((str "
@ -568,14 +568,14 @@ var abc = function(d) {
;; ;;
(ert-font-lock-deftest test-macro-test--correct-highlighting (ert-font-lock-deftest test-macro-test--correct-highlighting
emacs-lisp-mode emacs-lisp-mode
" "
(defun fun ()) (defun fun ())
;; ^ font-lock-keyword-face ;; ^ font-lock-keyword-face
;; ^ font-lock-function-name-face") ;; ^ font-lock-function-name-face")
(ert-font-lock-deftest test-macro-test--docstring (ert-font-lock-deftest test-macro-test--docstring
"A test with a docstring." "A test with a docstring."
emacs-lisp-mode emacs-lisp-mode
" "
(defun fun ()) (defun fun ())
@ -583,7 +583,7 @@ var abc = function(d) {
) )
(ert-font-lock-deftest test-macro-test--failing (ert-font-lock-deftest test-macro-test--failing
"A failing test." "A failing test."
:expected-result :failed :expected-result :failed
emacs-lisp-mode emacs-lisp-mode
" "
@ -591,18 +591,18 @@ var abc = function(d) {
;; ^ wrong-face") ;; ^ wrong-face")
(ert-font-lock-deftest-file test-macro-test--file (ert-font-lock-deftest-file test-macro-test--file
"Test reading correct assertions from a file" "Test reading correct assertions from a file."
javascript-mode javascript-mode
"correct.js") "correct.js")
(ert-font-lock-deftest-file test-macro-test--file-no-asserts (ert-font-lock-deftest-file test-macro-test--file-no-asserts
"Check failing on files without assertions" "Check failing on files without assertions."
:expected-result :failed :expected-result :failed
javascript-mode javascript-mode
"no-asserts.js") "no-asserts.js")
(ert-font-lock-deftest-file test-macro-test--file-failing (ert-font-lock-deftest-file test-macro-test--file-failing
"Test reading wrong assertions from a file" "Test reading wrong assertions from a file."
:expected-result :failed :expected-result :failed
javascript-mode javascript-mode
"broken.js") "broken.js")