aboutsummaryrefslogtreecommitdiffstats
path: root/test/lisp/eshell/em-alias-tests.el
blob: 336038e5e90dda12bbe584ba5055ae8e6c413012 (plain) (blame)
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
;;; em-alias-tests.el --- em-alias test suite  -*- lexical-binding:t -*-

;; Copyright (C) 2022-2026 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 alias module.

;;; Code:

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

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

(ert-deftest em-alias-test/simple-alias ()
  "Test a simple alias with no arguments"
  (with-temp-eshell
   (eshell-insert-command "alias say-hi 'echo hi'")
   (eshell-match-command-output "say-hi" "hi\n")
   (eshell-match-command-output "say-hi bye" "hi\n")))

(ert-deftest em-alias-test/alias-arg-vars ()
  "Test alias with $0, $1, ... variables"
  (with-temp-eshell
   (eshell-insert-command "alias show-args 'printnl $0 \"$1 $2\"'")
   (eshell-match-command-output "show-args one two" "show-args\none two\n")))

(ert-deftest em-alias-test/alias-arg-vars-indices ()
  "Test alias with $1, $2, ... variables using indices"
  (with-temp-eshell
   (eshell-insert-command "alias funny-sum '+ $1[0] $2[1]'")
   (eshell-match-command-output "funny-sum (list 1 2) (list 3 4)"
                                "5\n")))

(ert-deftest em-alias-test/alias-arg-vars-split-indices ()
  "Test alias with $0, $1, ... variables using split indices"
  (with-temp-eshell
   (eshell-insert-command "alias my-prefix 'echo $0[- 0]'")
   (eshell-match-command-output "my-prefix"
                                "my\n")
   (eshell-insert-command "alias funny-sum '+ $1[: 0] $2[: 1]'")
   (eshell-match-command-output "funny-sum 1:2 3:4"
                                "5\n")))

(ert-deftest em-alias-test/alias-all-args-var ()
  "Test alias with the $* variable"
  (with-temp-eshell
   (eshell-insert-command "alias show-all-args 'printnl $*'")
   (eshell-match-command-output "show-all-args" "\\`\\'")
   (eshell-match-command-output "show-all-args a" "a\n")
   (eshell-match-command-output "show-all-args a b c" "a\nb\nc\n")))

(ert-deftest em-alias-test/alias-all-args-var-splice ()
  "Test alias with splicing the $* variable"
  (with-temp-eshell
   (eshell-insert-command "alias show-all-args 'echo args: $@*'")
   (eshell-match-command-output "show-all-args" "args:\n")
   (eshell-match-command-output "show-all-args a" "(\"args:\" \"a\")\n")
   (eshell-match-command-output "show-all-args a b c"
                                "(\"args:\" \"a\" \"b\" \"c\")\n")))

(ert-deftest em-alias-test/alias-all-args-var-indices ()
  "Test alias with the $* variable using indices"
  (with-temp-eshell
   (eshell-insert-command "alias add-pair '+ $*[0] $*[1]'")
   (eshell-match-command-output "add-pair 1 2" "3\n")))

(ert-deftest em-alias-test/alias-all-args-var-split-indices ()
  "Test alias with the $* variable using split indices"
  (with-temp-eshell
   (eshell-insert-command "alias add-funny-pair '+ $*[0][: 0] $*[1][: 1]'")
   (eshell-match-command-output "add-funny-pair 1:2 3:4" "5\n")))

(ert-deftest em-alias-test/alias-list-is-sorted ()
  "Test that the alias list is sorted on insert"
  (with-temp-eshell
   (eshell-insert-command "alias aaa 'aaa'")
   (eshell-insert-command "alias ccc 'ccc'")
   (eshell-insert-command "alias bbb 'bbb'")
   (eshell-match-command-output
    "alias" "alias aaa aaa\nalias bbb bbb\nalias ccc ccc\n")))

(ert-deftest em-alias-test/alias-load-preserves-order ()
  "Test that loading the alias list from disk preserves the ordering"
  (let ((aliases (concat "alias aaa echo aaa\n"
                         "alias ccc echo ccc\n"
                         "alias bbb echo bbb\n")))
    (ert-with-temp-file aliasfile
      (with-temp-buffer
        (insert aliases)
        (write-file aliasfile))
      (with-temp-eshell
        (setq eshell-aliases-file aliasfile)
        (eshell-read-aliases-list)
        (eshell-match-command-output "alias" (regexp-quote aliases))))))

(ert-deftest em-alias-test/alias-save-sorted ()
  "Test that saving the alias file to disk saves in sorted order"
  (ert-with-temp-file aliasfile
    (with-temp-eshell
      (setq eshell-aliases-file aliasfile)
      (eshell-insert-command "alias aaa 'aaa'")
      (eshell-insert-command "alias ccc 'ccc'")
      (eshell-insert-command "alias bbb 'bbb'")
      (should (equal (with-temp-buffer
                       (insert-file-contents aliasfile)
                       (buffer-string))
                     "alias aaa aaa\nalias bbb bbb\nalias ccc ccc\n")))))

;; em-alias-tests.el ends here