ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
org-mode/testing
History
Eric Schulte 3af89e696a property names ending in plus accumulate 
This results in the following behavior.

  #+property: var  foo=1
  #+property: var+ bar=2

  #+begin_src emacs-lisp
    (+ foo bar)
  #+end_src

  #+results:
  : 3

  #+begin_src emacs-lisp
    (org-entry-get (point) "var" t)
  #+end_src

  #+results:
  : foo=1 bar=2

  * overwriting a file-wide property
    :PROPERTIES:
    :var:      foo=7
    :END:

  #+begin_src emacs-lisp
    foo
  #+end_src

  #+results:
  : 7

  #+begin_src emacs-lisp
    (org-entry-get (point) "var" t)
  #+end_src

  #+results:
  : foo=7

  * appending to a file-wide property
    :PROPERTIES:
    :var+:      baz=3
    :END:

  #+begin_src emacs-lisp
    (+ foo bar baz)
  #+end_src

  #+results:
  : 6

  #+begin_src emacs-lisp
    (org-entry-get (point) "var" t)
  #+end_src

  #+results:
  : foo=1 bar=2 baz=3

* lisp/org.el (org-update-property-plist): Updates a given property
  list with a property name and a property value.
  (org-set-regexps-and-options): Use org-update-property-plist.
  (org-entry-get): Use org-update-property-plist.
* testing/examples/property-inheritance.org: Example file for testing
  appending property behavior.
* testing/lisp/test-property-inheritance.el: Tests of appending
  property behavior.
* lisp/ob.el (org-babel-balanced-split): Allow splitting on single
  characters as well as groups of two characters.
  (org-babel-parse-multiple-vars): Split variables on single spaces.
 		2011-11-15 08:56:24 -07:00
..
contrib/lisp ensure that the testing/contrib/lisp directory is created 2010-10-06 08:58:08 -06:00
examples property names ending in plus accumulate 2011-11-15 08:56:24 -07:00
jump@820bb7d81b now using newer version of jump.el -- run $ git submodule update 2010-10-21 13:05:59 +01:00
lisp property names ending in plus accumulate 2011-11-15 08:56:24 -07:00
.gitignore ignore testing/ert, in case anyone wants to keep ert installed there 2011-03-01 10:01:40 -07:00
README.org construct a table from the output of maxima code block 2011-11-08 13:51:27 -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

Org-mode Testing

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

To run the tests interactively

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

      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. Ingest the library-of-babel.org file since some tests require this.

      (org-babel-lob-ingest "../contrib/babel/library-of-babel.org")
  5. Review the ERT documentation
  6. 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.

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

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