;;; test-ob.el --- tests for ob.el -*- lexical-binding: t; -*- ;; Copyright (c) 2010-2015, 2019 Eric Schulte ;; Authors: Eric Schulte, Martyn Jago ;; This file is not part of GNU Emacs. ;; This program is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. ;; This program is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with this program. If not, see . ;;; Code: (require 'ob-core) (require 'org-src) (require 'ob-ref) (require 'org-table) (eval-and-compile (require 'cl-lib)) (ert-deftest test-ob/indented-cached-org-bracket-link () "When the result of a source block is a cached indented link it should still return the link." (should (let ((default-directory temporary-file-directory)) (org-test-with-temp-text " * Test #+BEGIN_SRC emacs-lisp :results file :file test.txt :cache yes (message \"test\") #+END_SRC" ;; Execute twice as the first time creates the cache. (org-babel-execute-src-block) (string= (expand-file-name "test.txt") (org-babel-execute-src-block)))))) (ert-deftest test-ob/multi-line-header-regexp () (should(equal "^[ \t]*#\\+headers?:[ \t]*\$[^\n]*\$$" org-babel-multi-line-header-regexp)) ;;TODO can be optimised - and what about blah4 blah5 blah6? (should (string-match org-babel-multi-line-header-regexp " \t #+headers: blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n")) (should (equal "blah1 blah2 blah3 \t" (match-string 1 " \t #+headers: blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n"))) ;;TODO Check - should this fail? (should (not (org-test-string-exact-match org-babel-multi-line-header-regexp " \t #+headers : blah1 blah2 blah3 \t\n\t\n blah4 blah5 blah6 \n")))) (ert-deftest test-ob/src-block-regexp () (let ((test-block (concat "#+begin_src language -n-r-a-b -c :argument-1 yes :argument-2 no\n" "echo this is a test\n" "echo Currently in ' $PWD\n" "#+end_src")) (language "language") (flags "-n-r-a-b -c ") (arguments ":argument-1 yes :argument-2 no") (body "echo this is a test\necho Currently in ' $PWD\n")) (should (string-match org-babel-src-block-regexp test-block)) (should (string-match org-babel-src-block-regexp (upcase test-block))) (should (equal language (match-string 2 test-block))) ;;TODO Consider refactoring (should (equal flags (match-string 3 test-block))) (should (equal arguments (match-string 4 test-block))) (should (equal body (match-string 5 test-block))) ;;no switches (should (org-test-string-exact-match org-babel-src-block-regexp (replace-regexp-in-string flags "" test-block))) ;;no header arguments (should (org-test-string-exact-match org-babel-src-block-regexp (replace-regexp-in-string arguments "" test-block))) ;; should be valid with no body (should (org-test-string-exact-match org-babel-src-block-regexp (replace-regexp-in-string body "" test-block))))) (ert-deftest test-ob/default-inline-header-args () (should(equal '((:session . "none") (:results . "replace") (:exports . "results") (:hlines . "yes")) org-babel-default-inline-header-args))) (ert-deftest ob-test/org-babel-combine-header-arg-lists () (let ((results (org-babel-combine-header-arg-lists '((foo . :any) (bar) (baz . ((foo bar) (baz))) (qux . ((foo bar baz qux))) (quux . ((foo bar)))) '((bar) (baz . ((baz))) (quux . :any))))) (dolist (pair '((foo . :any) (bar) (baz . ((baz))) (quux . :any) (qux . ((foo bar baz qux))))) (should (equal (cdr pair) (cdr (assoc (car pair) results))))))) ;;; ob-get-src-block-info (ert-deftest test-ob/get-src-block-info-language () (org-test-at-marker nil org-test-file-ob-anchor (let ((info (org-babel-get-src-block-info))) (should (string= "emacs-lisp" (nth 0 info)))))) (ert-deftest test-ob/get-src-block-info-body () (org-test-at-marker nil org-test-file-ob-anchor (let ((info (org-babel-get-src-block-info))) (should (string-match (regexp-quote org-test-file-ob-anchor) (nth 1 info)))))) (ert-deftest test-ob/get-src-block-info-tangle () (org-test-at-marker nil org-test-file-ob-anchor (let ((info (org-babel-get-src-block-info))) (should (string= "no" (cdr (assq :tangle (nth 2 info)))))))) (ert-deftest test-ob/post-header-arguments () "When the result of a post-processing source block is an empty list, then it should be treated as such; not as the symbol nil." (should (let ((default-directory temporary-file-directory)) (org-test-with-temp-text " #+name: addheader #+header: :var rows=\"\" #+begin_src elisp :hlines yes '() #+end_src #+header: :post addheader(*this*) #+begin_src emacs-lisp :results table #+end_src #+RESULTS: : nil" (org-babel-execute-src-block) (goto-char (1- (point-max))) (equal (buffer-substring-no-properties (line-beginning-position) (line-end-position)) "#+RESULTS:"))))) (ert-deftest test-ob/elisp-in-header-arguments () "Test execution of elisp forms in header arguments." (org-test-with-temp-text-in-file " * elisp forms in header arguments :PROPERTIES: :header-args: :var prop = (* 7 6) :END: #+begin_src emacs-lisp prop #+end_src" (goto-char (point-min)) (org-babel-next-src-block) (should (= 42 (org-babel-execute-src-block))))) (ert-deftest test-ob/simple-named-code-block () "Test that simple named code blocks can be evaluated." (org-test-with-temp-text-in-file " #+name: i-have-a-name #+begin_src emacs-lisp 42 #+end_src" (org-babel-next-src-block 1) (should (= 42 (org-babel-execute-src-block))))) (ert-deftest test-ob/simple-variable-resolution () "Test that simple variable resolution is working." (org-test-with-temp-text-in-file " #+name: four #+begin_src emacs-lisp (list 1 2 3 4) #+end_src #+begin_src emacs-lisp :var four=four (length four) #+end_src" (org-babel-next-src-block 2) (should (= 4 (org-babel-execute-src-block))) (forward-line 5) (should (string= ": 4" (buffer-substring (point-at-bol) (point-at-eol))))) ;; Test reading lists. (org-test-with-temp-text-in-file " #+NAME: example-list - simple - not - nested - list #+BEGIN_SRC emacs-lisp :var x=example-list (print x) #+END_SRC" (should (equal '("simple" "list") (org-babel-execute-src-block))) (forward-line 5) (should (string= "| simple | list |" (buffer-substring (point-at-bol) (point-at-eol)))))) (ert-deftest test-ob/block-content-resolution () "Test block content resolution." (org-test-with-temp-text-in-file " #+name: four #+begin_src emacs-lisp (list 1 2 3 4) #+end_src #+begin_src emacs-lisp :var four=four[] (length (eval (car (read-from-string four)))) #+end_src" (org-babel-next-src-block 2) (should (= 4 (org-babel-execute-src-block))))) (ert-deftest test-ob/cons-cell-as-variable () "Test that cons cell can be assigned as variable." (org-test-with-temp-text " #+name: cons #+begin_src emacs-lisp (cons 1 2) #+end_src #+begin_src emacs-lisp :var x=cons x #+end_src" (org-babel-next-src-block 2) (should (equal (cons 1 2) (org-babel-execute-src-block))))) (ert-deftest test-ob/multi-line-header-arguments () "Test that multi-line header arguments and can be read." (org-test-with-temp-text-in-file " #+headers: :var letters='(a b c d e f g) #+begin_src emacs-lisp :var numbers='(1 2 3 4 5 6 7) (require 'cl-lib) (cl-map 'list #'list numbers letters) #+end_src" (org-babel-next-src-block) (let ((results (org-babel-execute-src-block))) (should (eq 'a (cadr (assoc 1 results)))) (should (eq 'd (cadr (assoc 4 results))))))) (ert-deftest test-ob/parse-header-args () (org-test-with-temp-text-in-file " #+begin_src example-lang :session :results output :var num=9 the body #+end_src" (org-babel-next-src-block) (let* ((info (org-babel-get-src-block-info)) (params (nth 2 info))) (message "%S" params) (should (equal "example-lang" (nth 0 info))) (should (string= "the body" (org-trim (nth 1 info)))) (should-not (member '(:session\ \ \ \ ) params)) (should (equal '(:session) (assq :session params))) (should (equal '(:result-type . output) (assq :result-type params))) (should (equal '(num . 9) (cdr (assq :var params))))))) (ert-deftest test-ob/parse-header-args2 () (org-test-with-temp-text-in-file " * resolving sub-trees as references #+begin_src emacs-lisp :var text=d4faa7b3-072b-4dcf-813c-dd7141c633f3 (length text) #+end_src #+begin_src org :noweb yes <> <> #+end_src ** simple subtree with custom ID :PROPERTIES: :CUSTOM_ID: simple-subtree :END: this is simple" (should (string-match (regexp-quote "this is simple") (org-babel-ref-resolve "simple-subtree"))) (org-babel-next-src-block) (should (= 14 (org-babel-execute-src-block))))) (ert-deftest test-ob/inline-src-blocks () (should (= 1 (org-test-with-temp-text "In the middle src_emacs-lisp{(+ 0 1)} of a line" (org-babel-execute-src-block)))) (should (= 2 (org-test-with-temp-text "One at the end of a line: src_emacs-lisp{(+ 1 1)}" (org-babel-execute-src-block)))) (should (= 3 (org-test-with-temp-text "src_emacs-lisp{(+ 2 1)} at the beginning of a line." (org-babel-execute-src-block)))) (should (= 4 (org-test-with-temp-text "In the middle src_emacs-lisp[:results silent\ :exports code]{(+ 3 1)} of a line" (org-babel-execute-src-block)))) (should (= 5 (org-test-with-temp-text "One at the end of a line: src_emacs-lisp[:results silent\ :exports code]{(+ 4 1)}" (org-babel-execute-src-block)))) (should (= 6 (org-test-with-temp-text "src_emacs-lisp[:results silent :exports code]{(+ 5 1)}\ at the beginning of a line." (org-babel-execute-src-block)))) (should (= 7 (org-test-with-temp-text "One also evaluated: src_emacs-lisp[:exports both\ :results silent]{(+ 6 1)}" (org-babel-execute-src-block))))) (ert-deftest test-ob/inline-src_blk-default-results-replace-line-1 () (let ((test-line "src_sh[:results output]{echo 1}") (org-babel-inline-result-wrap "=%s=")) ;; src_ at bol line 1... (org-test-with-temp-text test-line (goto-char (point-min)) (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=1=)}}}") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (forward-char) (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=1=)}}}") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (re-search-forward "{{{") ;;(should-error (org-ctrl-c-ctrl-c)) (backward-char 4) ;; last char of block body (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=1=)}}}") (buffer-substring-no-properties (point-at-bol) (point-at-eol))))) ;; src_ follows space line 1... (let ((test-line " src_emacs-lisp{ 1 }")) (org-test-with-temp-text test-line (should-error (org-ctrl-c-ctrl-c)) (forward-char) (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=1=)}}}") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (re-search-forward "{ 1 ") (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=1=)}}}") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (forward-char 6) (should-error (org-ctrl-c-ctrl-c)))) ;; Results on a subsequent line are replaced. (should (equal "src_emacs-lisp{(+ 1 2)}\n {{{results(=3=)}}}" (org-test-with-temp-text "src_emacs-lisp{(+ 1 2)}\n {{{results(=2=)}}}" (let ((org-babel-inline-result-wrap "=%s=")) (org-babel-execute-maybe)) (buffer-string)))) ;; Also handle results at the beginning of a line. (should (equal "src_emacs-lisp{(+ 1 2)}\n{{{results(=3=)}}}" (org-test-with-temp-text "src_emacs-lisp{(+ 1 2)}\n{{{results(=2=)}}}" (let ((org-babel-inline-result-wrap "=%s=")) (org-babel-execute-maybe)) (buffer-string))))) ;; Handle inline src blocks inside parsed affiliated keyword. (should (equal "#+caption: src_elisp{1} {{{results(=1=)}}}\n#+begin_src emacs-lisp\n1\n#+end_src" (org-test-with-temp-text "#+caption: src_elisp{1}\n#+begin_src emacs-lisp\n1\n#+end_src" (let ((org-babel-inline-result-wrap "=%s=")) (org-babel-execute-maybe)) (buffer-string)))) ;; Handle inline src blocks inside heading title. (should (equal "* Heading src_elisp{1} {{{results(=1=)}}}" (org-test-with-temp-text "* Heading src_elisp{1}" (let ((org-babel-inline-result-wrap "=%s=")) (org-babel-execute-maybe)) (buffer-string))))) (ert-deftest test-ob/inline-src_blk-default-results-replace-line-2 () ;; src_ at bol line 2... (let ((test-line " src_emacs-lisp{ \"x\" }") (org-babel-inline-result-wrap "=%s=")) (org-test-with-temp-text (concat "\n" test-line) (should-error (org-ctrl-c-ctrl-c)) (goto-char (point-min)) (should-error (org-ctrl-c-ctrl-c)) (forward-line) (should-error (org-ctrl-c-ctrl-c)) (forward-char) (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=x=)}}}") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))) (let ((test-line "Some text prior to block src_emacs-lisp{ \"y\" }") (org-babel-inline-result-wrap "=%s=")) (org-test-with-temp-text test-line (goto-char (point-max)) (insert (concat "\n" test-line " end")) (re-search-backward "src") (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=y=)}}} end") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (re-search-forward "\" ") (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=y=)}}} end") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (forward-char 3) (should-error (org-ctrl-c-ctrl-c))))) (ert-deftest test-ob/inline-src_blk-manual-results-replace () (let ((test-line " src_emacs-lisp[:results replace]{ \"x\" }") (org-babel-inline-result-wrap "=%s=")) (org-test-with-temp-text (concat "\n" test-line) (should-error (org-ctrl-c-ctrl-c)) (goto-char (point-max)) (org-babel-execute-maybe) (beginning-of-line) (should-error (org-ctrl-c-ctrl-c)) (forward-char) (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=x=)}}}") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))) (let ((test-line (concat " Some text prior to block " "src_emacs-lisp[:results replace]{ \"y\" }")) (org-babel-inline-result-wrap "=%s=")) (org-test-with-temp-text test-line (goto-char (point-max)) (insert (concat "\n" test-line " end")) (re-search-backward "src") (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=y=)}}} end") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (re-search-forward "\" ") (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=y=)}}} end") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (forward-char 3) (should-error (org-ctrl-c-ctrl-c))))) (ert-deftest test-ob/inline-src_blk-results-silent () (let ((test-line "src_emacs-lisp[ :results silent ]{ \"x\" }")) (org-test-with-temp-text test-line (org-babel-execute-maybe) (should (string= test-line (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))) (let ((test-line (concat " Some text prior to block src_emacs-lisp" "[ :results silent ]{ \"y\" }"))) (org-test-with-temp-text test-line (goto-char (point-max)) (insert (concat "\n" test-line " end")) (re-search-backward "src_") (org-babel-execute-maybe) (should (string= (concat test-line " end") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (re-search-forward "\" ") (org-babel-execute-maybe) (should (string= (concat test-line " end") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (forward-char 2) (should-error (org-ctrl-c-ctrl-c))))) (ert-deftest test-ob/inline-src_blk-results-raw () (let ((test-line "src_emacs-lisp[ :results raw ]{ \"x\" }")) (org-test-with-temp-text test-line (org-babel-execute-maybe) (should (string= (concat test-line " x") (buffer-string))))) (let ((test-line (concat " Some text prior to block " "src_emacs-lisp[ :results raw ]{ \"the\" }"))) (org-test-with-temp-text (concat test-line " end") (re-search-forward "src_") (org-babel-execute-maybe) (should (string= (concat test-line " the end") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (re-search-forward "\" ") (org-babel-execute-maybe) (should (string= (concat test-line " the the end") (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) (forward-char 2) (should-error (org-ctrl-c-ctrl-c))))) (ert-deftest test-ob/inline-src_blk-results-file () (let ((test-line "src_emacs-lisp[ :results file ]{ \"~/test-file\" }")) (org-test-with-temp-text test-line (org-babel-execute-maybe) (should (string= (concat test-line " {{{results([[file:~/test-file]])}}}") (buffer-substring-no-properties (point-min) (point-max))))))) (ert-deftest test-ob/inline-src_blk-results-scalar () (let ((test-line "src_emacs-lisp[ :results scalar ]{ \"x\" }") (org-babel-inline-result-wrap "=%s=")) (org-test-with-temp-text test-line (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=\"x\"=)}}}") (buffer-substring-no-properties (point-min) (point-max))))))) (ert-deftest test-ob/inline-src_blk-results-verbatim () (let ((test-line "src_emacs-lisp[ :results verbatim ]{ \"x\" }") (org-babel-inline-result-wrap "=%s=")) (org-test-with-temp-text test-line (org-babel-execute-maybe) (should (string= (concat test-line " {{{results(=\"x\"=)}}}") (buffer-substring-no-properties (point-min) (point-max))))))) (ert-deftest test-ob/inline-src_blk-wrap () (let ((org-babel-inline-result-wrap "=%s=")) ;; Export: use export snippet. (should (string-match-p "@@foo:1@@" (org-test-with-temp-text "src_emacs-lisp[:wrap export foo]{1}" (org-babel-execute-maybe) (buffer-string)))) (should (string-match-p "src_foo{1}" (org-test-with-temp-text "src_emacs-lisp[:wrap src foo]{1}" (org-babel-execute-maybe) (buffer-string)))) (should (string-match-p "src_foo\\[parameter\\]{1}" (org-test-with-temp-text "src_emacs-lisp[:wrap src foo parameter]{1}" (org-babel-execute-maybe) (buffer-string)))) (should (string-match-p "=1=" (org-test-with-temp-text "src_emacs-lisp[:wrap example]{1}" (org-babel-execute-maybe) (buffer-string)))) ;; Anything else is ignored. (should (string-match-p "{{{results(1)}}}" (org-test-with-temp-text "src_emacs-lisp[:wrap foo]{1}" (org-babel-execute-maybe) (buffer-string)))) (should (string-match-p "{{{results(a\\\\,b)}}}" (org-test-with-temp-text "src_emacs-lisp[:wrap foo]{\"a,b\"}" (org-babel-execute-maybe) (buffer-string)))))) (ert-deftest test-ob/combining-scalar-and-raw-result-types () (org-test-with-temp-text-in-file " #+begin_src sh :results scalar echo \"[[file:./cv.cls]]\" #+end_src #+name: : [[file:./cv.cls]] #+begin_src sh :results raw scalar echo \"[[file:./cv.cls]]\" #+end_src " (cl-flet ((next-result () (org-babel-next-src-block) (org-babel-execute-src-block) (goto-char (org-babel-where-is-src-block-result)) (forward-line 1))) (goto-char (point-min)) (next-result) (should (eq (org-element-type (org-element-at-point)) 'fixed-width)) (next-result) (should-not (eq (org-element-type (org-element-at-point)) 'fixed-width))))) (ert-deftest test-ob/no-defaut-value-for-var () "Test that the absence of a default value for a variable DOES THROW a proper error." (org-test-at-id "f2df5ba6-75fa-4e6b-8441-65ed84963627" (org-babel-next-src-block) (let ((err (should-error (org-babel-execute-src-block) :type 'error))) (should (equal '(error "Variable \"x\" must be assigned a default value") err))))) (ert-deftest test-ob/just-one-results-block () "Test that evaluating two times the same code block does not result in a duplicate results block." (org-test-with-temp-text "#+begin_src sh :results output\necho Hello\n#+end_src\n" (org-babel-execute-src-block) (org-babel-execute-src-block) ; second code block execution (should (search-forward "Hello")) ; the string inside the source code block (should (search-forward "Hello")) ; the same string in the results block (should-error (search-forward "Hello")))) (ert-deftest test-ob/nested-code-block () "Test nested code blocks inside code blocks don't cause problems." (should (string= "#+begin_src emacs-lisp\n 'foo\n#+end_src" (org-test-with-temp-text "#+begin_src org :results silent ,#+begin_src emacs-lisp 'foo ,#+end_src #+end_src" (let ((org-edit-src-content-indentation 2) (org-src-preserve-indentation nil)) (org-babel-execute-src-block)))))) (ert-deftest test-ob/partial-nested-code-block () "Test nested code blocks inside code blocks don't cause problems." (org-test-with-temp-text "#+begin_src org :results silent ,#+begin_src emacs-lisp #+end_src" (should (string= "#+begin_src emacs-lisp" (org-babel-execute-src-block))))) (ert-deftest test-ob/does-not-replace-a-block-with-the-results () (org-test-with-temp-text "#+NAME: foo #+BEGIN_SRC emacs-lisp 'foo #+END_SRC\n" (org-babel-next-src-block 1) (should (eq 'foo (org-babel-execute-src-block))) (goto-char (point-min)) (org-babel-next-src-block 1) (should (looking-at org-babel-src-block-regexp)))) (ert-deftest test-ob/replace-special-block-result () (should-error (org-test-with-temp-text " #+begin_src emacs-lisp :wrap special 'foo #+end_src" (org-babel-execute-src-block) (org-babel-execute-src-block) (buffer-string) (search-forward "#+begin_special" nil nil 2)))) (ert-deftest test-ob/catches-all-references () (org-test-with-temp-text " #+NAME: literal-example #+BEGIN_EXAMPLE A literal example on two lines #+END_EXAMPLE #+NAME: read-literal-example #+BEGIN_SRC emacs-lisp :var x=literal-example (cl-concatenate 'string x \" for me.\") #+END_SRC" (org-babel-next-src-block 1) (should (string= (org-babel-execute-src-block) "A literal example\non two lines\n for me.")))) (ert-deftest test-ob/ignore-reference-in-commented-headings () (should (= 2 (org-test-with-temp-text " * COMMENT H1 #+NAME: n : 1 * H2 #+NAME: n : 2 * Code #+BEGIN_SRC emacs-lisp :var x=n x #+END_SRC" (org-babel-execute-src-block))))) (ert-deftest test-ob/do-not-resolve-to-partial-names-data () (org-test-with-temp-text " #+name: base_plus | 1 | | 2 | #+name: base | 3 | | 4 | #+begin_src emacs-lisp :var x=base x #+end_src" (org-babel-next-src-block 1) (should (equal (org-babel-execute-src-block) '((3) (4)))))) (ert-deftest test-ob/do-not-resolve-to-partial-names-code () (org-test-with-temp-text " #+name: base_plus #+begin_src emacs-lisp 'bar #+end_src #+name: base #+begin_src emacs-lisp 'foo #+end_src #+begin_src emacs-lisp :var x=base x #+end_src" (org-babel-next-src-block 3) (should (equal (org-babel-execute-src-block) "foo")))) (ert-deftest test-ob/allow-spaces-around-=-in-var-specs () (org-test-with-temp-text "#+begin_src emacs-lisp :var a = 1 b = 2 c= 3 d =4 (+ a b c d) #+end_src " (should (= 10 (org-babel-execute-src-block))))) (ert-deftest test-ob/org-babel-update-intermediate () (org-test-with-temp-text "#+name: foo #+begin_src emacs-lisp 2 #+end_src #+results: foo : 4 #+begin_src emacs-lisp :var it=foo (+ it 1) #+end_src" (let ((org-babel-update-intermediate nil)) (goto-char (point-min)) (org-babel-next-src-block 2) (should (= 3 (org-babel-execute-src-block))) (goto-char (point-min)) (forward-line 6) (should (looking-at ": 4"))) (let ((org-babel-update-intermediate t)) (goto-char (point-min)) (org-babel-next-src-block 2) (should (= 3 (org-babel-execute-src-block))) (goto-char (point-min)) (forward-line 6) (should (looking-at ": 2"))))) (ert-deftest test-ob/eval-header-argument () (defvar test-ob--foo) (cl-flet ((check-eval (eval runp) (org-test-with-temp-text (format "#+begin_src emacs-lisp :eval %s (setq test-ob--foo :evald) #+end_src" eval) (let ((test-ob--foo :not-run)) (if runp (progn (should (org-babel-execute-src-block)) (should (eq test-ob--foo :evald))) (progn (should-not (org-babel-execute-src-block)) (should-not (eq test-ob--foo :evald)))))))) (check-eval "never" nil) (check-eval "no" nil) (check-eval "never-export" t) (check-eval "no-export" t) (let ((org-babel-exp-reference-buffer (current-buffer))) (check-eval "never" nil) (check-eval "no" nil) (check-eval "never-export" nil) (check-eval "no-export" nil)))) (ert-deftest test-ob/noweb-expansion () ;; Standard test. (should (string= "bar" (org-test-with-temp-text "#+begin_src sh :results output :tangle yes <> #+end_src #+name: foo #+begin_src sh bar #+end_src" (org-babel-expand-noweb-references)))) ;; Handle :noweb-sep. (should (string= "barbaz" (org-test-with-temp-text "#+begin_src sh :results output :tangle yes <> #+end_src #+begin_src sh :noweb-ref foo :noweb-sep \"\" bar #+end_src #+begin_src sh :noweb-ref foo :noweb-sep \"\" baz #+end_src" (org-babel-expand-noweb-references)))) ;; :noweb-ref is extracted from definition, not point of call. (should (string= "(+ 1 1)" (org-test-with-temp-text " * Call :PROPERTIES: :header-args: :noweb-ref bar :END: #+begin_src emacs-lisp :results output :tangle yes <> #+end_src * Evaluation :PROPERTIES: :header-args: :noweb-ref foo :END: #+begin_src sh :noweb-sep \"\" (+ 1 1) #+end_src" (org-babel-expand-noweb-references)))) ;; Handle recursive expansion. (should (equal "baz" (org-test-with-temp-text " #+begin_src emacs-lisp :noweb yes <> #+end_src #+name: foo #+begin_src emacs-lisp :noweb yes <> #+end_src #+name: bar #+begin_src emacs-lisp baz #+end_src" (org-babel-expand-noweb-references)))) ;; During recursive expansion, obey to `:noweb' property. (should (equal "<>" (org-test-with-temp-text " #+begin_src emacs-lisp :noweb yes <> #+end_src #+name: foo #+begin_src emacs-lisp :noweb no <> #+end_src #+name: bar #+begin_src emacs-lisp baz #+end_src" (org-babel-expand-noweb-references)))) ;; Respect COMMENT headlines (should (equal "C" (org-test-with-temp-text " #+begin_src emacs-lisp :noweb yes <> #+end_src * COMMENT A #+name: foo #+begin_src emacs-lisp A #+end_src * COMMENT B #+begin_src emacs-lisp :noweb-ref foo B #+end_src * C #+begin_src emacs-lisp :noweb-ref foo C #+end_src" (org-babel-expand-noweb-references)))) ;; Preserve case when replacing Noweb reference. (should (equal "(ignore)" (org-test-with-temp-text " #+begin_src emacs-lisp :noweb-ref AA \(ignore) #+end_src #+begin_src emacs-lisp :noweb yes <> #+end_src" (org-babel-expand-noweb-references)))) ;; Test :noweb-ref expansion. (should (equal "(message \"!! %s\" \"Running confpkg-test-setup\") (message \"- Ran `%s'\" 'confpkg-test-strip-package-statements) (message \"!! %s\" \"Still running confpkg-test-setup\") (message \"- Ran elisp blocks in `%s'\" 'confpkg-test-dependency-analysis) (message \"!! %s\" \"End of confpkg-test-setup\")" (org-test-with-temp-text " * Setup #+name: confpkg-test-setup #+begin_src emacs-lisp :results silent :noweb no-export (message \"!! %s\" \"Running confpkg-test-setup\") <> (message \"!! %s\" \"Still running confpkg-test-setup\") <> (message \"!! %s\" \"End of confpkg-test-setup\") #+end_src #+call: confpkg-test-setup[:results none]() * Identify cross-package dependencies #+begin_src emacs-lisp :noweb-ref confpkg-test-dependency-analysis (message \"- Ran elisp blocks in `%s'\" 'confpkg-test-dependency-analysis) #+end_src * Commenting out ~package!~ statements #+name: confpkg-test-strip-package-statements #+begin_src emacs-lisp (message \"- Ran `%s'\" 'confpkg-test-strip-package-statements) #+end_src " (goto-char (point-min)) (search-forward "begin_src") (org-babel-expand-noweb-references))))) (ert-deftest test-ob/splitting-variable-lists-in-references () (org-test-with-temp-text "" (should (= 1 (length (org-babel-ref-split-args "a=\"this, no work\"")))) (should (= 2 (length (org-babel-ref-split-args "a=\"this, no work\", b=1")))))) (ert-deftest test-ob/balanced-split () "Test `org-babel-balanced-split' specifications." (should (equal '(":a 1" "b [2 3]" "c (4 :d (5 6))") (org-babel-balanced-split ":a 1 :b [2 3] :c (4 :d (5 6))" '((32 9) . 58)))) ;; Handle un-balanced parens. (should (equal '(":foo ((6)" "bar 1") (org-babel-balanced-split ":foo ((6) :bar 1" '((32 9) . 58)))) (should (equal '(":foo \"(foo\"" "bar 2") (org-babel-balanced-split ":foo \"(foo\" :bar 2" '((32 9) . 58)))) ;; Handle un-balanced quotes. (should (equal '(":foo \"1" "bar 3") (org-babel-balanced-split ":foo \"1 :bar 3" '((32 9) . 58)))) ;; Handle empty string. (should (equal '(":foo \"\"") (org-babel-balanced-split ":foo \"\"" '((32 9) . 58)))) ;; Handle control characters within double quotes. (should (equal '(":foo \"\\n\"") (org-babel-balanced-split ":foo \"\\n\"" '((32 9) . 58))))) (ert-deftest test-ob/commented-last-block-line-no-var () (org-test-with-temp-text-in-file " #+begin_src emacs-lisp ;; #+end_src" (org-babel-next-src-block) (org-babel-execute-maybe) (should (re-search-forward "\\#\\+results:" nil t)) (forward-line) (should (string= "" (buffer-substring-no-properties (point-at-bol) (point-at-eol))))) (org-test-with-temp-text-in-file " #+begin_src emacs-lisp \"some text\";; #+end_src" (org-babel-next-src-block) (org-babel-execute-maybe) (should (re-search-forward "\\#\\+results:" nil t)) (forward-line) (should (string= ": some text" (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))) (ert-deftest test-ob/commented-last-block-line-with-var () (org-test-with-temp-text-in-file " #+begin_src emacs-lisp :var a=1 ;; #+end_src" (org-babel-next-src-block) (org-babel-execute-maybe) (re-search-forward "\\#\\+results:" nil t) (forward-line) (should (string= "" (buffer-substring-no-properties (point-at-bol) (point-at-eol))))) (org-test-with-temp-text-in-file " #+begin_src emacs-lisp :var a=2 2;; #+end_src" (org-babel-next-src-block) (org-babel-execute-maybe) (re-search-forward "\\#\\+results:" nil t) (forward-line) (should (string= ": 2" (buffer-substring-no-properties (point-at-bol) (point-at-eol)))))) (ert-deftest test-ob/org-babel-insert-result () "Test `org-babel-insert-result' specifications." ;; Do not error when output is an improper list. (should (org-test-with-temp-text " #+BEGIN_SRC emacs-lisp '((1 . nil) (2 . 3)) #+END_SRC " (org-babel-execute-maybe) t)) ;; Escape headlines when producing an example block. (should (string-match-p ",\\* Not an headline" (org-test-with-temp-text " #+BEGIN_SRC emacs-lisp \"* Not an headline\" #+END_SRC " (let ((org-babel-min-lines-for-block-output 1)) (org-babel-execute-maybe)) (buffer-string)))) ;; Escape special syntax in example blocks. (should (string-match-p ",#\\+END_SRC" (org-test-with-temp-text " #+BEGIN_SRC emacs-lisp \"#+END_SRC\" #+END_SRC " (let ((org-babel-min-lines-for-block-output 1)) (org-babel-execute-maybe)) (buffer-string)))) ;; No escaping is done with other blocks or raw type. (should-not (string-match-p ",\\* Not an headline" (org-test-with-temp-text " #+BEGIN_SRC emacs-lisp \"* Not an headline\" #+END_SRC " (let ((org-babel-min-lines-for-block-output 10)) (org-babel-execute-maybe)) (buffer-string)))) (should-not (string-match-p ",\\* Not an headline" (org-test-with-temp-text " #+BEGIN_SRC emacs-lisp :results raw \"* Not an headline\" #+END_SRC " (org-babel-execute-maybe) (buffer-string)))) (should-not (string-match-p ",\\* Not an headline" (org-test-with-temp-text " #+BEGIN_SRC emacs-lisp :results drawer \"* Not an headline\" #+END_SRC " (org-babel-execute-maybe) (buffer-string))))) (ert-deftest test-ob/remove-inline-result () "Test `org-babel-remove-inline-result' honors whitespace." (let* ((inline-sb "src_emacs-lisp{(+ 1 2)}") (inline-res " {{{results(=3=)}}}") (inline-sb-dot (concat inline-sb ".")) (inline-sb-res-dot (concat inline-sb inline-res "."))) (org-test-with-temp-text ;; Insert inline_src_block followed by dot. inline-sb-dot ;; Insert result before dot. (org-babel-execute-maybe) (should (string= inline-sb-res-dot (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) ;; Delete whitespace and result. (org-babel-remove-inline-result) (should (string= inline-sb-dot (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) ;; Add whitespace and result before dot. (search-forward inline-sb) (insert " " inline-res) (goto-char (point-at-bol)) ;; Remove whitespace and result. (org-babel-remove-inline-result) (should (string= inline-sb-dot (buffer-substring-no-properties (point-at-bol) (point-at-eol)))) ;; Add whitespace before dot. (search-forward inline-sb) (insert " ") (goto-char (point-at-bol)) ;; Add result before whitespace. (org-babel-execute-maybe) ;; Remove result - leave trailing whitespace and dot. (org-babel-remove-inline-result) (should (string= (concat inline-sb " .") (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))) (ert-deftest test-ob/org-babel-remove-result--results-default () "Test `org-babel-remove-result' with default :results." (mapcar (lambda (language) (test-ob-verify-result-and-removed-result "\n" (concat "* org-babel-remove-result #+begin_src " language " #+end_src * next heading"))) '("emacs-lisp"))) (ert-deftest test-ob/org-babel-results-indented-wrap () "Ensure that wrapped results are inserted correction when indented. If not inserted correctly then the second evaluation will fail trying to find the :END: marker." (org-test-with-temp-text "- indented #+begin_src sh :results file wrap echo test.txt #+end_src" (org-babel-next-src-block 1) (org-babel-execute-src-block) (org-babel-execute-src-block))) (ert-deftest test-ob/org-babel-results-indented-list () "Test that :results value list indents multi-line items correctly." (should (string= "- Foo1 Bar1 - Foo2 Bar2 " (org-test-with-temp-text "#+begin_src emacs-lisp :results value list '(\"Foo1 Bar1\" \"Foo2 Bar2\") #+end_src" (org-babel-execute-src-block) (org-forward-element) (org-narrow-to-element) (delete-trailing-whitespace) (buffer-string))))) (ert-deftest test-ob/file-desc-header-argument () "Test that the :file-desc header argument is used." (org-test-with-temp-text "#+begin_src emacs-lisp :results file :file-desc bar \"foo\" #+end_src #+begin_src emacs-lisp :results file :file-desc \"foo\" #+end_src" (org-babel-execute-src-block) (org-babel-next-src-block 1) (org-babel-execute-src-block) (goto-char (point-min)) (should (search-forward "[[file:foo][bar]]" nil t)) (should (search-forward "[[file:foo][foo]]" nil t))) (should (string-match-p (regexp-quote "[[file:foo]]") (org-test-with-temp-text " #+begin_src emacs-lisp :results file :file-desc [] \"foo\" #+end_src" (org-babel-next-src-block) (org-babel-execute-src-block) (buffer-substring-no-properties (point-min) (point-max))))) (should (string-match-p (regexp-quote "[[file:foo][foo]]") (org-test-with-temp-text " #+begin_src emacs-lisp :results file :file-desc \"foo\" #+end_src" (org-babel-next-src-block) (org-babel-execute-src-block) (buffer-substring-no-properties (point-min) (point-max)))))) (ert-deftest test-ob/result-file-link-type-header-argument () "Ensure that the result is a link to a file. The file is just a link to `:file' value. Inhibit non-empty result write to `:file' value." (org-test-with-temp-text " #+begin_src shell :results value file link :file \"/tmp/test.txt\" echo \"hello\" > /tmp/test.txt echo \"test\" #+end_src" (org-babel-execute-src-block) (should (search-forward "[[file:/tmp/test.txt]]" nil t)) (should (with-temp-buffer (insert-file-contents "/tmp/test.txt") (string= "hello\n" (buffer-string))))) ;; Without "link" output type, the result is not a file. (should-not (org-test-with-temp-text " #+begin_src shell :results value link :file \"/tmp/test.txt\" echo \"hello\" > /tmp/test.txt echo \"test\" #+end_src" (org-babel-execute-src-block) (search-forward "[[file:/tmp/test.txt]]" nil t)))) (ert-deftest test-ob/result-graphics-link-type-header-argument () "Ensure that the result is a link to a file. The file is just a link to `:file' value. Inhibit non-empty result write to `:file' value." (org-test-with-temp-text " #+begin_src shell :results value file graphics :file \"/tmp/test.txt\" echo \"hello\" > /tmp/test.txt echo \"test\" #+end_src" (org-babel-execute-src-block) (should (search-forward "[[file:/tmp/test.txt]]" nil nil)) (should (with-temp-buffer (insert-file-contents "/tmp/test.txt") (string= "hello\n" (buffer-string))))) ;; Without "link" output type, the result is not a file. (should-not (org-test-with-temp-text " #+begin_src shell :results value graphics :file \"/tmp/test.txt\" echo \"hello\" > /tmp/test.txt echo \"test\" #+end_src" (org-babel-execute-src-block) (search-forward "[[file:/tmp/test.txt]]" nil t)))) (ert-deftest test-ob/inline-src_blk-preceded-punct-preceded-by-point () (let ((test-line ".src_emacs-lisp[ :results verbatim ]{ \"x\" }") (org-babel-inline-result-wrap "=%s=")) (org-test-with-temp-text test-line (forward-char 1) (org-babel-execute-maybe) (should (re-search-forward "=\"x\"=" nil t)) (forward-line)))) (defun test-ob-verify-result-and-removed-result (result buffer-text) "Test helper function to test `org-babel-remove-result'. A temp buffer is populated with BUFFER-TEXT, the first block is executed, and the result of execution is verified against RESULT. The block is actually executed /twice/ to ensure result replacement happens correctly." (org-test-with-temp-text buffer-text (org-babel-next-src-block) (org-babel-execute-maybe) (org-babel-execute-maybe) (should (re-search-forward "\\#\\+results:" nil t)) (forward-line) (should (string= result (buffer-substring-no-properties (point-at-bol) (- (point-max) 16)))) (org-babel-previous-src-block) (org-babel-remove-result) (should (string= buffer-text (buffer-substring-no-properties (point-min) (point-max)))))) (ert-deftest test-ob/org-babel-remove-result--results-list () "Test `org-babel-remove-result' with :results list." (test-ob-verify-result-and-removed-result "- 1 - 2 - 3" "* org-babel-remove-result #+begin_src emacs-lisp :results list '(1 2 3) #+end_src * next heading")) (ert-deftest test-ob/org-babel-remove-result--results-wrap () "Test `org-babel-remove-result' with :results wrap." (test-ob-verify-result-and-removed-result ":results: hello there :end:" "* org-babel-remove-result #+begin_src emacs-lisp :results wrap \"hello there\" #+end_src * next heading")) (ert-deftest test-ob/org-babel-remove-result--results-org () "Test `org-babel-remove-result' with :results org." (test-ob-verify-result-and-removed-result "#+begin_src org ,* heading ,** subheading content #+end_src" "* org-babel-remove-result #+begin_src emacs-lisp :results org \"* heading ,** subheading content\" #+end_src * next heading")) (ert-deftest test-ob/org-babel-remove-result--results-html () "Test `org-babel-remove-result' with :results html." (test-ob-verify-result-and-removed-result "#+begin_export html #+end_export" "* org-babel-remove-result #+begin_src emacs-lisp :results html \"\" #+end_src * next heading")) (ert-deftest test-ob/org-babel-remove-result--results-latex () "Test `org-babel-remove-result' with :results latex." (test-ob-verify-result-and-removed-result "#+begin_export latex Line 1 Line 2 Line 3 #+end_export" "* org-babel-remove-result #+begin_src emacs-lisp :results latex \"Line 1 Line 2 Line 3\" #+end_src * next heading")) (ert-deftest test-ob/org-babel-remove-result--results-code () "Test `org-babel-remove-result' with :results code." (test-ob-verify-result-and-removed-result "#+begin_src emacs-lisp \"I am working!\" #+end_src" "* org-babel-remove-result #+begin_src emacs-lisp :results code (message \"I am working!\") #+end_src * next heading")) (ert-deftest test-ob/org-babel-remove-result--results-pp () "Test `org-babel-remove-result' with :results pp." (test-ob-verify-result-and-removed-result ": \"I /am/ working!\"" "* org-babel-remove-result #+begin_src emacs-lisp :results pp \"I /am/ working!\") #+end_src * next heading")) (ert-deftest test-ob/org-babel-remove-result--no-blank-line () "Test `org-babel-remove-result' without blank line between code and results." (should (equal " #+begin_src emacs-lisp (+ 1 1) #+end_src #+results: : 2 * next heading" (org-test-with-temp-text " #+begin_src emacs-lisp (+ 1 1) #+end_src #+results: : 2 * next heading" (org-babel-execute-maybe) (buffer-string))))) (ert-deftest test-ob/results-do-not-replace-code-blocks () (org-test-with-temp-text "Block two has a space after the name. #+name: foo #+begin_src emacs-lisp 1 #+end_src #+name: foo #+begin_src emacs-lisp 2 #+end_src #+name: foo #+begin_src emacs-lisp 3 #+end_src #+RESULTS: foo : foo " (dolist (num '(1 2 3)) ;; execute the block (goto-char (point-min)) (org-babel-next-src-block num) (org-babel-execute-src-block) ;; check the results (goto-char (point-max)) (move-beginning-of-line 0) (should (looking-at (format ": %d" num)))))) (ert-deftest test-ob/blocks-with-spaces () "Test expansion of blocks followed by blank lines." ;; Preserve number of blank lines after block. (should (equal "#+BEGIN_SRC emacs-lisp \(+ 1 2) #+END_SRC #+RESULTS: : 3\n\n\n" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp \(+ 1 2) #+END_SRC\n\n\n" (let ((org-babel-results-keyword "RESULTS")) (org-babel-execute-src-block)) (buffer-string)))) ;; Do not add spurious blank lines after results. (should (equal " - item 1 #+begin_src emacs-lisp 0 #+end_src #+RESULTS: : 0 - item 2" (org-test-with-temp-text " - item 1 #+begin_src emacs-lisp 0 #+end_src - item 2" (org-babel-execute-src-block) (buffer-string)))) (should (equal " - item 1 #+begin_src emacs-lisp 1 #+end_src #+RESULTS: : 1 - item 2" (org-test-with-temp-text " - item 1 #+begin_src emacs-lisp 1 #+end_src #+RESULTS: : 1 - item 2" (org-babel-execute-src-block) (buffer-string))))) (ert-deftest test-ob/results-in-narrowed-buffer () "Test block execution in a narrowed buffer." ;; If results don't exist, they should be inserted in visible part ;; of the buffer. (should (equal "#+BEGIN_SRC emacs-lisp\n(+ 1 2)\n#+END_SRC\n\n#+RESULTS:\n: 3" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 2)\n#+END_SRC\n\nParagraph" (narrow-to-region (point) (save-excursion (forward-line 3) (point))) (let ((org-babel-results-keyword "RESULTS")) (org-babel-execute-src-block)) (org-trim (buffer-string))))) (should (equal "#+NAME: test\n#+BEGIN_SRC emacs-lisp\n(+ 1 2)\n#+END_SRC\n\n#+RESULTS: test\n: 3" (org-test-with-temp-text "#+NAME: test\n#+BEGIN_SRC emacs-lisp\n(+ 1 2)\n#+END_SRC\n\nParagraph" (narrow-to-region (point) (save-excursion (forward-line 4) (point))) (let ((org-babel-results-keyword "RESULTS")) (org-babel-execute-src-block)) (org-trim (buffer-string))))) ;; Results in visible part of buffer, should be updated here. (should (equal "#+NAME: test #+BEGIN_SRC emacs-lisp \(+ 1 2) #+END_SRC #+RESULTS: test : 3" (org-test-with-temp-text "#+NAME: test #+BEGIN_SRC emacs-lisp \(+ 1 2) #+END_SRC #+RESULTS: test : 4 Paragraph" (narrow-to-region (point-min) (point)) (goto-char (point-min)) (let ((org-babel-results-keyword "RESULTS")) (org-babel-execute-src-block)) (org-trim (buffer-string))))) ;; Results in invisible part of buffer, should be updated there. (org-test-with-temp-text "#+NAME: test #+BEGIN_SRC emacs-lisp \(+ 1 2) #+END_SRC #+RESULTS: test : 4 Paragraph" (narrow-to-region (point) (save-excursion (forward-line 4) (point))) (let ((org-babel-results-keyword "RESULTS")) (org-babel-execute-src-block)) (should-not (re-search-forward "^#\\+RESULTS:" nil t)) (widen) (should (re-search-forward "^: 3" nil t)))) (ert-deftest test-ob/specific-colnames () "Test passing specific column names." (should (equal "#+name: input-table | id | var1 | |----+------| | 1 | bar | | 2 | baz | #+begin_src sh :var data=input-table :results table :exports results :colnames '(Rev Author) echo \"$data\" #+end_src #+RESULTS: | Rev | Author | |-----+--------| | 1 | bar | | 2 | baz | " (org-test-with-temp-text "#+name: input-table | id | var1 | |----+------| | 1 | bar | | 2 | baz | #+begin_src sh :var data=input-table :results table :exports results :colnames '(Rev Author) echo \"$data\" #+end_src " ;; we should find a code block (should (re-search-forward org-babel-src-block-regexp nil t)) (goto-char (match-beginning 0)) ;; now that we've located the code block, it may be evaluated (let ((org-babel-results-keyword "RESULTS")) (org-babel-execute-src-block)) (buffer-string))))) (ert-deftest test-ob/location-of-header-arg-eval () "Test location of header argument evaluation." (org-test-with-temp-text " #+name: top-block #+begin_src emacs-lisp :var pt=(point) pt #+end_src #+name: bottom-block #+begin_src emacs-lisp :var pt=top-block() pt #+end_src " ;; the value of the second block should be greater than the first (should (< (progn (re-search-forward org-babel-src-block-regexp nil t) (goto-char (match-beginning 0)) (prog1 (save-match-data (org-babel-execute-src-block)) (goto-char (match-end 0)))) (progn (re-search-forward org-babel-src-block-regexp nil t) (goto-char (match-beginning 0)) (org-babel-execute-src-block)))))) (ert-deftest test-ob/preserve-results-indentation () "Preserve indentation when executing a source block." (should (equal '(2 2) (org-test-with-temp-text " #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src" (org-babel-execute-src-block) (let ((case-fold-search t)) (search-forward "RESULTS")) (list (current-indentation) (progn (forward-line) (current-indentation)))))) (should (equal '(2 2) (org-test-with-temp-text " #+name: block\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src" (org-babel-execute-src-block) (let ((case-fold-search t)) (search-forward "RESULTS")) (list (current-indentation) (progn (forward-line) (current-indentation)))))) ;; Don't get fooled by TAB-based indentation. (should (equal '(6 6) (org-test-with-temp-text "\t #+begin_src emacs-lisp\n\t (+ 1 1)\n\t #+end_src" (setq tab-width 4) (org-babel-execute-src-block) (let ((case-fold-search t)) (search-forward "RESULTS")) (list (current-indentation) (progn (forward-line) (current-indentation)))))) ;; Properly indent examplified blocks. (should (equal " #+begin_example 0 1 2 3 4 5 6 7 8 9 #+end_example " (org-test-with-temp-text " #+begin_src emacs-lisp :results output (dotimes (i 10) (princ i) (princ \"\\n\")) #+end_src" (org-babel-execute-src-block) (search-forward "begin_example") (downcase (buffer-substring-no-properties (line-beginning-position) (point-max)))))) ;; Properly indent "org" blocks. (should (equal " #+begin_src org 0 1 2 3 4 5 6 7 8 9 #+end_src " (org-test-with-temp-text " #+begin_src emacs-lisp :results output org (dotimes (i 10) (princ i) (princ \"\\n\")) #+end_src" (org-babel-execute-src-block) (search-forward "begin_src org") (downcase (buffer-substring-no-properties (line-beginning-position) (point-max))))))) (ert-deftest test-ob/preserve-comma-escape () "Preserve comma escapes when inserting results." (should (equal "#+begin_example line 1 ,* headline 2 ,* headline 3 ,* headline 4 ,* headline 5 #+end_example " (org-test-with-temp-text "#+begin_src emacs-lisp :wrap example \"line 1 ,* headline 2 ,* headline 3 ,* headline 4 ,* headline 5 \" #+end_src " (org-babel-execute-src-block) (let ((case-fold-search t)) (search-forward "result" nil t)) (downcase (buffer-substring-no-properties (line-beginning-position 2) (point-max)))))) (should (string-match-p ",#" (org-test-with-temp-text "#+begin_src emacs-lisp :wrap export foo \"#+keyword: value\" #+end_src" (org-babel-execute-src-block) (buffer-string)))) (should (string-match-p ",#" (org-test-with-temp-text "#+begin_src emacs-lisp :wrap src foo \"#+keyword: value\" #+end_src" (org-babel-execute-src-block) (buffer-string)))) ;; Do not comma-escape when the block is not verbatim. (should-not (string-match-p ",#" (org-test-with-temp-text "#+begin_src emacs-lisp :wrap special \"#+keyword: value\" #+end_src" (org-babel-execute-src-block) (buffer-string))))) (ert-deftest test-ob/safe-header-args () "Detect safe and unsafe header args." (let ((safe-args '((:cache . "foo") (:results . "output") (:eval . "never") (:eval . "query"))) (unsafe-args '((:eval . "yes") (:results . "output file") (:foo . "bar"))) (malformed-args '((bar . "foo") ("foo" . "bar") :foo)) (safe-p (org-babel-header-args-safe-fn org-babel-safe-header-args))) (dolist (arg safe-args) (should (org-babel-one-header-arg-safe-p arg org-babel-safe-header-args))) (dolist (arg unsafe-args) (should (not (org-babel-one-header-arg-safe-p arg org-babel-safe-header-args)))) (dolist (arg malformed-args) (should (not (org-babel-one-header-arg-safe-p arg org-babel-safe-header-args)))) (should (not (funcall safe-p (append safe-args unsafe-args)))))) (ert-deftest test-ob/noweb-expansions-in-cache () "Ensure that noweb expansions are expanded before caching." (defvar noweb-expansions-in-cache-var) (let ((noweb-expansions-in-cache-var 0)) (org-test-with-temp-text " #+name: foo #+begin_src emacs-lisp \"I said\" #+end_src #+name: bar #+begin_src emacs-lisp :noweb yes :cache yes (setq noweb-expansions-in-cache-var (+ 1 noweb-expansions-in-cache-var)) (concat <> \" check noweb expansions\") #+end_src " ;; run the second block to create the cache (goto-char (point-min)) (re-search-forward (regexp-quote "#+name: bar")) (should (string= "I said check noweb expansions" (org-babel-execute-src-block))) (should (= noweb-expansions-in-cache-var 1)) ;; change the value of the first block (goto-char (point-min)) (re-search-forward (regexp-quote "said")) (goto-char (match-beginning 0)) (insert "haven't ") (re-search-forward (regexp-quote "#+name: bar")) (should (string= "I haven't said check noweb expansions" (org-babel-execute-src-block))) (should (= noweb-expansions-in-cache-var 2))))) (ert-deftest test-ob/file-ext-and-output-dir () (org-test-at-id "93573e1d-6486-442e-b6d0-3fedbdc37c9b" (org-babel-next-src-block) (should (equal "file-ext-basic.txt" (cdr (assq :file (nth 2 (org-babel-get-src-block-info t)))))) (org-babel-next-src-block) (should (equal "foo/file-ext-dir-relative.txt" (cdr (assq :file (nth 2 (org-babel-get-src-block-info t)))))) (org-babel-next-src-block) (should (equal "foo/file-ext-dir-relative-slash.txt" (cdr (assq :file (nth 2 (org-babel-get-src-block-info t)))))) (org-babel-next-src-block) (should (equal "/tmp/file-ext-dir-absolute.txt" (cdr (assq :file (nth 2 (org-babel-get-src-block-info t)))))) (org-babel-next-src-block) (should (equal "foo.bar" (cdr (assq :file (nth 2 (org-babel-get-src-block-info t)))))) (org-babel-next-src-block) (should (equal "xxx/foo.bar" (cdr (assq :file (nth 2 (org-babel-get-src-block-info t)))))) )) (ert-deftest test-ob/file-mode () "Ensure that :file-mode results in expected permissions." (should (equal #o755 (org-test-with-temp-text-in-file " #+begin_src emacs-lisp :results file :file t.sh :file-mode (identity #o755) nil #+end_src" (org-babel-next-src-block) (org-babel-execute-src-block) (unwind-protect (file-modes "t.sh") (delete-file "t.sh")))))) (ert-deftest test-ob-core/dir-attach () "Test :dir header using special 'attach value" (should (org-test-with-temp-text-in-file "* 'attach Symbol #+begin_src elisp :dir 'attach :results file (with-temp-file \"test.txt\" (insert \"attachment testing\n\")) \"test.txt\" #+end_src" (org-id-get-create) (org-babel-execute-src-block) (goto-char (org-babel-where-is-src-block-result)) (forward-line) (and (file-exists-p (format "%s/test.txt" (org-attach-dir nil t))) (string= (buffer-substring-no-properties (point) (line-end-position)) "[[attachment:test.txt]]")))) (should (org-test-with-temp-text-in-file "* 'attach String #+begin_src elisp :dir \"'attach\" :results file (with-temp-file \"test.txt\" (insert \"attachment testing\n\")) \"test.txt\" #+end_src" (org-id-get-create) (org-babel-execute-src-block) (goto-char (org-babel-where-is-src-block-result)) (forward-line) (and (file-exists-p (format "%s/test.txt" (org-attach-dir nil t))) (string= (buffer-substring-no-properties (point) (line-end-position)) "[[attachment:test.txt]]")))) (should (org-test-with-temp-text-in-file "* 'attach with Existing DIR property :PROPERTIES: :DIR: custom-attach-dir :END: #+begin_src elisp :dir 'attach :results file (with-temp-file \"test.txt\" (insert \"attachment testing\n\")) \"test.txt\" #+end_src" (message "DIR: %s" (org-attach-dir t)) (org-babel-execute-src-block) (goto-char (org-babel-where-is-src-block-result)) (forward-line) (and (file-exists-p (format "%s/test.txt" (org-attach-dir nil t))) (string= (buffer-substring-no-properties (point) (line-end-position)) "[[attachment:test.txt]]")))) ;; Strip attach dir from the file path. (should (org-test-with-temp-text-in-file "* heading :PROPERTIES: :DIR: custom-attach-dir :END: #+begin_src elisp :results value file \"custom-attach-dir/test.txt\" #+end_src" (message "DIR: %s" (org-attach-dir t)) (org-babel-execute-src-block) (goto-char (org-babel-where-is-src-block-result)) (forward-line) (string= (buffer-substring-no-properties (point) (line-end-position)) "[[attachment:test.txt]]"))) (should-error (org-test-with-temp-text-in-file "* 'attach with no ID or DIR #+begin_src elisp :dir 'attach :results file (with-temp-file \"test.txt\" (insert \"attachment testing\n\")) \"test.txt\" #+end_src" (org-babel-execute-src-block) (goto-char (org-babel-where-is-src-block-result)) (forward-line) (and (file-exists-p (format "%s/test.txt" (org-attach-dir nil t))) (string= (buffer-substring-no-properties (point) (line-end-position)) "[[attachment:test.txt]]"))))) (ert-deftest test-ob-core/dir-mkdirp () "Test :mkdirp with :dir header combination." (should-not (org-test-with-temp-text-in-file "#+begin_src emacs-lisp :dir \"data/code\" t #+end_src" (org-babel-execute-src-block) (message default-directory) (file-directory-p "data/code"))) (should-not (org-test-with-temp-text-in-file "#+begin_src emacs-lisp :mkdirp no :dir \"data/code\" t #+end_src" (org-babel-execute-src-block) (message default-directory) (file-directory-p "data/code"))) (should (org-test-with-temp-text-in-file "#+begin_src emacs-lisp :mkdirp yes :dir \"data/code\" t #+end_src" (org-babel-execute-src-block) (message default-directory) (prog1 (file-directory-p "data/code") (delete-directory "data" t)))) (should (equal "/tmp/test-dir-no-mkdirp/" (org-test-with-temp-text-in-file "#+begin_src emacs-lisp :dir /tmp/test-dir-no-mkdirp default-directory #+end_src" (org-babel-execute-src-block))))) (ert-deftest test-ob/script-escape () ;; Empty list. (should (equal nil (org-babel-script-escape "[]"))) (should (equal nil (org-babel-script-escape "()"))) (should (equal nil (org-babel-script-escape "'()"))) (should (equal nil (org-babel-script-escape "{}"))) ;; Delimited lists of numbers (should (equal '(1 2 3) (org-babel-script-escape "[1 2 3]"))) (should (equal '(1 2 3) (org-babel-script-escape "{1 2 3}"))) (should (equal '(1 2 3) (org-babel-script-escape "(1 2 3)"))) ;; Delimited lists of double-quoted strings (should (equal '("foo" "bar") (org-babel-script-escape "(\"foo\" \"bar\")"))) (should (equal '("foo" "bar") (org-babel-script-escape "[\"foo\" \"bar\"]"))) (should (equal '("foo" "bar") (org-babel-script-escape "{\"foo\" \"bar\"}"))) ;; ... with commas (should (equal '("foo" "bar") (org-babel-script-escape "(\"foo\", \"bar\")"))) (should (equal '("foo" "bar") (org-babel-script-escape "[\"foo\", \"bar\"]"))) (should (equal '("foo" "bar") (org-babel-script-escape "{\"foo\", \"bar\"}"))) ;; Delimited lists of single-quoted strings (should (equal '("foo" "bar") (org-babel-script-escape "('foo' 'bar')"))) (should (equal '("foo" "bar") (org-babel-script-escape "['foo' 'bar']"))) (should (equal '("foo" "bar") (org-babel-script-escape "{'foo' 'bar'}"))) ;; ... with commas (should (equal '("foo" "bar") (org-babel-script-escape "('foo', 'bar')"))) (should (equal '("foo" "bar") (org-babel-script-escape "['foo', 'bar']"))) (should (equal '("foo" "bar") (org-babel-script-escape "{'foo', 'bar'}"))) ;; Single quoted strings (should (equal "foo" (org-babel-script-escape "'foo'"))) ;; ... with internal double quote (should (equal "foo\"bar" (org-babel-script-escape "'foo\"bar'"))) ;; ... with internal backslash (should (equal "foo\\bar" (org-babel-script-escape "'foo\\bar'"))) ;; ... with internal escaped backslash (should (equal "foo\\bar" (org-babel-script-escape "'foo\\\\bar'"))) ;; ... with internal backslash-double quote (should (equal "foo\\\"bar" (org-babel-script-escape "'foo\\\"bar'"))) ;; ... with internal escaped backslash-double quote (should (equal "foo\\\"bar" (org-babel-script-escape "'foo\\\\\"bar'"))) ;; ... with internal escaped single quote (should (equal "foo'bar" (org-babel-script-escape "'foo\\'bar'"))) ;; ... with internal escaped backslash-escaped single quote (should (equal "foo\\'bar" (org-babel-script-escape "'foo\\\\\\'bar'"))) ;; Double quoted strings (should (equal "foo" (org-babel-script-escape "\"foo\""))) ;; ... with internal single quote (should (equal "foo'bar" (org-babel-script-escape "\"foo'bar\""))) ;; ... with internal backslash (should (equal "foo\\bar" (org-babel-script-escape "\"foo\\bar\""))) ;; ... with internal escaped backslash (should (equal "foo\\bar" (org-babel-script-escape "\"foo\\\\bar\""))) ;; ... with internal backslash-single quote (should (equal "foo\\'bar" (org-babel-script-escape "\"foo\\'bar\""))) ;; ... with internal escaped backslash-single quote (should (equal "foo\\'bar" (org-babel-script-escape "\"foo\\\\'bar\""))) ;; ... with internal escaped double quote (should (equal "foo\"bar" (org-babel-script-escape "\"foo\\\"bar\""))) ;; ... with internal escaped backslash-escaped double quote (should (equal "foo\\\"bar" (org-babel-script-escape "\"foo\\\\\\\"bar\"")))) (ert-deftest test-ob/process-params-no-duplicates () (should (equal (org-babel-process-params '((:colname-names) (:rowname-names) (:result-params) (:result-type) (:var . "\"foo\""))) '((:var) (:colname-names) (:rowname-names) (:result-params) (:result-type . value))))) (defun org-test-babel-confirm-evaluate (eval-value) (org-test-with-temp-text (format "#+begin_src emacs-lisp :eval %s nil #+end_src" eval-value) (goto-char (point-min)) (let ((info (org-babel-get-src-block-info))) (org-babel-check-confirm-evaluate info)))) (ert-deftest test-ob/check-eval () (let ((org-confirm-babel-evaluate t)) ;; Non-export tests (dolist (pair '(("no" . nil) ("never" . nil) ("query" . query) ("yes" . query))) (should (eq (org-test-babel-confirm-evaluate (car pair)) (cdr pair)))) ;; Export tests (let ((org-babel-exp-reference-buffer t)) (dolist (pair '(("no" . nil) ("never" . nil) ("query" . query) ("yes" . query) ("never-export" . nil) ("no-export" . nil) ("query-export" . query))) (message (car pair)) (should (eq (org-test-babel-confirm-evaluate (car pair)) (cdr pair)))))) (let ((org-confirm-babel-evaluate nil)) ;; Non-export tests (dolist (pair '(("no" . nil) ("never" . nil) ("query" . query) ("yes" . t))) (should (eq (org-test-babel-confirm-evaluate (car pair)) (cdr pair)))) ;; Export tests (let ((org-babel-exp-reference-buffer t)) (dolist (pair '(("no" . nil) ("never" . nil) ("query" . query) ("yes" . t) ("never-export" . nil) ("no-export" . nil) ("query-export" . query))) (message (car pair)) (should (eq (org-test-babel-confirm-evaluate (car pair)) (cdr pair))))))) (ert-deftest test-ob/check-eval-noweb-expanded () "`org-confirm-babel-evaluate' function receives expanded noweb refs." (should (equal t (org-test-with-temp-text " #+name: foo #+begin_src emacs-lisp :bar #+end_src #+begin_src emacs-lisp :noweb yes <> #+end_src" (let ((org-confirm-babel-evaluate (lambda (_ body) (not (string-match-p ":bar" body))))) (org-babel-check-confirm-evaluate (org-babel-get-src-block-info)))))) ;; The code block passed to `org-confirm-babel-evaluate' does not ;; include coderefs. (should (equal t (org-test-with-temp-text " #+name: foo #+begin_src emacs-lisp :bar #+end_src #+begin_src emacs-lisp :noweb yes #(ref:foo) <> #+end_src" (let ((org-coderef-label-format "#(ref:%s)") (org-confirm-babel-evaluate (lambda (_ body) (string-match-p "ref:foo" body)))) (org-babel-check-confirm-evaluate (org-babel-get-src-block-info))))))) (defun org-test-ob/update-block-body () "Test `org-babel-update-block-body' specifications." (should (equal "#+begin_src elisp\n 2\n#+end_src" (let ((org-edit-src-content-indentation 2)) (org-test-with-temp-text "#+begin_src elisp\n(+ 1 1)\n#+end_src" (org-babel-update-block-body "2") (buffer-string))))) ;; Preserve block indentation. (should (equal " #+begin_src elisp\n 2\n #+end_src" (let ((org-edit-src-content-indentation 1)) (org-test-with-temp-text " #+begin_src elisp\n (+ 1 1)\n #+end_src" (org-babel-update-block-body "2") (buffer-string))))) ;; Ignore NEW-BODY global indentation. (should (equal "#+begin_src elisp\n 2\n#+end_src" (let ((org-edit-src-content-indentation 2)) (org-test-with-temp-text "#+begin_src elisp\n(+ 1 1)\n#+end_src" (org-babel-update-block-body " 2") (buffer-string))))) ;; When indentation should be preserved ignore the two rules above. (should (equal " #+begin_src elisp\n2\n #+end_src" (let ((org-edit-src-content-indentation 1) (org-src-preserve-indentation t)) (org-test-with-temp-text " #+begin_src elisp\n (+ 1 1)\n #+end_src" (org-babel-update-block-body "2") (buffer-string))))) (should (equal " #+begin_src elisp -i\n2\n #+end_src" (let ((org-edit-src-content-indentation 1)) (org-test-with-temp-text " #+begin_src elisp -i\n (+ 1 1)\n #+end_src" (org-babel-update-block-body "2") (buffer-string))))) (should (equal "#+begin_src elisp\n 2\n#+end_src" (let ((org-edit-src-content-indentation 2) (org-src-preserve-indentation t)) (org-test-with-temp-text "#+begin_src elisp\n(+ 1 1)\n#+end_src" (org-babel-update-block-body " 2") (buffer-string))))) (should (equal "#+begin_src elisp -i\n 2\n#+end_src" (let ((org-edit-src-content-indentation 2) (org-src-preserve-indentation t)) (org-test-with-temp-text "#+begin_src elisp -i\n(+ 1 1)\n#+end_src" (org-babel-update-block-body " 2") (buffer-string)))))) (ert-deftest test-ob/find-named-result () "Test `org-babel-find-named-result' specifications." (should (= 1 (org-test-with-temp-text "#+results: foo\n: result" (org-babel-find-named-result "foo")))) (should-not (org-test-with-temp-text "#+results: foo\n: result" (org-babel-find-named-result "bar"))) (should-not (org-test-with-temp-text "#+results: foobar\n: result" (org-babel-find-named-result "foo"))) ;; Search is case insensitive. (should (org-test-with-temp-text "#+RESULTS: FOO\n: result" (org-babel-find-named-result "foo"))) ;; Handle hash in results keyword. (should (org-test-with-temp-text "#+results[hash]: FOO\n: result" (org-babel-find-named-result "foo"))) ;; Accept orphaned affiliated keywords. (should (org-test-with-temp-text "#+results: foo" (org-babel-find-named-result "foo")))) (ert-deftest test-ob/where-is-src-block-result () "Test `org-babel-where-is-src-block-result' specifications." ;; Find anonymous results. (should (equal "#+RESULTS:" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n\n#+RESULTS:\n: 2" (goto-char (org-babel-where-is-src-block-result)) (buffer-substring-no-properties (point) (line-end-position))))) ;; Find named results. Those have priority over anonymous ones. (should (equal "#+RESULTS: example" (org-test-with-temp-text " #+NAME: example #+BEGIN_SRC emacs-lisp \(+ 1 1) #+END_SRC #+RESULTS: example : 2" (goto-char (org-babel-where-is-src-block-result)) (buffer-substring-no-properties (point) (line-end-position))))) (should (equal "#+RESULTS: example" (org-test-with-temp-text " #+NAME: example #+BEGIN_SRC emacs-lisp \(+ 1 1) #+END_SRC #+RESULTS: : fake #+RESULTS: example : 2" (goto-char (org-babel-where-is-src-block-result)) (buffer-substring-no-properties (point) (line-end-position))))) ;; Return nil when no result is found. (should-not (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC" (org-babel-where-is-src-block-result))) (should-not (org-test-with-temp-text "- item\n #+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n\n" (org-babel-where-is-src-block-result))) ;; When optional argument INSERT is non-nil, add RESULTS keyword ;; whenever no RESULTS can be found. (should (equal "#+RESULTS:" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC" (let ((org-babel-results-keyword "RESULTS")) (goto-char (org-babel-where-is-src-block-result t))) (buffer-substring-no-properties (point) (line-end-position))))) ;; Insert a named RESULTS keyword if possible. (should (equal "#+RESULTS: e" (org-test-with-temp-text "#+NAME: e\n#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC" (let ((org-babel-results-keyword "RESULTS")) (goto-char (org-babel-where-is-src-block-result t))) (buffer-substring-no-properties (point) (line-end-position))))) ;; When optional argument HASH is provided, clear RESULTS keyword ;; and related contents if they do not match it. (should (equal "#+RESULTS[bbbb]:" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n\n#+RESULTS[aaaa]:\n: 3" (let ((org-babel-results-keyword "RESULTS")) (goto-char (org-babel-where-is-src-block-result nil nil "bbbb"))) (org-trim (buffer-substring-no-properties (point) (point-max)))))) (should (equal "#+RESULTS[bbbb]:" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n\n#+RESULTS[aaaa]:" (let ((org-babel-results-keyword "RESULTS")) (goto-char (org-babel-where-is-src-block-result nil nil "bbbb"))) (org-trim (buffer-substring-no-properties (point) (point-max)))))) ;; Handle hashes with times. (should (equal "#+RESULTS[(2014-03-04 00:41:10) bbbb]:" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp \(+ 1 1) #+END_SRC #+RESULTS[(2012-03-29 16:40:12) aaaa]:" (let ((org-babel-results-keyword "RESULTS") (org-babel-hash-show-time t)) (cl-letf (((symbol-function 'format-time-string) (lambda (&rest _) "(2014-03-04 00:41:10)"))) (goto-char (org-babel-where-is-src-block-result nil nil "bbbb")) (org-trim (buffer-substring-no-properties (point) (point-max)))))))) (should (equal "#+RESULTS[(2012-03-29 16:40:12) aaaa]:" (org-test-with-temp-text " #+BEGIN_SRC emacs-lisp \(+ 1 1) #+END_SRC #+RESULTS[(2012-03-29 16:40:12) aaaa]:" (let ((org-babel-results-keyword "RESULTS") (org-babel-hash-show-time t)) (cl-letf (((symbol-function 'format-time-string) (lambda (&rest _) "(2014-03-04 00:41:10)"))) (goto-char (org-babel-where-is-src-block-result nil nil "aaaa")) (org-trim (buffer-substring-no-properties (point) (point-max)))))))) ;; RESULTS keyword may not be the last affiliated keyword. (should (equal "#+RESULTS[bbbb]:" (org-test-with-temp-text " #+BEGIN_SRC emacs-lisp \(+ 1 1) #+END_SRC #+RESULTS[aaaa]: #+NAME: e : 3" (let ((org-babel-results-keyword "RESULTS")) (goto-char (org-babel-where-is-src-block-result nil nil "bbbb"))) (org-trim (buffer-substring-no-properties (point) (point-max)))))) ;; HASH does nothing if no RESULTS can be found. However, if INSERT ;; is also non-nil, RESULTS keyword is inserted along with the ;; expected hash. (should (equal "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC" (org-babel-where-is-src-block-result nil nil "bbbb") (buffer-string)))) (should (equal "#+RESULTS[bbbb]:" (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC" (let ((org-babel-results-keyword "RESULTS")) (goto-char (org-babel-where-is-src-block-result t nil "bbbb"))) (org-trim (buffer-substring-no-properties (point) (point-max))))))) (ert-deftest test-ob/goto-named-src-block () "Test interactive use of `org-babel-goto-named-src-block'." (org-test-with-temp-text-in-file " #+NAME: abc #+BEGIN_SRC emacs-lisp :results value (1+ 1) #+END_SRC #+CALL: abc( lorem() ) :results raw :wrap EXAMPLE #+BEGIN_SRC emacs-lisp <> #+END_SRC abc #+RESULTS: abc : 2 " ;; non-existent name (should-not (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\nno-name\n")) ;; correct name (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\nabc\n") (should (= 14 (point))) ;; call line - autocompletion (forward-line 3) (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n") (should (= 14 (point))) ;; noweb reference - autocompletion (forward-line 5) (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n") (should (= 14 (point))) ;; at symbol - autocompletion (forward-line 7) (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n") (should (= 14 (point))) ;; in results - autocompletion (forward-line 8) (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n") (should (= 14 (point))) (forward-line 9) (execute-kbd-macro "\M-xorg-babel-goto-named-src-block\n\n") (should (= 14 (point))))) (ert-deftest test-ob/evaluate-body-with-coderefs () (should (= 2 (org-test-with-temp-text "#+begin_src emacs-lisp -l \"#(ref:%s)\"\n2 #(ref:foo)\n#+end_src" (org-babel-execute-src-block)))) (should (= 3 (org-test-with-temp-text "#+begin_src emacs-lisp\n3 #(ref:foo)\n#+end_src" (let ((org-coderef-label-format "#(ref:%s)")) (org-babel-execute-src-block)))))) (ert-deftest test-ob/string-to-number () (should (= 0 (org-babel--string-to-number "0"))) (should (= 1 (org-babel--string-to-number "1"))) (should (eq nil (org-babel--string-to-number "1 2"))) (should (= 1000.0 (org-babel--string-to-number "1e3"))) (should (eq 0 (org-babel--string-to-number "000"))) (should (eq 1 (org-babel--string-to-number "001"))) (should (eq 10 (org-babel--string-to-number "010"))) (should (= 100 (org-babel--string-to-number "100"))) (should (= 0.1 (org-babel--string-to-number "0.1"))) (should (= 1.0 (org-babel--string-to-number "1.0")))) (ert-deftest test-ob/import-elisp-from-file () "Test `org-babel-import-elisp-from-file'." (should (equal (org-test-with-temp-text-in-file "line 1\nline 2\n" (cl-letf (((symbol-function 'display-warning) (lambda (&rest _) (error "No warnings should occur")) (org-table-convert-region-max-lines 2))) (org-babel-import-elisp-from-file (buffer-file-name)))) '(("line" 1) ("line" 2)))) ;; If an error occurs during table conversion, it is shown with ;; `display-warning' rather than as a message to make sure the ;; caller sees it. (should-error (org-test-with-temp-text-in-file "line 1\nline 2\n" (cl-letf (((symbol-function 'display-warning) (lambda (&rest _) (error "Warning should be displayed"))) (org-table-convert-region-max-lines 1)) (org-babel-import-elisp-from-file (buffer-file-name))))) ;; But an empty file (as is the case when there are no execution ;; results) does not trigger a warning. (should-not (org-test-with-temp-text-in-file "" (cl-letf (((symbol-function 'display-warning) (lambda (&rest _) (error "No warnings should occur")))) (org-babel-import-elisp-from-file (buffer-file-name)))))) (ert-deftest test-ob/org-babel-read () "Test `org-babel-read' specifications." (dolist (inhibit '(t nil)) ;; A number (should (equal 1 (org-babel-read "1" inhibit))) (should (equal -1 (org-babel-read "-1" inhibit))) (should (equal 1.2 (org-babel-read "1.2" inhibit))) ;; Allow whitespace (should (equal 1 (org-babel-read " 1 " inhibit))) ;; Not a number (should-not (equal 1 (org-babel-read "1foo" inhibit))) ;; Empty string (should (equal "" (org-babel-read "" inhibit))) (should (equal " " (org-babel-read " " inhibit))) ;; Elisp function call (should (equal (if inhibit ;; Verbatim string, with spaces "(+ 1 2) " ;; Result of evaluation 3) (org-babel-read "(+ 1 2) " inhibit))) ;; Elisp function call must start from ( (should-not (equal 3 (org-babel-read " (+ 1 2)" nil))) (should (equal (if inhibit "'(1 2)" ;; Result of evaluation '(1 2)) (org-babel-read "'(1 2)" inhibit))) ;; `(...) (should (equal (if inhibit "`(1 ,(+ 1 2))" ;; Result of evaluation '(1 3)) (org-babel-read "`(1 ,(+ 1 2))" inhibit))) ;; [...] (should (equal (if inhibit "[1 2 (foo)]" ;; Result of evaluation [1 2 (foo)]) (org-babel-read "[1 2 (foo)]" inhibit))) ;; Special case: *this* literal is evaluated (defvar *this* nil) (let ((*this* 100)) (should (equal (if inhibit "*this*" 100) (org-babel-read "*this*" inhibit)))) ;; Special case: data inside quotes (should (equal "foo" (org-babel-read " \"foo\" " inhibit))) (should (equal "foo with\" inside" (org-babel-read " \"foo with\\\" inside\" " inhibit))) (should (equal "abc\nsdf" (org-babel-read "\"abc\nsdf\"" inhibit))) (should (equal "foo" (org-babel-read "\"foo\"" inhibit))) (should (equal "\"foo\"(\"bar\"" (org-babel-read "\"foo\"(\"bar\"" inhibit))) ;; Unpaired quotes (should (equal "\"foo\"\"bar\"" (org-babel-read "\"foo\"\"bar\"" inhibit))))) (ert-deftest test-ob/demarcate-block-split-duplication () "Test duplication of language, body, switches, and headers in splitting." (let ((caption "#+caption: caption.") (regexp (rx "#+caption: caption.")) (org-adapt-indentation nil)) (org-test-with-temp-text (format " %s #+header: :var edge=\"also duplicated\" #+header: :wrap \"src any-spanish -n\" #+name: Nobody #+begin_src any-english -i -n :var here=\"duplicated\" :wrap \"src any-english -n\" above split below split #+end_src do not org-indent-block text here " caption) (let ((wrap-val "src any-spanish -n") above below avars bvars) (org-babel-demarcate-block) (goto-char (point-min)) (org-babel-next-src-block) ;; upper source block (setq above (org-babel-get-src-block-info)) (setq avars (org-babel--get-vars (nth 2 above))) (org-babel-next-src-block) ;; lower source block (setq below (org-babel-get-src-block-info)) (setq bvars (org-babel--get-vars (nth 2 below))) ;; duplicated multi-line header arguments: (should (string= "also duplicated" (cdr (assq 'edge avars)))) (should (string= "also duplicated" (cdr (assq 'edge bvars)))) (should (string= wrap-val (cdr (assq :wrap (nth 2 above))))) (should (string= wrap-val (cdr (assq :wrap (nth 2 below))))) ;; duplicated language, other header arguments, and switches: (should (string= "any-english" (nth 0 above))) (should (string= "any-english" (nth 0 below))) (should (string= "above split" (org-trim (nth 1 above)))) (should (string= "below split" (org-trim (nth 1 below)))) (should (string= "duplicated" (cdr (assq 'here avars)))) (should (string= "duplicated" (cdr (assq 'here bvars)))) (should (string= "-i -n" (nth 3 above))) (should (string= "-i -n" (nth 3 below))) ;; non-duplication of name and caption, which is not in above/below. (should (string= "Nobody" (nth 4 above))) (should-not (string= "" (nth 4 below))) (goto-char (point-min)) (should (re-search-forward regexp)) (should-not (re-search-forward regexp nil 'noerror)))))) (ert-deftest test-ob/demarcate-block-split-prefix-point () "Test prefix argument point splitting." (let ((org-adapt-indentation t) (org-edit-src-content-indentation 2) (org-src-preserve-indentation nil) (ok-col 11) (stars "^\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*")) (org-test-with-temp-text " ********** 10 stars with point between two lines #+begin_src emacs-lisp ;; to upper block ;; to lower block #+end_src " (org-babel-demarcate-block 'a-prefix-arg) (goto-char (point-min)) (dolist (regexp `(,stars "#\\+beg" ";; to upper block" "#\\+end" ,stars "#\\+beg" ";; to lower block" "#\\+end")) (should (re-search-forward regexp)) (goto-char (match-beginning 0)) (cond ((string= regexp stars) (should (= 0 (current-column)))) ((string-prefix-p ";;" regexp) (should (= (+ ok-col org-edit-src-content-indentation) (current-column)))) (t (should (= ok-col (current-column))))))))) (ert-deftest test-ob/demarcate-block-split-prefix-region () "Test prefix argument region splitting." (let ((org-adapt-indentation t) (org-edit-src-content-indentation 2) (org-src-preserve-indentation nil) (ok-col 11) (stars "^\\*\\*\\*\\*\\*\\*\\*\\*\\*\\*") (parts '("to upper block" "mark those words as region" "to lower block"))) (org-test-with-temp-text (format " ********** 10 stars with region between two lines #+header: :var b=\"also seen\" #+begin_src any-language -i -n :var a=\"seen\" %s %s %s #+end_src " (nth 0 parts) (nth 1 parts) (nth 2 parts)) (let ((n 0) info vars) (transient-mark-mode 1) (push-mark (point) t t) (search-forward (nth 1 parts)) (org-babel-demarcate-block 'a-prefix-argument) (goto-char (point-min)) (while (< n (length parts)) (org-babel-next-src-block) (setq info (org-babel-get-src-block-info)) (setq vars (org-babel--get-vars (nth 2 info))) (should (string= "any-language" (nth 0 info))) (should (string= (nth n parts) (org-trim (nth 1 info)))) (should (string= "seen" (cdr (assq 'a vars)))) (should (string= "also seen" (cdr (assq 'b vars)))) (should (string= "-i -n" (nth 3 info))) (cl-incf n))) (goto-char (point-min)) (dolist (regexp `(,stars "#\\+beg" ,(nth 0 parts) "#\\+end" ,stars "#\\+beg" ,(nth 1 parts) "#\\+end" ,stars "#\\+beg" ,(nth 2 parts) "#\\+end")) (should (re-search-forward regexp)) (goto-char (match-beginning 0)) (cond ((string= regexp stars) (should (= 0 (current-column)))) ((memq regexp parts) (should (= (+ ok-col org-edit-src-content-indentation) (current-column)))) (t (should (= ok-col (current-column))))))))) (ert-deftest test-ob/demarcate-block-split-user-errors () "Test for `user-error's in splitting" (let ((org-adapt-indentation t) (org-edit-src-content-indentation 2) (org-src-preserve-indentation)) (let* ((caption "#+caption: caption.") (within-body ";; within-body") (below-block "# below block") (template " %s%s #+begin_src emacs-lisp %s #+end_src %s%s ")) ;; Test point at caption. (org-test-with-temp-text (format template "" caption within-body below-block "") (should-error (org-babel-demarcate-block) :type 'user-error)) ;; Test region from below the block (mark) to within the body (point). (org-test-with-temp-text (format template "" caption within-body below-block "") ;; Set mark. (transient-mark-mode 1) (push-mark (point) t t) ;; Set point. (should (search-backward within-body nil 'noerror)) (goto-char (match-beginning 0)) (should-error (org-babel-demarcate-block) :type 'user-error))))) (ert-deftest test-ob/demarcate-block-wrap-point () "Test wrapping point in blank lines below a source block." (org-test-with-temp-text " #+begin_src any-language -i -n :var here=\"not duplicated\" to upper block #+end_src " (let (info vars) (org-babel-demarcate-block) (goto-char (point-min)) (org-babel-next-src-block) (setq info (org-babel-get-src-block-info)) ;; upper source block info (setq vars (org-babel--get-vars (nth 2 info))) (should (string= "any-language" (nth 0 info))) (should (string= "to upper block" (org-trim (nth 1 info)))) (should (string= "not duplicated" (cdr (assq 'here vars)))) (should (string= "-i -n" (nth 3 info))) (org-babel-next-src-block) (setq info (org-babel-get-src-block-info)) ;; lower source block info (setq vars (org-babel--get-vars (nth 2 info))) (should (string= "any-language" (nth 0 info))) (should (string= "" (org-trim (nth 1 info)))) (should-not vars) (should (string= "" (nth 3 info)))))) (ert-deftest test-ob/demarcate-block-wrap-region () "Test wrapping region in blank lines below a source block." (let ((region-text "mark this line as region leaving point in blank lines")) (org-test-with-temp-text (format " #+begin_src any-language -i -n :var here=\"not duplicated\" to upper block #+end_src %s " region-text) (let (info vars) (transient-mark-mode 1) (push-mark (point) t t) (search-forward region-text) (exchange-point-and-mark) (org-babel-demarcate-block) (goto-char (point-min)) (org-babel-next-src-block) (setq info (org-babel-get-src-block-info)) ;; upper source block info (setq vars (org-babel--get-vars (nth 2 info))) (should (string= "any-language" (nth 0 info))) (should (string= "to upper block" (org-trim (nth 1 info)))) (should (string= "not duplicated" (cdr (assq 'here vars)))) (should (string= "-i -n" (nth 3 info))) (org-babel-next-src-block) (setq info (org-babel-get-src-block-info)) ;; lower source block info (setq vars (org-babel--get-vars (nth 2 info))) (should (string= "any-language" (nth 0 info))) (should (string= region-text (org-trim (nth 1 info)))) (should-not vars) (should (string= "" (nth 3 info))))))) (provide 'test-ob) ;;; test-ob ends here