mirror of
https://git.savannah.gnu.org/git/emacs/org-mode.git
synced 2024-08-25 13:02:51 +00:00
2.1 KiB
2.1 KiB
Org-mode Testing
The following instructions describe how to get started using the Org-mode test framework.
-
Install the ERT and jump.el testing dependencies which are included as git submodules in the org-mode repository. To do so run the following git submodule commands from inside the base of the Org-mode directory (or just execute the following code block).
cd .. git submodule init git submodule update
-
Load the org-test.el file
(load-file "org-test.el")
- The
org-test-jump
command is now bound toM-C-j
in all emacs-lisp files. Call this command from any file in thelisp/
directory of the org-mode repository to jump to the related test file in thetesting/
directory. Call this functions with a prefix argument, and the corresponding test file will be stubbed out if it doesn't already exist. -
Review the ERT documentation, to do this run
makeinfo
in thetesting/ert
directory,cd ert makeinfo ert.texinfo
then browse the resulting info file.
- A number of org-mode-specific functions and macros are provided in
org-test.el
see the ;;; Functions for Writing Tests subsection of that file. Some of these functions make use of example org-mode files located in the examples/ directory. -
Functions for loading and running the Org-mode tests are provided in the ;;; Load and Run Tests subsection, the most important of which are
org-test-load
which loads the entire Org-mode test suiteorg-test-current-defun
which runs all tests for the current function around point (should be called from inside of an Org-mode elisp file)org-test-run-all-tests
which runs the entire Org-mode test suite- also note that the
ert
command can also be used to run tests