2012-01-28 17:38:03 -05:00
|
|
|
# -*- mode:org -*-
|
2012-04-20 18:59:14 -04:00
|
|
|
#+TITLE: Org-mode Testing
|
|
|
|
|
#+PROPERTY: results silent
|
|
|
|
|
|
|
|
|
|
* Dependencies
|
2012-01-28 17:38:03 -05:00
|
|
|
|
|
|
|
|
The only dependency is [[http://www.emacswiki.org/emacs/ErtTestLibrary][ERT]] the Emacs testing library which ships with
|
|
|
|
|
Emacs24. If you are running an older version of Emacs and don't
|
|
|
|
|
already have ERT installed it can be installed from its old [[https://github.com/ohler/ert][git
|
|
|
|
|
repository]].
|
|
|
|
|
|
2012-04-20 18:59:14 -04:00
|
|
|
* Non-interactive batch testing from the command line
|
|
|
|
|
|
2012-01-28 17:38:03 -05:00
|
|
|
The simplest way to run the Org-mode test suite is from the command
|
|
|
|
|
line with the following invocation. Note that the paths below are
|
|
|
|
|
relative to the base of the Org-mode directory.
|
2012-04-20 18:59:14 -04:00
|
|
|
|
2012-03-30 22:11:22 -04:00
|
|
|
#+BEGIN_SRC sh :dir (expand-file-name "..")
|
|
|
|
|
# For Emacs earlier than 24, add -L /path/to/ert
|
|
|
|
|
emacs -Q --batch \
|
|
|
|
|
-L lisp/ -L testing/ -L testing/lisp -l lisp/org.el \
|
|
|
|
|
-l lisp/org-id.el -l testing/org-test.el \
|
|
|
|
|
--eval "(progn (org-reload) (setq org-confirm-babel-evaluate nil))" \
|
|
|
|
|
-f org-test-run-batch-tests
|
2012-01-28 17:38:03 -05:00
|
|
|
#+END_SRC
|
|
|
|
|
|
|
|
|
|
The options in the above command are explained below.
|
2012-04-20 18:59:14 -04:00
|
|
|
|
2012-01-28 17:38:03 -05:00
|
|
|
| -Q | ignores any personal configuration ensuring a vanilla Emacs instance is used |
|
|
|
|
|
| --batch | runs Emacs in "batch" mode with no gui and termination after execution |
|
|
|
|
|
| -l | loads Org-mode and the org mode test suite defined in testing/org-test.el |
|
|
|
|
|
| --eval | reloads Org-mode and allows evaluation of code blocks by the tests |
|
|
|
|
|
| -f | actually runs the tests using the `org-test-run-batch-tests' function |
|
|
|
|
|
|
2012-04-20 18:59:14 -04:00
|
|
|
* Interactive testing from within Emacs
|
|
|
|
|
|
2012-01-28 17:38:03 -05:00
|
|
|
To run the Org-mode test suite from a current Emacs instance simply
|
|
|
|
|
load and run the test suite with the following commands.
|
|
|
|
|
|
|
|
|
|
1) First load the test suite.
|
|
|
|
|
#+BEGIN_SRC emacs-lisp :var here=(buffer-file-name)
|
|
|
|
|
(add-to-list 'load-path (file-name-directory here))
|
|
|
|
|
(require 'org-test)
|
|
|
|
|
#+END_SRC
|
|
|
|
|
|
|
|
|
|
2) Then run the test suite.
|
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
2011-03-02 13:07:15 -05:00
|
|
|
(org-test-run-all-tests)
|
2012-01-28 17:38:03 -05:00
|
|
|
#+END_SRC
|
2012-04-20 18:59:14 -04:00
|
|
|
|
|
|
|
|
* Troubleshooting
|
|
|
|
|
|
2012-01-28 17:51:57 -05:00
|
|
|
- If the value of the =org-babel-no-eval-on-ctrl-c-ctrl-c= is non-nil
|
|
|
|
|
then it will result in some test failure, as there are tests which
|
|
|
|
|
rely on this behavior.
|
