Function: ert-info

ert-info is a macro defined in ert.el.gz.

Signature

(ert-info (MESSAGE-FORM &key ((:prefix PREFIX-FORM) "Info: ")) &body BODY)

Documentation

Evaluate MESSAGE-FORM and BODY, and report the message if BODY fails.

To be used within ERT tests. MESSAGE-FORM should evaluate to a string that will be displayed together with the test result if the test fails. MESSAGE-FORM can also evaluate to a function; in this case, it will be called when displaying the info.

PREFIX-FORM should evaluate to a string as well and is displayed in front of the value of MESSAGE-FORM.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/ert.el.gz
(cl-defmacro ert-info ((message-form &key ((:prefix prefix-form) "Info: "))
                       &body body)
  "Evaluate MESSAGE-FORM and BODY, and report the message if BODY fails.

To be used within ERT tests.  MESSAGE-FORM should evaluate to a
string that will be displayed together with the test result if
the test fails.  MESSAGE-FORM can also evaluate to a function; in
this case, it will be called when displaying the info.

PREFIX-FORM should evaluate to a string as well and is displayed
in front of the value of MESSAGE-FORM."
  (declare (debug ((form &rest [sexp form]) body))
	   (indent 1))
  `(let ((ert--infos (cons (cons ,prefix-form ,message-form) ert--infos)))
     ,@body))