1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-03 02:31:03 -08:00
emacs/test/lisp/eshell/esh-cmd-tests.el
Jim Porter f3408af0a3 Make '$?' and '$$' variables more consistent in Eshell
Previously, '$?' (last exit code) was only useful for external
commands, and '$$' (last result) was only useful for Lisp commands.

* lisp/eshell/esh-cmd.el (eshell-lisp-form-nil-is-failure): New
option.
(eshell-lisp-command): Set last exit code to 1 when the command
signals an error, and 2 if it returns nil (for Lisp forms only).

* lisp/eshell/esh-proc.el (eshell-sentinel): Set last result to t if
the command succeeded.

* test/lisp/eshell/esh-cmd-tests.el
(esh-cmd-test/while-loop-lisp-form, esh-cmd-test/until-loop-lisp-form)
(esh-cmd-test/if-else-statement-lisp-form)
(esh-cmd-test/if-else-statement-lisp-form-2)
(esh-cmd-test/unless-else-statement-lisp-form): New tests.

* test/lisp/eshell/esh-var-tests.el
(esh-var-test/last-status-var-lisp-command)
(esh-var-test/last-status-var-lisp-form)
(esh-var-test/last-status-var-lisp-form-2)
(esh-var-test/last-status-var-ext-cmd)
(esh-var-test/last-status-var-ext-cmd): New tests.
(esh-var-test/last-result-var2): Rename from this...
( esh-var-test/last-result-var-twice): ... to this.

* doc/misc/eshell.texi (Variables): Update documentation about '$?'
and '$$'.
(Control Flow): Mention that '(lisp forms)' can be used as
conditionals.

