org-mode

History

Bastien Guerry c0675b478e test-org-src.el: Fix a test. * lisp/test-org-src.el (test-org-src/blank-line-block): Use `org-test-with-temp-text-in-file' because `org-in-src-block-p' checks against an Org mode text property. Don't check for the word at point. Thanks to Nick Dokos for reporting this failed test.		2012-12-15 08:04:43 +01:00
..
examples	testing/: Update two tests	2012-08-20 14:24:14 +02:00
jump@820bb7d81b	now using newer version of jump.el -- run $ git submodule update	2010-10-21 13:05:59 +01:00
lisp	test-org-src.el: Fix a test.	2012-12-15 08:04:43 +01:00
.gitignore	ignore org-id file generated during testing	2011-11-15 11:19:39 -07:00
README	Small reformatting of testing/README.	2012-04-21 00:59:14 +02:00
org-test-ob-consts.el	Fix the master branch.	2012-03-19 22:01:29 +01:00
org-test.el	testing/org-test.el: Fix `org-test-with-temp-text'.	2012-12-15 08:00:30 +01:00

README

# -*- mode:org -*-
#+TITLE: Org-mode Testing
#+PROPERTY: results silent

* Dependencies

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

* Non-interactive batch testing from the command line

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.

#+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
#+END_SRC

The options in the above command are explained below.

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

* Interactive testing from within Emacs

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
     (org-test-run-all-tests)
   #+END_SRC

* Troubleshooting

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