The following instructions describe how to get started using the Org-mode test framework.
:PROPERTIES: :tangle: no :END: 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).
#+begin_src sh cd .. git submodule init git submodule update #+end_src
2) Load the file #+begin_src emacs-lisp (load-file "org-test.el") #+end_src
org-test-jump command is now bound to
M-C-j in all
emacs-lisp files. Call this command from any file in the
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. #+begin_src emacs-lisp (org-babel-lob-ingest "../contrib/babel/library-of-babel.org") #+end_src
6) A number of org-mode-specific functions and macros are provided in
org-test.el see the subsection of
that file. Some of these functions make use of example org-mode
files located in the directory.
org-test-loadwhich loads the entire Org-mode test suite
org-test-current-defunwhich runs all tests for the current
org-test-run-all-testswhich runs the entire Org-mode test suite
ertcommand can also be used to run tests
8) Load and run all tests #+begin_src emacs-lisp (load-file "org-test.el") (org-babel-lob-ingest "../contrib/babel/library-of-babel.org") (org-test-load) (org-test-run-all-tests) #+end_src
First tangle this file out to your desktop.
;; add to the load path (add-to-list 'load-path (concat org-dir "/lisp/")) (add-to-list 'load-path (concat org-dir "/lisp/testing/")) (add-to-list 'load-path (concat org-dir "/lisp/testing/ert/"))
;; load Org-mode (require 'org)
;; setup the ID locations used in tests (require 'org-id) (org-id-update-id-locations (list (concat org-dir "/testing/examples/babel.org") (concat org-dir "/testing/examples/ob-C-test.org") (concat org-dir "/testing/examples/normal.org") (concat org-dir "/testing/examples/ob-awk-test.org") (concat org-dir "/testing/examples/ob-octave.org") (concat org-dir "/testing/examples/ob-fortran-test.org") (concat org-dir "/testing/examples/ob-maxima-test.org") (concat org-dir "/testing/examples/link-in-heading.org") (concat org-dir "/testing/examples/links.org")))
;; ensure that the latest Org-mode is loaded (org-reload)
;; load the test suite (load-file (concat org-dir "/testing/org-test.el"))
;; configure Babel (org-babel-lob-ingest (concat org-dir "/contrib/babel/library-of-babel.org")) (org-babel-do-load-languages 'org-babel-load-languages '((emacs-lisp . t) (sh . t))) (setq org-confirm-babel-evaluate nil)
;; run the test suite (org-test-run-all-tests)
;; print the results (with-current-buffer "*ert*" (print (buffer-string)))
Then run the test suite with the following command which could use any version of Emacs.
emacs --batch -Q -l ~/Desktop/run-org-tests.el