forked from mirrors/org-mode
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.
162 lines
6.5 KiB
EmacsLisp
162 lines
6.5 KiB
EmacsLisp
;;; test-ob-shell.el -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (c) 2010-2014, 2019 Eric Schulte
|
|
;; Authors: Eric Schulte
|
|
|
|
;; 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 <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Comment:
|
|
|
|
;; Template test file for Org tests
|
|
|
|
;;; Code:
|
|
(org-test-for-executable "sh")
|
|
(require 'ob-core)
|
|
(unless (featurep 'ob-shell)
|
|
(signal 'missing-test-dependency "Support for Shell code blocks"))
|
|
|
|
(ert-deftest test-ob-shell/dont-insert-spaces-on-expanded-bodies ()
|
|
"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]"
|
|
(org-babel-expand-body:generic "echo 2" '())))
|
|
(should (string-match "^[\n\r][\t ]*[\n\r]"
|
|
(org-babel-expand-body:generic "\n\necho 2" '()))))
|
|
|
|
(ert-deftest test-ob-shell/dont-error-on-empty-results ()
|
|
"Was throwing an elisp error when shell blocks threw errors and
|
|
returned empty results."
|
|
(should (null (org-babel-execute:sh "ls NoSuchFileOrDirectory.txt" nil))))
|
|
|
|
(ert-deftest test-ob-shell/session ()
|
|
"This also tests `org-babel-comint-with-output' in
|
|
ob-comint.el, which was not previously tested."
|
|
(let ((res (org-babel-execute:sh "echo 1; echo 2" '((:session . "yes")))))
|
|
(should res)
|
|
(should (listp res))))
|
|
|
|
; A list of tests using the samples in ob-shell-test.org
|
|
(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)
|
|
(should (equal "one two three" (org-trim (org-babel-execute-src-block))))))
|
|
|
|
(ert-deftest ob-shell/bash-uses-arrays ()
|
|
"Bash arrays"
|
|
(org-test-at-id "0ba56632-8dc1-405c-a083-c204bae477cf"
|
|
(org-babel-next-src-block 2)
|
|
(should (equal "one" (org-trim (org-babel-execute-src-block))))))
|
|
|
|
(ert-deftest ob-shell/generic-uses-no-assoc-arrays ()
|
|
"No associative arrays for generic"
|
|
(should
|
|
(equal "first one second two third three"
|
|
(org-test-at-id
|
|
"bec1a5b0-4619-4450-a8c0-2a746b44bf8d"
|
|
(org-babel-next-src-block)
|
|
(org-trim (org-babel-execute-src-block)))))
|
|
(should
|
|
(equal "bread 2 kg spaghetti 20 cm milk 50 dl"
|
|
(org-test-at-id
|
|
"82320a48-3409-49d7-85c9-5de1c6d3ff87"
|
|
(org-babel-next-src-block)
|
|
(org-trim (org-babel-execute-src-block))))))
|
|
|
|
(ert-deftest ob-shell/bash-uses-assoc-arrays ()
|
|
"Bash associative arrays"
|
|
(should
|
|
(equal "two"
|
|
(org-test-at-id
|
|
"bec1a5b0-4619-4450-a8c0-2a746b44bf8d"
|
|
(org-babel-next-src-block 2)
|
|
(org-trim (org-babel-execute-src-block)))))
|
|
;; Bash associative arrays as strings for the row.
|
|
(should
|
|
(equal "20 cm"
|
|
(org-test-at-id
|
|
"82320a48-3409-49d7-85c9-5de1c6d3ff87"
|
|
(org-babel-next-src-block 2)
|
|
(org-trim (org-babel-execute-src-block))))))
|
|
|
|
(ert-deftest ob-shell/simple-list ()
|
|
"Test list variables in shell."
|
|
;; With bash, a list is turned into an array.
|
|
(should
|
|
(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)))))
|
|
;; On sh, it is a string containing all values.
|
|
(should
|
|
(equal "1 2"
|
|
(org-test-with-temp-text
|
|
"#+BEGIN_SRC sh :results output :var l='(1 2)\necho ${l}\n#+END_SRC"
|
|
(org-trim (org-babel-execute-src-block))))))
|
|
|
|
(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)))))))
|
|
|
|
(provide 'test-ob-shell)
|
|
|
|
;;; test-ob-shell.el ends here
|