summaryrefslogtreecommitdiff
path: root/test/lisp/eshell/em-script-tests.el
blob: 3259022957bf6332d5db4135d59aa5d844428f84 (plain)
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
;;; em-script-tests.el --- em-script 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 script module.

;;; Code:

(require 'ert)
(require 'ert-x)
(require 'esh-mode)
(require 'eshell)
(require 'em-script)

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

(defvar eshell-execute-file-output)

;;; Tests:

(ert-deftest em-script-test/source-script ()
  "Test sourcing a simple script."
  (ert-with-temp-file temp-file :text "echo hi"
    (with-temp-eshell
     (eshell-match-command-output (format "source %s" temp-file)
                                  "hi\n"))))

(ert-deftest em-script-test/source-script/redirect ()
  "Test sourcing a script and redirecting its output."
  (ert-with-temp-file temp-file
    :text "echo hi\necho bye"
    (eshell-with-temp-buffer bufname "old"
      (with-temp-eshell
       (eshell-match-command-output
        (format "source %s > #<%s>" temp-file bufname)
        "\\`\\'"))
      (should (equal (buffer-string) "hibye")))))

(ert-deftest em-script-test/source-script/redirect/dev-null ()
  "Test sourcing a script and redirecting its output, including to /dev/null."
  (ert-with-temp-file temp-file
    :text "echo hi\necho bad > /dev/null\necho bye"
    (eshell-with-temp-buffer bufname "old"
      (with-temp-eshell
       (eshell-match-command-output
        (format "source %s > #<%s>" temp-file bufname)
        "\\`\\'"))
      (should (equal (buffer-string) "hibye")))))

(ert-deftest em-script-test/source-script/background ()
  "Test sourcing a script in the background."
  (skip-unless (executable-find "echo"))
  (ert-with-temp-file temp-file
    :text "*echo hi\nif {[ foo = foo ]} {*echo bye}"
    (eshell-with-temp-buffer bufname "old"
      (with-temp-eshell
       (eshell-match-command-output
        (format "source %s > #<%s> &" temp-file bufname)
        "\\`\\'")
       (eshell-wait-for-subprocess t))
      (should (equal (buffer-string) "hi\nbye\n")))))

(ert-deftest em-script-test/source-script/arg-vars ()
  "Test sourcing script with $0, $1, ... variables."
  (ert-with-temp-file temp-file :text "printnl $0 \"$1 $2\""
    (with-temp-eshell
     (eshell-match-command-output (format "source %s one two" temp-file)
                                  (format "%s\none two\n" temp-file)))))

(ert-deftest em-script-test/source-script/all-args-var ()
  "Test sourcing script with the $* variable."
  (ert-with-temp-file temp-file :text "printnl $*"
    (with-temp-eshell
     (eshell-match-command-output (format "source %s" temp-file)
                                  "\\`\\'")
     (eshell-match-command-output (format "source %s a" temp-file)
                                  "a\n")
     (eshell-match-command-output (format "source %s a b c" temp-file)
                                  "a\nb\nc\n"))))

(ert-deftest em-script-test/execute-file ()
  "Test running an Eshell script file via `eshell-execute-file'."
  (ert-with-temp-file temp-file
    :text "echo hi\necho bye"
    (with-temp-buffer
      (with-temp-eshell-settings
        (eshell-execute-file temp-file nil t))
      (should (equal (buffer-string) "hibye")))))

(ert-deftest em-script-test/execute-file/args ()
  "Test running an Eshell script file with args via `eshell-execute-file'."
  (ert-with-temp-file temp-file
    :text "+ $@*"
    (with-temp-buffer
      (with-temp-eshell-settings
        (eshell-execute-file temp-file '(1 2 3) t))
      (should (equal (buffer-string) "6")))))

(ert-deftest em-script-test/execute-file/output-file ()
  "Test `eshell-execute-file' redirecting to a file."
  (ert-with-temp-file temp-file :text "echo more"
    (ert-with-temp-file output-file :text "initial"
      (with-temp-eshell-settings
        (eshell-execute-file temp-file nil output-file))
      (should (equal (eshell-test-file-string output-file) "moreinitial")))))

(ert-deftest em-script-test/execute-file/output-symbol ()
  "Test `eshell-execute-file' redirecting to a symbol."
  (ert-with-temp-file temp-file :text "echo hi\necho bye"
    (with-temp-eshell-settings
      (eshell-execute-file temp-file nil 'eshell-execute-file-output))
    (should (equal eshell-execute-file-output "hibye"))))

(ert-deftest em-script-test/batch-file ()
  "Test running an Eshell script file as a batch script."
  (ert-with-temp-file temp-file
    :text "echo hi"
    (with-temp-buffer
      (with-temp-eshell-settings
       (call-process (expand-file-name invocation-name invocation-directory)
                     nil '(t nil) nil
                     "--batch" "-f" "eshell-batch-file" temp-file))
      (should (equal (buffer-string) "hi\n")))))

(ert-deftest em-script-test/batch-file/shebang ()
  "Test running an Eshell script file as a batch script via a shebang."
  (skip-unless (not (memq system-type '(windows-nt ms-dos))))
  (ert-with-temp-file temp-file
    :text (format
           "#!/usr/bin/env -S %s --batch -f eshell-batch-file\necho hi"
           (expand-file-name invocation-name invocation-directory))
    (set-file-modes temp-file #o744)
    (with-temp-buffer
      (with-temp-eshell-settings
        (call-process temp-file nil '(t nil)))
      (should (equal (buffer-string) "hi\n")))))

;; em-script-tests.el ends here