1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
|
;;; eshell-tests.el --- Eshell test suite -*- lexical-binding:t -*-
;; Copyright (C) 1999-2025 Free Software Foundation, Inc.
;; Author: John Wiegley <johnw@gnu.org>
;; 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:
;; Eshell test suite.
;;; Code:
(require 'ert)
(require 'ert-x)
(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:
(ert-deftest eshell-test/eshell-command/simple ()
"Test that the `eshell-command' function writes to the current buffer."
(skip-unless (executable-find "echo"))
(ert-with-temp-directory eshell-directory-name
(let ((eshell-history-file-name nil))
(with-temp-buffer
(eshell-command "*echo hi" t)
(should (equal (buffer-string) "hi\n"))))))
(ert-deftest eshell-test/eshell-command/pipeline ()
"Test that the `eshell-command' function writes to the current buffer.
This test uses a pipeline for the command."
(skip-unless (and (executable-find "echo")
(executable-find "cat")))
(ert-with-temp-directory eshell-directory-name
(let ((eshell-history-file-name nil))
(with-temp-buffer
(eshell-command "*echo hi | *cat" t)
(should (equal (buffer-string) "hi\n"))))))
(ert-deftest eshell-test/eshell-command/pipeline-wait ()
"Check that `eshell-command' waits for all its processes before returning."
(skip-unless (and (executable-find "echo")
(executable-find "sh")
(executable-find "rev")))
(ert-with-temp-directory eshell-directory-name
(let ((eshell-history-file-name nil))
(with-temp-buffer
(eshell-command
"*echo hello | sh -c 'sleep 1; rev' 1>&2 | *echo goodbye" t)
(should (equal (buffer-string) "goodbye\nolleh\n"))))))
(ert-deftest eshell-test/eshell-command/background ()
"Test that `eshell-command' works for background commands."
(skip-unless (executable-find "echo"))
(ert-with-temp-directory eshell-directory-name
(let ((orig-processes (process-list))
(eshell-history-file-name nil))
(with-temp-buffer
(eshell-command "*echo hi &" t)
(eshell-wait-for (lambda () (equal (process-list) orig-processes)))
(should (equal (buffer-string) "hi\n"))))))
(ert-deftest eshell-test/eshell-command/background-pipeline ()
"Test that `eshell-command' works for background commands.
This test uses a pipeline for the command."
(skip-unless (and (executable-find "echo")
(executable-find "cat")))
(ert-with-temp-directory eshell-directory-name
(let ((orig-processes (process-list))
(eshell-history-file-name nil))
(with-temp-buffer
(eshell-command "*echo hi | *cat &" t)
(eshell-wait-for (lambda () (equal (process-list) orig-processes)))
(should (equal (buffer-string) "hi\n"))))))
(ert-deftest eshell-test/eshell-command/output-buffer/sync ()
"Test that the `eshell-command' function writes to its output buffer."
(skip-unless (executable-find "echo"))
(ert-with-temp-directory eshell-directory-name
(let ((eshell-history-file-name nil))
(eshell-command "*echo 'hi\nbye'")
(with-current-buffer "*Eshell Command Output*"
(should (equal (buffer-string) "hi\nbye")))
(kill-buffer "*Eshell Command Output*"))))
(ert-deftest eshell-test/eshell-command/output-buffer/async ()
"Test that the `eshell-command' function writes to its async output buffer."
(skip-unless (executable-find "echo"))
(ert-with-temp-directory eshell-directory-name
(let ((orig-processes (process-list))
(eshell-history-file-name nil))
(eshell-command "*echo hi &")
(eshell-wait-for (lambda () (equal (process-list) orig-processes)))
(with-current-buffer "*Eshell Async Command Output*"
(goto-char (point-min))
(forward-line)
(should (looking-at "hi\n"))))))
(ert-deftest eshell-test/command-running-p ()
"Modeline should show no command running"
(with-temp-eshell
(let ((eshell-status-in-mode-line t))
(should (memq 'eshell-command-running-string mode-line-format))
(should (equal eshell-command-running-string "--")))))
(ert-deftest eshell-test/forward-arg ()
"Test moving across command arguments"
(with-temp-eshell
(eshell-insert-command "echo $(+ 1 (- 4 3)) \"alpha beta\" file" 'ignore)
(let ((end (point)) begin)
(beginning-of-line)
(setq begin (point))
(eshell-forward-argument 4)
(should (= end (point)))
(eshell-backward-argument 4)
(should (= begin (point))))))
(ert-deftest eshell-test/queue-input ()
"Test queuing command input.
This should let the current command finish, then automatically
insert the queued one at the next prompt, and finally run it."
(with-temp-eshell
(eshell-insert-command "sleep 1; echo slept")
(eshell-insert-command "echo alpha" #'eshell-queue-input)
(let ((start (marker-position (eshell-beginning-of-output))))
(eshell-wait-for (lambda () (not eshell-foreground-command)))
(should (string-match "^slept\n.*echo alpha\nalpha\n$"
(buffer-substring-no-properties
start (eshell-end-of-output)))))))
(ert-deftest eshell-test/flush-output ()
"Test flushing of previous output"
(with-temp-eshell
(eshell-insert-command "echo alpha")
(eshell-delete-output)
(should (eshell-match-output
(concat "^" (regexp-quote "*** output flushed ***\n") "$")))))
(ert-deftest eshell-test/get-old-input ()
"Test that we can get the input of a previous command."
(with-temp-eshell
(eshell-insert-command "echo alpha")
(goto-char eshell-last-input-start)
(should (string= (eshell-get-old-input) "echo alpha"))
;; Make sure that `eshell-get-old-input' works even if the point is
;; inside the prompt.
(let ((inhibit-field-text-motion t))
(beginning-of-line))
(should (string= (eshell-get-old-input) "echo alpha"))))
(ert-deftest eshell-test/get-old-input/rerun-command ()
"Test that we can rerun an old command when point is on it."
(with-temp-eshell
(let ((eshell-test-value "first"))
(eshell-match-command-output "echo $eshell-test-value" "first"))
;; Go to the previous prompt.
(forward-line -2)
(let ((inhibit-field-text-motion t))
(end-of-line))
;; Rerun the command, but with a different variable value.
(let ((eshell-test-value "second"))
(eshell-send-input))
(eshell-match-output "second")))
(ert-deftest eshell-test/get-old-input/run-output ()
"Test that we can run a line of output as a command when point is on it."
(with-temp-eshell
(eshell-match-command-output "echo \"echo there\"" "echo there")
;; Go to the output, and insert "hello" after "echo".
(forward-line -1)
(forward-word)
(insert " hello")
;; Run the line as a command.
(eshell-send-input)
(eshell-match-output "(\"hello\" \"there\")")))
(ert-deftest eshell-test/yank-output ()
"Test that yanking a line of output into the next prompt works (bug#66469)."
(with-temp-eshell
(eshell-insert-command "echo hello")
;; Go to the output and kill the line of text.
(forward-line -1)
(kill-line)
;; Go to the last prompt and yank the previous output.
(goto-char (point-max))
(yank)
;; Go to the beginning of the prompt and add some text.
(move-beginning-of-line 1)
(insert-and-inherit "echo ")
;; Make sure when we go to the beginning of the line, we go to the
;; right spot (before the "echo").
(move-end-of-line 1)
(move-beginning-of-line 1)
(should (looking-at "echo hello"))))
(provide 'eshell-tests)
;;; eshell-tests.el ends here
|