;;; esh-var-tests.el --- esh-var test suite  -*- lexical-binding:t -*-

;; Copyright (C) 2022 Free Software Foundation, Inc.

;; This file is part of GNU Emacs.

;; GNU Emacs 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.

;; GNU Emacs 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 GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:

;; Tests for Eshell's variable handling.

;;; Code:

(require 'ert)
(require 'esh-mode)
(require 'eshell)

(require 'eshell-tests-helpers
         (expand-file-name "eshell-tests-helpers"
                           (file-name-directory (or load-file-name
                                                    default-directory))))

(defvar eshell-test-value nil)

;;; Tests:


;; Variable interpolation

(ert-deftest esh-var-test/interp-var ()
  "Interpolate variable"
  (should (equal (eshell-test-command-result "echo $user-login-name")
                 user-login-name)))

(ert-deftest esh-var-test/interp-quoted-var ()
  "Interpolate quoted variable"
  (should (equal (eshell-test-command-result "echo $'user-login-name'")
                 user-login-name))
  (should (equal (eshell-test-command-result "echo $\"user-login-name\"")
                 user-login-name)))

(ert-deftest esh-var-test/interp-quoted-var-concat ()
  "Interpolate and concat quoted variable"
  (should (equal (eshell-test-command-result "echo $'user-login-name'-foo")
                 (concat user-login-name "-foo")))
  (should (equal (eshell-test-command-result "echo $\"user-login-name\"-foo")
                 (concat user-login-name "-foo"))))

(ert-deftest esh-var-test/interp-var-indices ()
  "Interpolate list variable with indices"
  (let ((eshell-test-value '("zero" "one" "two" "three" "four")))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[0]")
                   "zero"))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[0 2]")
                   '("zero" "two")))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[0 2 4]")
                   '("zero" "two" "four")))))

(ert-deftest esh-var-test/interp-var-split-indices ()
  "Interpolate string variable with indices"
  (let ((eshell-test-value "zero one two three four"))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[0]")
                   "zero"))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[0 2]")
                   '("zero" "two")))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[0 2 4]")
                   '("zero" "two" "four")))))

(ert-deftest esh-var-test/interp-var-string-split-indices ()
  "Interpolate string variable with string splitter and indices"
  (let ((eshell-test-value "zero:one:two:three:four"))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[: 0]")
                   "zero"))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[: 0 2]")
                   '("zero" "two"))))
  (let ((eshell-test-value "zeroXoneXtwoXthreeXfour"))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[X 0]")
                   "zero"))
    (should (equal (eshell-test-command-result "echo $eshell-test-value[X 0 2]")
                   '("zero" "two")))))

(ert-deftest esh-var-test/interp-var-regexp-split-indices ()
  "Interpolate string variable with regexp splitter and indices"
  (let ((eshell-test-value "zero:one!two:three!four"))
    (should (equal (eshell-test-command-result
                    "echo $eshell-test-value['[:!]' 0]")
                   "zero"))
    (should (equal (eshell-test-command-result
                    "echo $eshell-test-value['[:!]' 0 2]")
                   '("zero" "two")))
    (should (equal (eshell-test-command-result
                    "echo $eshell-test-value[\"[:!]\" 0]")
                   "zero"))
    (should (equal (eshell-test-command-result
                    "echo $eshell-test-value[\"[:!]\" 0 2]")
                   '("zero" "two")))))

(ert-deftest esh-var-test/interp-var-assoc ()
  "Interpolate alist variable with index"
  (let ((eshell-test-value '(("foo" . 1))))
    (should (eq (eshell-test-command-result "echo $eshell-test-value[foo]")
                1))))

(ert-deftest esh-var-test/interp-var-length-list ()
  "Interpolate length of list variable"
  (let ((eshell-test-value '((1 2) (3) (5 (6 7 8 9)))))
    (should (eq (eshell-test-command-result "echo $#eshell-test-value") 3))
    (should (eq (eshell-test-command-result "echo $#eshell-test-value[1]") 1))
    (should (eq (eshell-test-command-result "echo $#eshell-test-value[2][1]")
                4))))

(ert-deftest esh-var-test/interp-var-length-string ()
  "Interpolate length of string variable"
  (let ((eshell-test-value "foobar"))
    (should (eq (eshell-test-command-result "echo $#eshell-test-value") 6))))

(ert-deftest esh-var-test/interp-var-length-alist ()
  "Interpolate length of alist variable"
  (let ((eshell-test-value '(("foo" . (1 2 3)))))
    (should (eq (eshell-test-command-result "echo $#eshell-test-value") 1))
    (should (eq (eshell-test-command-result "echo $#eshell-test-value[foo]")
                3))))

(ert-deftest esh-var-test/interp-lisp ()
  "Interpolate Lisp form evaluation"
  (should (equal (eshell-test-command-result "+ $(+ 1 2) 3") 6)))

(ert-deftest esh-var-test/interp-lisp-indices ()
  "Interpolate Lisp form evaluation with index"
  (should (equal (eshell-test-command-result "+ $(list 1 2)[1] 3") 5)))

(ert-deftest esh-var-test/interp-cmd ()
  "Interpolate command result"
  (should (equal (eshell-test-command-result "+ ${+ 1 2} 3") 6)))

(ert-deftest esh-var-test/interp-cmd-indices ()
  "Interpolate command result with index"
  (should (equal (eshell-test-command-result "+ ${list 1 2}[1] 3") 5)))

(ert-deftest esh-var-test/interp-cmd-external ()
  "Interpolate command result from external command"
  (skip-unless (executable-find "echo"))
  (with-temp-eshell
   (eshell-command-result-p "echo ${*echo hi}"
                            "hi\n")))

(ert-deftest esh-var-test/interp-cmd-external-indices ()
  "Interpolate command result from external command with index"
  (skip-unless (executable-find "echo"))
  (with-temp-eshell
   (eshell-command-result-p "echo ${*echo \"hi\nbye\"}[1]"
                            "bye\n")))

(ert-deftest esh-var-test/interp-temp-cmd ()
  "Interpolate command result redirected to temp file"
  (should (equal (eshell-test-command-result "cat $<echo hi>") "hi")))

(ert-deftest esh-var-test/interp-concat-lisp ()
  "Interpolate and concat Lisp form"
  (should (equal (eshell-test-command-result "+ $(+ 1 2)3 3") 36)))

(ert-deftest esh-var-test/interp-concat-lisp2 ()
  "Interpolate and concat two Lisp forms"
  (should (equal (eshell-test-command-result "+ $(+ 1 2)$(+ 1 2) 3") 36)))

(ert-deftest esh-var-test/interp-concat-cmd ()
  "Interpolate and concat command"
  (should (equal (eshell-test-command-result "+ ${+ 1 2}3 3") 36)))

(ert-deftest esh-var-test/interp-concat-cmd2 ()
  "Interpolate and concat two commands"
  (should (equal (eshell-test-command-result "+ ${+ 1 2}${+ 1 2} 3") 36)))

(ert-deftest esh-var-test/interp-concat-cmd-external ()
  "Interpolate command result from external command with concatenation"
  (skip-unless (executable-find "echo"))
  (with-temp-eshell
   (eshell-command-result-p "echo ${echo hi}-${*echo there}"
                            "hi-there\n")))

(ert-deftest esh-var-test/quoted-interp-var ()
  "Interpolate variable inside double-quotes"
  (should (equal (eshell-test-command-result "echo \"$user-login-name\"")
                 user-login-name)))

(ert-deftest esh-var-test/quoted-interp-quoted-var ()
  "Interpolate quoted variable inside double-quotes"
  (should (equal (eshell-test-command-result
                  "echo \"hi, $'user-login-name'\"")
                 (concat "hi, " user-login-name)))
  (should (equal (eshell-test-command-result
                  "echo \"hi, $\\\"user-login-name\\\"\"")
                 (concat "hi, " user-login-name))))

(ert-deftest esh-var-test/quoted-interp-var-indices ()
  "Interpolate string variable with indices inside double-quotes"
  (let ((eshell-test-value '("zero" "one" "two" "three" "four")))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[0]\"")
                   "zero"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[0 2]\"")
                   '("zero" "two")))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[0 2 4]\"")
                   '("zero" "two" "four")))))

(ert-deftest esh-var-test/quoted-interp-var-split-indices ()
  "Interpolate string variable with indices inside double-quotes"
  (let ((eshell-test-value "zero one two three four"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[0]\"")
                   "zero"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[0 2]\"")
                   '("zero" "two")))))

(ert-deftest esh-var-test/quoted-interp-var-string-split-indices ()
  "Interpolate string variable with string splitter and indices
inside double-quotes"
  (let ((eshell-test-value "zero:one:two:three:four"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[: 0]\"")
                   "zero"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[: 0 2]\"")
                   '("zero" "two"))))
  (let ((eshell-test-value "zeroXoneXtwoXthreeXfour"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[X 0]\"")
                   "zero"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[X 0 2]\"")
                   '("zero" "two")))))

(ert-deftest esh-var-test/quoted-interp-var-regexp-split-indices ()
  "Interpolate string variable with regexp splitter and indices"
  (let ((eshell-test-value "zero:one!two:three!four"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value['[:!]' 0]\"")
                   "zero"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value['[:!]' 0 2]\"")
                   '("zero" "two")))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[\\\"[:!]\\\" 0]\"")
                   "zero"))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[\\\"[:!]\\\" 0 2]\"")
                   '("zero" "two")))))

(ert-deftest esh-var-test/quoted-interp-var-assoc ()
  "Interpolate alist variable with index inside double-quotes"
  (let ((eshell-test-value '(("foo" . 1))))
    (should (equal (eshell-test-command-result
                    "echo \"$eshell-test-value[foo]\"")
                   1))))

(ert-deftest esh-var-test/quoted-interp-var-length-list ()
  "Interpolate length of list variable inside double-quotes"
  (let ((eshell-test-value '((1 2) (3) (5 (6 7 8 9)))))
    (should (eq (eshell-test-command-result "echo \"$#eshell-test-value\"") 3))
    (should (eq (eshell-test-command-result "echo \"$#eshell-test-value[1]\"")
                1))
    (should (eq (eshell-test-command-result
                 "echo \"$#eshell-test-value[2][1]\"")
                4))))

(ert-deftest esh-var-test/quoted-interp-var-length-string ()
  "Interpolate length of string variable inside double-quotes"
  (let ((eshell-test-value "foobar"))
    (should (eq (eshell-test-command-result "echo \"$#eshell-test-value\"")
                6))))

(ert-deftest esh-var-test/quoted-interp-var-length-alist ()
  "Interpolate length of alist variable inside double-quotes"
  (let ((eshell-test-value '(("foo" . (1 2 3)))))
    (should (eq (eshell-test-command-result "echo \"$#eshell-test-value\"") 1))
    (should (eq (eshell-test-command-result "echo \"$#eshell-test-value[foo]\"")
                3))))

(ert-deftest esh-var-test/quoted-interp-lisp ()
  "Interpolate Lisp form evaluation inside double-quotes"
  (should (equal (eshell-test-command-result
                  "echo \"hi $(concat \\\"the\\\" \\\"re\\\")\"")
                 "hi there")))

(ert-deftest esh-var-test/quoted-interp-lisp-indices ()
  "Interpolate Lisp form evaluation with index"
  (should (equal (eshell-test-command-result "+ \"$(list 1 2)[1]\" 3") 5)))

(ert-deftest esh-var-test/quoted-interp-cmd ()
  "Interpolate command result inside double-quotes"
  (should (equal (eshell-test-command-result
                  "echo \"hi ${echo \\\"there\\\"}\"")
                 "hi there")))

(ert-deftest esh-var-test/quoted-interp-cmd-indices ()
  "Interpolate command result with index inside double-quotes"
  (should (equal (eshell-test-command-result "+ \"${list 1 2}[1]\" 3") 5)))

(ert-deftest esh-var-test/quoted-interp-temp-cmd ()
  "Interpolate command result redirected to temp file inside double-quotes"
  (should (equal (eshell-test-command-result "cat \"$<echo hi>\"") "hi")))


;; Built-in variables

(ert-deftest esh-var-test/window-height ()
  "$LINES should equal (window-height)"
  (should (eshell-test-command-result "= $LINES (window-height)")))

(ert-deftest esh-var-test/window-width ()
  "$COLUMNS should equal (window-width)"
  (should (eshell-test-command-result "= $COLUMNS (window-width)")))

(ert-deftest esh-var-test/last-result-var ()
  "Test using the \"last result\" ($$) variable"
  (with-temp-eshell
   (eshell-command-result-p "+ 1 2; + $$ 2"
                            "3\n5\n")))

(ert-deftest esh-var-test/last-result-var2 ()
  "Test using the \"last result\" ($$) variable twice"
  (with-temp-eshell
   (eshell-command-result-p "+ 1 2; + $$ $$"
                             "3\n6\n")))

(ert-deftest esh-var-test/last-arg-var ()
  "Test using the \"last arg\" ($_) variable"
  (with-temp-eshell
   (eshell-command-result-p "+ 1 2; + $_ 4"
                             "3\n6\n")))

;; esh-var-tests.el ends here