mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-12-11 09:20:32 +00:00

History

Litvinov Sergey 8d3a4da034 Extend ob-maxima: add input variables and graphic output * lisp/ob-maxima.el (org-babel-tangle-lang-exts): Maxima extension. (org-babel-maxima-expand): Add input variables and graphic output. (org-babel-execute:maxima): Add input variables and graphic output. (org-babel-maxima-var-to-maxima): Add input variables and graphic output. (org-babel-maxima-graphical-output-file): Add input variables and graphic output. (org-babel-maxima-elisp-to-maxima): Add input variables and graphic output. * testing/examples/ob-maxima-test.org: Examples for new Maxima behavior.		2011-11-08 13:40:23 -07:00
..
contrib/lisp	ensure that the testing/contrib/lisp directory is created	2010-10-06 08:58:08 -06:00
examples	Extend ob-maxima: add input variables and graphic output	2011-11-08 13:40:23 -07:00
jump@820bb7d81b	now using newer version of jump.el -- run $ git submodule update	2010-10-21 13:05:59 +01:00
lisp	Use macro to compose html link export tests	2011-09-25 09:49:39 +02:00
.gitignore	ignore testing/ert, in case anyone wants to keep ert installed there	2011-03-01 10:01:40 -07:00
org-test-ob-consts.el	ob-exp: fixed export when headings have links, with tests	2010-10-05 11:54:48 -06:00
org-test.el	Replace org-mode-p with usual (eq major-mode 'org-mode) check	2011-10-22 11:29:24 +02:00
README.org	Awk can be called with no in-file: and no :stdin	2011-07-24 14:05:55 -06:00

README.org

Org-mode Testing

To run the tests interactively
To run the tests in batch mode

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

To run the tests interactively

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
```
Load the org-test.el file
```
  (load-file "org-test.el")
```
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.

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

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

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

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)

To run the tests in batch mode

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/normal.org")
         (concat org-dir "/testing/examples/ob-awk-test.org")
         (concat org-dir "/testing/examples/ob-fortran-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