2010-10-05 22:51:04 -04:00
|
|
|
#+Title: Org-mode Testing
|
|
|
|
#+Babel: results silent
|
|
|
|
|
|
|
|
The following instructions describe how to get started using the
|
|
|
|
Org-mode test framework.
|
|
|
|
|
2011-06-14 17:37:11 -04:00
|
|
|
* To run the tests interactively
|
|
|
|
:PROPERTIES:
|
|
|
|
:tangle: no
|
|
|
|
:END:
|
2011-03-01 02:34:55 -05:00
|
|
|
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).
|
|
|
|
|
2010-10-05 22:51:04 -04:00
|
|
|
#+begin_src sh
|
|
|
|
cd ..
|
|
|
|
git submodule init
|
|
|
|
git submodule update
|
|
|
|
#+end_src
|
|
|
|
|
|
|
|
2) Load the [[file:org-test.el][org-test.el]] file
|
|
|
|
#+begin_src emacs-lisp
|
|
|
|
(load-file "org-test.el")
|
|
|
|
#+end_src
|
|
|
|
|
|
|
|
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/=
|
2010-10-06 11:04:06 -04:00
|
|
|
directory of the org-mode repository to jump to the related test
|
2010-10-05 22:51:04 -04:00
|
|
|
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.
|
|
|
|
|
2011-03-02 13:07:15 -05:00
|
|
|
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
|
2010-10-05 22:51:04 -04:00
|
|
|
|
2011-03-02 13:07:15 -05:00
|
|
|
5) [[info:ert#Top][Review the ERT documentation]]
|
|
|
|
|
|
|
|
6) A number of org-mode-specific functions and macros are provided in
|
2010-10-05 22:51:04 -04:00
|
|
|
=org-test.el= see the [[file:org-test.el::%3B%3B%3B%20Functions%20for%20writing%20tests][;;; Functions for Writing Tests]] subsection of
|
|
|
|
that file. Some of these functions make use of example org-mode
|
|
|
|
files located in the [[file:examples][examples/]] directory.
|
|
|
|
|
2011-03-02 13:07:15 -05:00
|
|
|
7) Functions for loading and running the Org-mode tests are provided
|
2010-10-05 22:51:04 -04:00
|
|
|
in the [[file:org-test.el::%3B%3B%3B%20Load%20and%20Run%20tests][;;; 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
|
2011-03-02 13:07:15 -05:00
|
|
|
|
|
|
|
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
|
|
|
|
|
2011-06-14 17:37:11 -04:00
|
|
|
* To run the tests in batch mode
|
|
|
|
First tangle this file out to your desktop.
|
|
|
|
#+headers: :tangle ~/Desktop/run-org-tests.el
|
|
|
|
#+begin_src emacs-lisp :var org-dir=(expand-file-name ".." (file-name-directory (or load-file-name (buffer-file-name))))
|
|
|
|
;; 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")
|
2011-08-03 21:08:56 -04:00
|
|
|
(concat org-dir "/testing/examples/ob-C-test.org")
|
2011-06-14 17:37:11 -04:00
|
|
|
(concat org-dir "/testing/examples/normal.org")
|
2011-07-24 06:28:35 -04:00
|
|
|
(concat org-dir "/testing/examples/ob-awk-test.org")
|
2011-07-20 18:44:50 -04:00
|
|
|
(concat org-dir "/testing/examples/ob-fortran-test.org")
|
2011-06-14 17:37:11 -04:00
|
|
|
(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)))
|
|
|
|
#+end_src
|
|
|
|
|
|
|
|
Then run the test suite with the following command which could use any
|
|
|
|
version of Emacs.
|
|
|
|
#+begin_src sh :results output silent
|
|
|
|
emacs --batch -Q -l ~/Desktop/run-org-tests.el
|
|
|
|
#+end_src
|