test-ob.el 31 KB

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