testing/org-test.el

   1 ;;;; org-test.el --- Tests for Org-mode
   2
   3 ;; Copyright (c) 2010-2013 Sebastian Rose, Eric Schulte
   4 ;; Authors:
   5 ;;     Sebastian Rose, Hannover, Germany, sebastian_rose gmx de
   6 ;;     Eric Schulte, Santa Fe, New Mexico, USA, schulte.eric gmail com
   7 ;;     David Maus, Brunswick, Germany, dmaus ictsoc de
   8
   9 ;; Released under the GNU General Public License version 3
  10 ;; see: http://www.gnu.org/licenses/gpl-3.0.html
  11
  12 ;; Definition of `special-mode' copied from Emacs23's simple.el to be
  13 ;; provide a testing environment for Emacs22.
  14
  15 ;;;; Comments:
  16
  17 ;; Interactive testing for Org mode.
  18
  19 ;; The heart of all this is the commands `org-test-current-defun'.  If
  20 ;; called while in a `defun' all ert tests with names matching the
  21 ;; name of the function are run.
  22
  23 ;;; Test Development
  24 ;; For test development purposes a number of navigation and test
  25 ;; function construction routines are available as a git submodule
  26 ;; (jump.el)
  27 ;; Install with...
  28 ;; $ git submodule init
  29 ;; $ git submodule update
  30
  31 \f
  32 ;;;; Code:
  33 (require 'org-test-ob-consts)
  34
  35 (let* ((org-test-dir (expand-file-name
  36                       (file-name-directory
  37                        (or load-file-name buffer-file-name))))
  38        (org-lisp-dir (expand-file-name
  39                       (concat org-test-dir "../lisp"))))
  40
  41   (unless (featurep 'org)
  42     (setq load-path (cons org-lisp-dir load-path))
  43     (require 'org)
  44     (require 'org-id)
  45      (org-babel-do-load-languages
  46      'org-babel-load-languages '((sh . t) (org . t))))
  47
  48   (let* ((load-path (cons
  49                      org-test-dir
  50                      (cons
  51                       (expand-file-name "jump" org-test-dir)
  52                       load-path))))
  53     (require 'cl)
  54     (when (= emacs-major-version 22)
  55       (defvar special-mode-map
  56         (let ((map (make-sparse-keymap)))
  57           (suppress-keymap map)
  58           (define-key map "q" 'quit-window)
  59           (define-key map " " 'scroll-up)
  60           (define-key map "\C-?" 'scroll-down)
  61           (define-key map "?" 'describe-mode)
  62           (define-key map "h" 'describe-mode)
  63           (define-key map ">" 'end-of-buffer)
  64           (define-key map "<" 'beginning-of-buffer)
  65           (define-key map "g" 'revert-buffer)
  66           (define-key map "z" 'kill-this-buffer)
  67           map))
  68
  69       (put 'special-mode 'mode-class 'special)
  70       (define-derived-mode special-mode nil "Special"
  71         "Parent major mode from which special major modes should inherit."
  72         (setq buffer-read-only t)))
  73     (require 'ert)
  74     (require 'ert-x)
  75     (when (file-exists-p
  76            (expand-file-name "jump/jump.el" org-test-dir))
  77       (require 'jump)
  78       (require 'which-func))))
  79
  80 (defconst org-test-default-test-file-name "tests.el"
  81   "For each defun a separate file with tests may be defined.
  82 tests.el is the fallback or default if you like.")
  83
  84 (defconst org-test-default-directory-name "testing"
  85   "Basename or the directory where the tests live.
  86 org-test searches this directory up the directory tree.")
  87
  88 (defconst org-test-dir
  89   (expand-file-name (file-name-directory (or load-file-name buffer-file-name))))
  90
  91 (defconst org-base-dir
  92   (expand-file-name ".." org-test-dir))
  93
  94 (defconst org-test-example-dir
  95   (expand-file-name "examples" org-test-dir))
  96
  97 (defconst org-test-file
  98   (expand-file-name "normal.org" org-test-example-dir))
  99
 100 (defconst org-test-no-heading-file
 101   (expand-file-name "no-heading.org" org-test-example-dir))
 102
 103 (defconst org-test-link-in-heading-file
 104   (expand-file-name "link-in-heading.org" org-test-dir))
 105
 106 \f
 107 ;;; Functions for writing tests
 108 (put 'missing-test-dependency
 109      'error-conditions
 110      '(error missing-test-dependency))
 111
 112 (defun org-test-for-executable (exe)
 113   "Throw an error if EXE is not available.
 114 This can be used at the top of code-block-language specific test
 115 files to avoid loading the file on systems without the
 116 executable."
 117   (unless (reduce
 118            (lambda (acc dir)
 119              (or acc (file-exists-p (expand-file-name exe dir))))
 120            exec-path :initial-value nil)
 121     (signal 'missing-test-dependency (list exe))))
 122
 123 (defun org-test-buffer (&optional file)
 124   "TODO:  Setup and return a buffer to work with.
 125 If file is non-nil insert it's contents in there.")
 126
 127 (defun org-test-compare-with-file (&optional file)
 128   "TODO:  Compare the contents of the test buffer with FILE.
 129 If file is not given, search for a file named after the test
 130 currently executed.")
 131
 132 (defmacro org-test-at-id (id &rest body)
 133   "Run body after placing the point in the headline identified by ID."
 134   (declare (indent 1))
 135   `(let* ((id-location (org-id-find ,id))
 136           (id-file (car id-location))
 137           (visited-p (get-file-buffer id-file))
 138           to-be-removed)
 139      (save-window-excursion
 140        (save-match-data
 141          (org-id-goto ,id)
 142          (setq to-be-removed (current-buffer))
 143          (condition-case nil
 144              (progn
 145                (org-show-subtree)
 146                (org-show-block-all))
 147            (error nil))
 148          (save-restriction ,@body)))
 149      (unless visited-p
 150        (kill-buffer to-be-removed))))
 151 (def-edebug-spec org-test-at-id (form body))
 152
 153 (defmacro org-test-in-example-file (file &rest body)
 154   "Execute body in the Org-mode example file."
 155   (declare (indent 1))
 156   `(let* ((my-file (or ,file org-test-file))
 157           (visited-p (get-file-buffer my-file))
 158           to-be-removed)
 159      (save-window-excursion
 160        (save-match-data
 161          (find-file my-file)
 162          (unless (eq major-mode 'org-mode)
 163            (org-mode))
 164          (setq to-be-removed (current-buffer))
 165          (goto-char (point-min))
 166          (condition-case nil
 167              (progn
 168                (outline-next-visible-heading 1)
 169                (org-show-subtree)
 170                (org-show-block-all))
 171            (error nil))
 172          (save-restriction ,@body)))
 173      (unless visited-p
 174        (kill-buffer to-be-removed))))
 175 (def-edebug-spec org-test-in-example-file (form body))
 176
 177 (defmacro org-test-at-marker (file marker &rest body)
 178   "Run body after placing the point at MARKER in FILE.
 179 Note the uuidgen command-line command can be useful for
 180 generating unique markers for insertion as anchors into org
 181 files."
 182   (declare (indent 2))
 183   `(org-test-in-example-file ,file
 184      (goto-char (point-min))
 185      (re-search-forward (regexp-quote ,marker))
 186      ,@body))
 187 (def-edebug-spec org-test-at-marker (form form body))
 188
 189 (defmacro org-test-with-temp-text (text &rest body)
 190   "Run body in a temporary buffer with Org-mode as the active
 191 mode holding TEXT.  If the string \"<point>\" appears in TEXT
 192 then remove it and place the point there before running BODY,
 193 otherwise place the point at the beginning of the inserted text."
 194   (declare (indent 1))
 195   (let ((inside-text (if (stringp text) text (eval text))))
 196     `(with-temp-buffer
 197        (org-mode)
 198        ,(let ((point (string-match (regexp-quote "<point>") inside-text)))
 199           (if point
 200               `(progn (insert `(replace-match "" nil nil inside-text))
 201                       (goto-char ,(match-beginning 0)))
 202             `(progn (insert ,inside-text)
 203                     (goto-char (point-min)))))
 204        ,@body)))
 205 (def-edebug-spec org-test-with-temp-text (form body))
 206
 207 (defmacro org-test-with-temp-text-in-file (text &rest body)
 208   "Run body in a temporary file buffer with Org-mode as the active mode."
 209   (declare (indent 1))
 210   (let ((file (make-temp-file "org-test"))
 211         (inside-text (if (stringp text) text (eval text)))
 212         (results (gensym)))
 213     `(let ((kill-buffer-query-functions nil) ,results)
 214        (with-temp-file ,file (insert ,inside-text))
 215        (find-file ,file)
 216        (org-mode)
 217        (setq ,results ,@body)
 218        (save-buffer) (kill-buffer (current-buffer))
 219        (delete-file ,file)
 220        ,results)))
 221 (def-edebug-spec org-test-with-temp-text-in-file (form body))
 222
 223 \f
 224 ;;; Navigation Functions
 225 (when (featurep 'jump)
 226   (defjump org-test-jump
 227     (("lisp/\\1.el" . "testing/lisp/test-\\1.el")
 228      ("lisp/\\1.el" . "testing/lisp/\\1.el/test.*.el")
 229      ("testing/lisp/test-\\1.el" . "lisp/\\1.el")
 230      ("testing/lisp/\\1.el" . "lisp/\\1.el/test.*.el"))
 231     (concat org-base-dir "/")
 232     "Jump between org-mode files and their tests."
 233     (lambda (path)
 234       (let* ((full-path (expand-file-name path org-base-dir))
 235              (file-name (file-name-nondirectory path))
 236              (name (file-name-sans-extension file-name)))
 237         (find-file full-path)
 238         (insert
 239          ";;; " file-name "\n\n"
 240          ";; Copyright (c) " (nth 5 (decode-time (current-time)))
 241          " " user-full-name "\n"
 242          ";; Authors: " user-full-name "\n\n"
 243          ";; Released under the GNU General Public License version 3\n"
 244          ";; see: http://www.gnu.org/licenses/gpl-3.0.html\n\n"
 245          ";;;; Comments:\n\n"
 246          ";; Template test file for Org-mode tests\n\n"
 247          "\f\n"
 248          ";;; Code:\n"
 249          "(let ((load-path (cons (expand-file-name\n"
 250          "                      \"..\" (file-name-directory\n"
 251          "                            (or load-file-name buffer-file-name)))\n"
 252          "                     load-path)))\n"
 253          "  (require 'org-test)\n"
 254          "  (require 'org-test-ob-consts))\n\n"
 255          "\f\n"
 256          ";;; Tests\n"
 257          "(ert-deftest " name "/example-test ()\n"
 258          "  \"Just an example to get you started.\"\n"
 259          "  (should t)\n"
 260          "  (should-not nil)\n"
 261          "  (should-error (error \"errr...\")))\n\n\n"
 262          "(provide '" name ")\n\n"
 263          ";;; " file-name " ends here\n") full-path))
 264     (lambda () ((lambda (res) (if (listp res) (car res) res)) (which-function)))))
 265
 266 (define-key emacs-lisp-mode-map "\M-\C-j" 'org-test-jump)
 267
 268 \f
 269 ;;; Miscellaneous helper functions
 270 (defun org-test-strip-text-props (s)
 271   "Return S without any text properties."
 272   (let ((noprop (copy-sequence s)))
 273     (set-text-properties 0 (length noprop) nil noprop)
 274     noprop))
 275 \f
 276
 277 (defun org-test-string-exact-match (regex string &optional start)
 278   "case sensative string-match"
 279   (let ((case-fold-search nil)
 280         (case-replace nil))
 281     (if(and (equal regex "")
 282             (not(equal string "")))
 283         nil
 284       (if (equal 0 (string-match regex string start))
 285           t
 286         nil))))
 287
 288 ;;; Load and Run tests
 289 (defun org-test-load ()
 290   "Load up the org-mode test suite."
 291   (interactive)
 292   (flet ((rld (base)
 293               ;; Recursively load all files, if files throw errors
 294               ;; then silently ignore the error and continue to the
 295               ;; next file.  This allows files to error out if
 296               ;; required executables aren't available.
 297               (mapc
 298                (lambda (path)
 299                  (if (file-directory-p path)
 300                      (rld path)
 301                    (condition-case err
 302                        (when (string-match "^[A-Za-z].*\\.el$"
 303                                          (file-name-nondirectory path))
 304                          (load-file path))
 305                      (missing-test-dependency
 306                       (let ((name (intern
 307                                    (concat "org-missing-dependency/"
 308                                            (file-name-nondirectory
 309                                             (file-name-sans-extension path))))))
 310                         (eval `(ert-deftest ,name ()
 311                                  :expected-result :failed (should nil))))))))
 312                (directory-files base 'full
 313                                 "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*\\.el$"))))
 314     (rld (expand-file-name "lisp" org-test-dir))))
 315
 316 (defun org-test-current-defun ()
 317   "Test the current function."
 318   (interactive)
 319   (ert (which-function)))
 320
 321 (defun org-test-current-file ()
 322   "Run all tests for current file."
 323   (interactive)
 324   (ert (concat "test-"
 325                (file-name-sans-extension
 326                 (file-name-nondirectory (buffer-file-name)))
 327                "/")))
 328
 329 (defvar org-test-buffers nil
 330   "Hold buffers open for running Org-mode tests.")
 331
 332 (defun org-test-touch-all-examples ()
 333   (dolist (file (directory-files
 334                  org-test-example-dir 'full
 335                  "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*\\.org$"))
 336     (unless (get-file-buffer file)
 337       (add-to-list 'org-test-buffers (find-file file)))))
 338
 339 (defun org-test-kill-all-examples ()
 340   (while org-test-buffers
 341     (let ((b (pop org-test-buffers)))
 342       (when (buffer-live-p b) (kill-buffer b)))))
 343
 344 (defun org-test-update-id-locations ()
 345   (org-id-update-id-locations
 346    (directory-files
 347     org-test-example-dir 'full
 348     "^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*\\.org$")))
 349
 350 (defun org-test-run-batch-tests ()
 351   "Run all defined tests matching \"\\(org\\|ob\\)\".
 352 Load all test files first."
 353   (interactive)
 354   (let ((org-id-track-globally t)
 355         (org-id-locations-file
 356          (convert-standard-filename
 357           (expand-file-name
 358            "testing/.test-org-id-locations"
 359            org-base-dir))))
 360     (org-test-touch-all-examples)
 361     (org-test-update-id-locations)
 362     (org-test-load)
 363     (ert-run-tests-batch-and-exit "\\(org\\|ob\\)")))
 364
 365 (defun org-test-run-all-tests ()
 366   "Run all defined tests matching \"\\(org\\|ob\\)\".
 367 Load all test files first."
 368   (interactive)
 369   (org-test-touch-all-examples)
 370   (org-test-load)
 371   (ert "\\(org\\|ob\\)")
 372   (org-test-kill-all-examples))
 373
 374 (provide 'org-test)
 375
 376 ;;; org-test.el ends here