History

Eric Schulte 750502e3bf ignore testing/ert, in case anyone wants to keep ert installed there This may be useful for testers using older version of Emacs		2011-03-01 10:01:40 -07:00
..
contrib/lisp	ensure that the testing/contrib/lisp directory is created	2010-10-06 08:58:08 -06:00
examples	Add links.org to testing/examples/	2011-01-17 18:23:45 +01:00
jump@820bb7d81b	now using newer version of jump.el -- run $ git submodule update	2010-10-21 13:05:59 +01:00
lisp	Changes to suit latest ert structure. ERT is now a part of EMACS and the source of the ERT git submodule is deprecated, as are some files within. Changes testing/README and .gitmodules to suit.	2011-03-01 09:59:01 -07:00
.gitignore	ignore testing/ert, in case anyone wants to keep ert installed there	2011-03-01 10:01:40 -07:00
README.org	Changes to suit latest ert structure. ERT is now a part of EMACS and the source of the ERT git submodule is deprecated, as are some files within. Changes testing/README and .gitmodules to suit.	2011-03-01 09:59:01 -07:00
org-test-ob-consts.el	ob-exp: fixed export when headings have links, with tests	2010-10-05 11:54:48 -06:00
org-test.el	Changes to suit latest ert structure. ERT is now a part of EMACS and the source of the ERT git submodule is deprecated, as are some files within. Changes testing/README and .gitmodules to suit.	2011-03-01 09:59:01 -07:00

Org-mode Testing

The following instructions describe how to get started using the Org-mode test framework.

Install the jump.el testing dependency which is included as a git submodule 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 to M-C-j in all emacs-lisp files. Call this command from any file in the lisp/ directory of the org-mode repository to jump to the related test file in the testing/ 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
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 suite
- org-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