org-mode/testing

Org-mode Testing

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

1. 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

2. Load the org-test.el file

     (load-file "org-test.el")

3. 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.

4. Ingest the library-of-babel.org file since some tests require this.

     (org-babel-lob-ingest "../contrib/babel/library-of-babel.org")

5. Review the ERT documentation
6. 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.

7. 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

8. Load and run all tests

     (load-file "org-test.el")
     (org-babel-lob-ingest "../contrib/babel/library-of-babel.org")
     (org-test-load)
     (org-test-run-all-tests)