testing: Make all files use `lexical-binding`
Mainly, add the corresponding cookie, but also add various `require`s
so that the compiler knows which vars should be trated as dynbound.
This does not fix all the warnings, but does try to eliminate
all those about "unused" variables. For the variables truly unused,
the patch usually adds an underscore to their name to silence the warning.
Some of the fixes affect files which already used `lexical-binding`.
Not sure why the test worked before: maybe because the tests were run
without compiling them first (which could cause some of the
missing `require`d packages to be autoloaded before we got to the
problematic code, thus hiding the problem)?
I found some suspicious code, for which I added FIXMEs.
There are also a few changes to the main files.
* lisp/org-protocol.el (org-protocol-check-filename-for-protocol):
Don't call `server-edit` if it's not yet defined. [ Needed to get
the tests to pass. ]
* lisp/ob-core.el (org-babel-temporary-directory)
(org-babel-temporary-stable-directory): Always define (and use nil
if we don't want to create a directory for it). Simplify the code based
on the fact that (defvar V E) only evaluates E if V is not yet `boundp`.
(org-babel-temp-file, org-babel-temp-stable-file)
(org-babel-remove-temporary-directory)
(org-babel-remove-temporary-stable-directory): Adjust accordingly.
* lisp/org.el (org-log-beginning): Add FIXME.
* testing/org-test.el: Require `org` and `org-id`.
(org-id-locations-file): Don't `defconst` it.
(org-test-at-id, org-test-in-example-file, org-test-at-marker)
(org-test-with-temp-text, org-test-with-temp-text-in-file): Move edebug
specs into `declare` (and simplify them).
(org-test-with-tramp-remote-dir--worker): Declare dynbound tramp vars.
(org--compile-when): Fix quoting of `exp`.
(org-test-load): Tweak regexps.
* testing/org-batch-test-init.el: Tweak regexp, remove dead code and
add a FIXME about it.
* testing/lisp/test-ox.el: Require `ox` instead of
erroring out if it's not already loaded. Also require `org-inlinetask`.
(org-test-with-parsed-data): Silence warnings when `info` is not used.
(test-org-export/bind-keyword): Add FIXME.
* testing/lisp/test-ox-publish.el: Require `org-test` and `ox-publish`.
(test-org-publish/resolve-external-link): Expose lambdas to
the compiler. Remove unused var `ids`.
(test-org-publish/get-project-from-filename): Remove unused var `file`.
* testing/lisp/test-org.el: Require `org-macs`, `org`,
`org-inlinetask`, `org-refile`, and `org-agenda`.
(test-org/org-read-date): Declare `org-time-was-given` as dynbound.
(test-org/set-regexps-and-options): Add FIXME.
* testing/lisp/test-org-timer.el: Require `org-timer`.
* testing/lisp/test-org-table.el: Require `ox`.
* testing/lisp/test-org-protocol.el: Require `org-protocol` instead of
erroring out if it's not already loaded. Also require `capture`, and
add missing `provide` statement.
* testing/lisp/test-org-pcomplete.el: Require `org`.
* testing/lisp/test-org-list.el: Require `org-list` and `org`.
* testing/lisp/test-org-lint.el: Require `org-footnote` and `org-lint`.
* testing/lisp/test-org-footnote.el: Require `org-footnote`.
* testing/lisp/test-org-element.el: Require `org-element` instead of
erroring out if it's not already loaded. Also require `org` and
`org-inlinetask`.
* testing/lisp/test-org-duration.el: Require `org-duration`.
* testing/lisp/test-org-datetree.el: Require `org-datetree`.
* testing/lisp/test-org-colview.el: Require `org-colview`,
`org-duration`, and `org-inlinetask`.
* testing/lisp/test-org-clock.el: Require `org-duration` and `org-clock`.
* testing/lisp/test-org-archive.el: Require `org-archive`.
* testing/lisp/test-org-agenda.el
(test-org-agenda/bulk-custom-arg-func): Add FIXME.
* testing/lisp/test-ol.el: Require `ol` and `org-id`.
(test-org-link/store-link): Declare `org-store-link-props` and add FIXME.
* testing/lisp/test-oc.el (test-org-cite/export-capability): Add FIXME.
* testing/lisp/test-ob.el: Require `ob-core`, `org-src`, `ob-ref`,
and `org-table`.
(test-ob/eval-header-argument): Rename `foo` to `test-ob--foo` and
declare it as dynbound.
(test-ob/blocks-with-spaces, test-ob/specific-colnames): Add FIXME.
(test-ob/noweb-expansions-in-cache):
Declare `noweb-expansions-in-cache-var` as dynbound.
* testing/lisp/test-ob-tangle.el: Require `org` and `ob-tangle`.
* testing/lisp/test-ob-shell.el:
* testing/lisp/test-ob-python.el: Require `ob-core`.
* testing/lisp/test-ob-lob.el: Require `ob-lob`.
(temporary-value-for-test): Declare as dynbound.
* testing/lisp/test-ob-plantuml.el: Require `ob-plantuml` instead of
erroring out if it's not already loaded.
* testing/lisp/test-ob-lilypond.el: Require `ob-lilypond` instead of
erroring out if it's not already loaded. Use `with-current-buffer`.
* testing/lisp/test-ob-julia.el: Require `ob-core`.
* testing/lisp/test-ob-java.el (org-babel-temporary-directory):
Remove dead code now that `org-babel-temporary-directory` is always bound.
* testing/lisp/test-ob-exp.el: Require `ob-exp`, `org-src`, and `org-test`.
(ob-exp/evaluate-all-executables-in-order):
Declare `*evaluation-collector*` as dynbound.
* testing/lisp/test-ob-emacs-lisp.el (ob-emacs-lisp/dynamic-lexical-edit)
(ob-emacs-lisp/dynamic-lexical-execute):
Rename dynbound var to `ob-emacs--x` and declare it as such.
* testing/lisp/test-ob-R.el: Require `ob-core`.
(ess-ask-for-ess-directory, ess-history-file): Declare vars.
2022-09-14 17:21:37 -04:00
|
|
|
;;; test-ob-shell.el -*- lexical-binding: t; -*-
|
2010-10-14 10:10:23 -04:00
|
|
|
|
2019-01-01 05:50:56 -05:00
|
|
|
;; Copyright (c) 2010-2014, 2019 Eric Schulte
|
2010-10-14 10:10:23 -04:00
|
|
|
;; Authors: Eric Schulte
|
|
|
|
|
|
2012-12-13 11:24:19 -05:00
|
|
|
;; 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
|
2021-03-20 03:27:57 -04:00
|
|
|
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
|
2012-12-13 11:24:19 -05:00
|
|
|
|
|
|
|
|
;;; Comment:
|
2010-10-14 10:10:23 -04:00
|
|
|
|
2016-08-23 16:13:56 -04:00
|
|
|
;; Template test file for Org tests
|
2010-10-14 10:10:23 -04:00
|
|
|
|
|
|
|
|
;;; Code:
|
2012-08-03 15:34:04 -04:00
|
|
|
(org-test-for-executable "sh")
|
testing: Make all files use `lexical-binding`
Mainly, add the corresponding cookie, but also add various `require`s
so that the compiler knows which vars should be trated as dynbound.
This does not fix all the warnings, but does try to eliminate
all those about "unused" variables. For the variables truly unused,
the patch usually adds an underscore to their name to silence the warning.
Some of the fixes affect files which already used `lexical-binding`.
Not sure why the test worked before: maybe because the tests were run
without compiling them first (which could cause some of the
missing `require`d packages to be autoloaded before we got to the
problematic code, thus hiding the problem)?
I found some suspicious code, for which I added FIXMEs.
There are also a few changes to the main files.
* lisp/org-protocol.el (org-protocol-check-filename-for-protocol):
Don't call `server-edit` if it's not yet defined. [ Needed to get
the tests to pass. ]
* lisp/ob-core.el (org-babel-temporary-directory)
(org-babel-temporary-stable-directory): Always define (and use nil
if we don't want to create a directory for it). Simplify the code based
on the fact that (defvar V E) only evaluates E if V is not yet `boundp`.
(org-babel-temp-file, org-babel-temp-stable-file)
(org-babel-remove-temporary-directory)
(org-babel-remove-temporary-stable-directory): Adjust accordingly.
* lisp/org.el (org-log-beginning): Add FIXME.
* testing/org-test.el: Require `org` and `org-id`.
(org-id-locations-file): Don't `defconst` it.
(org-test-at-id, org-test-in-example-file, org-test-at-marker)
(org-test-with-temp-text, org-test-with-temp-text-in-file): Move edebug
specs into `declare` (and simplify them).
(org-test-with-tramp-remote-dir--worker): Declare dynbound tramp vars.
(org--compile-when): Fix quoting of `exp`.
(org-test-load): Tweak regexps.
* testing/org-batch-test-init.el: Tweak regexp, remove dead code and
add a FIXME about it.
* testing/lisp/test-ox.el: Require `ox` instead of
erroring out if it's not already loaded. Also require `org-inlinetask`.
(org-test-with-parsed-data): Silence warnings when `info` is not used.
(test-org-export/bind-keyword): Add FIXME.
* testing/lisp/test-ox-publish.el: Require `org-test` and `ox-publish`.
(test-org-publish/resolve-external-link): Expose lambdas to
the compiler. Remove unused var `ids`.
(test-org-publish/get-project-from-filename): Remove unused var `file`.
* testing/lisp/test-org.el: Require `org-macs`, `org`,
`org-inlinetask`, `org-refile`, and `org-agenda`.
(test-org/org-read-date): Declare `org-time-was-given` as dynbound.
(test-org/set-regexps-and-options): Add FIXME.
* testing/lisp/test-org-timer.el: Require `org-timer`.
* testing/lisp/test-org-table.el: Require `ox`.
* testing/lisp/test-org-protocol.el: Require `org-protocol` instead of
erroring out if it's not already loaded. Also require `capture`, and
add missing `provide` statement.
* testing/lisp/test-org-pcomplete.el: Require `org`.
* testing/lisp/test-org-list.el: Require `org-list` and `org`.
* testing/lisp/test-org-lint.el: Require `org-footnote` and `org-lint`.
* testing/lisp/test-org-footnote.el: Require `org-footnote`.
* testing/lisp/test-org-element.el: Require `org-element` instead of
erroring out if it's not already loaded. Also require `org` and
`org-inlinetask`.
* testing/lisp/test-org-duration.el: Require `org-duration`.
* testing/lisp/test-org-datetree.el: Require `org-datetree`.
* testing/lisp/test-org-colview.el: Require `org-colview`,
`org-duration`, and `org-inlinetask`.
* testing/lisp/test-org-clock.el: Require `org-duration` and `org-clock`.
* testing/lisp/test-org-archive.el: Require `org-archive`.
* testing/lisp/test-org-agenda.el
(test-org-agenda/bulk-custom-arg-func): Add FIXME.
* testing/lisp/test-ol.el: Require `ol` and `org-id`.
(test-org-link/store-link): Declare `org-store-link-props` and add FIXME.
* testing/lisp/test-oc.el (test-org-cite/export-capability): Add FIXME.
* testing/lisp/test-ob.el: Require `ob-core`, `org-src`, `ob-ref`,
and `org-table`.
(test-ob/eval-header-argument): Rename `foo` to `test-ob--foo` and
declare it as dynbound.
(test-ob/blocks-with-spaces, test-ob/specific-colnames): Add FIXME.
(test-ob/noweb-expansions-in-cache):
Declare `noweb-expansions-in-cache-var` as dynbound.
* testing/lisp/test-ob-tangle.el: Require `org` and `ob-tangle`.
* testing/lisp/test-ob-shell.el:
* testing/lisp/test-ob-python.el: Require `ob-core`.
* testing/lisp/test-ob-lob.el: Require `ob-lob`.
(temporary-value-for-test): Declare as dynbound.
* testing/lisp/test-ob-plantuml.el: Require `ob-plantuml` instead of
erroring out if it's not already loaded.
* testing/lisp/test-ob-lilypond.el: Require `ob-lilypond` instead of
erroring out if it's not already loaded. Use `with-current-buffer`.
* testing/lisp/test-ob-julia.el: Require `ob-core`.
* testing/lisp/test-ob-java.el (org-babel-temporary-directory):
Remove dead code now that `org-babel-temporary-directory` is always bound.
* testing/lisp/test-ob-exp.el: Require `ob-exp`, `org-src`, and `org-test`.
(ob-exp/evaluate-all-executables-in-order):
Declare `*evaluation-collector*` as dynbound.
* testing/lisp/test-ob-emacs-lisp.el (ob-emacs-lisp/dynamic-lexical-edit)
(ob-emacs-lisp/dynamic-lexical-execute):
Rename dynbound var to `ob-emacs--x` and declare it as such.
* testing/lisp/test-ob-R.el: Require `ob-core`.
(ess-ask-for-ess-directory, ess-history-file): Declare vars.
2022-09-14 17:21:37 -04:00
|
|
|
(require 'ob-core)
|
2013-12-13 11:54:28 -05:00
|
|
|
(unless (featurep 'ob-shell)
|
2014-01-31 11:02:03 -05:00
|
|
|
(signal 'missing-test-dependency "Support for Shell code blocks"))
|
2012-03-19 16:38:12 -04:00
|
|
|
|
2014-01-31 11:02:03 -05:00
|
|
|
(ert-deftest test-ob-shell/dont-insert-spaces-on-expanded-bodies ()
|
2010-10-14 10:10:23 -04:00
|
|
|
"Expanded shell bodies should not start with a blank line
|
|
|
|
|
unless the body of the tangled block does."
|
|
|
|
|
(should-not (string-match "^[\n\r][\t ]*[\n\r]"
|
2010-10-20 16:36:20 -04:00
|
|
|
(org-babel-expand-body:generic "echo 2" '())))
|
2010-10-14 10:10:23 -04:00
|
|
|
(should (string-match "^[\n\r][\t ]*[\n\r]"
|
2022-12-30 11:18:15 -05:00
|
|
|
(org-babel-expand-body:generic "\n\necho 2" '()))))
|
2010-10-14 10:10:23 -04:00
|
|
|
|
2014-01-31 11:02:03 -05:00
|
|
|
(ert-deftest test-ob-shell/dont-error-on-empty-results ()
|
2022-12-30 11:18:15 -05:00
|
|
|
"Empty results should not cause a Lisp error."
|
|
|
|
|
(should (null (org-babel-execute:sh "" nil))))
|
|
|
|
|
|
|
|
|
|
(ert-deftest test-ob-shell/dont-error-on-babel-error ()
|
|
|
|
|
"Errors within Babel execution should not cause Lisp errors."
|
|
|
|
|
(if (should (null (org-babel-execute:sh "ls NoSuchFileOrDirectory.txt" nil)))
|
|
|
|
|
(kill-buffer "*Org-Babel Error Output*")))
|
2010-10-15 11:25:33 -04:00
|
|
|
|
2022-12-30 11:35:10 -05:00
|
|
|
(ert-deftest test-ob-shell/session-single-return-returns-string ()
|
|
|
|
|
"Sessions with a single result should return a string."
|
|
|
|
|
(let* ((session-name "test-ob-shell/session-evaluation-single-return-returns-string")
|
|
|
|
|
(kill-buffer-query-functions nil)
|
|
|
|
|
(result (org-babel-execute:sh
|
|
|
|
|
(format "echo %s" session-name)
|
|
|
|
|
`((:session . ,session-name)))))
|
2022-10-22 00:28:31 -04:00
|
|
|
(should result)
|
2022-12-30 11:35:10 -05:00
|
|
|
(if (should (string= session-name result))
|
|
|
|
|
(kill-buffer session-name))))
|
|
|
|
|
|
|
|
|
|
(ert-deftest test-ob-shell/session-multiple-returns-returns-list ()
|
|
|
|
|
"Sessions with multiple results should return a list."
|
|
|
|
|
(let* ((session-name "test-ob-shell/session-multiple-returns-returns-list")
|
|
|
|
|
(kill-buffer-query-functions nil)
|
|
|
|
|
(result (org-babel-execute:sh
|
|
|
|
|
"echo 1; echo 2"
|
|
|
|
|
`((:session . ,session-name)))))
|
|
|
|
|
(should result)
|
|
|
|
|
(should (listp result))
|
|
|
|
|
(if (should (equal '((1) (2)) result))
|
|
|
|
|
(kill-buffer session-name))))
|
2012-07-31 10:18:50 -04:00
|
|
|
|
2014-04-11 17:27:02 -04:00
|
|
|
(ert-deftest ob-shell/generic-uses-no-arrays ()
|
|
|
|
|
"No arrays for generic"
|
|
|
|
|
(org-test-at-id "0ba56632-8dc1-405c-a083-c204bae477cf"
|
|
|
|
|
(org-babel-next-src-block)
|
2020-09-06 16:37:32 -04:00
|
|
|
(should (equal "one two three" (org-trim (org-babel-execute-src-block))))))
|
2014-04-11 17:27:02 -04:00
|
|
|
|
|
|
|
|
(ert-deftest ob-shell/bash-uses-arrays ()
|
|
|
|
|
"Bash arrays"
|
|
|
|
|
(org-test-at-id "0ba56632-8dc1-405c-a083-c204bae477cf"
|
|
|
|
|
(org-babel-next-src-block 2)
|
2020-09-06 16:37:32 -04:00
|
|
|
(should (equal "one" (org-trim (org-babel-execute-src-block))))))
|
2014-04-11 17:27:02 -04:00
|
|
|
|
2022-12-30 11:39:35 -05:00
|
|
|
(ert-deftest test-ob-shell/generic-uses-no-assoc-arrays-simple-map ()
|
|
|
|
|
"Generic shell: no special handing for key-value mapping table
|
|
|
|
|
|
|
|
|
|
No associative arrays for generic. The shell will see all values
|
|
|
|
|
as a single string."
|
|
|
|
|
(org-test-with-temp-text
|
|
|
|
|
"#+NAME: sample_mapping_table
|
|
|
|
|
| first | one |
|
|
|
|
|
| second | two |
|
|
|
|
|
| third | three |
|
|
|
|
|
|
|
|
|
|
#+begin_src sh :exports results :results output :var table=sample_mapping_table
|
|
|
|
|
echo ${table}
|
|
|
|
|
<point>
|
|
|
|
|
#+end_src"
|
|
|
|
|
(should
|
|
|
|
|
(equal "first one second two third three"
|
|
|
|
|
(org-trim (org-babel-execute-src-block))))))
|
|
|
|
|
|
|
|
|
|
(ert-deftest test-ob-shell/generic-uses-no-assoc-arrays-3-columns ()
|
|
|
|
|
"Associative array tests (more than 2 columns)
|
|
|
|
|
|
|
|
|
|
No associative arrays for generic. The shell will see all values
|
|
|
|
|
as a single string."
|
|
|
|
|
(org-test-with-temp-text
|
|
|
|
|
"#+NAME: sample_big_table
|
|
|
|
|
| bread | 2 | kg |
|
|
|
|
|
| spaghetti | 20 | cm |
|
|
|
|
|
| milk | 50 | dl |
|
|
|
|
|
|
|
|
|
|
#+begin_src sh :exports results :results output :var table=sample_big_table
|
|
|
|
|
echo ${table}
|
|
|
|
|
<point>
|
|
|
|
|
#+end_src"
|
|
|
|
|
(should
|
|
|
|
|
(equal "bread 2 kg spaghetti 20 cm milk 50 dl"
|
|
|
|
|
(org-trim (org-babel-execute-src-block))))))
|
2014-04-11 17:27:02 -04:00
|
|
|
|
2022-12-31 12:56:51 -05:00
|
|
|
(ert-deftest test-ob-shell/bash-uses-assoc-arrays ()
|
|
|
|
|
"Bash shell: support for associative arrays
|
|
|
|
|
|
|
|
|
|
Bash will see a table that contains the first column as the
|
|
|
|
|
'index' of the associative array, and the second column as the
|
|
|
|
|
value. "
|
|
|
|
|
(org-test-with-temp-text
|
|
|
|
|
"#+NAME: sample_mapping_table
|
|
|
|
|
| first | one |
|
|
|
|
|
| second | two |
|
|
|
|
|
| third | three |
|
|
|
|
|
|
|
|
|
|
#+begin_src bash :exports :results output results :var table=sample_mapping_table
|
|
|
|
|
echo ${table[second]}
|
|
|
|
|
<point>
|
|
|
|
|
#+end_src "
|
|
|
|
|
(should
|
|
|
|
|
(equal "two"
|
|
|
|
|
(org-trim (org-babel-execute-src-block))))))
|
|
|
|
|
|
|
|
|
|
(ert-deftest test-ob-shell/bash-uses-assoc-arrays-with-lists ()
|
|
|
|
|
"Bash shell: support for associative arrays with lists
|
|
|
|
|
|
|
|
|
|
Bash will see an associative array that contains each row as a single
|
|
|
|
|
string. Bash cannot handle lists in associative arrays."
|
|
|
|
|
(org-test-with-temp-text
|
|
|
|
|
"#+NAME: sample_big_table
|
|
|
|
|
| bread | 2 | kg |
|
|
|
|
|
| spaghetti | 20 | cm |
|
|
|
|
|
| milk | 50 | dl |
|
|
|
|
|
|
|
|
|
|
#+begin_src bash :exports results :results output :var table=sample_big_table
|
|
|
|
|
echo ${table[spaghetti]}
|
|
|
|
|
<point>
|
|
|
|
|
#+end_src"
|
|
|
|
|
(should
|
|
|
|
|
(equal "20 cm"
|
|
|
|
|
(org-trim (org-babel-execute-src-block))))))
|
2014-04-11 17:27:02 -04:00
|
|
|
|
2017-06-09 18:06:24 -04:00
|
|
|
(ert-deftest ob-shell/simple-list ()
|
|
|
|
|
"Test list variables in shell."
|
|
|
|
|
;; With bash, a list is turned into an array.
|
|
|
|
|
(should
|
2020-09-06 16:37:32 -04:00
|
|
|
(equal "2"
|
|
|
|
|
(org-test-with-temp-text
|
|
|
|
|
"#+BEGIN_SRC bash :results output :var l='(1 2)\necho ${l[1]}\n#+END_SRC"
|
|
|
|
|
(org-trim (org-babel-execute-src-block)))))
|
2017-06-09 18:06:24 -04:00
|
|
|
;; On sh, it is a string containing all values.
|
|
|
|
|
(should
|
|
|
|
|
(equal "1 2"
|
|
|
|
|
(org-test-with-temp-text
|
2020-09-06 16:37:32 -04:00
|
|
|
"#+BEGIN_SRC sh :results output :var l='(1 2)\necho ${l}\n#+END_SRC"
|
|
|
|
|
(org-trim (org-babel-execute-src-block))))))
|
2010-10-14 10:10:23 -04:00
|
|
|
|
2022-06-18 03:48:01 -04:00
|
|
|
(ert-deftest ob-shell/remote-with-stdin-or-cmdline ()
|
|
|
|
|
"Test :stdin and :cmdline with a remote directory."
|
|
|
|
|
;; We assume `default-directory' is a local directory.
|
|
|
|
|
(skip-unless (not (memq system-type '(ms-dos windows-nt))))
|
|
|
|
|
(org-test-with-tramp-remote-dir remote-dir
|
|
|
|
|
(dolist (spec `( ()
|
|
|
|
|
(:dir ,remote-dir)
|
|
|
|
|
(:dir ,remote-dir :cmdline t)
|
|
|
|
|
(:dir ,remote-dir :stdin t)
|
|
|
|
|
(:dir ,remote-dir :cmdline t :shebang t)
|
|
|
|
|
(:dir ,remote-dir :stdin t :shebang t)
|
|
|
|
|
(:dir ,remote-dir :cmdline t :stdin t :shebang t)
|
|
|
|
|
(:cmdline t)
|
|
|
|
|
(:stdin t)
|
|
|
|
|
(:cmdline t :shebang t)
|
|
|
|
|
(:stdin t :shebang t)
|
|
|
|
|
(:cmdline t :stdin t :shebang t)))
|
|
|
|
|
(let ((default-directory (or (plist-get spec :dir) default-directory))
|
|
|
|
|
(org-confirm-babel-evaluate nil)
|
|
|
|
|
(params-line "")
|
|
|
|
|
(who-line " export who=tramp")
|
|
|
|
|
(args-line " echo ARGS: --verbose 23 71"))
|
|
|
|
|
(when-let ((dir (plist-get spec :dir)))
|
|
|
|
|
(setq params-line (concat params-line " " ":dir " dir)))
|
|
|
|
|
(when (plist-get spec :stdin)
|
|
|
|
|
(setq who-line " read -r who")
|
|
|
|
|
(setq params-line (concat params-line " :stdin input")))
|
|
|
|
|
(when (plist-get spec :cmdline)
|
|
|
|
|
(setq args-line " echo \"ARGS: $*\"")
|
|
|
|
|
(setq params-line (concat params-line " :cmdline \"--verbose 23 71\"")))
|
|
|
|
|
(when (plist-get spec :shebang)
|
|
|
|
|
(setq params-line (concat params-line " :shebang \"#!/bin/sh\"")))
|
|
|
|
|
(let* ((result (org-test-with-temp-text
|
|
|
|
|
(mapconcat #'identity
|
|
|
|
|
(list "#+name: input"
|
|
|
|
|
"tramp"
|
|
|
|
|
""
|
|
|
|
|
(concat "<point>"
|
|
|
|
|
"#+begin_src sh :results output " params-line)
|
|
|
|
|
args-line
|
|
|
|
|
who-line
|
|
|
|
|
" echo \"hello $who from $(pwd)/\""
|
|
|
|
|
"#+end_src")
|
|
|
|
|
"\n")
|
|
|
|
|
(org-trim (org-babel-execute-src-block))))
|
|
|
|
|
(expected (concat "ARGS: --verbose 23 71"
|
|
|
|
|
"\nhello tramp from " (file-local-name default-directory))))
|
|
|
|
|
(should (equal result expected)))))))
|
|
|
|
|
|
2022-10-23 02:30:57 -04:00
|
|
|
(ert-deftest ob-shell/results-table ()
|
|
|
|
|
"Test :results table."
|
|
|
|
|
(should
|
|
|
|
|
(equal '(("I \"want\" it all"))
|
|
|
|
|
(org-test-with-temp-text
|
|
|
|
|
"#+BEGIN_SRC sh :results table\necho 'I \"want\" it all'\n#+END_SRC"
|
|
|
|
|
(org-babel-execute-src-block)))))
|
|
|
|
|
|
2022-12-18 06:04:57 -05:00
|
|
|
(ert-deftest ob-shell/results-list ()
|
|
|
|
|
"Test :results list."
|
|
|
|
|
(org-test-with-temp-text
|
|
|
|
|
"#+BEGIN_SRC sh :results list\necho 1\necho 2\necho 3\n#+END_SRC"
|
|
|
|
|
(should
|
|
|
|
|
(equal '((1) (2) (3))
|
|
|
|
|
(org-babel-execute-src-block)))
|
|
|
|
|
(search-forward "#+results")
|
|
|
|
|
(beginning-of-line 2)
|
|
|
|
|
(should
|
|
|
|
|
(equal
|
|
|
|
|
"- 1\n- 2\n- 3\n"
|
|
|
|
|
(buffer-substring-no-properties (point) (point-max))))))
|
|
|
|
|
|
2022-10-26 07:35:26 -04:00
|
|
|
;;; Standard output
|
|
|
|
|
|
|
|
|
|
(ert-deftest ob-shell/standard-output-after-success ()
|
|
|
|
|
"Test standard output after exiting with a zero code."
|
|
|
|
|
(should (= 1
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"echo 1" nil))))
|
|
|
|
|
|
|
|
|
|
(ert-deftest ob-shell/standard-output-after-failure ()
|
|
|
|
|
"Test standard output after exiting with a non-zero code."
|
|
|
|
|
(should (= 1
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"echo 1; exit 2" nil))))
|
|
|
|
|
|
|
|
|
|
;;; Standard error
|
|
|
|
|
|
|
|
|
|
(ert-deftest ob-shell/error-output-after-success ()
|
|
|
|
|
"Test that standard error shows in the error buffer, alongside the
|
|
|
|
|
exit code, after exiting with a zero code."
|
|
|
|
|
(should
|
|
|
|
|
(string= "1
|
|
|
|
|
[ Babel evaluation exited with code 0 ]"
|
|
|
|
|
(progn (org-babel-eval-wipe-error-buffer)
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"echo 1 >&2" nil)
|
|
|
|
|
(with-current-buffer org-babel-error-buffer-name
|
|
|
|
|
(buffer-string))))))
|
|
|
|
|
|
|
|
|
|
(ert-deftest ob-shell/error-output-after-failure ()
|
|
|
|
|
"Test that standard error shows in the error buffer, alongside the
|
|
|
|
|
exit code, after exiting with a non-zero code."
|
|
|
|
|
(should
|
|
|
|
|
(string= "1
|
|
|
|
|
[ Babel evaluation exited with code 2 ]"
|
|
|
|
|
(progn (org-babel-eval-wipe-error-buffer)
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"echo 1 >&2; exit 2" nil)
|
|
|
|
|
(with-current-buffer org-babel-error-buffer-name
|
|
|
|
|
(buffer-string))))))
|
|
|
|
|
|
|
|
|
|
(ert-deftest ob-shell/error-output-after-failure-multiple ()
|
|
|
|
|
"Test that multiple standard error strings show in the error
|
|
|
|
|
buffer, alongside multiple exit codes."
|
|
|
|
|
(should
|
|
|
|
|
(string= "1
|
|
|
|
|
[ Babel evaluation exited with code 2 ]
|
|
|
|
|
3
|
|
|
|
|
[ Babel evaluation exited with code 4 ]"
|
|
|
|
|
(progn (org-babel-eval-wipe-error-buffer)
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"echo 1 >&2; exit 2" nil)
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"echo 3 >&2; exit 4" nil)
|
|
|
|
|
(with-current-buffer org-babel-error-buffer-name
|
|
|
|
|
(buffer-string))))))
|
|
|
|
|
|
|
|
|
|
;;; Exit codes
|
|
|
|
|
|
|
|
|
|
(ert-deftest ob-shell/exit-code ()
|
|
|
|
|
"Test that the exit code shows in the error buffer after exiting
|
|
|
|
|
with a non-zero return code."
|
|
|
|
|
(should
|
|
|
|
|
(string= "[ Babel evaluation exited with code 1 ]"
|
|
|
|
|
(progn (org-babel-eval-wipe-error-buffer)
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"exit 1" nil)
|
|
|
|
|
(with-current-buffer org-babel-error-buffer-name
|
|
|
|
|
(buffer-string))))))
|
|
|
|
|
|
|
|
|
|
(ert-deftest ob-shell/exit-code-multiple ()
|
|
|
|
|
"Test that multiple exit codes show in the error buffer after
|
|
|
|
|
exiting with a non-zero return code multiple times."
|
|
|
|
|
(should
|
|
|
|
|
(string= "[ Babel evaluation exited with code 1 ]
|
|
|
|
|
[ Babel evaluation exited with code 2 ]"
|
|
|
|
|
(progn (org-babel-eval-wipe-error-buffer)
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"exit 1" nil)
|
|
|
|
|
(org-babel-execute:sh
|
|
|
|
|
"exit 2" nil)
|
|
|
|
|
(with-current-buffer org-babel-error-buffer-name
|
|
|
|
|
(buffer-string))))))
|
2022-10-23 02:30:57 -04:00
|
|
|
|
2014-01-31 11:02:03 -05:00
|
|
|
(provide 'test-ob-shell)
|
|
|
|
|
|
|
|
|
|
;;; test-ob-shell.el ends here
|
