1 #+Title: Org-mode Testing
2 #+Babel: results silent
4 The following instructions describe how to get started using the
5 Org-mode test framework.
7 1) Install the jump.el testing dependency which is included as a git
8 submodule in the org-mode repository. To do so run the following
9 git submodule commands from inside the base of the Org-mode
10 directory (or just execute the following code block).
18 2) Load the [[file:org-test.el][org-test.el]] file
19 #+begin_src emacs-lisp
20 (load-file "org-test.el")
23 3) The =org-test-jump= command is now bound to =M-C-j= in all
24 emacs-lisp files. Call this command from any file in the =lisp/=
25 directory of the org-mode repository to jump to the related test
26 file in the =testing/= directory. Call this functions with a
27 prefix argument, and the corresponding test file will be stubbed
28 out if it doesn't already exist.
30 4) [[info:ert#Top][Review the ERT documentation]]
32 5) A number of org-mode-specific functions and macros are provided in
33 =org-test.el= see the [[file:org-test.el::%3B%3B%3B%20Functions%20for%20writing%20tests][;;; Functions for Writing Tests]] subsection of
34 that file. Some of these functions make use of example org-mode
35 files located in the [[file:examples][examples/]] directory.
37 6) Functions for loading and running the Org-mode tests are provided
38 in the [[file:org-test.el::%3B%3B%3B%20Load%20and%20Run%20tests][;;; Load and Run Tests]] subsection, the most important of
40 - =org-test-load= which loads the entire Org-mode test suite
41 - =org-test-current-defun= which runs all tests for the current
42 function around point (should be called from inside of an
44 - =org-test-run-all-tests= which runs the entire Org-mode test suite
45 - also note that the =ert= command can also be used to run tests