mirror/org-mode
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-12-04 08:47:03 +00:00
Code
a41eaf4d7b
org-mode/testing
History
Eric Schulte 8efcd4338d adding test of error when exporting marked subtree with code blocks
2010-12-13 12:41:55 -07:00
..
contrib/lisp ensure that the testing/contrib/lisp directory is created 2010-10-06 08:58:08 -06:00
ert@87b475f856 adding ERT and jump.el as git submodules 2010-10-05 11:54:48 -06:00
examples adding test of error when exporting marked subtree with code blocks 2010-12-13 12:41:55 -07:00
jump@820bb7d81b now using newer version of jump.el -- run $ git submodule update 2010-10-21 13:05:59 +01:00
lisp adding test of error when exporting marked subtree with code blocks 2010-12-13 12:41:55 -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 New function: Run all tests for current file 2010-11-22 19:29:05 +01:00
README.org typo in testing/README.org, once again, thanks Nick Dokos 2010-10-06 09:04:06 -06:00

README.org

Org-mode Testing

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

  1. Install the ERT and jump.el testing dependencies which are included as git submodules 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

  2. Load the org-test.el file

      (load-file "org-test.el")
  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/ 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. Review the ERT documentation, to do this run makeinfo in the testing/ert directory,

      cd ert
  makeinfo ert.texinfo

    then browse the resulting info file.

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

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