test-ob.el 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053
  1. ;;; test-ob.el --- tests for ob.el
  2. ;; Copyright (c) 2010-2012 Eric Schulte
  3. ;; Authors: Eric Schulte, Martyn Jago
  4. ;; This file is not part of GNU Emacs.
  5. ;; This program is free software; you can redistribute it and/or modify
  6. ;; it under the terms of the GNU General Public License as published by
  7. ;; the Free Software Foundation, either version 3 of the License, or
  8. ;; (at your option) any later version.
  9. ;; This program is distributed in the hope that it will be useful,
  10. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. ;; GNU General Public License for more details.
  13. ;; You should have received a copy of the GNU General Public License
  14. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  15. ;;; Code:
  16. (ert-deftest test-org-babel/multi-line-header-regexp ()
  17. (should(equal "^[ \t]*#\\+headers?:[ \t]*\\([^\n]*\\)$"
  18. org-babel-multi-line-header-regexp))
  19. ;;TODO can be optimised - and what about blah4 blah5 blah6?
  20. (should (string-match
  21. org-babel-multi-line-header-regexp
  22. " \t #+headers: blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n"))
  23. (should
  24. (equal
  25. "blah1 blah2 blah3 \t"
  26. (match-string
  27. 1
  28. " \t #+headers: blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n")))
  29. ;;TODO Check - should this fail?
  30. (should
  31. (not (org-test-string-exact-match
  32. org-babel-multi-line-header-regexp
  33. " \t #+headers : blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n"))))
  34. (ert-deftest test-org-babel/src-block-regexp ()
  35. (let ((test-block
  36. (concat
  37. "#+begin_src language -n-r-a-b -c :argument-1 yes :argument-2 no\n"
  38. "echo this is a test\n"
  39. "echo Currently in ' $PWD\n"
  40. "#+end_src"))
  41. (language "language")
  42. (flags "-n-r-a-b -c ")
  43. (arguments ":argument-1 yes :argument-2 no")
  44. (body "echo this is a test\necho Currently in ' $PWD\n"))
  45. (should (string-match org-babel-src-block-regexp test-block))
  46. (should (string-match org-babel-src-block-regexp (upcase test-block)))
  47. (should (equal language (match-string 2 test-block)))
  48. ;;TODO Consider refactoring
  49. (should (equal flags (match-string 3 test-block)))
  50. (should (equal arguments (match-string 4 test-block)))
  51. (should (equal body (match-string 5 test-block)))
  52. ;;no switches
  53. (should (org-test-string-exact-match
  54. org-babel-src-block-regexp
  55. (replace-regexp-in-string flags "" test-block)))
  56. ;;no header arguments
  57. (should (org-test-string-exact-match
  58. org-babel-src-block-regexp
  59. (replace-regexp-in-string arguments "" test-block)))
  60. ;; should be valid with no body
  61. (should (org-test-string-exact-match
  62. org-babel-src-block-regexp
  63. (replace-regexp-in-string body "" test-block)))))
  64. (ert-deftest test-org-babel/get-header ()
  65. (should (not (org-babel-get-header
  66. org-babel-default-header-args :doesnt-exist)))
  67. (should(equal '((:session . "none"))
  68. (org-babel-get-header
  69. org-babel-default-header-args :session)))
  70. (should(equal '((:session . "none"))
  71. (org-babel-get-header
  72. org-babel-default-header-args :session nil)))
  73. (should (not (org-babel-get-header
  74. org-babel-default-header-args :SESSION)))
  75. (should (equal '((:tangle . "no"))
  76. (org-babel-get-header
  77. org-babel-default-header-args :tangle)))
  78. ;; with OTHERS option
  79. (should (equal org-babel-default-header-args
  80. (org-babel-get-header
  81. org-babel-default-header-args :doesnt-exist 'others)))
  82. (should (equal org-babel-default-header-args
  83. (org-babel-get-header
  84. org-babel-default-header-args nil 'others)))
  85. (should (null
  86. (assoc :noweb
  87. (org-babel-get-header
  88. org-babel-default-header-args :noweb 'others)))))
  89. (ert-deftest test-org-babel/default-inline-header-args ()
  90. (should(equal
  91. '((:session . "none") (:results . "replace") (:exports . "results"))
  92. org-babel-default-inline-header-args)))
  93. (ert-deftest ob-test/org-babel-combine-header-arg-lists ()
  94. (let ((results (org-babel-combine-header-arg-lists
  95. '((foo . :any)
  96. (bar)
  97. (baz . ((foo bar) (baz)))
  98. (qux . ((foo bar baz qux)))
  99. (quux . ((foo bar))))
  100. '((bar)
  101. (baz . ((baz)))
  102. (quux . :any)))))
  103. (dolist (pair '((foo . :any)
  104. (bar)
  105. (baz . ((baz)))
  106. (quux . :any)
  107. (qux . ((foo bar baz qux)))))
  108. (should (equal (cdr pair)
  109. (cdr (assoc (car pair) results)))))))
  110. ;;; ob-get-src-block-info
  111. (ert-deftest test-org-babel/get-src-block-info-language ()
  112. (org-test-at-marker nil org-test-file-ob-anchor
  113. (let ((info (org-babel-get-src-block-info)))
  114. (should (string= "emacs-lisp" (nth 0 info))))))
  115. (ert-deftest test-org-babel/get-src-block-info-body ()
  116. (org-test-at-marker nil org-test-file-ob-anchor
  117. (let ((info (org-babel-get-src-block-info)))
  118. (should (string-match (regexp-quote org-test-file-ob-anchor)
  119. (nth 1 info))))))
  120. (ert-deftest test-org-babel/get-src-block-info-tangle ()
  121. (org-test-at-marker nil org-test-file-ob-anchor
  122. (let ((info (org-babel-get-src-block-info)))
  123. (should (string= "no" (cdr (assoc :tangle (nth 2 info))))))))
  124. (ert-deftest test-org-babel/elisp-in-header-arguments ()
  125. "Test execution of elisp forms in header arguments."
  126. (org-test-with-temp-text-in-file "
  127. * elisp forms in header arguments
  128. :PROPERTIES:
  129. :var: prop = (* 7 6)
  130. :END:
  131. #+begin_src emacs-lisp
  132. prop
  133. #+end_src"
  134. (progn
  135. (goto-char (point-min))
  136. (org-babel-next-src-block)
  137. (let ((info (org-babel-get-src-block-info)))
  138. (should (= 42 (org-babel-execute-src-block)))))))
  139. (ert-deftest test-org-babel/simple-named-code-block ()
  140. "Test that simple named code blocks can be evaluated."
  141. (org-test-with-temp-text-in-file "
  142. #+name: i-have-a-name
  143. #+begin_src emacs-lisp
  144. 42
  145. #+end_src"
  146. (progn
  147. (org-babel-next-src-block 1)
  148. (should (= 42 (org-babel-execute-src-block))))))
  149. (ert-deftest test-org-babel/simple-variable-resolution ()
  150. "Test that simple variable resolution is working."
  151. (org-test-with-temp-text-in-file "
  152. #+name: four
  153. #+begin_src emacs-lisp
  154. (list 1 2 3 4)
  155. #+end_src
  156. #+begin_src emacs-lisp :var four=four
  157. (length four)
  158. #+end_src"
  159. (progn
  160. (org-babel-next-src-block 2)
  161. (should (= 4 (org-babel-execute-src-block)))
  162. (forward-line 5)
  163. (should (string= ": 4" (buffer-substring
  164. (point-at-bol)
  165. (point-at-eol)))))))
  166. (ert-deftest test-org-babel/multi-line-header-arguments ()
  167. "Test that multi-line header arguments and can be read."
  168. (org-test-with-temp-text-in-file "
  169. #+headers: :var letters='(a b c d e f g)
  170. #+begin_src emacs-lisp :var numbers='(1 2 3 4 5 6 7)
  171. (require 'cl)
  172. (defalias 'my-map (if (org-version-check \"24.2.50\" \"cl\" :predicate)
  173. 'cl-map
  174. 'map))
  175. (my-map 'list #'list numbers letters)
  176. #+end_src"
  177. (progn
  178. (org-babel-next-src-block)
  179. (let ((results (org-babel-execute-src-block)))
  180. (should(equal 'a (cadr (assoc 1 results))))
  181. (should(equal 'd (cadr (assoc 4 results))))))))
  182. (ert-deftest test-org-babel/parse-header-args ()
  183. (org-test-with-temp-text-in-file "
  184. #+begin_src example-lang :session :results output :var num=9
  185. the body
  186. #+end_src"
  187. (progn
  188. (org-babel-next-src-block)
  189. (let* ((info (org-babel-get-src-block-info))
  190. (params (nth 2 info)))
  191. (message "%S" params)
  192. (should(equal "example-lang" (nth 0 info)))
  193. (should(string= "the body" (org-babel-trim (nth 1 info))))
  194. (should-not (member '(:session\ \ \ \ ) params))
  195. (should(equal '(:session) (assoc :session params)))
  196. (should(equal '(:result-type . output) (assoc :result-type params)))
  197. (should(equal '(num . 9) (cdr (assoc :var params))))))))
  198. (ert-deftest test-org-babel/parse-header-args2 ()
  199. (org-test-with-temp-text-in-file "
  200. * resolving sub-trees as references
  201. #+begin_src emacs-lisp :var text=d4faa7b3-072b-4dcf-813c-dd7141c633f3
  202. (length text)
  203. #+end_src
  204. #+begin_src org :noweb yes
  205. <<simple-subtree>>
  206. <<d4faa7b3-072b-4dcf-813c-dd7141c633f3>>
  207. #+end_src
  208. ** simple subtree with custom ID
  209. :PROPERTIES:
  210. :CUSTOM_ID: simple-subtree
  211. :END:
  212. this is simple"
  213. (progn
  214. (should (string-match (regexp-quote "this is simple")
  215. (org-babel-ref-resolve "simple-subtree")))
  216. (org-babel-next-src-block)
  217. (should (= 14 (org-babel-execute-src-block))))))
  218. (ert-deftest test-org-babel/inline-src-blocks ()
  219. (org-test-at-id "54cb8dc3-298c-4883-a933-029b3c9d4b18"
  220. (macrolet ((at-next (&rest body)
  221. `(progn
  222. (move-end-of-line 1)
  223. (re-search-forward org-babel-inline-src-block-regexp nil t)
  224. (goto-char (match-beginning 1))
  225. (save-match-data ,@body))))
  226. (at-next (should (equal 1 (org-babel-execute-src-block))))
  227. (at-next (should (equal 2 (org-babel-execute-src-block))))
  228. (at-next (should (equal 3 (org-babel-execute-src-block)))))))
  229. (ert-deftest test-org-babel/org-babel-get-inline-src-block-matches ()
  230. (org-test-at-id "0D0983D4-DE33-400A-8A05-A225A567BC74"
  231. (let ((test-point (point)))
  232. (should (fboundp 'org-babel-get-inline-src-block-matches))
  233. (should (re-search-forward "src_" nil t)) ;; 1
  234. (should (org-babel-get-inline-src-block-matches))
  235. (should (re-search-forward "}" nil (point-at-bol))) ;; 1
  236. (should-not (org-babel-get-inline-src-block-matches))
  237. (should (re-search-forward "in" nil t)) ;; 2
  238. (should-not (org-babel-get-inline-src-block-matches))
  239. (should (re-search-forward "echo" nil t)) ;; 2
  240. (should (org-babel-get-inline-src-block-matches))
  241. (should (re-search-forward "blocks" nil t)) ;; 3
  242. (backward-char 8) ;; 3
  243. (should (org-babel-get-inline-src-block-matches))
  244. (forward-char 1) ;;3
  245. (should-not (org-babel-get-inline-src-block-matches))
  246. (should (re-search-forward ":results" nil t)) ;; 4
  247. (should (org-babel-get-inline-src-block-matches))
  248. (end-of-line)
  249. (should-not (org-babel-get-inline-src-block-matches)))))
  250. (ert-deftest test-org-babel/inline-src_blk-default-results-replace-line-1 ()
  251. (let ((test-line "src_sh{echo 1}"))
  252. ;; src_ at bol line 1...
  253. (org-test-with-temp-text
  254. test-line
  255. (goto-char (point-min)) (org-ctrl-c-ctrl-c)
  256. (should (string=
  257. (concat test-line " =1=")
  258. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  259. (forward-char) (org-ctrl-c-ctrl-c)
  260. (should (string=
  261. (concat test-line " =1= =1=")
  262. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  263. (re-search-forward "1}")
  264. (should-error (org-ctrl-c-ctrl-c))
  265. (backward-char) ;; last char of block body
  266. (org-ctrl-c-ctrl-c)
  267. (should (string=
  268. (concat test-line " =1= =1= =1=")
  269. (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))
  270. ;; src_ follows space line 1...
  271. (let ((test-line " src_emacs-lisp{ 1 }"))
  272. (org-test-with-temp-text
  273. test-line
  274. (should-error (org-ctrl-c-ctrl-c))
  275. (forward-char) (org-ctrl-c-ctrl-c)
  276. (should (string=
  277. (concat test-line " =1=")
  278. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  279. (re-search-forward "{ 1 ") (org-ctrl-c-ctrl-c)
  280. (should (string=
  281. (concat test-line " =1= =1=")
  282. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  283. (forward-char)
  284. (should-error (org-ctrl-c-ctrl-c)))))
  285. (ert-deftest test-org-babel/inline-src_blk-default-results-replace-line-2 ()
  286. ;; src_ at bol line 2...
  287. (let ((test-line " src_emacs-lisp{ \"x\" }"))
  288. (org-test-with-temp-text
  289. (concat "\n" test-line)
  290. (should-error (org-ctrl-c-ctrl-c))
  291. (goto-char (point-min))
  292. (should-error (org-ctrl-c-ctrl-c))
  293. (forward-line)
  294. (should-error (org-ctrl-c-ctrl-c))
  295. (forward-char) (org-ctrl-c-ctrl-c)
  296. (should (string=
  297. (concat test-line " =x=")
  298. (buffer-substring-no-properties
  299. (point-at-bol) (point-at-eol))))))
  300. (let ((test-line "Some text prior to block src_emacs-lisp{ \"y\" }"))
  301. (org-test-with-temp-text
  302. test-line
  303. (goto-char (point-max))
  304. (insert (concat "\n" test-line " end"))
  305. (re-search-backward "src") (org-ctrl-c-ctrl-c)
  306. (should (string=
  307. (concat test-line " =y= end")
  308. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  309. (re-search-forward "\" ") (org-ctrl-c-ctrl-c)
  310. (should (string=
  311. (concat test-line " =y= =y= end")
  312. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  313. (forward-char)
  314. (should-error (org-ctrl-c-ctrl-c))))))
  315. (ert-deftest test-org-babel/inline-src_blk-manual-results-replace ()
  316. (let ((test-line " src_emacs-lisp[:results replace]{ \"x\" }"))
  317. (org-test-with-temp-text
  318. (concat "\n" test-line)
  319. (should-error (org-ctrl-c-ctrl-c))
  320. (goto-char (point-max))
  321. (should-error (org-ctrl-c-ctrl-c))
  322. (beginning-of-line)
  323. (should-error (org-ctrl-c-ctrl-c))
  324. (forward-char) (org-ctrl-c-ctrl-c)
  325. (should (string=
  326. (concat test-line " =x=")
  327. (buffer-substring-no-properties
  328. (point-at-bol) (point-at-eol))))))
  329. (let ((test-line (concat " Some text prior to block "
  330. "src_emacs-lisp[:results replace]{ \"y\" }")))
  331. (org-test-with-temp-text test-line
  332. (goto-char (point-max))
  333. (insert (concat "\n" test-line " end"))
  334. (re-search-backward "src") (org-ctrl-c-ctrl-c)
  335. (should (string=
  336. (concat test-line " =y= end")
  337. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  338. (re-search-forward "\" ") (org-ctrl-c-ctrl-c)
  339. (should (string=
  340. (concat test-line " =y= =y= end")
  341. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  342. (forward-char)
  343. (should-error (org-ctrl-c-ctrl-c)))))
  344. (ert-deftest test-org-babel/inline-src_blk-results-silent ()
  345. (let ((test-line "src_emacs-lisp[ :results silent ]{ \"x\" }"))
  346. (org-test-with-temp-text test-line
  347. (org-ctrl-c-ctrl-c)
  348. (should (string= test-line
  349. (buffer-substring-no-properties
  350. (point-at-bol) (point-at-eol))))
  351. (end-of-buffer)
  352. (should-error (org-ctrl-c-ctrl-c))))
  353. (let ((test-line (concat " Some text prior to block src_emacs-lisp"
  354. "[ :results silent ]{ \"y\" }")))
  355. (org-test-with-temp-text
  356. test-line
  357. (goto-char (point-max))
  358. (insert (concat "\n" test-line " end"))
  359. (re-search-backward "src_") (org-ctrl-c-ctrl-c)
  360. (should (string= (concat test-line " end")
  361. (buffer-substring-no-properties
  362. (point-at-bol) (point-at-eol))))
  363. (re-search-forward "\" ") (org-ctrl-c-ctrl-c)
  364. (should (string= (concat test-line " end")
  365. (buffer-substring-no-properties
  366. (point-at-bol) (point-at-eol))))
  367. (forward-char)
  368. (should-error (org-ctrl-c-ctrl-c)))))
  369. (ert-deftest test-org-babel/inline-src_blk-results-raw ()
  370. (let ((test-line "src_emacs-lisp[ :results raw ]{ \"x\" }"))
  371. (org-test-with-temp-text test-line
  372. (org-ctrl-c-ctrl-c)
  373. (should (string= (concat test-line " x")
  374. (buffer-string)))))
  375. (let ((test-line (concat " Some text prior to block "
  376. "src_emacs-lisp[ :results raw ]{ \"the\" }")))
  377. (org-test-with-temp-text (concat test-line " end")
  378. (re-search-forward "src_") (org-ctrl-c-ctrl-c)
  379. (should (string= (concat test-line " the end")
  380. (buffer-substring-no-properties
  381. (point-at-bol) (point-at-eol))))
  382. (re-search-forward "\" ") (org-ctrl-c-ctrl-c)
  383. (should (string= (concat test-line " the the end")
  384. (buffer-substring-no-properties
  385. (point-at-bol) (point-at-eol))))
  386. (forward-char)
  387. (should-error (org-ctrl-c-ctrl-c)))))
  388. (ert-deftest test-org-babel/inline-src_blk-results-file ()
  389. (let ((test-line "src_emacs-lisp[ :results file ]{ \"~/test-file\" }"))
  390. (org-test-with-temp-text
  391. test-line
  392. (org-ctrl-c-ctrl-c)
  393. (should (string= (concat test-line " [[file:~/test-file]]")
  394. (buffer-substring-no-properties
  395. (point-min) (point-max)))))))
  396. (ert-deftest test-org-babel/inline-src_blk-results-scalar ()
  397. (let ((test-line "src_emacs-lisp[ :results scalar ]{ \"x\" }"))
  398. (org-test-with-temp-text
  399. test-line
  400. (org-ctrl-c-ctrl-c)
  401. (should (string= (concat test-line " =\"x\"=")
  402. (buffer-substring-no-properties
  403. (point-min) (point-max)))))))
  404. (ert-deftest test-org-babel/inline-src_blk-results-verbatim ()
  405. (let ((test-line "src_emacs-lisp[ :results verbatim ]{ \"x\" }"))
  406. (org-test-with-temp-text
  407. test-line
  408. (org-ctrl-c-ctrl-c)
  409. (should (string= (concat test-line " =\"x\"=")
  410. (buffer-substring-no-properties
  411. (point-min) (point-max)))))))
  412. (ert-deftest test-org-babel/combining-scalar-and-raw-result-types ()
  413. (org-test-with-temp-text-in-file "
  414. #+begin_src sh :results scalar
  415. echo \"[[file:./cv.cls]]\"
  416. #+end_src
  417. #+name:
  418. : [[file:./cv.cls]]
  419. #+begin_src sh :results raw scalar
  420. echo \"[[file:./cv.cls]]\"
  421. #+end_src
  422. "
  423. (flet ((next-result ()
  424. (org-babel-next-src-block)
  425. (org-babel-execute-src-block)
  426. (goto-char (org-babel-where-is-src-block-result))
  427. (forward-line 1)))
  428. (goto-char (point-min))
  429. (next-result)
  430. (should (org-babel-in-example-or-verbatim))
  431. (next-result)
  432. (should (not (org-babel-in-example-or-verbatim))))))
  433. (ert-deftest test-org-babel/no-defaut-value-for-var ()
  434. "Test that the absence of a default value for a variable DOES THROW
  435. a proper error."
  436. (org-test-at-id "f2df5ba6-75fa-4e6b-8441-65ed84963627"
  437. (org-babel-next-src-block)
  438. (let ((err
  439. (should-error (org-babel-execute-src-block) :type 'error)))
  440. (should
  441. (equal
  442. '(error
  443. "variable \"x\" in block \"carre\" must be assigned a default value")
  444. err)))))
  445. (ert-deftest test-org-babel/just-one-results-block ()
  446. "Test that evaluating two times the same code block does not result in a
  447. duplicate results block."
  448. (org-test-with-temp-text "#+begin_src sh\necho Hello\n#+end_src\n"
  449. (org-babel-execute-src-block)
  450. (org-babel-execute-src-block) ; second code block execution
  451. (should (search-forward "Hello")) ; the string inside the source code block
  452. (should (search-forward "Hello")) ; the same string in the results block
  453. (should-error (search-forward "Hello"))))
  454. (ert-deftest test-org-babel/nested-code-block ()
  455. "Test nested code blocks inside code blocks don't cause problems."
  456. (org-test-with-temp-text "#+begin_src org :results silent
  457. ,#+begin_src emacs-lisp
  458. , 'foo
  459. ,#+end_src
  460. #+end_src"
  461. (should (string= (org-babel-execute-src-block)
  462. "#+begin_src emacs-lisp\n 'foo\n#+end_src"))))
  463. (ert-deftest test-org-babel/partial-nested-code-block ()
  464. "Test nested code blocks inside code blocks don't cause problems."
  465. (org-test-with-temp-text "#+begin_src org :results silent
  466. ,#+begin_src emacs-lisp
  467. #+end_src"
  468. (should (string= "#+begin_src emacs-lisp" (org-babel-execute-src-block)))))
  469. (ert-deftest test-ob/does-not-replace-a-block-with-the-results ()
  470. (org-test-with-temp-text "#+NAME: foo
  471. #+BEGIN_SRC emacs-lisp
  472. 'foo
  473. #+END_SRC\n"
  474. (org-babel-next-src-block 1)
  475. (should (eq 'foo (org-babel-execute-src-block)))
  476. (goto-char (point-min))
  477. (org-babel-next-src-block 1)
  478. (should (looking-at org-babel-src-block-regexp))))
  479. (ert-deftest test-ob/catches-all-references ()
  480. (org-test-with-temp-text "
  481. #+NAME: literal-example
  482. #+BEGIN_EXAMPLE
  483. A literal example
  484. on two lines
  485. #+END_EXAMPLE
  486. #+NAME: read-literal-example
  487. #+BEGIN_SRC emacs-lisp :var x=literal-example
  488. (concatenate 'string x \" for me.\")
  489. #+END_SRC"
  490. (org-babel-next-src-block 1)
  491. (should (string= (org-babel-execute-src-block)
  492. "A literal example\non two lines for me."))))
  493. (ert-deftest test-ob/resolve-code-blocks-before-data-blocks ()
  494. (org-test-with-temp-text "
  495. #+name: foo
  496. : bar
  497. #+name: foo
  498. #+begin_src emacs-lisp
  499. \"baz\"
  500. #+end_src
  501. #+begin_src emacs-lisp :var foo=foo
  502. foo
  503. #+end_src"
  504. (org-babel-next-src-block 2)
  505. (should (string= (org-babel-execute-src-block) "baz"))))
  506. (ert-deftest test-ob/do-not-resolve-to-partial-names-data ()
  507. (org-test-with-temp-text "
  508. #+tblname: base_plus
  509. | 1 |
  510. | 2 |
  511. #+tblname: base
  512. | 3 |
  513. | 4 |
  514. #+begin_src emacs-lisp :var x=base
  515. x
  516. #+end_src"
  517. (org-babel-next-src-block 1)
  518. (should (equal (org-babel-execute-src-block) '((3) (4))))))
  519. (ert-deftest test-ob/do-not-resolve-to-partial-names-code ()
  520. (org-test-with-temp-text "
  521. #+name: base_plus
  522. #+begin_src emacs-lisp
  523. 'bar
  524. #+end_src
  525. #+name: base
  526. #+begin_src emacs-lisp
  527. 'foo
  528. #+end_src
  529. #+begin_src emacs-lisp :var x=base
  530. x
  531. #+end_src"
  532. (org-babel-next-src-block 3)
  533. (should (equal (org-babel-execute-src-block) "foo"))))
  534. (ert-deftest test-ob/allow-spaces-around-=-in-var-specs ()
  535. (org-test-with-temp-text "#+begin_src emacs-lisp :var a = 1 b = 2 c= 3 d =4
  536. (+ a b c d)
  537. #+end_src
  538. "
  539. (should (= 10 (org-babel-execute-src-block)))))
  540. (ert-deftest test-ob/org-babel-update-intermediate ()
  541. (org-test-with-temp-text "#+name: foo
  542. #+begin_src emacs-lisp
  543. 2
  544. #+end_src
  545. #+results: foo
  546. : 4
  547. #+begin_src emacs-lisp :var it=foo
  548. (+ it 1)
  549. #+end_src"
  550. (let ((org-babel-update-intermediate nil))
  551. (goto-char (point-min))
  552. (org-babel-next-src-block 2)
  553. (should (= 3 (org-babel-execute-src-block)))
  554. (goto-char (point-min))
  555. (forward-line 6)
  556. (should (looking-at ": 4")))
  557. (let ((org-babel-update-intermediate t))
  558. (goto-char (point-min))
  559. (org-babel-next-src-block 2)
  560. (should (= 3 (org-babel-execute-src-block)))
  561. (goto-char (point-min))
  562. (forward-line 6)
  563. (should (looking-at ": 2")))))
  564. (ert-deftest test-ob/eval-header-argument ()
  565. (flet ((check-eval (eval runp)
  566. (org-test-with-temp-text (format "#+begin_src emacs-lisp :eval %s
  567. (setq foo :evald)
  568. #+end_src" eval)
  569. (let ((foo :not-run))
  570. (if runp
  571. (progn (should (org-babel-execute-src-block))
  572. (should (eq foo :evald)))
  573. (progn (should-not (org-babel-execute-src-block))
  574. (should-not (eq foo :evald))))))))
  575. (check-eval "never" nil)
  576. (check-eval "no" nil)
  577. (check-eval "never-export" t)
  578. (check-eval "no-export" t)
  579. (let ((org-current-export-file "something"))
  580. (check-eval "never" nil)
  581. (check-eval "no" nil)
  582. (check-eval "never-export" nil)
  583. (check-eval "no-export" nil))))
  584. (ert-deftest test-ob/noweb-expansion-1 ()
  585. (org-test-with-temp-text "#+begin_src sh :results output :tangle yes
  586. <<foo>>
  587. #+end_src
  588. #+name: foo
  589. #+begin_src sh
  590. bar
  591. #+end_src"
  592. (should (string= (org-babel-expand-noweb-references) "bar"))))
  593. (ert-deftest test-ob/noweb-expansion-2 ()
  594. (org-test-with-temp-text "#+begin_src sh :results output :tangle yes
  595. <<foo>>
  596. #+end_src
  597. #+name: foo
  598. #+begin_src sh :noweb-sep \"\"
  599. bar
  600. #+end_src
  601. #+begin_src sh :noweb-ref foo :noweb-sep \"\"
  602. baz
  603. #+end_src"
  604. (should (string= (org-babel-expand-noweb-references) "barbaz"))))
  605. (ert-deftest test-ob/splitting-variable-lists-in-references ()
  606. (org-test-with-temp-text ""
  607. (should (= 1 (length (org-babel-ref-split-args
  608. "a=\"this, no work\""))))
  609. (should (= 2 (length (org-babel-ref-split-args
  610. "a=\"this, no work\", b=1"))))))
  611. (ert-deftest test-ob/org-babel-balanced-split ()
  612. (should (equal
  613. '(":a 1" "b [2 3]" "c (4 :d (5 6))")
  614. (org-babel-balanced-split ":a 1 :b [2 3] :c (4 :d (5 6))"
  615. '((32 9) . 58)))))
  616. (ert-deftest test-ob/commented-last-block-line-no-var ()
  617. (org-test-with-temp-text-in-file "
  618. #+begin_src emacs-lisp
  619. ;;
  620. #+end_src"
  621. (progn
  622. (org-babel-next-src-block)
  623. (org-ctrl-c-ctrl-c)
  624. (should (re-search-forward "\\#\\+results:" nil t))
  625. (forward-line)
  626. (should
  627. (string=
  628. ""
  629. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))
  630. (org-test-with-temp-text-in-file "
  631. #+begin_src emacs-lisp
  632. \"some text\";;
  633. #+end_src"
  634. (progn
  635. (org-babel-next-src-block)
  636. (org-ctrl-c-ctrl-c)
  637. (should (re-search-forward "\\#\\+results:" nil t))
  638. (forward-line)
  639. (should
  640. (string=
  641. ": some text"
  642. (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))))
  643. (ert-deftest test-ob/commented-last-block-line-with-var ()
  644. (org-test-with-temp-text-in-file "
  645. #+begin_src emacs-lisp :var a=1
  646. ;;
  647. #+end_src"
  648. (progn
  649. (org-babel-next-src-block)
  650. (org-ctrl-c-ctrl-c)
  651. (re-search-forward "\\#\\+results:" nil t)
  652. (forward-line)
  653. (should (string=
  654. ""
  655. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))
  656. (org-test-with-temp-text-in-file "
  657. #+begin_src emacs-lisp :var a=2
  658. 2;;
  659. #+end_src"
  660. (progn
  661. (org-babel-next-src-block)
  662. (org-ctrl-c-ctrl-c)
  663. (re-search-forward "\\#\\+results:" nil t)
  664. (forward-line)
  665. (should (string=
  666. ": 2"
  667. (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))))
  668. (defun test-ob-verify-result-and-removed-result (result buffer-text)
  669. "Test helper function to test `org-babel-remove-result'.
  670. A temp buffer is populated with BUFFER-TEXT, the first block is executed,
  671. and the result of execution is verified against RESULT.
  672. The block is actually executed /twice/ to ensure result
  673. replacement happens correctly."
  674. (org-test-with-temp-text
  675. buffer-text
  676. (progn
  677. (org-babel-next-src-block) (org-ctrl-c-ctrl-c) (org-ctrl-c-ctrl-c)
  678. (should (re-search-forward "\\#\\+results:" nil t))
  679. (forward-line)
  680. (should (string= result
  681. (buffer-substring-no-properties
  682. (point-at-bol)
  683. (- (point-max) 16))))
  684. (org-babel-previous-src-block) (org-babel-remove-result)
  685. (should (string= buffer-text
  686. (buffer-substring-no-properties
  687. (point-min) (point-max)))))))
  688. (ert-deftest test-ob/org-babel-remove-result--results-default ()
  689. "Test `org-babel-remove-result' with default :results."
  690. (mapcar (lambda (language)
  691. (test-ob-verify-result-and-removed-result
  692. "\n"
  693. (concat
  694. "* org-babel-remove-result
  695. #+begin_src " language "
  696. #+end_src
  697. * next heading")))
  698. '("sh" "emacs-lisp")))
  699. (ert-deftest test-ob/org-babel-remove-result--results-list ()
  700. "Test `org-babel-remove-result' with :results list."
  701. (test-ob-verify-result-and-removed-result
  702. "- 1
  703. - 2
  704. - 3
  705. - (quote (4 5))"
  706. "* org-babel-remove-result
  707. #+begin_src emacs-lisp :results list
  708. '(1 2 3 '(4 5))
  709. #+end_src
  710. * next heading"))
  711. (ert-deftest test-ob/org-babel-results-indented-wrap ()
  712. "Ensure that wrapped results are inserted correction when indented.
  713. If not inserted correctly then the second evaluation will fail
  714. trying to find the :END: marker."
  715. (org-test-with-temp-text
  716. "- indented
  717. #+begin_src sh :results file wrap
  718. echo test.txt
  719. #+end_src"
  720. (org-babel-next-src-block 1)
  721. (org-babel-execute-src-block)
  722. (org-babel-execute-src-block)))
  723. (ert-deftest test-ob/file-desc-header-argument ()
  724. "Test that the :file-desc header argument is used."
  725. (org-test-with-temp-text "#+begin_src emacs-lisp :results file :file-desc bar
  726. \"foo\"
  727. #+end_src
  728. #+begin_src emacs-lisp :results file :file-desc
  729. \"foo\"
  730. #+end_src"
  731. (org-babel-execute-src-block)
  732. (org-babel-next-src-block 1)
  733. (org-babel-execute-src-block)
  734. (goto-char (point-min))
  735. (should (search-forward "[[file:foo][bar]]" nil t))
  736. (should (search-forward "[[file:foo][foo]]" nil t))))
  737. (ert-deftest test-ob/org-babel-remove-result--results-pp ()
  738. "Test `org-babel-remove-result' with :results pp."
  739. (test-ob-verify-result-and-removed-result
  740. ": \"I /am/ working!\""
  741. "* org-babel-remove-result
  742. #+begin_src emacs-lisp :results pp
  743. \"I /am/ working!\")
  744. #+end_src
  745. * next heading"))
  746. (ert-deftest test-org-babel/inline-src_blk-preceded-punct-preceded-by-point ()
  747. (let ((test-line ".src_emacs-lisp[ :results verbatim ]{ \"x\" }"))
  748. (org-test-with-temp-text
  749. test-line
  750. (forward-char 1)
  751. (org-ctrl-c-ctrl-c)
  752. (should (re-search-forward "=\"x\"=" nil t))
  753. (forward-line))))
  754. (ert-deftest test-ob/commented-last-block-line-with-var ()
  755. (org-test-with-temp-text-in-file "
  756. #+begin_src emacs-lisp :var a=1
  757. ;;
  758. #+end_src"
  759. (progn
  760. (org-babel-next-src-block)
  761. (org-ctrl-c-ctrl-c)
  762. (re-search-forward "\\#\\+results:" nil t)
  763. (forward-line)
  764. (should (string=
  765. ""
  766. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))
  767. (org-test-with-temp-text-in-file "
  768. #+begin_src emacs-lisp :var a=2
  769. 2;;
  770. #+end_src"
  771. (progn
  772. (org-babel-next-src-block)
  773. (org-ctrl-c-ctrl-c)
  774. (re-search-forward "\\#\\+results:" nil t)
  775. (forward-line)
  776. (should (string=
  777. ": 2"
  778. (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))))
  779. (defun test-ob-verify-result-and-removed-result (result buffer-text)
  780. "Test helper function to test `org-babel-remove-result'.
  781. A temp buffer is populated with BUFFER-TEXT, the first block is executed,
  782. and the result of execution is verified against RESULT.
  783. The block is actually executed /twice/ to ensure result
  784. replacement happens correctly."
  785. (org-test-with-temp-text
  786. buffer-text
  787. (progn
  788. (org-babel-next-src-block) (org-ctrl-c-ctrl-c) (org-ctrl-c-ctrl-c)
  789. (should (re-search-forward "\\#\\+results:" nil t))
  790. (forward-line)
  791. (should (string= result
  792. (buffer-substring-no-properties
  793. (point-at-bol)
  794. (- (point-max) 16))))
  795. (org-babel-previous-src-block) (org-babel-remove-result)
  796. (should (string= buffer-text
  797. (buffer-substring-no-properties
  798. (point-min) (point-max)))))))
  799. (ert-deftest test-ob/org-babel-remove-result--results-default ()
  800. "Test `org-babel-remove-result' with default :results."
  801. (mapcar (lambda (language)
  802. (test-ob-verify-result-and-removed-result
  803. "\n"
  804. (concat
  805. "* org-babel-remove-result
  806. #+begin_src " language "
  807. #+end_src
  808. * next heading")))
  809. '("sh" "emacs-lisp")))
  810. (ert-deftest test-ob/org-babel-remove-result--results-list ()
  811. "Test `org-babel-remove-result' with :results list."
  812. (test-ob-verify-result-and-removed-result
  813. "- 1
  814. - 2
  815. - 3
  816. - (quote (4 5))"
  817. "* org-babel-remove-result
  818. #+begin_src emacs-lisp :results list
  819. '(1 2 3 '(4 5))
  820. #+end_src
  821. * next heading"))
  822. (ert-deftest test-ob/org-babel-remove-result--results-wrap ()
  823. "Test `org-babel-remove-result' with :results wrap."
  824. (test-ob-verify-result-and-removed-result
  825. ":RESULTS:
  826. hello there
  827. :END:"
  828. "* org-babel-remove-result
  829. #+begin_src emacs-lisp :results wrap
  830. \"hello there\"
  831. #+end_src
  832. * next heading"))
  833. (ert-deftest test-ob/org-babel-remove-result--results-org ()
  834. "Test `org-babel-remove-result' with :results org."
  835. (test-ob-verify-result-and-removed-result
  836. "#+BEGIN_SRC org
  837. ,* heading
  838. ,** subheading
  839. content
  840. #+END_SRC"
  841. "* org-babel-remove-result
  842. #+begin_src emacs-lisp :results org
  843. \"* heading
  844. ** subheading
  845. content\"
  846. #+end_src
  847. * next heading"))
  848. (ert-deftest test-ob/org-babel-remove-result--results-html ()
  849. "Test `org-babel-remove-result' with :results html."
  850. (test-ob-verify-result-and-removed-result
  851. "#+BEGIN_HTML
  852. <head><body></body></head>
  853. #+END_HTML"
  854. "* org-babel-remove-result
  855. #+begin_src emacs-lisp :results html
  856. \"<head><body></body></head>\"
  857. #+end_src
  858. * next heading"))
  859. (ert-deftest test-ob/org-babel-remove-result--results-latex ()
  860. "Test `org-babel-remove-result' with :results latex."
  861. (test-ob-verify-result-and-removed-result
  862. "#+BEGIN_LaTeX
  863. Line 1
  864. Line 2
  865. Line 3
  866. #+END_LaTeX"
  867. "* org-babel-remove-result
  868. #+begin_src emacs-lisp :results latex
  869. \"Line 1
  870. Line 2
  871. Line 3\"
  872. #+end_src
  873. * next heading"))
  874. (ert-deftest test-ob/org-babel-remove-result--results-code ()
  875. "Test `org-babel-remove-result' with :results code."
  876. (test-ob-verify-result-and-removed-result
  877. "#+BEGIN_SRC emacs-lisp
  878. \"I am working!\"
  879. #+END_SRC"
  880. "* org-babel-remove-result
  881. #+begin_src emacs-lisp :results code
  882. (message \"I am working!\")
  883. #+end_src
  884. * next heading"))
  885. (ert-deftest test-ob/org-babel-remove-result--results-pp ()
  886. "Test `org-babel-remove-result' with :results pp."
  887. (test-ob-verify-result-and-removed-result
  888. ": \"I /am/ working!\""
  889. "* org-babel-remove-result
  890. #+begin_src emacs-lisp :results pp
  891. \"I /am/ working!\")
  892. #+end_src
  893. * next heading"))
  894. (ert-deftest test-ob/results-do-not-replace-code-blocks ()
  895. (org-test-with-temp-text "Block two has a space after the name.
  896. #+name: foo
  897. #+begin_src emacs-lisp
  898. 1
  899. #+end_src emacs-lisp
  900. #+name: foo
  901. #+begin_src emacs-lisp
  902. 2
  903. #+end_src
  904. #+name: foo
  905. #+begin_src emacs-lisp
  906. 3
  907. #+end_src
  908. #+RESULTS: foo
  909. : foo
  910. "
  911. (dolist (num '(1 2 3))
  912. ;; execute the block
  913. (goto-char (point-min))
  914. (org-babel-next-src-block num) (org-babel-execute-src-block)
  915. ;; check the results
  916. (goto-char (point-max))
  917. (move-beginning-of-line 0)
  918. (should (looking-at (format ": %d" num))))))
  919. (provide 'test-ob)
  920. ;;; test-ob ends here