test-ob.el 59 KB

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