From: Bruno Barbier <brubar.cs@gmail.com>
To: Ruijie Yu <ruijie@netyu.xyz>
Cc: Ihor Radchenko <yantar92@posteo.net>, emacs-orgmode@gnu.org
Subject: Re: [PATCH] Add tests for ob-haskell (GHCi)
Date: Sun, 07 May 2023 13:15:05 +0200 [thread overview]
Message-ID: <6457883b.5d0a0220.2b9fc.8fd2@mx.google.com> (raw)
In-Reply-To: <sdvjzxkh4ft.fsf@netyu.xyz>
[-- Attachment #1: Type: text/plain, Size: 1963 bytes --]
Ruijie Yu <ruijie@netyu.xyz> writes:
> Minor remarks below regarding the patchset.
>
> Bruno Barbier <brubar.cs@gmail.com> writes:
>
>> +;; Copyright (c) 2023 Free Software Foundation, Inc.
>
> lisp/org.el has only a single space, so probably single space here as well.
Done.
>> +
>> +;; Authors: Bruno BARBIER <brubar.cs@gmail.com>
>> +
>> +;; 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.
>
> Do we need the text for "part of GNU Emacs"?
>
I guess it doesn't harm: I added it, thanks.
>> +
>> +(defun test-ob-haskell-ghci--with-global-session-worker (todo)
>> + "See `test-ob-haskell-ghci--with-global-session-worker'."
>
> This docstring doesn't say much and only refers to itself. Maybe
> explain what it does? (Or now that I look at it, potentially you wanted
> to refer to the macro `test-ob-haskell-ghci-with-global-session'
> instead.)
I've rewritten that function later ... which made the documentation even worse :-)
I've fixed it, thanks.
>
>> +(defun test-ob-haskell-ghci (args content &optional preamble unprotected)
>> + "Execute the code block CONTENT in a new GHCi session; return the result.
>> +Add ARGS to the code block argument line. Insert PREAMBLE
>> +before the code block. When UNPROTECTED is non-nil, don't control
>> +which session is used (i.e. don't call
>> +`test-ob-haskell-ghci--with-global-session-worker')."
>> + (when (listp content)
>> + (setq content (string-join content "\n")))
>> + (unless preamble
>> + (setq preamble ""))
>> + (let ((todo (lambda ()
>
> One space.
AFAICS, the last version has only one space here.
>> +
>> +;;;; Not define errors
>> +;;
> Single space?
It was an invisible 'd' actually; I repainted in black :-)
Thanks.
Thank you for your review,
Bruno
[-- Attachment #2: 0001-ob-haskell-Add-tests-for-GHCi.patch --]
[-- Type: text/x-patch, Size: 15081 bytes --]
From 136878a096eb9f459e97da6617f94ba84085db9b Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Fri, 18 Nov 2022 20:14:20 +0100
Subject: [PATCH 01/13] ob-haskell: Add tests for GHCi
testing/lisp/test-ob-haskell-ghci.el: New file.
---
testing/lisp/test-ob-haskell-ghci.el | 454 +++++++++++++++++++++++++++
1 file changed, 454 insertions(+)
create mode 100644 testing/lisp/test-ob-haskell-ghci.el
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
new file mode 100644
index 000000000..4023873de
--- /dev/null
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -0,0 +1,454 @@
+;;; test-ob-haskell-ghci.el --- tests for ob-haskell.el GHCi -*- lexical-binding: t; -*-
+
+;; Copyright (c) 2023 Free Software Foundation, Inc.
+;; Authors: Bruno BARBIER <brubar.cs@gmail.com>
+
+;; This file is 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/>.
+
+;;; Commentary:
+;;
+
+;;;; Useful references
+;;
+;; - https://orgmode.org/worg/org-contrib/babel/languages/lang-compat.html
+;; - GHCi manual: https://downloads.haskell.org/ghc/latest/docs/users_guide/ghci.html
+;;;; FIXME: Random failures
+;;
+;; To increase the chances of failure when running tests, you can use this command line:
+;;
+;; (for I in 0 1 2 3 4 5 6 7 8 9 10 0 1 2 3 4 5 6 7 8 9 10 0 1 2 3 4 5 6 7 8 9 10; do make 'BTEST_OB_LANGUAGES=haskell' BTEST_RE='haskell' test-dirty & done) 2>&1 | grep FAILED
+;;
+
+;;;; Status
+;;
+;; All the tests should succeed (except for random failures); those
+;; flagged with ":expected-result :failed" are known
+;; limitations/bugs. Tested with (2023-03-18):
+;;
+;; | emacs-version | 29.0.60 |
+;; | org-version | main@4cad6c8ea (Mar 16 2023) |
+;; | haskell-mode | master@20d4e23 (Mar 4 2023) |
+;; | ghci | 9.0.2 |
+
+
+;;; Code:
+;;
+
+(require 'org-test "../testing/org-test")
+(org-test-for-executable "ghci")
+(unless (featurep 'haskell-mode)
+ (signal 'missing-test-dependency "haskell-mode"))
+
+
+;;; Helpers
+;;
+
+(defun test-ob-haskell-ghci--with-global-session-worker (todo)
+ "See `test-ob-haskell-ghci--with-global-session-worker'."
+ (when (get-buffer "*haskell*")
+ (error "A buffer named '*haskell*' exists. Can't safely test haskell blocks"))
+ (unwind-protect (funcall todo)
+ ;; Kill the "*haskell*" buffer to not pollute other tests.
+ (when-let ((hb (get-buffer "*haskell*")))
+ (with-current-buffer hb
+ (let ((kill-buffer-query-functions nil)
+ (kill-buffer-hook nil))
+ (kill-buffer hb))))))
+
+(defmacro test-ob-haskell-ghci-with-global-session (&rest body)
+ "Eval BODY in a new session, then destroy the session.
+The library ob-haskell doesn't implement session yet. It will
+always use a buffer named \"*haskell*\". We kill that buffer
+after the source block execution. To be safe, we fail if such a
+buffer already exists."
+ `(test-ob-haskell-ghci--with-global-session-worker (lambda () ,@body)))
+
+(defun test-ob-haskell-ghci (args content &optional preamble unprotected)
+ "Execute the code block CONTENT in a new GHCi session; return the result.
+Add ARGS to the code block argument line. Insert PREAMBLE
+before the code block. When UNPROTECTED is non-nil, don't control
+which session is used (i.e. don't call
+`test-ob-haskell-ghci--with-global-session-worker')."
+ (when (listp content)
+ (setq content (string-join content "\n")))
+ (unless preamble
+ (setq preamble ""))
+ (let ((todo (lambda ()
+ (org-test-with-temp-text
+ (concat preamble "\n" "#+begin_src haskell :compile no "
+ args "\n" "<point>" content "\n#+end_src")
+ (org-babel-execute-src-block)))))
+ (if unprotected (funcall todo)
+ (test-ob-haskell-ghci-with-global-session (funcall todo)))))
+
+
+;;; Tests
+
+
+;;;; Hello Worlds.
+;;
+
+(ert-deftest ob-haskell/hello-world-value-pure ()
+ (should (equal "Hello World!"
+ (test-ob-haskell-ghci "" "\"Hello World!\""))))
+
+(ert-deftest ob-haskell/hello-world-value-IO ()
+ (should (equal "Hello World!"
+ (test-ob-haskell-ghci "" "return \"Hello World!\""))))
+
+(ert-deftest ob-haskell/hello-world-output ()
+ (should (equal "Hello World!"
+ (test-ob-haskell-ghci ":results output" "putStrLn \"Hello World!\""))))
+
+(ert-deftest ob-haskell/hello-world-output-nothing ()
+ :expected-result :failed
+ (should (equal ""
+ (test-ob-haskell-ghci ":results output" "return \"Hello World!\""))))
+
+(ert-deftest ob-haskell/hello-world-output-multilines ()
+ :expected-result :failed
+ (should (equal "Hello World!"
+ (test-ob-haskell-ghci ":results output" "
+:{
+main :: IO ()
+main = putStrLn \"Hello World!\"
+:}
+
+main
+"))))
+
+;;;; Sessions
+;;
+
+(ert-deftest ob-haskell/sessions-must-not-share-variables ()
+ "Sessions must not share variables."
+ :expected-result :failed
+ (test-ob-haskell-ghci-with-global-session
+ (test-ob-haskell-ghci ":session s1" "x=2" nil :unprotected)
+ (should (equal 2 (test-ob-haskell-ghci ":session s1" "x" nil :unprotected)))
+ (test-ob-haskell-ghci ":session s2" "x=3" nil :unprotected)
+ (should-not (equal 3 (test-ob-haskell-ghci ":session s1" "x" nil :unprotected)))
+ ))
+
+(ert-deftest ob-haskell/no-session-means-one-shot-sessions ()
+ "When no session, use a new session."
+ :expected-result :failed
+ (test-ob-haskell-ghci-with-global-session
+ (test-ob-haskell-ghci "" "x=2" nil :unprotected)
+ (should-not (equal 2 (test-ob-haskell-ghci "" "x" nil :unprotected)))))
+
+
+;;;; Values
+;;
+
+(ert-deftest ob-haskell/value-is-the-last-expression ()
+ "Return the value of the last expression."
+ (should (equal 3 (test-ob-haskell-ghci "" '("1" "1+1" "1+1+1"))))
+ (should (equal 3 (test-ob-haskell-ghci "" '("x=1" "y=1+1" "x+y")))))
+
+(ert-deftest ob-haskell/value-is-the-last-expression-2 ()
+ "Return the value of the last expression."
+ (should (equal 7 (test-ob-haskell-ghci "" "
+putStrLn \"a string\"
+return \"useless\"
+3+4
+"))))
+
+
+
+(ert-deftest ob-haskell/eval-numbers ()
+ "Evaluation of numbers."
+ (should (equal 7 (test-ob-haskell-ghci "" "7")))
+ (should (equal 7.5 (test-ob-haskell-ghci "" "7.5")))
+ (should (equal 10.0 (test-ob-haskell-ghci "" "10::Double")))
+ (should (equal 10 (test-ob-haskell-ghci "" "10::Int"))))
+
+
+(ert-deftest ob-haskell/eval-strings ()
+ "Evaluation of strings."
+ (should (equal "a string" (test-ob-haskell-ghci "" "\"a string\""))))
+
+
+;;;; Local variables
+(ert-deftest ob-haskell/let-one-line ()
+ "Local definitions on one line."
+ (should (equal 6 (test-ob-haskell-ghci "" "let { x=2; y=3 } in x*y"))))
+
+(ert-deftest ob-haskell/let-multilines-1 ()
+ "Local definitions on multiple lines."
+ :expected-result :failed
+ (should (equal 6 (test-ob-haskell-ghci "" "
+:{
+ let { x=2
+ ; y=3
+ }
+ in x*y
+:}
+"))))
+
+(ert-deftest ob-haskell/let-multilines-2 ()
+ "Local definitions on multiple lines, relying on indentation."
+ :expected-result :failed
+ (should (equal 6 (test-ob-haskell-ghci "" "
+:{
+ let x=2
+ y=3
+ in x*y
+:}
+"))))
+
+;;;; Declarations with multiple lines.
+(ert-deftest ob-haskell/decl-multilines-1 ()
+ "A multiline declaration, then use it."
+ (should (equal 3 (test-ob-haskell-ghci "" "
+:{
+let length' [] = 0
+ length' (_:l) = 1 + length' l
+:}
+length' [1,2,3]
+"))))
+
+(ert-deftest ob-haskell/decl-multilines-2 ()
+ "A multiline declaration, then use it."
+ (should (equal 5 (test-ob-haskell-ghci "" "
+:{
+length' :: [a] -> Int
+length' [] = 0
+length' (_:l) = 1 + length' l
+:}
+
+length' [1..5]
+"))))
+
+
+(ert-deftest ob-haskell/primes ()
+ "From haskell.org."""
+ :expected-result :failed
+ (should (equal '(2 3 5 7 11 13 17 19 23 29)
+ (test-ob-haskell-ghci "" "
+:{
+primes = filterPrime [2..] where
+ filterPrime (p:xs) =
+ p : filterPrime [x | x <- xs, x `mod` p /= 0]
+:}
+
+take 10 primes
+"))))
+
+;;;; Lists
+;;
+
+(ert-deftest ob-haskell/a-simple-list ()
+ "Evaluation of list of values."
+ (should (equal '(1 2 3) (test-ob-haskell-ghci "" "[1,2,3]"))))
+
+
+(ert-deftest ob-haskell/2D-lists ()
+ "Evaluation of nested lists into a table."
+ (should (equal '((1 2 3) (4 5 6))
+ (test-ob-haskell-ghci "" "[[1..3], [4..6]]"))))
+
+(ert-deftest ob-haskell/2D-lists-multilines ()
+ "Evaluation of nested lists into a table, as multilines."
+ :expected-result :failed
+ (should (equal '((1 2 3) (4 5 6))
+ (test-ob-haskell-ghci "" "
+:{
+[ [1..3]
+, [4..6]
+, [7..9]
+]
+:}
+"))))
+
+
+;;;; Tuples
+;;
+
+(ert-deftest ob-haskell/a-simple-tuple ()
+ "Evaluation of tuple of values."
+ (should (equal '(1 2 3) (test-ob-haskell-ghci "" "(1,2,3)"))))
+
+
+(ert-deftest ob-haskell/2D-tuples ()
+ "Evaluation of nested tuples into a table."
+ (should (equal '((1 2 3) (4 5 6))
+ (test-ob-haskell-ghci "" "((1,2,3), (4,5,6))"))))
+
+(ert-deftest ob-haskell/2D-tuples-multilines ()
+ "Evaluation of nested tuples into a table, as multilines."
+ (should (equal '((1 2 3) (4 5 6) (7 8 9))
+ (test-ob-haskell-ghci "" "
+:{
+( (1,2,3)
+, (4,5,6)
+, (7,8,9)
+)
+:}
+"))))
+
+
+;;;; Data tables
+;;
+
+(ert-deftest ob-haskell/int-table-data ()
+ "From worg: int-table-data."
+ (should (equal 10 (test-ob-haskell-ghci ":var t=int-table-data"
+ "sum [sum r | r <- t]"
+ "#+name: int-table-data
+ | 1 | 2 |
+ | 3 | 4 |"))))
+
+(ert-deftest ob-haskell/float-table-data ()
+ "From worg: float-table-data."
+ (should (equal 11.0 (test-ob-haskell-ghci ":var t=float-table-data"
+ "sum [sum r | r <- t]"
+ "#+name: float-table-data
+ | 1.1 | 2.2 |
+ | 3.3 | 4.4 |"))))
+
+(ert-deftest ob-haskell/string-table-data ()
+ "From worg: string-table-data."
+ (should (equal "abcd" (test-ob-haskell-ghci ":var t=string-table-data"
+ "concat [concat r | r <- t]"
+ "#+name: string-table-data
+ | a | b |
+ | c | d |"))))
+
+;;;; Reuse results
+;;
+(ert-deftest ob-haskell/reuse-table ()
+ "Reusing a computed tables."
+ (should (equal 78 (test-ob-haskell-ghci ":var t=a-table"
+ "sum [sum r | r <- t]"
+ "#+name: a-table
+#+begin_src haskell
+ [ [x..x+2] | x <- [1,4 .. 12] ]
+#+end_src
+"))))
+
+
+;;;; Not defined errors
+;;
+
+(ert-deftest ob-haskell/not-defined ()
+ "Evaluation of undefined variables."
+ (should (string-match "Variable not in scope"
+ (test-ob-haskell-ghci "" "notDefined :: IO Int"))))
+
+(ert-deftest ob-haskell/not-defined-then-defined-1 ()
+ "Evaluation of undefined variables.
+This is a valid haskell source, but, invalid when entered one
+line at a time in GHCi."
+ (let ((r (test-ob-haskell-ghci "" "
+v :: Int
+v = 4
+")))
+ (should (and r (string-match "Variable not in scope" r)))))
+
+(ert-deftest ob-haskell/not-defined-then-defined-1-fixed ()
+ "Like not-defined-then-defined-1, but using the mutiline marks."
+ :expected-result :failed
+ (let ((r (test-ob-haskell-ghci "" "
+:{
+ v :: Int
+ v = 4
+:}
+")))
+ (should (eq nil r))))
+
+(ert-deftest ob-haskell/not-defined-then-defined-1-fixed-2 ()
+ "Like not-defined-then-defined-1, but using one line."
+ (should (eq nil (test-ob-haskell-ghci "" "v = 4 :: Int"))))
+
+
+
+(ert-deftest ob-haskell/not-defined-then-defined-2 ()
+ "Evaluation of undefined variables, followed by a correct one."
+ ;; ghci output is:
+ ;; | <interactive>:2:1-4: error:
+ ;; | • Variable not in scope: main :: IO ()
+ ;; | • Perhaps you meant ‘min’ (imported from Prelude)
+ ;; | Hello, World!
+ ;; and ob-haskell just reports the last line "Hello, World!".
+ (should (string-match "Variable not in scope"
+ (test-ob-haskell-ghci ":results output" "
+main :: IO ()
+main = putStrLn \"Hello, World!\"
+main
+"))))
+
+;;;; Imports
+;;
+
+(ert-deftest ob-haskell/import ()
+ "Import and use library."
+ (should (equal 65 (test-ob-haskell-ghci "" "
+import Data.IORef
+r <- newIORef 65
+readIORef r
+"))))
+
+(ert-deftest ob-haskell/import-with-vars ()
+ "Import and use library with vars."
+ (should (equal 65 (test-ob-haskell-ghci ":var x=65" "
+import Data.IORef
+r <- newIORef x
+readIORef r
+"))))
+
+;;;; What is the result?
+;;
+
+(ert-deftest ob-haskell/results-value-1 ()
+ "Don't confuse output and values: nothing."
+ (should (equal nil (test-ob-haskell-ghci ":results value" "return ()"))))
+
+(ert-deftest ob-haskell/results-value-2 ()
+ "Don't confuse output and values: a list."
+ (should (equal '(1 2) (test-ob-haskell-ghci ":results value" "return [1,2]"))))
+
+(ert-deftest ob-haskell/results-value-3 ()
+ "Don't confuse output and values: nothing."
+ :expected-result :failed
+ (should (equal nil (test-ob-haskell-ghci ":results value" "putStrLn \"3\""))))
+
+(ert-deftest ob-haskell/results-value-4 ()
+ "Don't confuse output and values: nothing."
+ :expected-result :failed
+ (should (equal nil (test-ob-haskell-ghci ":results value" "
+putStrLn \"3\"
+return ()
+"))))
+
+
+;;;; GHCi commands
+;;
+
+(ert-deftest ob-haskell/ghci-type ()
+ "The ghci meta command ':type'."
+ (should (equal "3 :: Num p => p"
+ (test-ob-haskell-ghci ":results output" ":type 3"))))
+
+(ert-deftest ob-haskell/ghci-info ()
+ "The ghci meta command ':info' ."
+ (should (equal "repeat :: a -> [a] -- Defined in ‘GHC.List’"
+ (test-ob-haskell-ghci ":results output" ":info repeat"))))
+
+
+(provide 'test-ob-haskell-ghci)
+
+;;; test-ob-haskell-ghci.el ends here
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-org-babel-haskell-initiate-session-Remove-secondary-.patch --]
[-- Type: text/x-patch, Size: 1294 bytes --]
From 21bfe4a1c932b1cb3a40c8df21e08c1907f08b31 Mon Sep 17 00:00:00 2001
From: Ihor Radchenko <yantar92@posteo.net>
Date: Fri, 24 Mar 2023 11:20:22 +0100
Subject: [PATCH 02/13] org-babel-haskell-initiate-session: Remove secondary
prompt
* lisp/ob-haskell.el (org-babel-haskell-initiate-session): Set
secondary prompt to "". If we do not do this, org-comint may treat
secondary prompts as a part of output.
---
lisp/ob-haskell.el | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/lisp/ob-haskell.el b/lisp/ob-haskell.el
index 909de19ab..500be89a2 100644
--- a/lisp/ob-haskell.el
+++ b/lisp/ob-haskell.el
@@ -169,7 +169,14 @@ (defun org-babel-haskell-initiate-session (&optional _session _params)
then create one. Return the initialized session."
(org-require-package 'inf-haskell "haskell-mode")
(or (get-buffer "*haskell*")
- (save-window-excursion (run-haskell) (sleep-for 0.25) (current-buffer))))
+ (save-window-excursion
+ (run-haskell)
+ (sleep-for 0.25)
+ ;; Disable secondary prompt.
+ (org-babel-comint-input-command
+ (current-buffer)
+ ":set prompt-cont \"\"")
+ (current-buffer))))
(defun org-babel-load-session:haskell (session body params)
"Load BODY into SESSION."
--
2.39.3
[-- Attachment #4: 0003-testing-lisp-test-ob-haskell-ghci.el-Fix-some-tests.patch --]
[-- Type: text/x-patch, Size: 1510 bytes --]
From 040c505ede7b207b8c847660471d53233a956531 Mon Sep 17 00:00:00 2001
From: Ihor Radchenko <yantar92@posteo.net>
Date: Fri, 24 Mar 2023 11:25:19 +0100
Subject: [PATCH 03/13] * testing/lisp/test-ob-haskell-ghci.el: Fix some tests
(ob-haskell/2D-lists-multilines):
(ob-haskell/ghci-info): Fix incorrect test assertions.
---
testing/lisp/test-ob-haskell-ghci.el | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index 4023873de..1a060a412 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -263,8 +263,7 @@ (ert-deftest ob-haskell/2D-lists ()
(ert-deftest ob-haskell/2D-lists-multilines ()
"Evaluation of nested lists into a table, as multilines."
- :expected-result :failed
- (should (equal '((1 2 3) (4 5 6))
+ (should (equal '((1 2 3) (4 5 6) (7 8 9))
(test-ob-haskell-ghci "" "
:{
[ [1..3]
@@ -445,8 +444,9 @@ (ert-deftest ob-haskell/ghci-type ()
(ert-deftest ob-haskell/ghci-info ()
"The ghci meta command ':info' ."
- (should (equal "repeat :: a -> [a] -- Defined in ‘GHC.List’"
- (test-ob-haskell-ghci ":results output" ":info repeat"))))
+ (should (string-match-p
+ "repeat :: a -> \\[a\\][ \t]+-- Defined in ‘GHC.List’"
+ (test-ob-haskell-ghci ":results output" ":info repeat"))))
(provide 'test-ob-haskell-ghci)
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #5: 0004-testing-lisp-test-ob-haskell-ghci.el-Enable-fixed-te.patch --]
[-- Type: text/x-patch, Size: 2126 bytes --]
From d37a3db8eb5ff1f8cdeb7625bff7b07e2e5bfe83 Mon Sep 17 00:00:00 2001
From: Ihor Radchenko <yantar92@posteo.net>
Date: Fri, 24 Mar 2023 11:26:00 +0100
Subject: [PATCH 04/13] * testing/lisp/test-ob-haskell-ghci.el: Enable fixed
tests
(ob-haskell/hello-world-output-multilines):
(ob-haskell/let-multilines-1):
(ob-haskell/let-multilines-2):
(ob-haskell/primes):
(ob-haskell/not-defined-then-defined-1-fixed): Re-enable tests.
---
testing/lisp/test-ob-haskell-ghci.el | 5 -----
1 file changed, 5 deletions(-)
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index 1a060a412..0a5e83280 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -119,7 +119,6 @@ (ert-deftest ob-haskell/hello-world-output-nothing ()
(test-ob-haskell-ghci ":results output" "return \"Hello World!\""))))
(ert-deftest ob-haskell/hello-world-output-multilines ()
- :expected-result :failed
(should (equal "Hello World!"
(test-ob-haskell-ghci ":results output" "
:{
@@ -189,7 +188,6 @@ (ert-deftest ob-haskell/let-one-line ()
(ert-deftest ob-haskell/let-multilines-1 ()
"Local definitions on multiple lines."
- :expected-result :failed
(should (equal 6 (test-ob-haskell-ghci "" "
:{
let { x=2
@@ -201,7 +199,6 @@ (ert-deftest ob-haskell/let-multilines-1 ()
(ert-deftest ob-haskell/let-multilines-2 ()
"Local definitions on multiple lines, relying on indentation."
- :expected-result :failed
(should (equal 6 (test-ob-haskell-ghci "" "
:{
let x=2
@@ -236,7 +233,6 @@ (ert-deftest ob-haskell/decl-multilines-2 ()
(ert-deftest ob-haskell/primes ()
"From haskell.org."""
- :expected-result :failed
(should (equal '(2 3 5 7 11 13 17 19 23 29)
(test-ob-haskell-ghci "" "
:{
@@ -360,7 +356,6 @@ (ert-deftest ob-haskell/not-defined-then-defined-1 ()
(ert-deftest ob-haskell/not-defined-then-defined-1-fixed ()
"Like not-defined-then-defined-1, but using the mutiline marks."
- :expected-result :failed
(let ((r (test-ob-haskell-ghci "" "
:{
v :: Int
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #6: 0005-lisp-ob-haskell-Request-the-last-value-from-GHCi.patch --]
[-- Type: text/x-patch, Size: 4161 bytes --]
From 6857bce319ea181ddf40e0b1dadd16c35badbbe4 Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 25 Mar 2023 09:59:31 +0100
Subject: [PATCH 05/13] lisp/ob-haskell: Request the last value from GHCi
* lisp/ob-haskell.el (org-babel-interpret-haskell): When the result
type is 'value, use the last value as defined by GHCi.
* testing/lisp/test-ob-haskell-ghci.el: Update tests related to output/value.
---
lisp/ob-haskell.el | 32 ++++++++++++++++++++++------
testing/lisp/test-ob-haskell-ghci.el | 6 ++----
2 files changed, 28 insertions(+), 10 deletions(-)
diff --git a/lisp/ob-haskell.el b/lisp/ob-haskell.el
index 500be89a2..961ae9c8a 100644
--- a/lisp/ob-haskell.el
+++ b/lisp/ob-haskell.el
@@ -135,12 +135,32 @@ (defun org-babel-interpret-haskell (body params)
(session (org-babel-haskell-initiate-session session params))
(comint-preoutput-filter-functions
(cons 'ansi-color-filter-apply comint-preoutput-filter-functions))
- (raw (org-babel-comint-with-output
- (session org-babel-haskell-eoe nil full-body)
- (insert (org-trim full-body))
- (comint-send-input nil t)
- (insert org-babel-haskell-eoe)
- (comint-send-input nil t)))
+ (raw (pcase result-type
+ (`output
+ (org-babel-comint-with-output
+ (session org-babel-haskell-eoe nil full-body)
+ (insert (org-trim full-body))
+ (comint-send-input nil t)
+ (insert (concat "putStrLn (\"\\\"\" ++ " org-babel-haskell-eoe " ++ \"\\\"\")\n"))
+ (comint-send-input nil t)))
+ (`value (org-babel-comint-with-output
+ (session org-babel-haskell-eoe nil full-body)
+ (insert "__LAST_VALUE_IMPROBABLE_NAME__=()::()\n")
+ (comint-send-input nil t)
+ (insert full-body)
+ (comint-send-input nil t)
+ (insert "__LAST_VALUE_IMPROBABLE_NAME__=it\n")
+ (comint-send-input nil t)
+ (insert (concat "putStrLn (\"\\\"\" ++ " org-babel-haskell-eoe " ++ \"\\\"\")\n"))
+ (comint-send-input nil t))
+ (org-babel-comint-with-output
+ (session org-babel-haskell-eoe nil)
+ (insert "__LAST_VALUE_IMPROBABLE_NAME__\n")
+ (comint-send-input nil t)
+ (insert (concat "putStrLn (\"\\\"\" ++ " org-babel-haskell-eoe " ++ \"\\\"\")\n"))
+ (comint-send-input nil t))
+ )
+ ))
(results (mapcar #'org-strip-quotes
(cdr (member org-babel-haskell-eoe
(reverse (mapcar #'org-trim raw)))))))
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index 0a5e83280..eefa26042 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -114,8 +114,8 @@ (ert-deftest ob-haskell/hello-world-output ()
(test-ob-haskell-ghci ":results output" "putStrLn \"Hello World!\""))))
(ert-deftest ob-haskell/hello-world-output-nothing ()
- :expected-result :failed
- (should (equal ""
+ ;; GHCi prints the value on standard output. So, the last value is part of the output.
+ (should (equal "Hello World!"
(test-ob-haskell-ghci ":results output" "return \"Hello World!\""))))
(ert-deftest ob-haskell/hello-world-output-multilines ()
@@ -417,12 +417,10 @@ (ert-deftest ob-haskell/results-value-2 ()
(ert-deftest ob-haskell/results-value-3 ()
"Don't confuse output and values: nothing."
- :expected-result :failed
(should (equal nil (test-ob-haskell-ghci ":results value" "putStrLn \"3\""))))
(ert-deftest ob-haskell/results-value-4 ()
"Don't confuse output and values: nothing."
- :expected-result :failed
(should (equal nil (test-ob-haskell-ghci ":results value" "
putStrLn \"3\"
return ()
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #7: 0006-ob-haskell-Implement-sessions.patch --]
[-- Type: text/x-patch, Size: 4757 bytes --]
From f8a7978467551057439f0baa2342f4a6945df43a Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 25 Mar 2023 10:06:44 +0100
Subject: [PATCH 06/13] ob-haskell: Implement sessions
* lisp/ob-haskell.el (org-babel-haskell-initiate-session): Implement
sessions.
* testing/lisp/test-ob-haskell-ghci.el: Update tests related to
sessions.
---
lisp/ob-haskell.el | 50 +++++++++++++++++++++-------
testing/lisp/test-ob-haskell-ghci.el | 8 +++--
2 files changed, 44 insertions(+), 14 deletions(-)
diff --git a/lisp/ob-haskell.el b/lisp/ob-haskell.el
index 961ae9c8a..6bbc91439 100644
--- a/lisp/ob-haskell.el
+++ b/lisp/ob-haskell.el
@@ -51,6 +51,8 @@ (declare-function haskell-mode "ext:haskell-mode" ())
(declare-function run-haskell "ext:inf-haskell" (&optional arg))
(declare-function inferior-haskell-load-file
"ext:inf-haskell" (&optional reload))
+(declare-function inferior-haskell-start-process
+ "ext:inf-haskell" ())
(declare-function org-entry-get "org" (pom property &optional inherit literal-nil))
(defvar org-babel-tangle-lang-exts)
@@ -183,20 +185,44 @@ (defun org-babel-execute:haskell (body params)
(org-babel-interpret-haskell body params)
(org-babel-haskell-execute body params))))
-(defun org-babel-haskell-initiate-session (&optional _session _params)
+
+
+
+;; Variable defined in inf-haskell (haskell-mode package).
+(defvar inferior-haskell-buffer)
+
+(defun org-babel-haskell-initiate-session (&optional session-name _params)
"Initiate a haskell session.
-If there is not a current inferior-process-buffer in SESSION
-then create one. Return the initialized session."
+Return the initialized session."
(org-require-package 'inf-haskell "haskell-mode")
- (or (get-buffer "*haskell*")
- (save-window-excursion
- (run-haskell)
- (sleep-for 0.25)
- ;; Disable secondary prompt.
- (org-babel-comint-input-command
- (current-buffer)
- ":set prompt-cont \"\"")
- (current-buffer))))
+ (when (and session-name (string= session-name "none"))
+ (setq session-name nil))
+ (unless session-name
+ ;; As haskell-mode is using the buffer name "*haskell*", we stay
+ ;; away from it.
+ (setq session-name (generate-new-buffer-name "*ob-haskell*")))
+ (let ((session (get-buffer session-name)))
+ (save-window-excursion
+ (or (org-babel-comint-buffer-livep session)
+ (let ((inferior-haskell-buffer session))
+ (when (and (bufferp session) (not (org-babel-comint-buffer-livep session)))
+ (when (bufferp "*haskell*") (error "Conflicting buffer '*haskell*', rename it or kill it."))
+ (with-current-buffer session (rename-buffer "*haskell*")))
+ (save-window-excursion
+ ;; We don't use `run-haskell' to not popup the buffer.
+ ;; And we protect default-directory.
+ (let ((default-directory default-directory))
+ (inferior-haskell-start-process))
+ (sleep-for 0.25)
+ (setq session inferior-haskell-buffer)
+ (with-current-buffer session (rename-buffer session-name))
+ ;; Disable secondary prompt.
+ (org-babel-comint-input-command
+ session
+ ":set prompt-cont \"\"")
+ session))))
+ session))
+
(defun org-babel-load-session:haskell (session body params)
"Load BODY into SESSION."
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index eefa26042..0a7e5738c 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -134,7 +134,6 @@ (ert-deftest ob-haskell/hello-world-output-multilines ()
(ert-deftest ob-haskell/sessions-must-not-share-variables ()
"Sessions must not share variables."
- :expected-result :failed
(test-ob-haskell-ghci-with-global-session
(test-ob-haskell-ghci ":session s1" "x=2" nil :unprotected)
(should (equal 2 (test-ob-haskell-ghci ":session s1" "x" nil :unprotected)))
@@ -144,11 +143,16 @@ (ert-deftest ob-haskell/sessions-must-not-share-variables ()
(ert-deftest ob-haskell/no-session-means-one-shot-sessions ()
"When no session, use a new session."
- :expected-result :failed
(test-ob-haskell-ghci-with-global-session
(test-ob-haskell-ghci "" "x=2" nil :unprotected)
(should-not (equal 2 (test-ob-haskell-ghci "" "x" nil :unprotected)))))
+(ert-deftest ob-haskell/reuse-variables-in-same-session ()
+ "Reuse variables between blocks using the same session."
+ (test-ob-haskell-ghci ":session s1" "x=2" nil)
+ (should (equal 2 (test-ob-haskell-ghci ":session s1" "x"))))
+
+
;;;; Values
;;
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #8: 0007-ob-haskell-Update-tests-about-errors.patch --]
[-- Type: text/x-patch, Size: 1491 bytes --]
From b8c8038f79247b9ab1643c4766c2c85ff2a2f6d8 Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 25 Mar 2023 10:09:26 +0100
Subject: [PATCH 07/13] ob-haskell: Update tests about errors
testing/lisp/test-ob-haskell-ghci.el: Update tests about errors.
---
testing/lisp/test-ob-haskell-ghci.el | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index 0a7e5738c..089042553 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -345,18 +345,20 @@ (ert-deftest ob-haskell/reuse-table ()
(ert-deftest ob-haskell/not-defined ()
"Evaluation of undefined variables."
- (should (string-match "Variable not in scope"
- (test-ob-haskell-ghci "" "notDefined :: IO Int"))))
+ :expected-result :failed
+ (should-error (test-ob-haskell-ghci "" "notDefined :: IO Int")))
+
(ert-deftest ob-haskell/not-defined-then-defined-1 ()
"Evaluation of undefined variables.
This is a valid haskell source, but, invalid when entered one
line at a time in GHCi."
- (let ((r (test-ob-haskell-ghci "" "
+ :expected-result :failed
+ (should-error (test-ob-haskell-ghci "" "
v :: Int
v = 4
")))
- (should (and r (string-match "Variable not in scope" r)))))
+
(ert-deftest ob-haskell/not-defined-then-defined-1-fixed ()
"Like not-defined-then-defined-1, but using the mutiline marks."
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #9: 0008-testing-lisp-test-ob-haskell-ghci.el-Cleanup-comment.patch --]
[-- Type: text/x-patch, Size: 1495 bytes --]
From ad1ce32a7d281a842ba3b790b79099254b619fff Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 1 Apr 2023 10:00:30 +0200
Subject: [PATCH 08/13] * testing/lisp/test-ob-haskell-ghci.el: Cleanup
comments
---
testing/lisp/test-ob-haskell-ghci.el | 18 ------------------
1 file changed, 18 deletions(-)
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index 089042553..2bcff5ee0 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -25,24 +25,6 @@
;;
;; - https://orgmode.org/worg/org-contrib/babel/languages/lang-compat.html
;; - GHCi manual: https://downloads.haskell.org/ghc/latest/docs/users_guide/ghci.html
-;;;; FIXME: Random failures
-;;
-;; To increase the chances of failure when running tests, you can use this command line:
-;;
-;; (for I in 0 1 2 3 4 5 6 7 8 9 10 0 1 2 3 4 5 6 7 8 9 10 0 1 2 3 4 5 6 7 8 9 10; do make 'BTEST_OB_LANGUAGES=haskell' BTEST_RE='haskell' test-dirty & done) 2>&1 | grep FAILED
-;;
-
-;;;; Status
-;;
-;; All the tests should succeed (except for random failures); those
-;; flagged with ":expected-result :failed" are known
-;; limitations/bugs. Tested with (2023-03-18):
-;;
-;; | emacs-version | 29.0.60 |
-;; | org-version | main@4cad6c8ea (Mar 16 2023) |
-;; | haskell-mode | master@20d4e23 (Mar 4 2023) |
-;; | ghci | 9.0.2 |
-
;;; Code:
;;
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #10: 0009-lisp-ob-haskell.el-Simplify-org-babel-haskell-eoe.patch --]
[-- Type: text/x-patch, Size: 2482 bytes --]
From 6ca6e108979eced50ae10d1efc0bf0f55d5f6a75 Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 1 Apr 2023 10:19:24 +0200
Subject: [PATCH 09/13] lisp/ob-haskell.el: Simplify org-babel-haskell-eoe
lisp/ob-haskell.el
(org-babel-haskell-eoe): New default value.
(org-babel-interpret-haskell): Update for the new value of `org-babel-haskell-eoe'.
---
lisp/ob-haskell.el | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/lisp/ob-haskell.el b/lisp/ob-haskell.el
index 6bbc91439..98b1b10f0 100644
--- a/lisp/ob-haskell.el
+++ b/lisp/ob-haskell.el
@@ -63,7 +63,7 @@ (defvar org-babel-default-header-args:haskell
(defvar org-babel-haskell-lhs2tex-command "lhs2tex")
-(defvar org-babel-haskell-eoe "\"org-babel-haskell-eoe\"")
+(defvar org-babel-haskell-eoe "org-babel-haskell-eoe")
(defvar haskell-prompt-regexp)
@@ -143,7 +143,7 @@ (defun org-babel-interpret-haskell (body params)
(session org-babel-haskell-eoe nil full-body)
(insert (org-trim full-body))
(comint-send-input nil t)
- (insert (concat "putStrLn (\"\\\"\" ++ " org-babel-haskell-eoe " ++ \"\\\"\")\n"))
+ (insert (concat "putStrLn \"" org-babel-haskell-eoe "\"\n"))
(comint-send-input nil t)))
(`value (org-babel-comint-with-output
(session org-babel-haskell-eoe nil full-body)
@@ -153,13 +153,13 @@ (defun org-babel-interpret-haskell (body params)
(comint-send-input nil t)
(insert "__LAST_VALUE_IMPROBABLE_NAME__=it\n")
(comint-send-input nil t)
- (insert (concat "putStrLn (\"\\\"\" ++ " org-babel-haskell-eoe " ++ \"\\\"\")\n"))
+ (insert (concat "putStrLn \"" org-babel-haskell-eoe "\"\n"))
(comint-send-input nil t))
(org-babel-comint-with-output
(session org-babel-haskell-eoe nil)
(insert "__LAST_VALUE_IMPROBABLE_NAME__\n")
(comint-send-input nil t)
- (insert (concat "putStrLn (\"\\\"\" ++ " org-babel-haskell-eoe " ++ \"\\\"\")\n"))
+ (insert (concat "putStrLn \"" org-babel-haskell-eoe "\"\n"))
(comint-send-input nil t))
)
))
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #11: 0010-testing-lisp-test-ob-haskell-ghci.el-Test-output-wit.patch --]
[-- Type: text/x-patch, Size: 1817 bytes --]
From c4adca4caa3d6d10ba7b65c4de7c132aa56871d0 Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 29 Apr 2023 10:27:57 +0200
Subject: [PATCH 10/13] * testing/lisp/test-ob-haskell-ghci.el: Test output
without EOL
(ob-haskell/output-without-eol-1):
(ob-haskell/output-without-eol-2):
(ob-haskell/output-without-eol-3): New tests.
---
testing/lisp/test-ob-haskell-ghci.el | 32 ++++++++++++++++++++++++++++
1 file changed, 32 insertions(+)
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index 2bcff5ee0..36f745e61 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -166,6 +166,38 @@ (ert-deftest ob-haskell/eval-strings ()
"Evaluation of strings."
(should (equal "a string" (test-ob-haskell-ghci "" "\"a string\""))))
+;;;; Output without EOL
+;;
+
+(ert-deftest ob-haskell/output-without-eol-1 ()
+ "Cannot get output from incomplete lines, when entered line by line."
+ :expected-result :failed
+ (should (equal "123"
+ (test-ob-haskell-ghci ":results output" "
+ putStr(\"1\")
+ putStr(\"2\")
+ putStr(\"3\")
+ putStr(\"\\n\")
+"))))
+
+(ert-deftest ob-haskell/output-without-eol-2 ()
+ "Incomplete output lines are OK when using a multiline block."
+ (should (equal "123"
+ (test-ob-haskell-ghci ":results output" "
+:{
+ do putStr(\"1\")
+ putStr(\"2\")
+ putStr(\"3\")
+ putStr(\"\\n\")
+:}
+"))))
+
+(ert-deftest ob-haskell/output-without-eol-3 ()
+ "Incomplete output lines are OK on one line."
+ (should (equal "123"
+ (test-ob-haskell-ghci ":results output" "
+do { putStr(\"1\"); putStr(\"2\"); putStr(\"3\"); putStr(\"\\n\") }
+"))))
;;;; Local variables
(ert-deftest ob-haskell/let-one-line ()
--
2.39.3
[-- Attachment #12: 0011-lisp-ob-haskell.el-Fix-how-to-use-sessions.patch --]
[-- Type: text/x-patch, Size: 11477 bytes --]
From 2bae53acd280b394c8f1624aef2426bbe6720f03 Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 29 Apr 2023 10:43:16 +0200
Subject: [PATCH 11/13] lisp/ob-haskell.el: Fix how to use sessions
* lisp/ob-haskell.el
(org-babel-haskell-initiate-session): Redesign how to handle session names.
(org-babel-haskell-with-session): New function to manage sessions.
(org-babel-interpret-haskell): Refactor code. Use
`org-babel-haskell-with-session` to manage sessions.
(org-babel-prep-session:haskell): Don't ignore the PARAMS argument.
---
lisp/ob-haskell.el | 182 +++++++++++++++++++++++++++------------------
1 file changed, 110 insertions(+), 72 deletions(-)
diff --git a/lisp/ob-haskell.el b/lisp/ob-haskell.el
index 98b1b10f0..deaa434f8 100644
--- a/lisp/ob-haskell.el
+++ b/lisp/ob-haskell.el
@@ -129,54 +129,58 @@ (defun org-babel-interpret-haskell (body params)
(lambda ()
(setq-local comint-prompt-regexp
(concat haskell-prompt-regexp "\\|^λ?> "))))
- (let* ((session (cdr (assq :session params)))
- (result-type (cdr (assq :result-type params)))
- (full-body (org-babel-expand-body:generic
- body params
- (org-babel-variable-assignments:haskell params)))
- (session (org-babel-haskell-initiate-session session params))
- (comint-preoutput-filter-functions
- (cons 'ansi-color-filter-apply comint-preoutput-filter-functions))
- (raw (pcase result-type
- (`output
- (org-babel-comint-with-output
- (session org-babel-haskell-eoe nil full-body)
- (insert (org-trim full-body))
- (comint-send-input nil t)
- (insert (concat "putStrLn \"" org-babel-haskell-eoe "\"\n"))
- (comint-send-input nil t)))
- (`value (org-babel-comint-with-output
- (session org-babel-haskell-eoe nil full-body)
- (insert "__LAST_VALUE_IMPROBABLE_NAME__=()::()\n")
- (comint-send-input nil t)
- (insert full-body)
- (comint-send-input nil t)
- (insert "__LAST_VALUE_IMPROBABLE_NAME__=it\n")
- (comint-send-input nil t)
- (insert (concat "putStrLn \"" org-babel-haskell-eoe "\"\n"))
- (comint-send-input nil t))
- (org-babel-comint-with-output
- (session org-babel-haskell-eoe nil)
- (insert "__LAST_VALUE_IMPROBABLE_NAME__\n")
- (comint-send-input nil t)
- (insert (concat "putStrLn \"" org-babel-haskell-eoe "\"\n"))
- (comint-send-input nil t))
- )
- ))
- (results (mapcar #'org-strip-quotes
- (cdr (member org-babel-haskell-eoe
- (reverse (mapcar #'org-trim raw)))))))
- (org-babel-reassemble-table
- (let ((result
- (pcase result-type
- (`output (mapconcat #'identity (reverse results) "\n"))
- (`value (car results)))))
- (org-babel-result-cond (cdr (assq :result-params params))
- result (when result (org-babel-script-escape result))))
- (org-babel-pick-name (cdr (assq :colname-names params))
- (cdr (assq :colname-names params)))
- (org-babel-pick-name (cdr (assq :rowname-names params))
- (cdr (assq :rowname-names params))))))
+ (org-babel-haskell-with-session
+ params
+ (lambda (session)
+ (cl-labels
+ ((csend (txt)
+ (insert txt) (comint-send-input nil t))
+ (eom ()
+ (csend (concat "putStrLn \"" org-babel-haskell-eoe "\"\n")))
+ (with-output (todo)
+ (let ((comint-preoutput-filter-functions
+ (cons 'ansi-color-filter-apply
+ comint-preoutput-filter-functions)))
+ (org-babel-comint-with-output
+ (session org-babel-haskell-eoe nil nil)
+ (funcall todo)))))
+ (let* ((result-type (cdr (assq :result-type params)))
+ (full-body (org-babel-expand-body:generic
+ body params
+ (org-babel-variable-assignments:haskell params)))
+ (raw (pcase result-type
+ (`output
+ (with-output
+ (lambda () (csend (org-trim full-body)) (eom))))
+ (`value
+ ;; We first compute the value and store the
+ ;; value, ignoring any output.
+ (with-output
+ (lambda ()
+ (csend "__LAST_VALUE_IMPROBABLE_NAME__=()::()\n")
+ (csend (org-trim full-body))
+ (csend "__LAST_VALUE_IMPROBABLE_NAME__=it\n")
+ (eom)))
+ ;; We now display and capture the value.
+ (with-output
+ (lambda()
+ (csend "__LAST_VALUE_IMPROBABLE_NAME__\n")
+ (eom))))))
+ (results (mapcar #'org-strip-quotes
+ (cdr (member org-babel-haskell-eoe
+ (reverse (mapcar #'org-trim raw)))))))
+ (org-babel-reassemble-table
+ (let ((result
+ (pcase result-type
+ (`output (mapconcat #'identity (reverse results) "\n"))
+ (`value (car results)))))
+ (org-babel-result-cond (cdr (assq :result-params params))
+ result (when result (org-babel-script-escape result))))
+ (org-babel-pick-name (cdr (assq :colname-names params))
+ (cdr (assq :colname-names params)))
+ (org-babel-pick-name (cdr (assq :rowname-names params))
+ (cdr (assq :rowname-names params)))))))))
+
(defun org-babel-execute:haskell (body params)
"Execute a block of Haskell code."
@@ -186,6 +190,23 @@ (defun org-babel-execute:haskell (body params)
(org-babel-haskell-execute body params))))
+(defun org-babel-haskell-with-session (params todo)
+ "Call TODO with a suitable session buffer.
+Use PARAMS to get/create/destroy the session as needed.
+Return the result of the call."
+ (let* ((sn (cdr (assq :session params)))
+ (session (org-babel-haskell-initiate-session sn params))
+ (one-shot (equal sn "none")))
+ (unwind-protect
+ (funcall todo session)
+ (when (and one-shot (buffer-live-p session))
+ ;; As we don't control how the session temporary buffer is
+ ;; created, we need to explicitly work around the hooks and
+ ;; query functions.
+ (with-current-buffer session
+ (let ((kill-buffer-query-functions nil)
+ (kill-buffer-hook nil))
+ (kill-buffer session)))))))
;; Variable defined in inf-haskell (haskell-mode package).
@@ -193,34 +214,51 @@ (defvar inferior-haskell-buffer)
(defun org-babel-haskell-initiate-session (&optional session-name _params)
"Initiate a haskell session.
-Return the initialized session."
+Return the initialized session, i.e. the buffer for this session.
+When SESSION-NAME is nil, use a global session named
+\"*ob-haskell*\". When SESSION-NAME is the string \"none\", use
+a temporary buffer. Else, (re)use the session named
+SESSION-NAME. The buffer name is the session name. See also
+`org-babel-haskell-with-session'."
(org-require-package 'inf-haskell "haskell-mode")
- (when (and session-name (string= session-name "none"))
- (setq session-name nil))
- (unless session-name
- ;; As haskell-mode is using the buffer name "*haskell*", we stay
- ;; away from it.
- (setq session-name (generate-new-buffer-name "*ob-haskell*")))
+ (cond
+ ((equal "none" session-name)
+ ;; Temporary buffer name.
+ (setq session-name (generate-new-buffer-name " *ob-haskell-tmp*")))
+ ((eq nil session-name)
+ ;; The global default session. As haskell-mode is using the buffer
+ ;; named "*haskell*", we stay away from it.
+ (setq session-name "*ob-haskell*")))
(let ((session (get-buffer session-name)))
(save-window-excursion
(or (org-babel-comint-buffer-livep session)
(let ((inferior-haskell-buffer session))
- (when (and (bufferp session) (not (org-babel-comint-buffer-livep session)))
- (when (bufferp "*haskell*") (error "Conflicting buffer '*haskell*', rename it or kill it."))
- (with-current-buffer session (rename-buffer "*haskell*")))
- (save-window-excursion
- ;; We don't use `run-haskell' to not popup the buffer.
- ;; And we protect default-directory.
- (let ((default-directory default-directory))
- (inferior-haskell-start-process))
- (sleep-for 0.25)
- (setq session inferior-haskell-buffer)
- (with-current-buffer session (rename-buffer session-name))
- ;; Disable secondary prompt.
- (org-babel-comint-input-command
- session
- ":set prompt-cont \"\"")
- session))))
+ ;; As inferior-haskell expects the buffer to be named
+ ;; "*haskell*", we rename it, unless the user explicitly
+ ;; requested to use the name "*haskell*".
+ (when (not (equal "*haskell*" session-name))
+ (when (and (bufferp session)
+ (not (org-babel-comint-buffer-livep session)))
+ (when (bufferp "*haskell*")
+ (user-error "Conflicting buffer '*haskell*', rename it or kill it"))
+ (with-current-buffer session (rename-buffer "*haskell*"))))
+ (unwind-protect
+ (save-window-excursion
+ ;; We don't use `run-haskell' to not popup the buffer.
+ ;; And we protect default-directory.
+ (let ((default-directory default-directory))
+ (inferior-haskell-start-process))
+ (sleep-for 0.25)
+ (setq session inferior-haskell-buffer))
+ (when (and (not (equal "*haskell*" session-name))
+ (bufferp session))
+ (with-current-buffer session (rename-buffer session-name))))
+ ;; Disable secondary prompt.
+ (org-babel-comint-input-command
+ session
+ ":set prompt-cont \"\"")
+ session)
+ ))
session))
@@ -237,7 +275,7 @@ (defun org-babel-load-session:haskell (session body params)
(defun org-babel-prep-session:haskell (session params)
"Prepare SESSION according to the header arguments in PARAMS."
(save-window-excursion
- (let ((buffer (org-babel-haskell-initiate-session session)))
+ (let ((buffer (org-babel-haskell-initiate-session session params)))
(org-babel-comint-in-buffer buffer
(mapc (lambda (line)
(insert line)
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #13: 0012-testing-lisp-test-ob-haskell-ghci.el-Modify-test-ob-.patch --]
[-- Type: text/x-patch, Size: 3515 bytes --]
From 61b7727d950bf884c13110f39c6b17eba0237b32 Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 29 Apr 2023 11:06:45 +0200
Subject: [PATCH 12/13] * testing/lisp/test-ob-haskell-ghci.el: Modify
`test-ob-haskell-ghci`
* testing/lisp/test-ob-haskell-ghci.el
(test-ob-haskell-ghci--with-global-session-worker)
(test-ob-haskell-ghci-with-global-session): Deleted.
(test-ob-haskell-ghci-checking-buffers): New function.
(test-ob-haskell-ghci): Update to handle the new meaning of sessions.
---
testing/lisp/test-ob-haskell-ghci.el | 42 +++++++++++-----------------
1 file changed, 16 insertions(+), 26 deletions(-)
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index 36f745e61..fcce06365 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -38,43 +38,33 @@ (unless (featurep 'haskell-mode)
;;; Helpers
;;
-(defun test-ob-haskell-ghci--with-global-session-worker (todo)
- "See `test-ob-haskell-ghci--with-global-session-worker'."
+(defun test-ob-haskell-ghci-checking-buffers (todo)
+ "Check some buffer related invariants.."
(when (get-buffer "*haskell*")
(error "A buffer named '*haskell*' exists. Can't safely test haskell blocks"))
- (unwind-protect (funcall todo)
- ;; Kill the "*haskell*" buffer to not pollute other tests.
+ (prog1 (funcall todo)
(when-let ((hb (get-buffer "*haskell*")))
- (with-current-buffer hb
- (let ((kill-buffer-query-functions nil)
- (kill-buffer-hook nil))
- (kill-buffer hb))))))
-
-(defmacro test-ob-haskell-ghci-with-global-session (&rest body)
- "Eval BODY in a new session, then destroy the session.
-The library ob-haskell doesn't implement session yet. It will
-always use a buffer named \"*haskell*\". We kill that buffer
-after the source block execution. To be safe, we fail if such a
-buffer already exists."
- `(test-ob-haskell-ghci--with-global-session-worker (lambda () ,@body)))
+ ;; We created a "*haskell*" buffer. That shouldn't happen.
+ (error "'ob-haskell' created a buffer named '*haskell*'"))))
+
+
(defun test-ob-haskell-ghci (args content &optional preamble unprotected)
"Execute the code block CONTENT in a new GHCi session; return the result.
Add ARGS to the code block argument line. Insert PREAMBLE
-before the code block. When UNPROTECTED is non-nil, don't control
-which session is used (i.e. don't call
-`test-ob-haskell-ghci--with-global-session-worker')."
+before the code block. When UNPROTECTED is non-nil, check pre/post conditions."
(when (listp content)
(setq content (string-join content "\n")))
(unless preamble
(setq preamble ""))
- (let ((todo (lambda ()
- (org-test-with-temp-text
- (concat preamble "\n" "#+begin_src haskell :compile no "
- args "\n" "<point>" content "\n#+end_src")
- (org-babel-execute-src-block)))))
- (if unprotected (funcall todo)
- (test-ob-haskell-ghci-with-global-session (funcall todo)))))
+ (let ((todo (lambda ()
+ (prog1 (org-test-with-temp-text
+ (concat preamble "\n" "#+begin_src haskell :compile no "
+ args "\n" "<point>" content "\n#+end_src")
+ (org-babel-execute-src-block))))))
+ (if unprotected (funcall todo)
+ (test-ob-haskell-ghci-checking-buffers todo))))
+
;;; Tests
--
2.39.3
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #14: 0013-testing-lisp-test-ob-haskell-ghci.el-Update-session-.patch --]
[-- Type: text/x-patch, Size: 3132 bytes --]
From 52b7b78e3413e93cb8098e699a0b44c04e94bb37 Mon Sep 17 00:00:00 2001
From: Bruno BARBIER <brubar.cs@gmail.com>
Date: Sat, 29 Apr 2023 11:10:42 +0200
Subject: [PATCH 13/13] * testing/lisp/test-ob-haskell-ghci.el: Update session
tests
* testing/lisp/test-ob-haskell-ghci.el
(ob-haskell/no-session-means-one-shot-sessions): Deleted.
(ob-haskell/session-named-none-means-one-shot-sessions): New test.
(ob-haskell/sessions-must-not-share-variables): Rewrite tests to match
the new meaning of session names.
(ob-haskell/may-use-the-*haskell*-session): New test.
---
testing/lisp/test-ob-haskell-ghci.el | 36 +++++++++++++++++++---------
1 file changed, 25 insertions(+), 11 deletions(-)
diff --git a/testing/lisp/test-ob-haskell-ghci.el b/testing/lisp/test-ob-haskell-ghci.el
index fcce06365..f49ebcc40 100644
--- a/testing/lisp/test-ob-haskell-ghci.el
+++ b/testing/lisp/test-ob-haskell-ghci.el
@@ -106,24 +106,38 @@ (ert-deftest ob-haskell/hello-world-output-multilines ()
(ert-deftest ob-haskell/sessions-must-not-share-variables ()
"Sessions must not share variables."
- (test-ob-haskell-ghci-with-global-session
- (test-ob-haskell-ghci ":session s1" "x=2" nil :unprotected)
- (should (equal 2 (test-ob-haskell-ghci ":session s1" "x" nil :unprotected)))
- (test-ob-haskell-ghci ":session s2" "x=3" nil :unprotected)
- (should-not (equal 3 (test-ob-haskell-ghci ":session s1" "x" nil :unprotected)))
- ))
-
-(ert-deftest ob-haskell/no-session-means-one-shot-sessions ()
+ (test-ob-haskell-ghci ":session s1" "x=2" nil)
+ (should (equal 2 (test-ob-haskell-ghci ":session s1" "x" nil)))
+ (test-ob-haskell-ghci ":session s2" "x=3" nil)
+ (should-not (equal 3 (test-ob-haskell-ghci ":session s1" "x" nil)))
+ )
+
+(ert-deftest ob-haskell/session-named-none-means-one-shot-sessions ()
"When no session, use a new session."
- (test-ob-haskell-ghci-with-global-session
- (test-ob-haskell-ghci "" "x=2" nil :unprotected)
- (should-not (equal 2 (test-ob-haskell-ghci "" "x" nil :unprotected)))))
+ (test-ob-haskell-ghci ":session none" "x=2" nil)
+ (should-not (equal 2 (test-ob-haskell-ghci ":session \"none\"" "x" nil)))
+ (test-ob-haskell-ghci ":session none" "x=2" nil)
+ (should-not (equal 2 (test-ob-haskell-ghci ":session \"none\"" "x" nil))))
(ert-deftest ob-haskell/reuse-variables-in-same-session ()
"Reuse variables between blocks using the same session."
(test-ob-haskell-ghci ":session s1" "x=2" nil)
(should (equal 2 (test-ob-haskell-ghci ":session s1" "x"))))
+(ert-deftest ob-haskell/may-use-the-*haskell*-session ()
+ "The user may use the special *haskell* buffer."
+ (when (get-buffer "*haskell*")
+ (error "A buffer named '*haskell*' exists. Can't run this test"))
+ (unwind-protect
+ (progn
+ (test-ob-haskell-ghci ":session *haskell*" "x=2" nil :unprotected)
+ (should (equal 2 (test-ob-haskell-ghci ":session *haskell*" "x" nil :unprotected))))
+ (with-current-buffer "*haskell*"
+ (let ((kill-buffer-query-functions nil)
+ (kill-buffer-hook nil))
+ (kill-buffer "*haskell*")))))
+
+
;;;; Values
--
2.39.3
next prev parent reply other threads:[~2023-05-07 11:16 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-19 9:12 [PATCH] Add tests for ob-haskell (GHCi) Bruno Barbier
2023-03-19 10:20 ` Ihor Radchenko
2023-03-19 10:28 ` Ihor Radchenko
2023-03-19 10:32 ` Bruno Barbier
2023-03-22 10:16 ` Ihor Radchenko
2023-03-24 10:36 ` Ihor Radchenko
2023-03-25 10:01 ` Bruno Barbier
2023-03-26 9:09 ` Ihor Radchenko
2023-03-26 9:40 ` Bruno Barbier
2023-03-26 9:46 ` Ihor Radchenko
[not found] ` <notmuch-sha1-0807e1720f829950d42ef560bc30e56bd152766c>
2023-05-07 8:50 ` Bruno Barbier
2023-05-07 9:18 ` Ruijie Yu via General discussions about Org-mode.
2023-05-07 11:15 ` Bruno Barbier [this message]
2023-05-08 10:59 ` Ihor Radchenko
2023-05-21 7:40 ` Bruno Barbier
2023-06-02 8:44 ` Ihor Radchenko
2023-08-10 12:51 ` Ihor Radchenko
2023-08-25 19:10 ` Bruno Barbier
2023-09-07 14:21 ` Bruno Barbier
2023-09-08 8:23 ` Ihor Radchenko
2023-09-08 9:49 ` Bruno Barbier
2023-03-23 10:35 ` Ihor Radchenko
2023-03-23 21:01 ` ParetoOptimalDev
2023-03-23 21:30 ` ParetoOptimalDev
2023-03-24 10:40 ` Ihor Radchenko
2023-03-26 3:27 ` ParetoOptimalDev
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6457883b.5d0a0220.2b9fc.8fd2@mx.google.com \
--to=brubar.cs@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=ruijie@netyu.xyz \
--cc=yantar92@posteo.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).