org-mode/testing/lisp/test-ob-maxima.el

173 lines
6.3 KiB
EmacsLisp
Raw Normal View History

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 21:21:37 +00:00
;;; test-ob-maxima.el --- tests for ob-maxima.el -*- lexical-binding: t; -*-
2019-01-01 10:50:56 +00:00
;; Copyright (c) 2010-2014, 2019 Sergey Litvinov
;; Authors: Sergey Litvinov
2012-12-13 16:24:19 +00: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
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
2012-12-13 16:24:19 +00:00
(org-test-for-executable "maxima")
(unless (featurep 'ob-maxima)
(signal 'missing-test-dependency "Support for Maxima code blocks"))
(ert-deftest ob-maxima/integer-input ()
"Test of integer input"
(org-test-at-id "b5842ed4-8e8b-4b18-a1c9-cef006b6a6c8"
(org-babel-next-src-block)
(should (equal 4 (org-babel-execute-src-block)))))
(ert-deftest ob-maxima/string-input ()
"Test of string input"
(org-test-at-id "b5842ed4-8e8b-4b18-a1c9-cef006b6a6c8"
(org-babel-next-src-block 2)
(should (equal "- sin(x)" (org-babel-execute-src-block)))))
(ert-deftest ob-maxima/simple-list-input ()
"Test of flat list input"
(org-test-at-id "b5561c6a-73cd-453a-ba5e-62ad84844de6"
(org-babel-next-src-block)
(should (equal "[1, 2, 3] " (org-babel-execute-src-block)))))
(ert-deftest ob-maxima/list-input ()
"Test of list input"
(org-test-at-id "b5561c6a-73cd-453a-ba5e-62ad84844de6"
(org-babel-next-src-block 2)
(should (equal "[2, [2, 3], 4] " (org-babel-execute-src-block)))))
(ert-deftest ob-maxima/table-input1 ()
"Test of table input"
(org-test-at-id "400ee228-6b12-44fd-8097-7986f0f0db43"
(org-babel-next-src-block)
(should (equal "[[2.0], [3.0]] " (org-babel-execute-src-block)))))
(ert-deftest ob-maxima/table-input2 ()
"Test of table input"
(org-test-at-id "400ee228-6b12-44fd-8097-7986f0f0db43"
(org-babel-next-src-block 2)
(should (equal "[[2.0, 3.0]] " (org-babel-execute-src-block)))))
(ert-deftest ob-maxima/matrix-output ()
"Test of table output"
(org-test-at-id "cc158527-b867-4b1d-8ae0-b8c713a90fd7"
(org-babel-next-src-block)
(should
(equal
'((1 2 3) (2 3 4) (3 4 5)) (org-babel-execute-src-block)))))
* lisp/ob-maxima.el: enable use of `batch' loader and `draw' * (org-babel-header-args:maxima): Document the two new header arguments (batch and graphics-pkg) that are specific to ob-maxima. * (org-babel-maxima--command-arguments-default): A new variable storing the default command-line argument(s). This value was hard-coded in `org-babel-maxima:execute'. * (org-babel-maxima--graphic-package-options): A new variable that stores an alist of Maxima graphics packages and the Maxima code to set up that package. * (org-babel-maxima--default-epilogue): A new variable that stores an alist of the clean-up code that is run at end of a `graphical-output' or `non-graphical-output' source block. * (org-babel-maxima--output-filter-regexps): A new variable that stores a list of regexps to identify "bad" output lines to be removed from Maxima's output. Source-code comments document each regexp's purpose. Two additional regexps have been added: one filters un-wanted output from `batch' and the other removes empty input lines that `batch'-ed output may spuriously produce (actual empty input lines are syntax errors, see the new tests below). * (org-babel-maxima--output-filter): A new function that takes a single line of Maxima output. It returns nil if the line has zero length or matches a regexp in `org-babel-maxima--output-filter-regexps'; otherwise, it returns the line. This function and regexp replace the hard-coded filter in `org-babel-execute:maxima'. * (org-babel-maxima-expand): Prepare the source block for execution, depending on whether it is producing graphical output or not. In case of graphical output, use the `graphics-pkg' header to set the graphics package and use `org-babel-maxima--graphic-package-options' to set-up the package. Grovel the graphics terminal from the output filename. * (org-babel-execute:maxima): Use the :batch header argument and `org-babel-maxima--command-arguments-default' to execute the source block. Replace the existing, in-line output filter and its regexps with `org-babel-maxima--output-filter' and `org-babel-maxima--output-filter-regexps'. * testing/examples/ob-maxima-test.org: Add test examples. Include examples of the batch-related tests from testing/lisp/test-ob-maxima.el. Provide an example of the `:graphics-pkg' header argument with the `draw' package. * testing/lisp/test-ob-maxima.el: Introduce six new, batch-related test functions. Each test exercises the :batch header argument. The response to unusual inputs is tested (empty strings, strings with just whitespace, input with the `:lisp' reader, and two syntax-related errors). link: https://list.orgmode.org/87cyz1ivzw.fsf@t14.reltub.ca/
2023-09-19 18:36:06 +00:00
;; 6 tests to test the :batch header argument
(ert-deftest ob-maxima/batch+verbatim ()
"Exercise the `:batch' header argument.
Since `--very-quiet' is set, the input and output are printed
without labels."
(org-test-with-temp-text
(format "#+begin_src maxima :results verbatim :batch batch
(assume(z>0),
integrate(exp(-t)*t^z, t, 0, inf));
#+end_src")
(should (equal (org-babel-execute-src-block)
"(assume(z > 0),integrate(exp(-t)*t^z,t,0,inf))\n gamma(z + 1)"))))
(ert-deftest ob-maxima/batch+verbatim+quiet ()
"Exercise the `:batch' header argument.
Since `--quiet' is set, the input and output are printed with
labels."
(org-test-with-temp-text
(format "#+name: ob-maxima/batch+verbatim
#+begin_src maxima :results verbatim :batch batch :cmdline --quiet
(assume(z>0),
integrate(exp(-t)*t^z, t, 0, inf));
#+end_src")
(should (equal (org-babel-execute-src-block)
"(%i1) (assume(z > 0),integrate(exp(-t)*t^z,t,0,inf))\n(%o1) gamma(z + 1)"))))
(ert-deftest ob-maxima/batch+verbatim+:lisp ()
"Exercise the `:batch' header argument with `:lisp' reader.
Since `--quiet' is set, the output is printed (as a lisp form)."
(org-test-with-temp-text
(format "#+name: ob-maxima/batch+verbatim+:lisp
#+begin_src maxima :results verbatim :batch batch :cmdline --quiet
:lisp #$(assume(z>0),integrate(exp(-t)*t^z, t, 0, inf));#$
#+end_src
")
(should (equal (org-babel-execute-src-block)
"((%GAMMA SIMP) ((MPLUS SIMP) 1 $Z))"))))
(ert-deftest ob-maxima/batch+verbatim+empty-string-vq ()
"Exercise the `:batch' header argument with empty string input.
Since `--very-quiet' is set, the output is printed."
(org-test-with-temp-text
(format "#+name: ob-maxima/batch+verbatim+empty-string-vq
#+begin_src maxima :results verbatim :batch batch :cmdline --very-quiet
\"\";
#+end_src
")
(should (equal (org-babel-execute-src-block) "\"\"\n "))))
(ert-deftest ob-maxima/batch+verbatim+empty-string ()
"Exercise the `:batch' header argument with empty string input.
Since `--quiet' is set, the input and output are printed with
labels."
(org-test-with-temp-text
(format "#+name: ob-maxima/batch+verbatim+empty-string
#+begin_src maxima :results verbatim :batch batch :cmdline --quiet
\"\";
#+end_src
")
(should (equal (org-babel-execute-src-block) "(%i1) \"\"\n(%o1) "))))
(ert-deftest ob-maxima/batch+verbatim+whitespace-string ()
"Exercise the `:batch' header argument with whitespace input.
Since `--quiet' is set, the input and output are printed with
labels."
(org-test-with-temp-text
(format "#+name: ob-maxima/batch+verbatim+whitespace-string
#+begin_src maxima :results verbatim :batch batch :cmdline --quiet
\" \";
#+end_src
")
(should (equal (org-babel-execute-src-block)
"(%i1) \" \"\n(%o1) "))))
(ert-deftest ob-maxima/batch+verbatim+syntax-error ()
"Exercise the `:batch' header argument with syntax error.
Send empty input line to Maxima."
(org-test-with-temp-text
(format "#+name: ob-maxima/batch+verbatim+syntax-error
#+begin_src maxima :results verbatim :batch batch :cmdline --quiet
;
#+end_src
")
(should (string-match "incorrect syntax: Premature termination of input at ;\\."
(org-babel-execute-src-block)))))
(ert-deftest ob-maxima/batch+verbatim+eof-error ()
"Exercise the `:batch' header argument with syntax error.
Send an incomplete expression to Maxima."
(org-test-with-temp-text
(format "#+name: ob-maxima/batch+verbatim+eof-error
#+begin_src maxima :results verbatim :batch batch :cmdline --quiet
x:
#+end_src
")
(should (string-match "end of file while scanning expression\\."
(org-babel-execute-src-block)))))
(provide 'test-ob-maxima)
;;; test-ob-maxima.el ends here