emacs/test/lisp/eshell/esh-ext-tests.el

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

;; Copyright (C) 2022-2025 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 external command handling.

;;; Code:

(require 'tramp)
(require 'ert)
(require 'esh-mode)
(require 'esh-ext)
(require 'eshell)
(require 'ert-x)

(require 'eshell-tests-helpers
         (ert-resource-file "eshell-tests-helpers"))

;;; Tests:

(ert-deftest esh-ext-test/addpath/end ()
  "Test that \"addpath\" adds paths to the end of $PATH."
  (with-temp-eshell
   (let ((eshell-path-env-list '("/some/path" "/other/path"))
         (expected-path (string-join '("/some/path" "/other/path" "/new/path"
                                       "/new/path2")
                                     (path-separator))))
     (eshell-match-command-output "addpath /new/path /new/path2"
                                  (concat expected-path "\n"))
     (eshell-match-command-output "echo $PATH"
                                  (concat expected-path "\n")))))

(ert-deftest esh-ext-test/addpath/begin ()
  "Test that \"addpath -b\" adds paths to the beginning of $PATH."
  (with-temp-eshell
   (let ((eshell-path-env-list '("/some/path" "/other/path"))
         (expected-path (string-join '("/new/path" "/new/path2" "/some/path"
                                       "/other/path")
                                     (path-separator))))
     (eshell-match-command-output "addpath -b /new/path /new/path2"
                                  (concat expected-path "\n"))
     (eshell-match-command-output "echo $PATH"
                                  (concat expected-path "\n")))))

(ert-deftest esh-ext-test/addpath/set-locally ()
  "Test adding to the path temporarily in a subcommand."
  (let* ((eshell-path-env-list '("/some/path" "/other/path"))
         (original-path (string-join eshell-path-env-list (path-separator)))
         (local-path (string-join (append eshell-path-env-list '("/new/path"))
                                  (path-separator))))
    (with-temp-eshell
     (eshell-match-command-output
      "{ addpath /new/path; env }"
      (format "PATH=%s\n" (regexp-quote local-path)))
     ;; After the last command, the previous $PATH value should be restored.
     (eshell-match-command-output "echo $PATH"
                                  (concat original-path "\n")))))

(ert-deftest esh-ext-test/explicitly-remote-command ()
  "Test that an explicitly-remote command is remote no matter the current dir."
  (skip-unless (and (eshell-tests-remote-accessible-p)
                    (executable-find "sh")))
  (dolist (default-directory (list default-directory
                                   ert-remote-temporary-file-directory))
    (dolist (cmd (list "sh" (executable-find "sh")))
      (ert-info ((format "Directory: %s; executable: %s" default-directory cmd))
        (with-temp-eshell
         ;; Check the value of $INSIDE_EMACS using `sh' in order to
         ;; delay variable expansion.
         (eshell-match-command-output
          (format "%s%s -c 'echo $INSIDE_EMACS'"
                  (file-remote-p ert-remote-temporary-file-directory) cmd)
          "eshell,tramp"))))))

(ert-deftest esh-ext-test/explicitly-local-command ()
  "Test that an explicitly-local command is local no matter the current dir."
  (skip-unless (and (eshell-tests-remote-accessible-p)
                    (executable-find "sh")))
  (dolist (default-directory (list default-directory
                                   ert-remote-temporary-file-directory))
    (dolist (cmd (list "sh" (executable-find "sh")))
      (ert-info ((format "In directory: %s" default-directory))
        (with-temp-eshell
         ;; Check the value of $INSIDE_EMACS using `sh' in order to
         ;; delay variable expansion.
         (eshell-match-command-output
          (format "/local:%s -c 'echo $INSIDE_EMACS'" cmd)
          "eshell\n"))))))

;; esh-ext-tests.el ends here