test-ob.el 31 KB

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