test-ob.el 63 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084
  1. ;;; test-ob.el --- tests for ob.el
  2. ;; Copyright (c) 2010-2015, 2019 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. (eval-and-compile (require 'cl-lib))
  17. (ert-deftest test-ob/indented-cached-org-bracket-link ()
  18. "When the result of a source block is a cached indented link it
  19. should still return the link."
  20. (should
  21. (let ((default-directory temporary-file-directory))
  22. (org-test-with-temp-text
  23. "
  24. * Test
  25. #+<point>BEGIN_SRC emacs-lisp :results file :file test.txt :cache yes
  26. (message \"test\")
  27. #+END_SRC"
  28. ;; Execute twice as the first time creates the cache.
  29. (org-babel-execute-src-block)
  30. (string= (expand-file-name "test.txt")
  31. (org-babel-execute-src-block))))))
  32. (ert-deftest test-ob/multi-line-header-regexp ()
  33. (should(equal "^[ \t]*#\\+headers?:[ \t]*\\([^\n]*\\)$"
  34. org-babel-multi-line-header-regexp))
  35. ;;TODO can be optimised - and what about blah4 blah5 blah6?
  36. (should (string-match
  37. org-babel-multi-line-header-regexp
  38. " \t #+headers: blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n"))
  39. (should
  40. (equal
  41. "blah1 blah2 blah3 \t"
  42. (match-string
  43. 1
  44. " \t #+headers: blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n")))
  45. ;;TODO Check - should this fail?
  46. (should
  47. (not (org-test-string-exact-match
  48. org-babel-multi-line-header-regexp
  49. " \t #+headers : blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n"))))
  50. (ert-deftest test-ob/src-block-regexp ()
  51. (let ((test-block
  52. (concat
  53. "#+begin_src language -n-r-a-b -c :argument-1 yes :argument-2 no\n"
  54. "echo this is a test\n"
  55. "echo Currently in ' $PWD\n"
  56. "#+end_src"))
  57. (language "language")
  58. (flags "-n-r-a-b -c ")
  59. (arguments ":argument-1 yes :argument-2 no")
  60. (body "echo this is a test\necho Currently in ' $PWD\n"))
  61. (should (string-match org-babel-src-block-regexp test-block))
  62. (should (string-match org-babel-src-block-regexp (upcase test-block)))
  63. (should (equal language (match-string 2 test-block)))
  64. ;;TODO Consider refactoring
  65. (should (equal flags (match-string 3 test-block)))
  66. (should (equal arguments (match-string 4 test-block)))
  67. (should (equal body (match-string 5 test-block)))
  68. ;;no switches
  69. (should (org-test-string-exact-match
  70. org-babel-src-block-regexp
  71. (replace-regexp-in-string flags "" test-block)))
  72. ;;no header arguments
  73. (should (org-test-string-exact-match
  74. org-babel-src-block-regexp
  75. (replace-regexp-in-string arguments "" test-block)))
  76. ;; should be valid with no body
  77. (should (org-test-string-exact-match
  78. org-babel-src-block-regexp
  79. (replace-regexp-in-string body "" test-block)))))
  80. (ert-deftest test-ob/default-inline-header-args ()
  81. (should(equal
  82. '((:session . "none")
  83. (:results . "replace")
  84. (:exports . "results")
  85. (:hlines . "yes"))
  86. org-babel-default-inline-header-args)))
  87. (ert-deftest ob-test/org-babel-combine-header-arg-lists ()
  88. (let ((results (org-babel-combine-header-arg-lists
  89. '((foo . :any)
  90. (bar)
  91. (baz . ((foo bar) (baz)))
  92. (qux . ((foo bar baz qux)))
  93. (quux . ((foo bar))))
  94. '((bar)
  95. (baz . ((baz)))
  96. (quux . :any)))))
  97. (dolist (pair '((foo . :any)
  98. (bar)
  99. (baz . ((baz)))
  100. (quux . :any)
  101. (qux . ((foo bar baz qux)))))
  102. (should (equal (cdr pair)
  103. (cdr (assoc (car pair) results)))))))
  104. ;;; ob-get-src-block-info
  105. (ert-deftest test-ob/get-src-block-info-language ()
  106. (org-test-at-marker nil org-test-file-ob-anchor
  107. (let ((info (org-babel-get-src-block-info)))
  108. (should (string= "emacs-lisp" (nth 0 info))))))
  109. (ert-deftest test-ob/get-src-block-info-body ()
  110. (org-test-at-marker nil org-test-file-ob-anchor
  111. (let ((info (org-babel-get-src-block-info)))
  112. (should (string-match (regexp-quote org-test-file-ob-anchor)
  113. (nth 1 info))))))
  114. (ert-deftest test-ob/get-src-block-info-tangle ()
  115. (org-test-at-marker nil org-test-file-ob-anchor
  116. (let ((info (org-babel-get-src-block-info)))
  117. (should (string= "no" (cdr (assq :tangle (nth 2 info))))))))
  118. (ert-deftest test-ob/elisp-in-header-arguments ()
  119. "Test execution of elisp forms in header arguments."
  120. (org-test-with-temp-text-in-file "
  121. * elisp forms in header arguments
  122. :PROPERTIES:
  123. :header-args: :var prop = (* 7 6)
  124. :END:
  125. #+begin_src emacs-lisp
  126. prop
  127. #+end_src"
  128. (goto-char (point-min))
  129. (org-babel-next-src-block)
  130. (should (= 42 (org-babel-execute-src-block)))))
  131. (ert-deftest test-ob/simple-named-code-block ()
  132. "Test that simple named code blocks can be evaluated."
  133. (org-test-with-temp-text-in-file "
  134. #+name: i-have-a-name
  135. #+begin_src emacs-lisp
  136. 42
  137. #+end_src"
  138. (org-babel-next-src-block 1)
  139. (should (= 42 (org-babel-execute-src-block)))))
  140. (ert-deftest test-ob/simple-variable-resolution ()
  141. "Test that simple variable resolution is working."
  142. (org-test-with-temp-text-in-file "
  143. #+name: four
  144. #+begin_src emacs-lisp
  145. (list 1 2 3 4)
  146. #+end_src
  147. #+begin_src emacs-lisp :var four=four
  148. (length four)
  149. #+end_src"
  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-ob/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-lib)
  162. (cl-map 'list #'list numbers letters)
  163. #+end_src"
  164. (org-babel-next-src-block)
  165. (let ((results (org-babel-execute-src-block)))
  166. (should (eq 'a (cadr (assoc 1 results))))
  167. (should (eq 'd (cadr (assoc 4 results)))))))
  168. (ert-deftest test-ob/parse-header-args ()
  169. (org-test-with-temp-text-in-file "
  170. #+begin_src example-lang :session :results output :var num=9
  171. the body
  172. #+end_src"
  173. (org-babel-next-src-block)
  174. (let* ((info (org-babel-get-src-block-info))
  175. (params (nth 2 info)))
  176. (message "%S" params)
  177. (should (equal "example-lang" (nth 0 info)))
  178. (should (string= "the body" (org-trim (nth 1 info))))
  179. (should-not (member '(:session\ \ \ \ ) params))
  180. (should (equal '(:session) (assq :session params)))
  181. (should (equal '(:result-type . output) (assq :result-type params)))
  182. (should (equal '(num . 9) (cdr (assq :var params)))))))
  183. (ert-deftest test-ob/parse-header-args2 ()
  184. (org-test-with-temp-text-in-file "
  185. * resolving sub-trees as references
  186. #+begin_src emacs-lisp :var text=d4faa7b3-072b-4dcf-813c-dd7141c633f3
  187. (length text)
  188. #+end_src
  189. #+begin_src org :noweb yes
  190. <<simple-subtree>>
  191. <<d4faa7b3-072b-4dcf-813c-dd7141c633f3>>
  192. #+end_src
  193. ** simple subtree with custom ID
  194. :PROPERTIES:
  195. :CUSTOM_ID: simple-subtree
  196. :END:
  197. this is simple"
  198. (should (string-match (regexp-quote "this is simple")
  199. (org-babel-ref-resolve "simple-subtree")))
  200. (org-babel-next-src-block)
  201. (should (= 14 (org-babel-execute-src-block)))))
  202. (ert-deftest test-ob/inline-src-blocks ()
  203. (should
  204. (= 1
  205. (org-test-with-temp-text
  206. "In the middle <point>src_emacs-lisp{(+ 0 1)} of a line"
  207. (org-babel-execute-src-block))))
  208. (should
  209. (= 2
  210. (org-test-with-temp-text
  211. "One at the end of a line: <point>src_emacs-lisp{(+ 1 1)}"
  212. (org-babel-execute-src-block))))
  213. (should
  214. (= 3
  215. (org-test-with-temp-text
  216. "src_emacs-lisp{(+ 2 1)} at the beginning of a line."
  217. (org-babel-execute-src-block))))
  218. (should
  219. (= 4
  220. (org-test-with-temp-text
  221. "In the middle <point>src_emacs-lisp[:results silent\
  222. :exports code]{(+ 3 1)} of a line"
  223. (org-babel-execute-src-block))))
  224. (should
  225. (= 5
  226. (org-test-with-temp-text
  227. "One at the end of a line: <point>src_emacs-lisp[:results silent\
  228. :exports code]{(+ 4 1)}"
  229. (org-babel-execute-src-block))))
  230. (should
  231. (= 6
  232. (org-test-with-temp-text
  233. "src_emacs-lisp[:results silent :exports code]{(+ 5 1)}\
  234. at the beginning of a line."
  235. (org-babel-execute-src-block))))
  236. (should
  237. (= 7
  238. (org-test-with-temp-text
  239. "One also evaluated: <point>src_emacs-lisp[:exports both\
  240. :results silent]{(+ 6 1)}"
  241. (org-babel-execute-src-block)))))
  242. (ert-deftest test-ob/inline-src_blk-default-results-replace-line-1 ()
  243. (let ((test-line "src_sh{echo 1}")
  244. (org-babel-inline-result-wrap "=%s="))
  245. ;; src_ at bol line 1...
  246. (org-test-with-temp-text
  247. test-line
  248. (goto-char (point-min)) (org-babel-execute-maybe)
  249. (should (string=
  250. (concat test-line " {{{results(=1=)}}}")
  251. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  252. (forward-char) (org-babel-execute-maybe)
  253. (should (string=
  254. (concat test-line " {{{results(=1=)}}}")
  255. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  256. (re-search-forward "{{{")
  257. ;;(should-error (org-ctrl-c-ctrl-c))
  258. (backward-char 4) ;; last char of block body
  259. (org-babel-execute-maybe)
  260. (should (string=
  261. (concat test-line " {{{results(=1=)}}}")
  262. (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))
  263. ;; src_ follows space line 1...
  264. (let ((test-line " src_emacs-lisp{ 1 }"))
  265. (org-test-with-temp-text
  266. test-line
  267. (should-error (org-ctrl-c-ctrl-c))
  268. (forward-char) (org-babel-execute-maybe)
  269. (should (string=
  270. (concat test-line " {{{results(=1=)}}}")
  271. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  272. (re-search-forward "{ 1 ") (org-babel-execute-maybe)
  273. (should (string=
  274. (concat test-line " {{{results(=1=)}}}")
  275. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  276. (forward-char 6)
  277. (should-error (org-ctrl-c-ctrl-c))))
  278. ;; Results on a subsequent line are replaced.
  279. (should
  280. (equal
  281. "src_emacs-lisp{(+ 1 2)}\n {{{results(=3=)}}}"
  282. (org-test-with-temp-text "src_emacs-lisp{(+ 1 2)}\n {{{results(=2=)}}}"
  283. (let ((org-babel-inline-result-wrap "=%s=")) (org-babel-execute-maybe))
  284. (buffer-string))))
  285. ;; Also handle results at the beginning of a line.
  286. (should
  287. (equal
  288. "src_emacs-lisp{(+ 1 2)}\n{{{results(=3=)}}}"
  289. (org-test-with-temp-text "src_emacs-lisp{(+ 1 2)}\n{{{results(=2=)}}}"
  290. (let ((org-babel-inline-result-wrap "=%s=")) (org-babel-execute-maybe))
  291. (buffer-string))))))
  292. (ert-deftest test-ob/inline-src_blk-default-results-replace-line-2 ()
  293. ;; src_ at bol line 2...
  294. (let ((test-line " src_emacs-lisp{ \"x\" }")
  295. (org-babel-inline-result-wrap "=%s="))
  296. (org-test-with-temp-text
  297. (concat "\n" test-line)
  298. (should-error (org-ctrl-c-ctrl-c))
  299. (goto-char (point-min))
  300. (should-error (org-ctrl-c-ctrl-c))
  301. (forward-line)
  302. (should-error (org-ctrl-c-ctrl-c))
  303. (forward-char) (org-babel-execute-maybe)
  304. (should (string=
  305. (concat test-line " {{{results(=x=)}}}")
  306. (buffer-substring-no-properties
  307. (point-at-bol) (point-at-eol))))))
  308. (let ((test-line "Some text prior to block src_emacs-lisp{ \"y\" }")
  309. (org-babel-inline-result-wrap "=%s="))
  310. (org-test-with-temp-text
  311. test-line
  312. (goto-char (point-max))
  313. (insert (concat "\n" test-line " end"))
  314. (re-search-backward "src") (org-babel-execute-maybe)
  315. (should (string=
  316. (concat test-line " {{{results(=y=)}}} end")
  317. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  318. (re-search-forward "\" ") (org-babel-execute-maybe)
  319. (should (string=
  320. (concat test-line " {{{results(=y=)}}} end")
  321. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  322. (forward-char 3)
  323. (should-error (org-ctrl-c-ctrl-c)))))
  324. (ert-deftest test-ob/inline-src_blk-manual-results-replace ()
  325. (let ((test-line " src_emacs-lisp[:results replace]{ \"x\" }")
  326. (org-babel-inline-result-wrap "=%s="))
  327. (org-test-with-temp-text
  328. (concat "\n" test-line)
  329. (should-error (org-ctrl-c-ctrl-c))
  330. (goto-char (point-max))
  331. (org-babel-execute-maybe)
  332. (beginning-of-line)
  333. (should-error (org-ctrl-c-ctrl-c))
  334. (forward-char) (org-babel-execute-maybe)
  335. (should (string=
  336. (concat test-line " {{{results(=x=)}}}")
  337. (buffer-substring-no-properties
  338. (point-at-bol) (point-at-eol))))))
  339. (let ((test-line (concat " Some text prior to block "
  340. "src_emacs-lisp[:results replace]{ \"y\" }"))
  341. (org-babel-inline-result-wrap "=%s="))
  342. (org-test-with-temp-text test-line
  343. (goto-char (point-max))
  344. (insert (concat "\n" test-line " end"))
  345. (re-search-backward "src") (org-babel-execute-maybe)
  346. (should (string=
  347. (concat test-line " {{{results(=y=)}}} end")
  348. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  349. (re-search-forward "\" ") (org-babel-execute-maybe)
  350. (should (string=
  351. (concat test-line " {{{results(=y=)}}} end")
  352. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
  353. (forward-char 3)
  354. (should-error (org-ctrl-c-ctrl-c)))))
  355. (ert-deftest test-ob/inline-src_blk-results-silent ()
  356. (let ((test-line "src_emacs-lisp[ :results silent ]{ \"x\" }"))
  357. (org-test-with-temp-text test-line
  358. (org-babel-execute-maybe)
  359. (should (string= test-line
  360. (buffer-substring-no-properties
  361. (point-at-bol) (point-at-eol))))))
  362. (let ((test-line (concat " Some text prior to block src_emacs-lisp"
  363. "[ :results silent ]{ \"y\" }")))
  364. (org-test-with-temp-text
  365. test-line
  366. (goto-char (point-max))
  367. (insert (concat "\n" test-line " end"))
  368. (re-search-backward "src_") (org-babel-execute-maybe)
  369. (should (string= (concat test-line " end")
  370. (buffer-substring-no-properties
  371. (point-at-bol) (point-at-eol))))
  372. (re-search-forward "\" ") (org-babel-execute-maybe)
  373. (should (string= (concat test-line " end")
  374. (buffer-substring-no-properties
  375. (point-at-bol) (point-at-eol))))
  376. (forward-char 2)
  377. (should-error (org-ctrl-c-ctrl-c)))))
  378. (ert-deftest test-ob/inline-src_blk-results-raw ()
  379. (let ((test-line "src_emacs-lisp[ :results raw ]{ \"x\" }"))
  380. (org-test-with-temp-text test-line
  381. (org-babel-execute-maybe)
  382. (should (string= (concat test-line " x")
  383. (buffer-string)))))
  384. (let ((test-line (concat " Some text prior to block "
  385. "src_emacs-lisp[ :results raw ]{ \"the\" }")))
  386. (org-test-with-temp-text (concat test-line " end")
  387. (re-search-forward "src_") (org-babel-execute-maybe)
  388. (should (string= (concat test-line " the end")
  389. (buffer-substring-no-properties
  390. (point-at-bol) (point-at-eol))))
  391. (re-search-forward "\" ") (org-babel-execute-maybe)
  392. (should (string= (concat test-line " the the end")
  393. (buffer-substring-no-properties
  394. (point-at-bol) (point-at-eol))))
  395. (forward-char 2)
  396. (should-error (org-ctrl-c-ctrl-c)))))
  397. (ert-deftest test-ob/inline-src_blk-results-file ()
  398. (let ((test-line "src_emacs-lisp[ :results file ]{ \"~/test-file\" }"))
  399. (org-test-with-temp-text
  400. test-line
  401. (org-babel-execute-maybe)
  402. (should (string= (concat test-line " {{{results([[file:~/test-file]])}}}")
  403. (buffer-substring-no-properties
  404. (point-min) (point-max)))))))
  405. (ert-deftest test-ob/inline-src_blk-results-scalar ()
  406. (let ((test-line "src_emacs-lisp[ :results scalar ]{ \"x\" }")
  407. (org-babel-inline-result-wrap "=%s="))
  408. (org-test-with-temp-text
  409. test-line
  410. (org-babel-execute-maybe)
  411. (should (string= (concat test-line " {{{results(=\"x\"=)}}}")
  412. (buffer-substring-no-properties
  413. (point-min) (point-max)))))))
  414. (ert-deftest test-ob/inline-src_blk-results-verbatim ()
  415. (let ((test-line "src_emacs-lisp[ :results verbatim ]{ \"x\" }")
  416. (org-babel-inline-result-wrap "=%s="))
  417. (org-test-with-temp-text
  418. test-line
  419. (org-babel-execute-maybe)
  420. (should (string= (concat test-line " {{{results(=\"x\"=)}}}")
  421. (buffer-substring-no-properties
  422. (point-min) (point-max)))))))
  423. (ert-deftest test-ob/combining-scalar-and-raw-result-types ()
  424. (org-test-with-temp-text-in-file "
  425. #+begin_src sh :results scalar
  426. echo \"[[file:./cv.cls]]\"
  427. #+end_src
  428. #+name:
  429. : [[file:./cv.cls]]
  430. #+begin_src sh :results raw scalar
  431. echo \"[[file:./cv.cls]]\"
  432. #+end_src
  433. "
  434. (cl-flet ((next-result ()
  435. (org-babel-next-src-block)
  436. (org-babel-execute-src-block)
  437. (goto-char (org-babel-where-is-src-block-result))
  438. (forward-line 1)))
  439. (goto-char (point-min))
  440. (next-result)
  441. (should (eq (org-element-type (org-element-at-point)) 'fixed-width))
  442. (next-result)
  443. (should-not
  444. (eq (org-element-type (org-element-at-point)) 'fixed-width)))))
  445. (ert-deftest test-ob/no-defaut-value-for-var ()
  446. "Test that the absence of a default value for a variable DOES THROW
  447. a proper error."
  448. (org-test-at-id "f2df5ba6-75fa-4e6b-8441-65ed84963627"
  449. (org-babel-next-src-block)
  450. (let ((err
  451. (should-error (org-babel-execute-src-block) :type 'error)))
  452. (should
  453. (equal
  454. '(error
  455. "Variable \"x\" must be assigned a default value")
  456. err)))))
  457. (ert-deftest test-ob/just-one-results-block ()
  458. "Test that evaluating two times the same code block does not result in a
  459. duplicate results block."
  460. (org-test-with-temp-text "#+begin_src sh\necho Hello\n#+end_src\n"
  461. (org-babel-execute-src-block)
  462. (org-babel-execute-src-block) ; second code block execution
  463. (should (search-forward "Hello")) ; the string inside the source code block
  464. (should (search-forward "Hello")) ; the same string in the results block
  465. (should-error (search-forward "Hello"))))
  466. (ert-deftest test-ob/nested-code-block ()
  467. "Test nested code blocks inside code blocks don't cause problems."
  468. (should
  469. (string= "#+begin_src emacs-lisp\n 'foo\n#+end_src"
  470. (org-test-with-temp-text "#+begin_src org :results silent
  471. ,#+begin_src emacs-lisp
  472. 'foo
  473. ,#+end_src
  474. #+end_src"
  475. (let ((org-edit-src-content-indentation 2)
  476. (org-src-preserve-indentation nil))
  477. (org-babel-execute-src-block))))))
  478. (ert-deftest test-ob/partial-nested-code-block ()
  479. "Test nested code blocks inside code blocks don't cause problems."
  480. (org-test-with-temp-text "#+begin_src org :results silent
  481. ,#+begin_src emacs-lisp
  482. #+end_src"
  483. (should (string= "#+begin_src emacs-lisp" (org-babel-execute-src-block)))))
  484. (ert-deftest test-ob/does-not-replace-a-block-with-the-results ()
  485. (org-test-with-temp-text "#+NAME: foo
  486. #+BEGIN_SRC emacs-lisp
  487. 'foo
  488. #+END_SRC\n"
  489. (org-babel-next-src-block 1)
  490. (should (eq 'foo (org-babel-execute-src-block)))
  491. (goto-char (point-min))
  492. (org-babel-next-src-block 1)
  493. (should (looking-at org-babel-src-block-regexp))))
  494. (ert-deftest test-ob/catches-all-references ()
  495. (org-test-with-temp-text "
  496. #+NAME: literal-example
  497. #+BEGIN_EXAMPLE
  498. A literal example
  499. on two lines
  500. #+END_EXAMPLE
  501. #+NAME: read-literal-example
  502. #+BEGIN_SRC emacs-lisp :var x=literal-example
  503. (cl-concatenate 'string x \" for me.\")
  504. #+END_SRC"
  505. (org-babel-next-src-block 1)
  506. (should (string= (org-babel-execute-src-block)
  507. "A literal example\non two lines\n for me."))))
  508. (ert-deftest test-ob/ignore-reference-in-commented-headings ()
  509. (should
  510. (= 2
  511. (org-test-with-temp-text
  512. "
  513. * COMMENT H1
  514. #+NAME: n
  515. : 1
  516. * H2
  517. #+NAME: n
  518. : 2
  519. * Code
  520. <point>#+BEGIN_SRC emacs-lisp :var x=n
  521. x
  522. #+END_SRC"
  523. (org-babel-execute-src-block)))))
  524. (ert-deftest test-ob/do-not-resolve-to-partial-names-data ()
  525. (org-test-with-temp-text "
  526. #+name: base_plus
  527. | 1 |
  528. | 2 |
  529. #+name: base
  530. | 3 |
  531. | 4 |
  532. #+begin_src emacs-lisp :var x=base
  533. x
  534. #+end_src"
  535. (org-babel-next-src-block 1)
  536. (should (equal (org-babel-execute-src-block) '((3) (4))))))
  537. (ert-deftest test-ob/do-not-resolve-to-partial-names-code ()
  538. (org-test-with-temp-text "
  539. #+name: base_plus
  540. #+begin_src emacs-lisp
  541. 'bar
  542. #+end_src
  543. #+name: base
  544. #+begin_src emacs-lisp
  545. 'foo
  546. #+end_src
  547. #+begin_src emacs-lisp :var x=base
  548. x
  549. #+end_src"
  550. (org-babel-next-src-block 3)
  551. (should (equal (org-babel-execute-src-block) "foo"))))
  552. (ert-deftest test-ob/allow-spaces-around-=-in-var-specs ()
  553. (org-test-with-temp-text "#+begin_src emacs-lisp :var a = 1 b = 2 c= 3 d =4
  554. (+ a b c d)
  555. #+end_src
  556. "
  557. (should (= 10 (org-babel-execute-src-block)))))
  558. (ert-deftest test-ob/org-babel-update-intermediate ()
  559. (org-test-with-temp-text "#+name: foo
  560. #+begin_src emacs-lisp
  561. 2
  562. #+end_src
  563. #+results: foo
  564. : 4
  565. #+begin_src emacs-lisp :var it=foo
  566. (+ it 1)
  567. #+end_src"
  568. (let ((org-babel-update-intermediate nil))
  569. (goto-char (point-min))
  570. (org-babel-next-src-block 2)
  571. (should (= 3 (org-babel-execute-src-block)))
  572. (goto-char (point-min))
  573. (forward-line 6)
  574. (should (looking-at ": 4")))
  575. (let ((org-babel-update-intermediate t))
  576. (goto-char (point-min))
  577. (org-babel-next-src-block 2)
  578. (should (= 3 (org-babel-execute-src-block)))
  579. (goto-char (point-min))
  580. (forward-line 6)
  581. (should (looking-at ": 2")))))
  582. (ert-deftest test-ob/eval-header-argument ()
  583. (cl-flet ((check-eval (eval runp)
  584. (org-test-with-temp-text (format "#+begin_src emacs-lisp :eval %s
  585. (setq foo :evald)
  586. #+end_src" eval)
  587. (let ((foo :not-run))
  588. (if runp
  589. (progn (should (org-babel-execute-src-block))
  590. (should (eq foo :evald)))
  591. (progn (should-not (org-babel-execute-src-block))
  592. (should-not (eq foo :evald))))))))
  593. (check-eval "never" nil)
  594. (check-eval "no" nil)
  595. (check-eval "never-export" t)
  596. (check-eval "no-export" t)
  597. (let ((org-babel-exp-reference-buffer (current-buffer)))
  598. (check-eval "never" nil)
  599. (check-eval "no" nil)
  600. (check-eval "never-export" nil)
  601. (check-eval "no-export" nil))))
  602. (ert-deftest test-ob/noweb-expansion ()
  603. ;; Standard test.
  604. (should
  605. (string=
  606. "bar"
  607. (org-test-with-temp-text "#+begin_src sh :results output :tangle yes
  608. <<foo>>
  609. #+end_src
  610. #+name: foo
  611. #+begin_src sh
  612. bar
  613. #+end_src"
  614. (org-babel-expand-noweb-references))))
  615. ;; Handle :noweb-sep.
  616. (should
  617. (string=
  618. "barbaz"
  619. (org-test-with-temp-text "#+begin_src sh :results output :tangle yes
  620. <<foo>>
  621. #+end_src
  622. #+begin_src sh :noweb-ref foo :noweb-sep \"\"
  623. bar
  624. #+end_src
  625. #+begin_src sh :noweb-ref foo :noweb-sep \"\"
  626. baz
  627. #+end_src"
  628. (org-babel-expand-noweb-references))))
  629. ;; :noweb-ref is extracted from definition, not point of call.
  630. (should
  631. (string=
  632. "(+ 1 1)"
  633. (org-test-with-temp-text
  634. "
  635. * Call
  636. :PROPERTIES:
  637. :header-args: :noweb-ref bar
  638. :END:
  639. <point>#+begin_src emacs-lisp :results output :tangle yes
  640. <<foo>>
  641. #+end_src
  642. * Evaluation
  643. :PROPERTIES:
  644. :header-args: :noweb-ref foo
  645. :END:
  646. #+begin_src sh :noweb-sep \"\"
  647. (+ 1 1)
  648. #+end_src"
  649. (org-babel-expand-noweb-references))))
  650. ;; Handle recursive expansion.
  651. (should
  652. (equal "baz"
  653. (org-test-with-temp-text "
  654. #+begin_src emacs-lisp :noweb yes<point>
  655. <<foo>>
  656. #+end_src
  657. #+name: foo
  658. #+begin_src emacs-lisp :noweb yes
  659. <<bar>>
  660. #+end_src
  661. #+name: bar
  662. #+begin_src emacs-lisp
  663. baz
  664. #+end_src"
  665. (org-babel-expand-noweb-references))))
  666. ;; During recursive expansion, obey to `:noweb' property.
  667. (should
  668. (equal "<<bar>>"
  669. (org-test-with-temp-text "
  670. #+begin_src emacs-lisp :noweb yes<point>
  671. <<foo>>
  672. #+end_src
  673. #+name: foo
  674. #+begin_src emacs-lisp :noweb no
  675. <<bar>>
  676. #+end_src
  677. #+name: bar
  678. #+begin_src emacs-lisp
  679. baz
  680. #+end_src"
  681. (org-babel-expand-noweb-references)))))
  682. (ert-deftest test-ob/splitting-variable-lists-in-references ()
  683. (org-test-with-temp-text ""
  684. (should (= 1 (length (org-babel-ref-split-args
  685. "a=\"this, no work\""))))
  686. (should (= 2 (length (org-babel-ref-split-args
  687. "a=\"this, no work\", b=1"))))))
  688. (ert-deftest test-ob/balanced-split ()
  689. "Test `org-babel-balanced-split' specifications."
  690. (should (equal
  691. '(":a 1" "b [2 3]" "c (4 :d (5 6))")
  692. (org-babel-balanced-split ":a 1 :b [2 3] :c (4 :d (5 6))"
  693. '((32 9) . 58))))
  694. ;; Handle un-balanced parens.
  695. (should
  696. (equal '(":foo ((6)" "bar 1")
  697. (org-babel-balanced-split ":foo ((6) :bar 1" '((32 9) . 58))))
  698. (should
  699. (equal '(":foo \"(foo\"" "bar 2")
  700. (org-babel-balanced-split ":foo \"(foo\" :bar 2" '((32 9) . 58))))
  701. ;; Handle un-balanced quotes.
  702. (should
  703. (equal '(":foo \"1" "bar 3")
  704. (org-babel-balanced-split ":foo \"1 :bar 3" '((32 9) . 58))))
  705. ;; Handle empty string.
  706. (should
  707. (equal '(":foo \"\"")
  708. (org-babel-balanced-split ":foo \"\"" '((32 9) . 58))))
  709. ;; Handle control characters within double quotes.
  710. (should
  711. (equal '(":foo \"\\n\"")
  712. (org-babel-balanced-split ":foo \"\\n\"" '((32 9) . 58)))))
  713. (ert-deftest test-ob/commented-last-block-line-no-var ()
  714. (org-test-with-temp-text-in-file "
  715. #+begin_src emacs-lisp
  716. ;;
  717. #+end_src"
  718. (org-babel-next-src-block)
  719. (org-babel-execute-maybe)
  720. (should (re-search-forward "\\#\\+results:" nil t))
  721. (forward-line)
  722. (should
  723. (string=
  724. ""
  725. (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))
  726. (org-test-with-temp-text-in-file "
  727. #+begin_src emacs-lisp
  728. \"some text\";;
  729. #+end_src"
  730. (org-babel-next-src-block)
  731. (org-babel-execute-maybe)
  732. (should (re-search-forward "\\#\\+results:" nil t))
  733. (forward-line)
  734. (should
  735. (string=
  736. ": some text"
  737. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))
  738. (ert-deftest test-ob/commented-last-block-line-with-var ()
  739. (org-test-with-temp-text-in-file "
  740. #+begin_src emacs-lisp :var a=1
  741. ;;
  742. #+end_src"
  743. (org-babel-next-src-block)
  744. (org-babel-execute-maybe)
  745. (re-search-forward "\\#\\+results:" nil t)
  746. (forward-line)
  747. (should (string=
  748. ""
  749. (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))
  750. (org-test-with-temp-text-in-file "
  751. #+begin_src emacs-lisp :var a=2
  752. 2;;
  753. #+end_src"
  754. (org-babel-next-src-block)
  755. (org-babel-execute-maybe)
  756. (re-search-forward "\\#\\+results:" nil t)
  757. (forward-line)
  758. (should (string=
  759. ": 2"
  760. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))
  761. (ert-deftest test-ob/org-babel-insert-result ()
  762. "Test `org-babel-insert-result' specifications."
  763. ;; Do not error when output is an improper list.
  764. (should
  765. (org-test-with-temp-text
  766. "
  767. <point>#+BEGIN_SRC emacs-lisp
  768. '((1 . nil) (2 . 3))
  769. #+END_SRC
  770. "
  771. (org-babel-execute-maybe) t))
  772. ;; Escape headlines when producing an example block.
  773. (should
  774. (string-match-p
  775. ",\\* Not an headline"
  776. (org-test-with-temp-text
  777. "
  778. <point>#+BEGIN_SRC emacs-lisp
  779. \"* Not an headline\"
  780. #+END_SRC
  781. "
  782. (let ((org-babel-min-lines-for-block-output 1)) (org-babel-execute-maybe))
  783. (buffer-string))))
  784. ;; Escape special syntax in example blocks.
  785. (should
  786. (string-match-p
  787. ",#\\+END_SRC"
  788. (org-test-with-temp-text
  789. "
  790. <point>#+BEGIN_SRC emacs-lisp
  791. \"#+END_SRC\"
  792. #+END_SRC
  793. "
  794. (let ((org-babel-min-lines-for-block-output 1)) (org-babel-execute-maybe))
  795. (buffer-string))))
  796. ;; No escaping is done with other blocks or raw type.
  797. (should-not
  798. (string-match-p
  799. ",\\* Not an headline"
  800. (org-test-with-temp-text
  801. "
  802. <point>#+BEGIN_SRC emacs-lisp
  803. \"* Not an headline\"
  804. #+END_SRC
  805. "
  806. (let ((org-babel-min-lines-for-block-output 10))
  807. (org-babel-execute-maybe))
  808. (buffer-string))))
  809. (should-not
  810. (string-match-p
  811. ",\\* Not an headline"
  812. (org-test-with-temp-text
  813. "
  814. <point>#+BEGIN_SRC emacs-lisp :results raw
  815. \"* Not an headline\"
  816. #+END_SRC
  817. "
  818. (org-babel-execute-maybe)
  819. (buffer-string))))
  820. (should-not
  821. (string-match-p
  822. ",\\* Not an headline"
  823. (org-test-with-temp-text
  824. "
  825. <point>#+BEGIN_SRC emacs-lisp :results drawer
  826. \"* Not an headline\"
  827. #+END_SRC
  828. "
  829. (org-babel-execute-maybe)
  830. (buffer-string)))))
  831. (ert-deftest test-ob/remove-inline-result ()
  832. "Test `org-babel-remove-inline-result' honors whitespace."
  833. (let*
  834. ((inline-sb "src_emacs-lisp{(+ 1 2)}")
  835. (inline-res " {{{results(=3=)}}}")
  836. (inline-sb-dot (concat inline-sb "."))
  837. (inline-sb-res-dot (concat inline-sb inline-res ".")))
  838. (org-test-with-temp-text
  839. ;; Insert inline_src_block followed by dot.
  840. inline-sb-dot
  841. ;; Insert result before dot.
  842. (org-babel-execute-maybe)
  843. (should (string= inline-sb-res-dot
  844. (buffer-substring-no-properties
  845. (point-at-bol) (point-at-eol))))
  846. ;; Delete whitespace and result.
  847. (org-babel-remove-inline-result)
  848. (should (string= inline-sb-dot
  849. (buffer-substring-no-properties
  850. (point-at-bol) (point-at-eol))))
  851. ;; Add whitespace and result before dot.
  852. (search-forward inline-sb)
  853. (insert " " inline-res)
  854. (goto-char (point-at-bol))
  855. ;; Remove whitespace and result.
  856. (org-babel-remove-inline-result)
  857. (should (string= inline-sb-dot
  858. (buffer-substring-no-properties
  859. (point-at-bol) (point-at-eol))))
  860. ;; Add whitespace before dot.
  861. (search-forward inline-sb)
  862. (insert " ")
  863. (goto-char (point-at-bol))
  864. ;; Add result before whitespace.
  865. (org-babel-execute-maybe)
  866. ;; Remove result - leave trailing whitespace and dot.
  867. (org-babel-remove-inline-result)
  868. (should (string= (concat inline-sb " .")
  869. (buffer-substring-no-properties
  870. (point-at-bol) (point-at-eol)))))))
  871. (ert-deftest test-ob/org-babel-remove-result--results-default ()
  872. "Test `org-babel-remove-result' with default :results."
  873. (mapcar (lambda (language)
  874. (test-ob-verify-result-and-removed-result
  875. "\n"
  876. (concat
  877. "* org-babel-remove-result
  878. #+begin_src " language "
  879. #+end_src
  880. * next heading")))
  881. '("sh" "emacs-lisp")))
  882. (ert-deftest test-ob/org-babel-results-indented-wrap ()
  883. "Ensure that wrapped results are inserted correction when indented.
  884. If not inserted correctly then the second evaluation will fail
  885. trying to find the :END: marker."
  886. (org-test-with-temp-text
  887. "- indented
  888. #+begin_src sh :results file wrap
  889. echo test.txt
  890. #+end_src"
  891. (org-babel-next-src-block 1)
  892. (org-babel-execute-src-block)
  893. (org-babel-execute-src-block)))
  894. (ert-deftest test-ob/file-desc-header-argument ()
  895. "Test that the :file-desc header argument is used."
  896. (org-test-with-temp-text "#+begin_src emacs-lisp :results file :file-desc bar
  897. \"foo\"
  898. #+end_src
  899. #+begin_src emacs-lisp :results file :file-desc
  900. \"foo\"
  901. #+end_src"
  902. (org-babel-execute-src-block)
  903. (org-babel-next-src-block 1)
  904. (org-babel-execute-src-block)
  905. (goto-char (point-min))
  906. (should (search-forward "[[file:foo][bar]]" nil t))
  907. (should (search-forward "[[file:foo][foo]]" nil t))))
  908. (ert-deftest test-ob/result-file-link-type-header-argument ()
  909. "Ensure that the result is a link to a file.
  910. The file is just a link to `:file' value. Inhibit non-empty
  911. result write to `:file' value."
  912. (org-test-with-temp-text "
  913. <point>#+begin_src shell :results value file link :file \"/tmp/test.txt\"
  914. echo \"hello\" > /tmp/test.txt
  915. echo \"test\"
  916. #+end_src"
  917. (org-babel-execute-src-block)
  918. (should (search-forward "[[file:/tmp/test.txt]]" nil t))
  919. (should (with-temp-buffer
  920. (insert-file-contents "/tmp/test.txt")
  921. (string= "hello\n" (buffer-string)))))
  922. ;; Without "link" output type, the result is not a file.
  923. (should-not
  924. (org-test-with-temp-text "
  925. <point>#+begin_src shell :results value link :file \"/tmp/test.txt\"
  926. echo \"hello\" > /tmp/test.txt
  927. echo \"test\"
  928. #+end_src"
  929. (org-babel-execute-src-block)
  930. (search-forward "[[file:/tmp/test.txt]]" nil t))))
  931. (ert-deftest test-ob/result-graphics-link-type-header-argument ()
  932. "Ensure that the result is a link to a file.
  933. The file is just a link to `:file' value. Inhibit non-empty
  934. result write to `:file' value."
  935. (org-test-with-temp-text "
  936. <point>#+begin_src shell :results value file graphics :file \"/tmp/test.txt\"
  937. echo \"hello\" > /tmp/test.txt
  938. echo \"test\"
  939. #+end_src"
  940. (org-babel-execute-src-block)
  941. (should (search-forward "[[file:/tmp/test.txt]]" nil nil))
  942. (should (with-temp-buffer
  943. (insert-file-contents "/tmp/test.txt")
  944. (string= "hello\n" (buffer-string)))))
  945. ;; Without "link" output type, the result is not a file.
  946. (should-not
  947. (org-test-with-temp-text "
  948. <point>#+begin_src shell :results value graphics :file \"/tmp/test.txt\"
  949. echo \"hello\" > /tmp/test.txt
  950. echo \"test\"
  951. #+end_src"
  952. (org-babel-execute-src-block)
  953. (search-forward "[[file:/tmp/test.txt]]" nil t))))
  954. (ert-deftest test-ob/inline-src_blk-preceded-punct-preceded-by-point ()
  955. (let ((test-line ".src_emacs-lisp[ :results verbatim ]{ \"x\" }")
  956. (org-babel-inline-result-wrap "=%s="))
  957. (org-test-with-temp-text
  958. test-line
  959. (forward-char 1)
  960. (org-babel-execute-maybe)
  961. (should (re-search-forward "=\"x\"=" nil t))
  962. (forward-line))))
  963. (ert-deftest test-ob/commented-last-block-line-with-var ()
  964. (org-test-with-temp-text-in-file "
  965. #+begin_src emacs-lisp :var a=1
  966. ;;
  967. #+end_src"
  968. (org-babel-next-src-block)
  969. (org-babel-execute-maybe)
  970. (re-search-forward "\\#\\+results:" nil t)
  971. (forward-line)
  972. (should (string=
  973. ""
  974. (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))
  975. (org-test-with-temp-text-in-file "
  976. #+begin_src emacs-lisp :var a=2
  977. 2;;
  978. #+end_src"
  979. (org-babel-next-src-block)
  980. (org-babel-execute-maybe)
  981. (re-search-forward "\\#\\+results:" nil t)
  982. (forward-line)
  983. (should (string=
  984. ": 2"
  985. (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))
  986. (defun test-ob-verify-result-and-removed-result (result buffer-text)
  987. "Test helper function to test `org-babel-remove-result'.
  988. A temp buffer is populated with BUFFER-TEXT, the first block is executed,
  989. and the result of execution is verified against RESULT.
  990. The block is actually executed /twice/ to ensure result
  991. replacement happens correctly."
  992. (org-test-with-temp-text
  993. buffer-text
  994. (org-babel-next-src-block) (org-babel-execute-maybe) (org-babel-execute-maybe)
  995. (should (re-search-forward "\\#\\+results:" nil t))
  996. (forward-line)
  997. (should (string= result
  998. (buffer-substring-no-properties
  999. (point-at-bol)
  1000. (- (point-max) 16))))
  1001. (org-babel-previous-src-block) (org-babel-remove-result)
  1002. (should (string= buffer-text
  1003. (buffer-substring-no-properties
  1004. (point-min) (point-max))))))
  1005. (ert-deftest test-ob/org-babel-remove-result--results-list ()
  1006. "Test `org-babel-remove-result' with :results list."
  1007. (test-ob-verify-result-and-removed-result
  1008. "- 1
  1009. - 2
  1010. - 3"
  1011. "* org-babel-remove-result
  1012. #+begin_src emacs-lisp :results list
  1013. '(1 2 3)
  1014. #+end_src
  1015. * next heading"))
  1016. (ert-deftest test-ob/org-babel-remove-result--results-wrap ()
  1017. "Test `org-babel-remove-result' with :results wrap."
  1018. (test-ob-verify-result-and-removed-result
  1019. ":results:
  1020. hello there
  1021. :end:"
  1022. "* org-babel-remove-result
  1023. #+begin_src emacs-lisp :results wrap
  1024. \"hello there\"
  1025. #+end_src
  1026. * next heading"))
  1027. (ert-deftest test-ob/org-babel-remove-result--results-org ()
  1028. "Test `org-babel-remove-result' with :results org."
  1029. (test-ob-verify-result-and-removed-result
  1030. "#+begin_src org
  1031. ,* heading
  1032. ,** subheading
  1033. content
  1034. #+end_src"
  1035. "* org-babel-remove-result
  1036. #+begin_src emacs-lisp :results org
  1037. \"* heading
  1038. ,** subheading
  1039. content\"
  1040. #+end_src
  1041. * next heading"))
  1042. (ert-deftest test-ob/org-babel-remove-result--results-html ()
  1043. "Test `org-babel-remove-result' with :results html."
  1044. (test-ob-verify-result-and-removed-result
  1045. "#+begin_export html
  1046. <head><body></body></head>
  1047. #+end_export"
  1048. "* org-babel-remove-result
  1049. #+begin_src emacs-lisp :results html
  1050. \"<head><body></body></head>\"
  1051. #+end_src
  1052. * next heading"))
  1053. (ert-deftest test-ob/org-babel-remove-result--results-latex ()
  1054. "Test `org-babel-remove-result' with :results latex."
  1055. (test-ob-verify-result-and-removed-result
  1056. "#+begin_export latex
  1057. Line 1
  1058. Line 2
  1059. Line 3
  1060. #+end_export"
  1061. "* org-babel-remove-result
  1062. #+begin_src emacs-lisp :results latex
  1063. \"Line 1
  1064. Line 2
  1065. Line 3\"
  1066. #+end_src
  1067. * next heading"))
  1068. (ert-deftest test-ob/org-babel-remove-result--results-code ()
  1069. "Test `org-babel-remove-result' with :results code."
  1070. (test-ob-verify-result-and-removed-result
  1071. "#+begin_src emacs-lisp
  1072. \"I am working!\"
  1073. #+end_src"
  1074. "* org-babel-remove-result
  1075. #+begin_src emacs-lisp :results code
  1076. (message \"I am working!\")
  1077. #+end_src
  1078. * next heading"))
  1079. (ert-deftest test-ob/org-babel-remove-result--results-pp ()
  1080. "Test `org-babel-remove-result' with :results pp."
  1081. (test-ob-verify-result-and-removed-result
  1082. ": \"I /am/ working!\""
  1083. "* org-babel-remove-result
  1084. #+begin_src emacs-lisp :results pp
  1085. \"I /am/ working!\")
  1086. #+end_src
  1087. * next heading"))
  1088. (ert-deftest test-ob/org-babel-remove-result--no-blank-line ()
  1089. "Test `org-babel-remove-result' without blank line between code and results."
  1090. (should
  1091. (equal "
  1092. #+begin_src emacs-lisp
  1093. (+ 1 1)
  1094. #+end_src
  1095. #+results:
  1096. : 2
  1097. * next heading"
  1098. (org-test-with-temp-text
  1099. "
  1100. <point>#+begin_src emacs-lisp
  1101. (+ 1 1)
  1102. #+end_src
  1103. #+results:
  1104. : 2
  1105. * next heading"
  1106. (org-babel-execute-maybe)
  1107. (buffer-string)))))
  1108. (ert-deftest test-ob/results-do-not-replace-code-blocks ()
  1109. (org-test-with-temp-text "Block two has a space after the name.
  1110. #+name: foo
  1111. #+begin_src emacs-lisp
  1112. 1
  1113. #+end_src
  1114. #+name: foo
  1115. #+begin_src emacs-lisp
  1116. 2
  1117. #+end_src
  1118. #+name: foo
  1119. #+begin_src emacs-lisp
  1120. 3
  1121. #+end_src
  1122. #+RESULTS: foo
  1123. : foo
  1124. "
  1125. (dolist (num '(1 2 3))
  1126. ;; execute the block
  1127. (goto-char (point-min))
  1128. (org-babel-next-src-block num) (org-babel-execute-src-block)
  1129. ;; check the results
  1130. (goto-char (point-max))
  1131. (move-beginning-of-line 0)
  1132. (should (looking-at (format ": %d" num))))))
  1133. (ert-deftest test-ob/blocks-with-spaces ()
  1134. "Test expansion of blocks followed by blank lines."
  1135. ;; Preserve number of blank lines after block.
  1136. (should
  1137. (equal "#+BEGIN_SRC emacs-lisp
  1138. \(+ 1 2)
  1139. #+END_SRC
  1140. #+RESULTS:
  1141. : 3\n\n\n"
  1142. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp
  1143. \(+ 1 2)
  1144. #+END_SRC\n\n\n"
  1145. (let ((org-babel-next-src-block "RESULTS"))
  1146. (org-babel-execute-src-block))
  1147. (buffer-string))))
  1148. ;; Do not add spurious blank lines after results.
  1149. (should
  1150. (equal
  1151. "
  1152. - item 1
  1153. #+begin_src emacs-lisp
  1154. 0
  1155. #+end_src
  1156. #+RESULTS:
  1157. : 0
  1158. - item 2"
  1159. (org-test-with-temp-text "
  1160. - item 1
  1161. #+begin_src emacs-lisp<point>
  1162. 0
  1163. #+end_src
  1164. - item 2"
  1165. (org-babel-execute-src-block)
  1166. (buffer-string))))
  1167. (should
  1168. (equal
  1169. "
  1170. - item 1
  1171. #+begin_src emacs-lisp
  1172. 1
  1173. #+end_src
  1174. #+RESULTS:
  1175. : 1
  1176. - item 2"
  1177. (org-test-with-temp-text "
  1178. - item 1
  1179. #+begin_src emacs-lisp<point>
  1180. 1
  1181. #+end_src
  1182. #+RESULTS:
  1183. : 1
  1184. - item 2"
  1185. (org-babel-execute-src-block)
  1186. (buffer-string)))))
  1187. (ert-deftest test-ob/results-in-narrowed-buffer ()
  1188. "Test block execution in a narrowed buffer."
  1189. ;; If results don't exist, they should be inserted in visible part
  1190. ;; of the buffer.
  1191. (should
  1192. (equal
  1193. "#+BEGIN_SRC emacs-lisp\n(+ 1 2)\n#+END_SRC\n\n#+RESULTS:\n: 3"
  1194. (org-test-with-temp-text
  1195. "#+BEGIN_SRC emacs-lisp\n(+ 1 2)\n#+END_SRC\n\nParagraph"
  1196. (narrow-to-region (point) (save-excursion (forward-line 3) (point)))
  1197. (let ((org-babel-results-keyword "RESULTS"))
  1198. (org-babel-execute-src-block))
  1199. (org-trim (buffer-string)))))
  1200. (should
  1201. (equal
  1202. "#+NAME: test\n#+BEGIN_SRC emacs-lisp\n(+ 1 2)\n#+END_SRC\n\n#+RESULTS: test\n: 3"
  1203. (org-test-with-temp-text
  1204. "#+NAME: test\n#+BEGIN_SRC emacs-lisp\n(+ 1 2)\n#+END_SRC\n\nParagraph"
  1205. (narrow-to-region (point) (save-excursion (forward-line 4) (point)))
  1206. (let ((org-babel-results-keyword "RESULTS"))
  1207. (org-babel-execute-src-block))
  1208. (org-trim (buffer-string)))))
  1209. ;; Results in visible part of buffer, should be updated here.
  1210. (should
  1211. (equal
  1212. "#+NAME: test
  1213. #+BEGIN_SRC emacs-lisp
  1214. \(+ 1 2)
  1215. #+END_SRC
  1216. #+RESULTS: test
  1217. : 3"
  1218. (org-test-with-temp-text
  1219. "#+NAME: test
  1220. #+BEGIN_SRC emacs-lisp
  1221. \(+ 1 2)
  1222. #+END_SRC
  1223. #+RESULTS: test
  1224. : 4
  1225. <point>
  1226. Paragraph"
  1227. (narrow-to-region (point-min) (point))
  1228. (goto-char (point-min))
  1229. (let ((org-babel-results-keyword "RESULTS"))
  1230. (org-babel-execute-src-block))
  1231. (org-trim (buffer-string)))))
  1232. ;; Results in invisible part of buffer, should be updated there.
  1233. (org-test-with-temp-text
  1234. "#+NAME: test
  1235. #+BEGIN_SRC emacs-lisp
  1236. \(+ 1 2)
  1237. #+END_SRC
  1238. #+RESULTS: test
  1239. : 4
  1240. Paragraph"
  1241. (narrow-to-region (point) (save-excursion (forward-line 4) (point)))
  1242. (let ((org-babel-results-keyword "RESULTS"))
  1243. (org-babel-execute-src-block))
  1244. (should-not (re-search-forward "^#\\+RESULTS:" nil t))
  1245. (widen)
  1246. (should (re-search-forward "^: 3" nil t))))
  1247. (ert-deftest test-ob/specific-colnames ()
  1248. "Test passing specific column names."
  1249. (should
  1250. (equal "#+name: input-table
  1251. | id | var1 |
  1252. |----+------|
  1253. | 1 | bar |
  1254. | 2 | baz |
  1255. #+begin_src sh :var data=input-table :exports results :colnames '(Rev Author)
  1256. echo \"$data\"
  1257. #+end_src
  1258. #+RESULTS:
  1259. | Rev | Author |
  1260. |-----+--------|
  1261. | 1 | bar |
  1262. | 2 | baz |
  1263. "
  1264. (org-test-with-temp-text
  1265. "#+name: input-table
  1266. | id | var1 |
  1267. |----+------|
  1268. | 1 | bar |
  1269. | 2 | baz |
  1270. #+begin_src sh :var data=input-table :exports results :colnames '(Rev Author)
  1271. echo \"$data\"
  1272. #+end_src
  1273. "
  1274. ;; we should find a code block
  1275. (should (re-search-forward org-babel-src-block-regexp nil t))
  1276. (goto-char (match-beginning 0))
  1277. ;; now that we've located the code block, it may be evaluated
  1278. (let ((org-babel-execute-src-block "RESULTS"))
  1279. (org-babel-execute-src-block))
  1280. (buffer-string)))))
  1281. (ert-deftest test-ob/location-of-header-arg-eval ()
  1282. "Test location of header argument evaluation."
  1283. (org-test-with-temp-text "
  1284. #+name: top-block
  1285. #+begin_src emacs-lisp :var pt=(point)
  1286. pt
  1287. #+end_src
  1288. #+name: bottom-block
  1289. #+begin_src emacs-lisp :var pt=top-block()
  1290. pt
  1291. #+end_src
  1292. "
  1293. ;; the value of the second block should be greater than the first
  1294. (should
  1295. (< (progn (re-search-forward org-babel-src-block-regexp nil t)
  1296. (goto-char (match-beginning 0))
  1297. (prog1 (save-match-data (org-babel-execute-src-block))
  1298. (goto-char (match-end 0))))
  1299. (progn (re-search-forward org-babel-src-block-regexp nil t)
  1300. (goto-char (match-beginning 0))
  1301. (org-babel-execute-src-block))))))
  1302. (ert-deftest test-ob/preserve-results-indentation ()
  1303. "Preserve indentation when executing a source block."
  1304. (should
  1305. (equal
  1306. '(2 2)
  1307. (org-test-with-temp-text " #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
  1308. (org-babel-execute-src-block)
  1309. (let ((case-fold-search t)) (search-forward "RESULTS"))
  1310. (list (org-get-indentation)
  1311. (progn (forward-line) (org-get-indentation))))))
  1312. (should
  1313. (equal
  1314. '(2 2)
  1315. (org-test-with-temp-text
  1316. " #+name: block\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
  1317. (org-babel-execute-src-block)
  1318. (let ((case-fold-search t)) (search-forward "RESULTS"))
  1319. (list (org-get-indentation)
  1320. (progn (forward-line) (org-get-indentation))))))
  1321. ;; Don't get fooled by TAB-based indentation.
  1322. (should
  1323. (equal
  1324. '(6 6)
  1325. (org-test-with-temp-text
  1326. "\t #+begin_src emacs-lisp\n\t (+ 1 1)\n\t #+end_src"
  1327. (setq tab-width 4)
  1328. (org-babel-execute-src-block)
  1329. (let ((case-fold-search t)) (search-forward "RESULTS"))
  1330. (list (org-get-indentation)
  1331. (progn (forward-line) (org-get-indentation))))))
  1332. ;; Properly indent examplified blocks.
  1333. (should
  1334. (equal
  1335. " #+begin_example
  1336. 0
  1337. 1
  1338. 2
  1339. 3
  1340. 4
  1341. 5
  1342. 6
  1343. 7
  1344. 8
  1345. 9
  1346. #+end_example
  1347. "
  1348. (org-test-with-temp-text
  1349. " #+begin_src emacs-lisp :results output
  1350. (dotimes (i 10) (princ i) (princ \"\\n\"))
  1351. #+end_src"
  1352. (org-babel-execute-src-block)
  1353. (search-forward "begin_example")
  1354. (downcase
  1355. (buffer-substring-no-properties (line-beginning-position)
  1356. (point-max))))))
  1357. ;; Properly indent "org" blocks.
  1358. (should
  1359. (equal
  1360. " #+begin_src org
  1361. 0
  1362. 1
  1363. 2
  1364. 3
  1365. 4
  1366. 5
  1367. 6
  1368. 7
  1369. 8
  1370. 9
  1371. #+end_src
  1372. "
  1373. (org-test-with-temp-text
  1374. " #+begin_src emacs-lisp :results output org
  1375. (dotimes (i 10) (princ i) (princ \"\\n\"))
  1376. #+end_src"
  1377. (org-babel-execute-src-block)
  1378. (search-forward "begin_src org")
  1379. (downcase
  1380. (buffer-substring-no-properties (line-beginning-position)
  1381. (point-max)))))))
  1382. (ert-deftest test-ob/safe-header-args ()
  1383. "Detect safe and unsafe header args."
  1384. (let ((safe-args '((:cache . "foo")
  1385. (:results . "output")
  1386. (:eval . "never")
  1387. (:eval . "query")))
  1388. (unsafe-args '((:eval . "yes")
  1389. (:results . "output file")
  1390. (:foo . "bar")))
  1391. (malformed-args '((bar . "foo")
  1392. ("foo" . "bar")
  1393. :foo))
  1394. (safe-p (org-babel-header-args-safe-fn org-babel-safe-header-args)))
  1395. (dolist (arg safe-args)
  1396. (should (org-babel-one-header-arg-safe-p arg org-babel-safe-header-args)))
  1397. (dolist (arg unsafe-args)
  1398. (should (not (org-babel-one-header-arg-safe-p arg org-babel-safe-header-args))))
  1399. (dolist (arg malformed-args)
  1400. (should (not (org-babel-one-header-arg-safe-p arg org-babel-safe-header-args))))
  1401. (should (not (funcall safe-p (append safe-args unsafe-args))))))
  1402. (ert-deftest test-ob/noweb-expansions-in-cache ()
  1403. "Ensure that noweb expansions are expanded before caching."
  1404. (let ((noweb-expansions-in-cache-var 0))
  1405. (org-test-with-temp-text "
  1406. #+name: foo
  1407. #+begin_src emacs-lisp
  1408. \"I said\"
  1409. #+end_src
  1410. #+name: bar
  1411. #+begin_src emacs-lisp :noweb yes :cache yes
  1412. (setq noweb-expansions-in-cache-var
  1413. (+ 1 noweb-expansions-in-cache-var))
  1414. (concat <<foo>> \" check noweb expansions\")
  1415. #+end_src
  1416. "
  1417. ;; run the second block to create the cache
  1418. (goto-char (point-min))
  1419. (re-search-forward (regexp-quote "#+name: bar"))
  1420. (should (string= "I said check noweb expansions"
  1421. (org-babel-execute-src-block)))
  1422. (should (= noweb-expansions-in-cache-var 1))
  1423. ;; change the value of the first block
  1424. (goto-char (point-min))
  1425. (re-search-forward (regexp-quote "said"))
  1426. (goto-char (match-beginning 0))
  1427. (insert "haven't ")
  1428. (re-search-forward (regexp-quote "#+name: bar"))
  1429. (should (string= "I haven't said check noweb expansions"
  1430. (org-babel-execute-src-block)))
  1431. (should (= noweb-expansions-in-cache-var 2)))))
  1432. (ert-deftest test-ob/file-ext-and-output-dir ()
  1433. (org-test-at-id "93573e1d-6486-442e-b6d0-3fedbdc37c9b"
  1434. (org-babel-next-src-block)
  1435. (should (equal "file-ext-basic.txt"
  1436. (cdr (assq :file (nth 2 (org-babel-get-src-block-info t))))))
  1437. (org-babel-next-src-block)
  1438. (should (equal "foo/file-ext-dir-relative.txt"
  1439. (cdr (assq :file (nth 2 (org-babel-get-src-block-info t))))))
  1440. (org-babel-next-src-block)
  1441. (should (equal "foo/file-ext-dir-relative-slash.txt"
  1442. (cdr (assq :file (nth 2 (org-babel-get-src-block-info t))))))
  1443. (org-babel-next-src-block)
  1444. (should (equal "/tmp/file-ext-dir-absolute.txt"
  1445. (cdr (assq :file (nth 2 (org-babel-get-src-block-info t))))))
  1446. (org-babel-next-src-block)
  1447. (should (equal "foo.bar"
  1448. (cdr (assq :file (nth 2 (org-babel-get-src-block-info t))))))
  1449. (org-babel-next-src-block)
  1450. (should (equal "xxx/foo.bar"
  1451. (cdr (assq :file (nth 2 (org-babel-get-src-block-info t))))))
  1452. ))
  1453. (ert-deftest test-ob-core/dir-mkdirp ()
  1454. "Test :mkdirp with :dir header combination."
  1455. (should-not
  1456. (org-test-with-temp-text-in-file
  1457. "#+begin_src emacs-lisp :dir \"data/code\"
  1458. t
  1459. #+end_src"
  1460. (org-babel-execute-src-block)
  1461. (message default-directory)
  1462. (file-directory-p "data/code")))
  1463. (should-not
  1464. (org-test-with-temp-text-in-file
  1465. "#+begin_src emacs-lisp :mkdirp no :dir \"data/code\"
  1466. t
  1467. #+end_src"
  1468. (org-babel-execute-src-block)
  1469. (message default-directory)
  1470. (file-directory-p "data/code")))
  1471. (should
  1472. (org-test-with-temp-text-in-file
  1473. "#+begin_src emacs-lisp :mkdirp yes :dir \"data/code\"
  1474. t
  1475. #+end_src"
  1476. (org-babel-execute-src-block)
  1477. (message default-directory)
  1478. (prog1 (file-directory-p "data/code")
  1479. (delete-directory "data" t))))
  1480. (should
  1481. (equal "/tmp/test-dir-no-mkdirp/"
  1482. (org-test-with-temp-text-in-file
  1483. "#+begin_src emacs-lisp :dir /tmp/test-dir-no-mkdirp
  1484. default-directory
  1485. #+end_src"
  1486. (org-babel-execute-src-block)))))
  1487. (ert-deftest test-ob/script-escape ()
  1488. ;; Delimited lists of numbers
  1489. (should (equal '(1 2 3)
  1490. (org-babel-script-escape "[1 2 3]")))
  1491. (should (equal '(1 2 3)
  1492. (org-babel-script-escape "{1 2 3}")))
  1493. (should (equal '(1 2 3)
  1494. (org-babel-script-escape "(1 2 3)")))
  1495. ;; Delimited lists of double-quoted strings
  1496. (should (equal '("foo" "bar")
  1497. (org-babel-script-escape "(\"foo\" \"bar\")")))
  1498. (should (equal '("foo" "bar")
  1499. (org-babel-script-escape "[\"foo\" \"bar\"]")))
  1500. (should (equal '("foo" "bar")
  1501. (org-babel-script-escape "{\"foo\" \"bar\"}")))
  1502. ;; ... with commas
  1503. (should (equal '("foo" "bar")
  1504. (org-babel-script-escape "(\"foo\", \"bar\")")))
  1505. (should (equal '("foo" "bar")
  1506. (org-babel-script-escape "[\"foo\", \"bar\"]")))
  1507. (should (equal '("foo" "bar")
  1508. (org-babel-script-escape "{\"foo\", \"bar\"}")))
  1509. ;; Delimited lists of single-quoted strings
  1510. (should (equal '("foo" "bar")
  1511. (org-babel-script-escape "('foo' 'bar')")))
  1512. (should (equal '("foo" "bar")
  1513. (org-babel-script-escape "['foo' 'bar']")))
  1514. (should (equal '("foo" "bar")
  1515. (org-babel-script-escape "{'foo' 'bar'}")))
  1516. ;; ... with commas
  1517. (should (equal '("foo" "bar")
  1518. (org-babel-script-escape "('foo', 'bar')")))
  1519. (should (equal '("foo" "bar")
  1520. (org-babel-script-escape "['foo', 'bar']")))
  1521. (should (equal '("foo" "bar")
  1522. (org-babel-script-escape "{'foo', 'bar'}")))
  1523. ;; Single quoted strings
  1524. (should (equal "foo"
  1525. (org-babel-script-escape "'foo'")))
  1526. ;; ... with internal double quote
  1527. (should (equal "foo\"bar"
  1528. (org-babel-script-escape "'foo\"bar'")))
  1529. ;; ... with internal backslash
  1530. (should (equal "foo\\bar"
  1531. (org-babel-script-escape "'foo\\bar'")))
  1532. ;; ... with internal escaped backslash
  1533. (should (equal "foo\\bar"
  1534. (org-babel-script-escape "'foo\\\\bar'")))
  1535. ;; ... with internal backslash-double quote
  1536. (should (equal "foo\\\"bar"
  1537. (org-babel-script-escape "'foo\\\"bar'")))
  1538. ;; ... with internal escaped backslash-double quote
  1539. (should (equal "foo\\\"bar"
  1540. (org-babel-script-escape "'foo\\\\\"bar'")))
  1541. ;; ... with internal escaped single quote
  1542. (should (equal "foo'bar"
  1543. (org-babel-script-escape "'foo\\'bar'")))
  1544. ;; ... with internal escaped backslash-escaped single quote
  1545. (should (equal "foo\\'bar"
  1546. (org-babel-script-escape "'foo\\\\\\'bar'")))
  1547. ;; Double quoted strings
  1548. (should (equal "foo"
  1549. (org-babel-script-escape "\"foo\"")))
  1550. ;; ... with internal single quote
  1551. (should (equal "foo'bar"
  1552. (org-babel-script-escape "\"foo'bar\"")))
  1553. ;; ... with internal backslash
  1554. (should (equal "foo\\bar"
  1555. (org-babel-script-escape "\"foo\\bar\"")))
  1556. ;; ... with internal escaped backslash
  1557. (should (equal "foo\\bar"
  1558. (org-babel-script-escape "\"foo\\\\bar\"")))
  1559. ;; ... with internal backslash-single quote
  1560. (should (equal "foo\\'bar"
  1561. (org-babel-script-escape "\"foo\\'bar\"")))
  1562. ;; ... with internal escaped backslash-single quote
  1563. (should (equal "foo\\'bar"
  1564. (org-babel-script-escape "\"foo\\\\'bar\"")))
  1565. ;; ... with internal escaped double quote
  1566. (should (equal "foo\"bar"
  1567. (org-babel-script-escape "\"foo\\\"bar\"")))
  1568. ;; ... with internal escaped backslash-escaped double quote
  1569. (should (equal "foo\\\"bar"
  1570. (org-babel-script-escape "\"foo\\\\\\\"bar\""))))
  1571. (ert-deftest test-ob/process-params-no-duplicates ()
  1572. (should
  1573. (equal (org-babel-process-params '((:colname-names)
  1574. (:rowname-names)
  1575. (:result-params)
  1576. (:result-type)
  1577. (:var . "\"foo\"")))
  1578. '((:var)
  1579. (:colname-names)
  1580. (:rowname-names)
  1581. (:result-params)
  1582. (:result-type . value)))))
  1583. (defun org-test-babel-confirm-evaluate (eval-value)
  1584. (org-test-with-temp-text (format "#+begin_src emacs-lisp :eval %s
  1585. nil
  1586. #+end_src" eval-value)
  1587. (goto-char (point-min))
  1588. (let ((info (org-babel-get-src-block-info)))
  1589. (org-babel-check-confirm-evaluate info))))
  1590. (ert-deftest test-ob/check-eval ()
  1591. (let ((org-confirm-babel-evaluate t))
  1592. ;; Non-export tests
  1593. (dolist (pair '(("no" . nil)
  1594. ("never" . nil)
  1595. ("query" . query)
  1596. ("yes" . query)))
  1597. (should (eq (org-test-babel-confirm-evaluate (car pair)) (cdr pair))))
  1598. ;; Export tests
  1599. (let ((org-babel-exp-reference-buffer t))
  1600. (dolist (pair '(("no" . nil)
  1601. ("never" . nil)
  1602. ("query" . query)
  1603. ("yes" . query)
  1604. ("never-export" . nil)
  1605. ("no-export" . nil)
  1606. ("query-export" . query)))
  1607. (message (car pair))
  1608. (should (eq (org-test-babel-confirm-evaluate (car pair)) (cdr pair))))))
  1609. (let ((org-confirm-babel-evaluate nil))
  1610. ;; Non-export tests
  1611. (dolist (pair '(("no" . nil)
  1612. ("never" . nil)
  1613. ("query" . query)
  1614. ("yes" . t)))
  1615. (should (eq (org-test-babel-confirm-evaluate (car pair)) (cdr pair))))
  1616. ;; Export tests
  1617. (let ((org-babel-exp-reference-buffer t))
  1618. (dolist (pair '(("no" . nil)
  1619. ("never" . nil)
  1620. ("query" . query)
  1621. ("yes" . t)
  1622. ("never-export" . nil)
  1623. ("no-export" . nil)
  1624. ("query-export" . query)))
  1625. (message (car pair))
  1626. (should (eq (org-test-babel-confirm-evaluate (car pair)) (cdr pair)))))))
  1627. (defun org-test-ob/update-block-body ()
  1628. "Test `org-babel-update-block-body' specifications."
  1629. (should
  1630. (equal "#+begin_src elisp\n 2\n#+end_src"
  1631. (let ((org-edit-src-content-indentation 2))
  1632. (org-test-with-temp-text "#+begin_src elisp\n(+ 1 1)\n#+end_src"
  1633. (org-babel-update-block-body "2")
  1634. (buffer-string)))))
  1635. ;; Preserve block indentation.
  1636. (should
  1637. (equal " #+begin_src elisp\n 2\n #+end_src"
  1638. (let ((org-edit-src-content-indentation 1))
  1639. (org-test-with-temp-text
  1640. " #+begin_src elisp\n (+ 1 1)\n #+end_src"
  1641. (org-babel-update-block-body "2")
  1642. (buffer-string)))))
  1643. ;; Ignore NEW-BODY global indentation.
  1644. (should
  1645. (equal "#+begin_src elisp\n 2\n#+end_src"
  1646. (let ((org-edit-src-content-indentation 2))
  1647. (org-test-with-temp-text "#+begin_src elisp\n(+ 1 1)\n#+end_src"
  1648. (org-babel-update-block-body " 2")
  1649. (buffer-string)))))
  1650. ;; When indentation should be preserved ignore the two rules above.
  1651. (should
  1652. (equal " #+begin_src elisp\n2\n #+end_src"
  1653. (let ((org-edit-src-content-indentation 1)
  1654. (org-src-preserve-indentation t))
  1655. (org-test-with-temp-text
  1656. " #+begin_src elisp\n (+ 1 1)\n #+end_src"
  1657. (org-babel-update-block-body "2")
  1658. (buffer-string)))))
  1659. (should
  1660. (equal " #+begin_src elisp -i\n2\n #+end_src"
  1661. (let ((org-edit-src-content-indentation 1))
  1662. (org-test-with-temp-text
  1663. " #+begin_src elisp -i\n (+ 1 1)\n #+end_src"
  1664. (org-babel-update-block-body "2")
  1665. (buffer-string)))))
  1666. (should
  1667. (equal "#+begin_src elisp\n 2\n#+end_src"
  1668. (let ((org-edit-src-content-indentation 2)
  1669. (org-src-preserve-indentation t))
  1670. (org-test-with-temp-text "#+begin_src elisp\n(+ 1 1)\n#+end_src"
  1671. (org-babel-update-block-body " 2")
  1672. (buffer-string)))))
  1673. (should
  1674. (equal "#+begin_src elisp -i\n 2\n#+end_src"
  1675. (let ((org-edit-src-content-indentation 2)
  1676. (org-src-preserve-indentation t))
  1677. (org-test-with-temp-text "#+begin_src elisp -i\n(+ 1 1)\n#+end_src"
  1678. (org-babel-update-block-body " 2")
  1679. (buffer-string))))))
  1680. (ert-deftest test-ob/find-named-result ()
  1681. "Test `org-babel-find-named-result' specifications."
  1682. (should
  1683. (= 1
  1684. (org-test-with-temp-text "#+results: foo\n: result"
  1685. (org-babel-find-named-result "foo"))))
  1686. (should-not
  1687. (org-test-with-temp-text "#+results: foo\n: result"
  1688. (org-babel-find-named-result "bar")))
  1689. (should-not
  1690. (org-test-with-temp-text "#+results: foobar\n: result"
  1691. (org-babel-find-named-result "foo")))
  1692. ;; Search is case insensitive.
  1693. (should
  1694. (org-test-with-temp-text "#+RESULTS: FOO\n: result"
  1695. (org-babel-find-named-result "foo")))
  1696. ;; Handle hash in results keyword.
  1697. (should
  1698. (org-test-with-temp-text "#+results[hash]: FOO\n: result"
  1699. (org-babel-find-named-result "foo")))
  1700. ;; Accept orphaned affiliated keywords.
  1701. (should
  1702. (org-test-with-temp-text "#+results: foo"
  1703. (org-babel-find-named-result "foo"))))
  1704. (ert-deftest test-ob/where-is-src-block-result ()
  1705. "Test `org-babel-where-is-src-block-result' specifications."
  1706. ;; Find anonymous results.
  1707. (should
  1708. (equal "#+RESULTS:"
  1709. (org-test-with-temp-text
  1710. "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n\n#+RESULTS:\n: 2"
  1711. (goto-char (org-babel-where-is-src-block-result))
  1712. (buffer-substring-no-properties (point) (line-end-position)))))
  1713. ;; Find named results. Those have priority over anonymous ones.
  1714. (should
  1715. (equal "#+RESULTS: example"
  1716. (org-test-with-temp-text
  1717. "
  1718. <point>#+NAME: example
  1719. #+BEGIN_SRC emacs-lisp
  1720. \(+ 1 1)
  1721. #+END_SRC
  1722. #+RESULTS: example
  1723. : 2"
  1724. (goto-char (org-babel-where-is-src-block-result))
  1725. (buffer-substring-no-properties (point) (line-end-position)))))
  1726. (should
  1727. (equal "#+RESULTS: example"
  1728. (org-test-with-temp-text
  1729. "
  1730. <point>#+NAME: example
  1731. #+BEGIN_SRC emacs-lisp
  1732. \(+ 1 1)
  1733. #+END_SRC
  1734. #+RESULTS:
  1735. : fake
  1736. #+RESULTS: example
  1737. : 2"
  1738. (goto-char (org-babel-where-is-src-block-result))
  1739. (buffer-substring-no-properties (point) (line-end-position)))))
  1740. ;; Return nil when no result is found.
  1741. (should-not
  1742. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  1743. (org-babel-where-is-src-block-result)))
  1744. (should-not
  1745. (org-test-with-temp-text
  1746. "- item\n #+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n\n"
  1747. (org-babel-where-is-src-block-result)))
  1748. ;; When optional argument INSERT is non-nil, add RESULTS keyword
  1749. ;; whenever no RESULTS can be found.
  1750. (should
  1751. (equal
  1752. "#+RESULTS:"
  1753. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  1754. (let ((org-babel-results-keyword "RESULTS"))
  1755. (goto-char (org-babel-where-is-src-block-result t)))
  1756. (buffer-substring-no-properties (point) (line-end-position)))))
  1757. ;; Insert a named RESULTS keyword if possible.
  1758. (should
  1759. (equal
  1760. "#+RESULTS: e"
  1761. (org-test-with-temp-text
  1762. "#+NAME: e\n#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  1763. (let ((org-babel-results-keyword "RESULTS"))
  1764. (goto-char (org-babel-where-is-src-block-result t)))
  1765. (buffer-substring-no-properties (point) (line-end-position)))))
  1766. ;; When optional argument HASH is provided, clear RESULTS keyword
  1767. ;; and related contents if they do not match it.
  1768. (should
  1769. (equal
  1770. "#+RESULTS[bbbb]:"
  1771. (org-test-with-temp-text
  1772. "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n\n#+RESULTS[aaaa]:\n: 3"
  1773. (let ((org-babel-results-keyword "RESULTS"))
  1774. (goto-char (org-babel-where-is-src-block-result nil nil "bbbb")))
  1775. (org-trim (buffer-substring-no-properties (point) (point-max))))))
  1776. (should
  1777. (equal
  1778. "#+RESULTS[bbbb]:"
  1779. (org-test-with-temp-text
  1780. "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n\n#+RESULTS[aaaa]:"
  1781. (let ((org-babel-results-keyword "RESULTS"))
  1782. (goto-char (org-babel-where-is-src-block-result nil nil "bbbb")))
  1783. (org-trim (buffer-substring-no-properties (point) (point-max))))))
  1784. ;; Handle hashes with times.
  1785. (should
  1786. (equal
  1787. "#+RESULTS[<2014-03-04 00:41:10> bbbb]:"
  1788. (org-test-with-temp-text
  1789. "
  1790. <point>#+BEGIN_SRC emacs-lisp
  1791. \(+ 1 1)
  1792. #+END_SRC
  1793. #+RESULTS[<2012-03-29 16:40:12> aaaa]:"
  1794. (let ((org-babel-results-keyword "RESULTS")
  1795. (org-babel-hash-show-time t))
  1796. (cl-letf (((symbol-function 'format-time-string)
  1797. (lambda (&rest _) "<2014-03-04 00:41:10>")))
  1798. (goto-char (org-babel-where-is-src-block-result nil nil "bbbb"))
  1799. (org-trim (buffer-substring-no-properties (point) (point-max))))))))
  1800. (should
  1801. (equal
  1802. "#+RESULTS[<2012-03-29 16:40:12> aaaa]:"
  1803. (org-test-with-temp-text
  1804. "
  1805. <point>#+BEGIN_SRC emacs-lisp
  1806. \(+ 1 1)
  1807. #+END_SRC
  1808. #+RESULTS[<2012-03-29 16:40:12> aaaa]:"
  1809. (let ((org-babel-results-keyword "RESULTS")
  1810. (org-babel-hash-show-time t))
  1811. (cl-letf (((symbol-function 'format-time-string)
  1812. (lambda (&rest _) "<2014-03-04 00:41:10>")))
  1813. (goto-char (org-babel-where-is-src-block-result nil nil "aaaa"))
  1814. (org-trim (buffer-substring-no-properties (point) (point-max))))))))
  1815. ;; RESULTS keyword may not be the last affiliated keyword.
  1816. (should
  1817. (equal
  1818. "#+RESULTS[bbbb]:"
  1819. (org-test-with-temp-text
  1820. "
  1821. <point>#+BEGIN_SRC emacs-lisp
  1822. \(+ 1 1)
  1823. #+END_SRC
  1824. #+RESULTS[aaaa]:
  1825. #+NAME: e
  1826. : 3"
  1827. (let ((org-babel-results-keyword "RESULTS"))
  1828. (goto-char (org-babel-where-is-src-block-result nil nil "bbbb")))
  1829. (org-trim (buffer-substring-no-properties (point) (point-max))))))
  1830. ;; HASH does nothing if no RESULTS can be found. However, if INSERT
  1831. ;; is also non-nil, RESULTS keyword is inserted along with the
  1832. ;; expected hash.
  1833. (should
  1834. (equal
  1835. "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  1836. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  1837. (org-babel-where-is-src-block-result nil nil "bbbb")
  1838. (buffer-string))))
  1839. (should
  1840. (equal
  1841. "#+RESULTS[bbbb]:"
  1842. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  1843. (let ((org-babel-results-keyword "RESULTS"))
  1844. (goto-char (org-babel-where-is-src-block-result t nil "bbbb")))
  1845. (org-trim (buffer-substring-no-properties (point) (point-max)))))))
  1846. (ert-deftest test-ob/goto-named-src-block ()
  1847. "Test interactive use of `org-babel-goto-named-src-block'."
  1848. (org-test-with-temp-text-in-file
  1849. "
  1850. #+NAME: abc
  1851. #+BEGIN_SRC emacs-lisp :results value
  1852. (1+ 1)
  1853. #+END_SRC
  1854. #+CALL: abc( lorem() ) :results raw :wrap EXAMPLE
  1855. #+BEGIN_SRC emacs-lisp
  1856. <<abc>>
  1857. #+END_SRC
  1858. abc
  1859. #+RESULTS: abc
  1860. : 2
  1861. "
  1862. ;; non-existent name
  1863. (should-not
  1864. (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\nno-name\n"))
  1865. ;; correct name
  1866. (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\nabc\n")
  1867. (should (= 14 (point)))
  1868. ;; call line - autocompletion
  1869. (forward-line 3)
  1870. (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n")
  1871. (should (= 14 (point)))
  1872. ;; noweb reference - autocompletion
  1873. (forward-line 5)
  1874. (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n")
  1875. (should (= 14 (point)))
  1876. ;; at symbol - autocompletion
  1877. (forward-line 7)
  1878. (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n")
  1879. (should (= 14 (point)))
  1880. ;; in results - autocompletion
  1881. (forward-line 8)
  1882. (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n")
  1883. (should (= 14 (point)))
  1884. (forward-line 9)
  1885. (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n")
  1886. (should (= 14 (point)))))
  1887. (ert-deftest test-ob/evaluate-body-with-coderefs ()
  1888. (should
  1889. (= 2
  1890. (org-test-with-temp-text
  1891. "#+begin_src emacs-lisp -l \"#(ref:%s)\"\n2 #(ref:foo)\n#+end_src"
  1892. (org-babel-execute-src-block))))
  1893. (should
  1894. (= 3
  1895. (org-test-with-temp-text
  1896. "#+begin_src emacs-lisp\n3 #(ref:foo)\n#+end_src"
  1897. (let ((org-coderef-label-format "#(ref:%s)"))
  1898. (org-babel-execute-src-block))))))
  1899. (ert-deftest test-ob/string-to-number ()
  1900. (should (= 0 (org-babel--string-to-number "0")))
  1901. (should (= 1 (org-babel--string-to-number "1")))
  1902. (should (eq nil (org-babel--string-to-number "000")))
  1903. (should (eq nil (org-babel--string-to-number "001")))
  1904. (should (eq nil (org-babel--string-to-number "010")))
  1905. (should (= 100 (org-babel--string-to-number "100")))
  1906. (should (= 0.1 (org-babel--string-to-number "0.1")))
  1907. (should (= 1.0 (org-babel--string-to-number "1.0"))))
  1908. (provide 'test-ob)
  1909. ;;; test-ob ends here