org-test.el 14 KB

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