Hello,
I am patching a bug in ob-octave.el (see attachment) involving the
creation of graphics files. The bug itself is easy to fix: a single line
in ob-octave.el ensures the special variable `ans' is bound, to prevent
Octave from exiting with a non-zero exit code.
However, I would like feedback/suggestions on writing such a
test. Issues include:
1. how to clean up the side-effects, including changes in the test
buffer, filesystem and potentially creating an error buffer;
2. the general absence of similar tests (except in test-ob.el,
test-ob/result-graphics-link-type-header-argument).
To address 1., I have wrapped the tests in an `unwind-protect' form to
ensure clean-up code gets run. The ERT manual does not suggest much
beyond this. At the moment, when the test is run, clean-up is being done
whether the test fails or passes.
I am unsure about 2. Is the absence of such tests because there is a
policy against them, or ...
Leo
diff --git a/lisp/ob-octave.el b/lisp/ob-octave.el
index 55926b789..f85b79fa2 100644
--- a/lisp/ob-octave.el
+++ b/lisp/ob-octave.el
@@ -91,7 +91,7 @@ end")
(list
"set (0, \"defaultfigurevisible\", \"off\");"
full-body
- (format "print -dpng %s" gfx-file))
+ (format "print -dpng %s\nans=%S" gfx-file gfx-file))
"\n")
full-body)
result-type matlabp)))
diff --git a/testing/examples/ob-octave-test.org b/testing/examples/ob-octave-test.org
index 9839d637e..0fc84bc26 100644
--- a/testing/examples/ob-octave-test.org
+++ b/testing/examples/ob-octave-test.org
@@ -46,10 +46,16 @@ ans = s
* Graphical tests
-#+begin_src octave :results graphics :file chart.png
+ :PROPERTIES:
+ :ID: b8b1d6a0-b7f6-49bd-8cb0-0c74f737332f
+ :END:
+
+Graphics file
+#+begin_src octave :results file graphics :file sombrero.png
sombrero;
#+end_src
+Graphics session
#+begin_src octave :session
sombrero;
#+end_src
diff --git a/testing/lisp/test-ob-octave.el b/testing/lisp/test-ob-octave.el
index 78ce10214..bdc9befef 100644
--- a/testing/lisp/test-ob-octave.el
+++ b/testing/lisp/test-ob-octave.el
@@ -64,4 +64,22 @@
(org-babel-next-src-block 5)
(should (equal nil (org-babel-execute-src-block)))))
+(ert-deftest ob-octave/graphics-file ()
+ "Graphics file. Test that link is correctly inserted and graphics file is created (and not empty). Clean-up side-effects."
+ (org-test-at-id "b8b1d6a0-b7f6-49bd-8cb0-0c74f737332f"
+ (org-babel-next-src-block)
+ (org-babel-execute-src-block)
+ (unwind-protect
+ (prog1
+ (and (should (search-forward "[[file:sombrero.png]]" nil nil))
+ (should (file-readable-p "sombrero.png"))
+ (should (let ((size (nth 7 (file-attributes "sombrero.png"))))
+ (> size 0)))
+ (should (not (get-buffer "*Org-Babel Error Output*")))))
+ ;; clean-up
+ (delete-file "sombrero.png")
+ (when (get-buffer "*Org-Babel Error Output*")
+ (kill-buffer "*Org-Babel Error Output*"))
+ (revert-buffer t t))))
+
(provide 'test-ob-octave)