* etc/NEWS: Announce this change (bug#57129).
2022-08-12 22:07:13 -07:00

283 lines
10 KiB
EmacsLisp
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; esh-cmd-tests.el --- esh-cmd 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 command invocation.
;;; 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:
;; Command invocation
(ert-deftest esh-cmd-test/simple-command-result ()
"Test invocation with a simple command."
(should (equal (eshell-test-command-result "+ 1 2") 3)))
(ert-deftest esh-cmd-test/lisp-command ()
"Test invocation with an elisp command."
(should (equal (eshell-test-command-result "(+ 1 2)") 3)))
(ert-deftest esh-cmd-test/lisp-command-with-quote ()
"Test invocation with an elisp command containing a quote."
(should (equal (eshell-test-command-result "(eq 'foo nil)") nil)))
(ert-deftest esh-cmd-test/lisp-command-args ()
"Test invocation with elisp and trailing args.
Test that trailing arguments outside the S-expression are
ignored. e.g. \"(+ 1 2) 3\" => 3"
(should (equal (eshell-test-command-result "(+ 1 2) 3") 3)))
(ert-deftest esh-cmd-test/subcommand ()
"Test invocation with a simple subcommand."
(should (equal (eshell-test-command-result "{+ 1 2}") 3)))
(ert-deftest esh-cmd-test/subcommand-args ()
"Test invocation with a subcommand and trailing args.
Test that trailing arguments outside the subcommand are ignored.
e.g. \"{+ 1 2} 3\" => 3"
(should (equal (eshell-test-command-result "{+ 1 2} 3") 3)))
(ert-deftest esh-cmd-test/subcommand-lisp ()
"Test invocation with an elisp subcommand and trailing args.
Test that trailing arguments outside the subcommand are ignored.
e.g. \"{(+ 1 2)} 3\" => 3"
(should (equal (eshell-test-command-result "{(+ 1 2)} 3") 3)))
;; Logical operators
(ert-deftest esh-cmd-test/and-operator ()
"Test logical && operator."
(skip-unless (executable-find "["))
(with-temp-eshell
(eshell-command-result-p "[ foo = foo ] && echo hi"
"hi\n")
(eshell-command-result-p "[ foo = bar ] && echo hi"
"\\`\\'")))
(ert-deftest esh-cmd-test/or-operator ()
"Test logical || operator."
(skip-unless (executable-find "["))
(with-temp-eshell
(eshell-command-result-p "[ foo = foo ] || echo hi"
"\\`\\'")
(eshell-command-result-p "[ foo = bar ] || echo hi"
"hi\n")))
;; Control flow statements
(ert-deftest esh-cmd-test/for-loop ()
"Test invocation of a for loop."
(with-temp-eshell
(eshell-command-result-p "for i in 5 { echo $i }"
"5\n")))
(ert-deftest esh-cmd-test/for-loop-list ()
"Test invocation of a for loop iterating over a list."
(with-temp-eshell
(eshell-command-result-p "for i in (list 1 2 (list 3 4)) { echo $i }"
"1\n2\n(3 4)\n")))
(ert-deftest esh-cmd-test/for-loop-multiple-args ()
"Test invocation of a for loop iterating over multiple arguments."
(with-temp-eshell
(eshell-command-result-p "for i in 1 2 (list 3 4) { echo $i }"
"1\n2\n3\n4\n")))
(ert-deftest esh-cmd-test/for-name-loop () ; bug#15231
"Test invocation of a for loop using `name'."
(let ((process-environment (cons "name" process-environment)))
(should (equal (eshell-test-command-result
"for name in 3 { echo $name }")
3))))
(ert-deftest esh-cmd-test/for-name-shadow-loop () ; bug#15372
"Test invocation of a for loop using an env-var."
(let ((process-environment (cons "name=env-value" process-environment)))
(with-temp-eshell
(eshell-command-result-p
"echo $name; for name in 3 { echo $name }; echo $name"
"env-value\n3\nenv-value\n"))))
(ert-deftest esh-cmd-test/while-loop ()
"Test invocation of a while loop."
(with-temp-eshell
(let ((eshell-test-value '(0 1 2)))
(eshell-command-result-p
(concat "while $eshell-test-value "
"{ setq eshell-test-value (cdr eshell-test-value) }")
"(1 2)\n(2)\n"))))
(ert-deftest esh-cmd-test/while-loop-lisp-form ()
"Test invocation of a while loop using a Lisp form."
(with-temp-eshell
(let ((eshell-test-value 0))
(eshell-command-result-p
(concat "while (/= eshell-test-value 3) "
"{ setq eshell-test-value (1+ eshell-test-value) }")
"1\n2\n3\n"))))
(ert-deftest esh-cmd-test/while-loop-ext-cmd ()
"Test invocation of a while loop using an external command."
(skip-unless (executable-find "["))
(with-temp-eshell
(let ((eshell-test-value 0))
(eshell-command-result-p
(concat "while {[ $eshell-test-value -ne 3 ]} "
"{ setq eshell-test-value (1+ eshell-test-value) }")
"1\n2\n3\n"))))
(ert-deftest esh-cmd-test/until-loop ()
"Test invocation of an until loop."
(with-temp-eshell
(let ((eshell-test-value nil))
(eshell-command-result-p
(concat "until $eshell-test-value "
"{ setq eshell-test-value t }")
"t\n"))))
(ert-deftest esh-cmd-test/until-loop-lisp-form ()
"Test invocation of an until loop using a Lisp form."
(skip-unless (executable-find "["))
(with-temp-eshell
(let ((eshell-test-value 0))
(eshell-command-result-p
(concat "until (= eshell-test-value 3) "
"{ setq eshell-test-value (1+ eshell-test-value) }")
"1\n2\n3\n"))))
(ert-deftest esh-cmd-test/until-loop-ext-cmd ()
"Test invocation of an until loop using an external command."
(skip-unless (executable-find "["))
(with-temp-eshell
(let ((eshell-test-value 0))
(eshell-command-result-p
(concat "until {[ $eshell-test-value -eq 3 ]} "
"{ setq eshell-test-value (1+ eshell-test-value) }")
"1\n2\n3\n"))))
(ert-deftest esh-cmd-test/if-statement ()
"Test invocation of an if statement."
(with-temp-eshell
(let ((eshell-test-value t))
(eshell-command-result-p "if $eshell-test-value {echo yes}"
"yes\n"))
(let ((eshell-test-value nil))
(eshell-command-result-p "if $eshell-test-value {echo yes}"
"\\`\\'"))))
(ert-deftest esh-cmd-test/if-else-statement ()
"Test invocation of an if/else statement."
(with-temp-eshell
(let ((eshell-test-value t))
(eshell-command-result-p "if $eshell-test-value {echo yes} {echo no}"
"yes\n"))
(let ((eshell-test-value nil))
(eshell-command-result-p "if $eshell-test-value {echo yes} {echo no}"
"no\n"))))
(ert-deftest esh-cmd-test/if-else-statement-lisp-form ()
"Test invocation of an if/else statement using a Lisp form."
(with-temp-eshell
(eshell-command-result-p "if (zerop 0) {echo yes} {echo no}"
"yes\n")
(eshell-command-result-p "if (zerop 1) {echo yes} {echo no}"
"no\n")
(let ((debug-on-error nil))
(eshell-command-result-p "if (zerop \"foo\") {echo yes} {echo no}"
"no\n"))))
(ert-deftest esh-cmd-test/if-else-statement-lisp-form-2 ()
"Test invocation of an if/else statement using a Lisp form.
This tests when `eshell-lisp-form-nil-is-failure' is nil."
(let ((eshell-lisp-form-nil-is-failure nil))
(with-temp-eshell
(eshell-command-result-p "if (zerop 0) {echo yes} {echo no}"
"yes\n")
(eshell-command-result-p "if (zerop 1) {echo yes} {echo no}"
"yes\n")
(let ((debug-on-error nil))
(eshell-command-result-p "if (zerop \"foo\") {echo yes} {echo no}"
"no\n")))))
(ert-deftest esh-cmd-test/if-else-statement-ext-cmd ()
"Test invocation of an if/else statement using an external command."
(skip-unless (executable-find "["))
(with-temp-eshell
(eshell-command-result-p "if {[ foo = foo ]} {echo yes} {echo no}"
"yes\n")
(eshell-command-result-p "if {[ foo = bar ]} {echo yes} {echo no}"
"no\n")))
(ert-deftest esh-cmd-test/unless-statement ()
"Test invocation of an unless statement."
(with-temp-eshell
(let ((eshell-test-value t))
(eshell-command-result-p "unless $eshell-test-value {echo no}"
"\\`\\'"))
(let ((eshell-test-value nil))
(eshell-command-result-p "unless $eshell-test-value {echo no}"
"no\n"))))
(ert-deftest esh-cmd-test/unless-else-statement ()
"Test invocation of an unless/else statement."
(with-temp-eshell
(let ((eshell-test-value t))
(eshell-command-result-p "unless $eshell-test-value {echo no} {echo yes}"
"yes\n"))
(let ((eshell-test-value nil))
(eshell-command-result-p "unless $eshell-test-value {echo no} {echo yes}"
"no\n"))))
(ert-deftest esh-cmd-test/unless-else-statement-lisp-form ()
"Test invocation of an unless/else statement using a Lisp form."
(with-temp-eshell
(eshell-command-result-p "unless (zerop 0) {echo no} {echo yes}"
"yes\n")
(eshell-command-result-p "unless (zerop 1) {echo no} {echo yes}"
"no\n")
(let ((debug-on-error nil))
(eshell-command-result-p "unless (zerop \"foo\") {echo no} {echo yes}"
"no\n"))))
(ert-deftest esh-cmd-test/unless-else-statement-ext-cmd ()
"Test invocation of an unless/else statement using an external command."
(skip-unless (executable-find "["))
(with-temp-eshell
(eshell-command-result-p "unless {[ foo = foo ]} {echo no} {echo yes}"
"yes\n")
(eshell-command-result-p "unless {[ foo = bar ]} {echo no} {echo yes}"
"no\n")))
;; esh-cmd-tests.el ends here