emacs/test/lisp/eshell/em-hist-tests.el

186 lines
7.4 KiB
EmacsLisp
Raw Normal View History

;;; em-hist-tests.el --- em-hist test suite -*- lexical-binding:t -*-
2024-01-02 09:47:10 +08:00
;; Copyright (C) 2017-2024 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/>.
;;; Code:
(eval-when-compile
(require 'cl-lib))
(require 'ert)
Prefer ert-with-temp-(directory|file) * test/lisp/abbrev-tests.el (read-write-abbrev-file-test) (read-write-abbrev-file-test-with-props) (abbrev-edit-save-to-file-test): * test/lisp/auth-source-tests.el (auth-source-test-netrc-create-secret) (auth-source-delete): * test/lisp/autoinsert-tests.el (autoinsert-tests-auto-insert-file): * test/lisp/bookmark-tests.el (with-bookmark-test-save-load): * test/lisp/buff-menu-tests.el (buff-menu-24962): * test/lisp/calendar/icalendar-tests.el (icalendar-tests--do-test-export): * test/lisp/calendar/todo-mode-tests.el (with-todo-test): * test/lisp/dired-tests.el (dired-test-bug27243-01, dired-test-bug27243-02) (dired-test-bug27243-03, dired-test-bug27631) (dired-test-bug27968, dired-test-with-temp-dirs): * test/lisp/dired-x-tests.el (dired-test-bug25942): * test/lisp/emacs-lisp/bytecomp-tests.el (bytecomp-tests--with-temp-file): * test/lisp/emacs-lisp/check-declare-tests.el (check-declare-tests-scan) (check-declare-tests-verify-mismatch): * test/lisp/emacs-lisp/edebug-tests.el (edebug-tests-with-normal-env): * test/lisp/emacs-lisp/package-tests.el (with-package-test) (package-test-signed): * test/lisp/emacs-lisp/testcover-tests.el (testcover-tests-markup-region) (testcover-tests-run-test-case): * test/lisp/emulation/viper-tests.el (viper-test-undo-kmacro): * test/lisp/epg-tests.el (with-epg-tests): * test/lisp/eshell/em-hist-tests.el (eshell-write-readonly-history): * test/lisp/eshell/em-ls-tests.el (em-ls-test-bug27631): * test/lisp/ffap-tests.el (ffap-tests-25243): * test/lisp/files-tests.el (files-tests-bug-18141) (files-tests-read-file-in-~, files-tests-make-directory) (files-tests-copy-directory, files-tests-executable-find) (files-tests-dont-rewrite-precious-files) (files-tests--save-some-buffers): * test/lisp/ls-lisp-tests.el (ls-lisp-test-bug27631): * test/lisp/mail/uudecode-tests.el (uudecode-tests-decode-region-internal) (uudecode-tests-decode-region-external): * test/lisp/net/browse-url-tests.el (browse-url-tests-delete-temp-file): * test/lisp/progmodes/elisp-mode-tests.el (xref--case-insensitive): * test/lisp/progmodes/etags-tests.el (etags-buffer-local-tags-table-list): * test/lisp/progmodes/flymake-tests.el (ruby-backend): * test/lisp/progmodes/python-tests.el (python-tests-with-temp-file): * test/lisp/progmodes/sql-tests.el (with-sql-test-connect-harness): * test/lisp/saveplace-tests.el (saveplace-test-save-place-to-alist/file) (saveplace-test-forget-unreadable-files) (saveplace-test-place-alist-to-file): * test/lisp/so-long-tests/spelling-tests.el: * test/lisp/textmodes/reftex-tests.el (reftex-locate-bibliography-files) (reftex-parse-from-file-test): * test/lisp/thumbs-tests.el (thumbs-tests-thumbsdir/create-if-missing): * test/lisp/vc/vc-bzr-tests.el (vc-bzr-test-bug9726) (vc-bzr-test-bug9781, vc-bzr-test-faulty-bzr-autoloads): * test/lisp/vc/diff-mode-tests.el (diff-mode-test-ignore-trailing-dashes): * test/lisp/vc/ediff-ptch-tests.el (ediff-ptch-test-bug26084): * test/lisp/wdired-tests.el (wdired-test-bug32173-01) (wdired-test-bug32173-02, wdired-test-symlink-name) (wdired-test-unfinished-edit-01, wdired-test-bug34915) (wdired-test-bug39280): * test/src/buffer-tests.el (test-kill-buffer-auto-save-default): * test/src/filelock-tests.el (filelock-tests--fixture): * test/src/inotify-tests.el (inotify-file-watch-simple): * test/src/undo-tests.el (undo-test-file-modified): Prefer 'ert-with-temp-(directory|file)' to using 'make-temp-file' directly. In some cases, this is just cleanup, but in several cases this fixes bugs where an error would have lead to us not cleaning up.
2021-11-06 23:20:59 +01:00
(require 'ert-x)
(require 'em-hist)
(require 'eshell)
(require 'eshell-tests-helpers
(expand-file-name "eshell-tests-helpers"
(file-name-directory (or load-file-name
default-directory))))
(cl-defun em-hist-test/check-history-file (file-name expected &optional
(expected-ring t))
"Check that the contents of FILE-NAME match the EXPECTED history entries.
2023-12-10 13:22:04 +01:00
Additionally, check that after loading the file, the history ring
matches too. If EXPECTED-RING is a list, compare the ring
elements against that; if t (the default), check against EXPECTED."
(when (eq expected-ring t) (setq expected-ring expected))
;; First check the actual file.
(should (equal (with-temp-buffer
(insert-file-contents file-name)
(buffer-string))
(mapconcat (lambda (i) (concat i "\n")) expected)))
;; Now read the history ring and check that too.
(let (eshell-history-ring eshell-history-index eshell-hist--new-items)
(eshell-read-history file-name)
(should (equal (nreverse (ring-elements eshell-history-ring))
expected-ring))))
;;; Tests:
(ert-deftest em-hist-test/write-history/append ()
"Test appending new history to history file."
(ert-with-temp-file histfile
(with-temp-eshell
(em-hist-test/check-history-file histfile nil)
(eshell-insert-command "echo hi")
(eshell-write-history histfile 'append)
(em-hist-test/check-history-file histfile '("echo hi"))
(eshell-insert-command "echo bye")
(eshell-write-history histfile 'append)
(em-hist-test/check-history-file histfile '("echo hi" "echo bye")))))
(ert-deftest em-hist-test/write-history/append-multiple-eshells ()
"Test appending new history to history file from multiple Eshells."
(ert-with-temp-file histfile
(with-temp-eshell
(with-temp-eshell
;; Enter some commands and save them.
(eshell-insert-command "echo foo")
(eshell-insert-command "echo bar")
(eshell-write-history histfile 'append)
(em-hist-test/check-history-file histfile '("echo foo" "echo bar")))
;; Now do the same in the first Eshell buffer.
(eshell-insert-command "echo goat")
(eshell-insert-command "echo panda")
(eshell-write-history histfile 'append)
(em-hist-test/check-history-file
histfile '("echo foo" "echo bar" "echo goat" "echo panda")))))
(ert-deftest em-hist-test/write-history/overwrite ()
"Test overwriting history file."
(ert-with-temp-file histfile
(with-temp-eshell
(em-hist-test/check-history-file histfile nil)
(eshell-insert-command "echo hi")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo hi")
(eshell-write-history histfile)
(em-hist-test/check-history-file
histfile '("echo hi" "echo bye" "echo bye" "echo hi"))
(let ((eshell-hist-ignoredups t))
(em-hist-test/check-history-file
histfile '("echo hi" "echo bye" "echo bye" "echo hi")
'("echo hi" "echo bye" "echo hi")))
(let ((eshell-hist-ignoredups 'erase))
(em-hist-test/check-history-file
histfile '("echo hi" "echo bye" "echo bye" "echo hi")
'("echo bye" "echo hi"))))))
(ert-deftest em-hist-test/write-history/overwrite-multiple-shells ()
"Test overwriting history file from multiple Eshells."
(ert-with-temp-file histfile
(with-temp-eshell
(with-temp-eshell
;; Enter some commands and save them.
(eshell-insert-command "echo foo")
(eshell-insert-command "echo bar")
(eshell-write-history histfile)
(em-hist-test/check-history-file histfile '("echo foo" "echo bar")))
;; Now do the same in the first Eshell buffer.
(eshell-insert-command "echo goat")
(eshell-insert-command "echo panda")
(eshell-write-history histfile)
(em-hist-test/check-history-file
histfile '("echo goat" "echo panda")))))
(ert-deftest em-hist-test/write-history/read-only ()
"Test that having read-only strings in history is okay."
Prefer ert-with-temp-(directory|file) * test/lisp/abbrev-tests.el (read-write-abbrev-file-test) (read-write-abbrev-file-test-with-props) (abbrev-edit-save-to-file-test): * test/lisp/auth-source-tests.el (auth-source-test-netrc-create-secret) (auth-source-delete): * test/lisp/autoinsert-tests.el (autoinsert-tests-auto-insert-file): * test/lisp/bookmark-tests.el (with-bookmark-test-save-load): * test/lisp/buff-menu-tests.el (buff-menu-24962): * test/lisp/calendar/icalendar-tests.el (icalendar-tests--do-test-export): * test/lisp/calendar/todo-mode-tests.el (with-todo-test): * test/lisp/dired-tests.el (dired-test-bug27243-01, dired-test-bug27243-02) (dired-test-bug27243-03, dired-test-bug27631) (dired-test-bug27968, dired-test-with-temp-dirs): * test/lisp/dired-x-tests.el (dired-test-bug25942): * test/lisp/emacs-lisp/bytecomp-tests.el (bytecomp-tests--with-temp-file): * test/lisp/emacs-lisp/check-declare-tests.el (check-declare-tests-scan) (check-declare-tests-verify-mismatch): * test/lisp/emacs-lisp/edebug-tests.el (edebug-tests-with-normal-env): * test/lisp/emacs-lisp/package-tests.el (with-package-test) (package-test-signed): * test/lisp/emacs-lisp/testcover-tests.el (testcover-tests-markup-region) (testcover-tests-run-test-case): * test/lisp/emulation/viper-tests.el (viper-test-undo-kmacro): * test/lisp/epg-tests.el (with-epg-tests): * test/lisp/eshell/em-hist-tests.el (eshell-write-readonly-history): * test/lisp/eshell/em-ls-tests.el (em-ls-test-bug27631): * test/lisp/ffap-tests.el (ffap-tests-25243): * test/lisp/files-tests.el (files-tests-bug-18141) (files-tests-read-file-in-~, files-tests-make-directory) (files-tests-copy-directory, files-tests-executable-find) (files-tests-dont-rewrite-precious-files) (files-tests--save-some-buffers): * test/lisp/ls-lisp-tests.el (ls-lisp-test-bug27631): * test/lisp/mail/uudecode-tests.el (uudecode-tests-decode-region-internal) (uudecode-tests-decode-region-external): * test/lisp/net/browse-url-tests.el (browse-url-tests-delete-temp-file): * test/lisp/progmodes/elisp-mode-tests.el (xref--case-insensitive): * test/lisp/progmodes/etags-tests.el (etags-buffer-local-tags-table-list): * test/lisp/progmodes/flymake-tests.el (ruby-backend): * test/lisp/progmodes/python-tests.el (python-tests-with-temp-file): * test/lisp/progmodes/sql-tests.el (with-sql-test-connect-harness): * test/lisp/saveplace-tests.el (saveplace-test-save-place-to-alist/file) (saveplace-test-forget-unreadable-files) (saveplace-test-place-alist-to-file): * test/lisp/so-long-tests/spelling-tests.el: * test/lisp/textmodes/reftex-tests.el (reftex-locate-bibliography-files) (reftex-parse-from-file-test): * test/lisp/thumbs-tests.el (thumbs-tests-thumbsdir/create-if-missing): * test/lisp/vc/vc-bzr-tests.el (vc-bzr-test-bug9726) (vc-bzr-test-bug9781, vc-bzr-test-faulty-bzr-autoloads): * test/lisp/vc/diff-mode-tests.el (diff-mode-test-ignore-trailing-dashes): * test/lisp/vc/ediff-ptch-tests.el (ediff-ptch-test-bug26084): * test/lisp/wdired-tests.el (wdired-test-bug32173-01) (wdired-test-bug32173-02, wdired-test-symlink-name) (wdired-test-unfinished-edit-01, wdired-test-bug34915) (wdired-test-bug39280): * test/src/buffer-tests.el (test-kill-buffer-auto-save-default): * test/src/filelock-tests.el (filelock-tests--fixture): * test/src/inotify-tests.el (inotify-file-watch-simple): * test/src/undo-tests.el (undo-test-file-modified): Prefer 'ert-with-temp-(directory|file)' to using 'make-temp-file' directly. In some cases, this is just cleanup, but in several cases this fixes bugs where an error would have lead to us not cleaning up.
2021-11-06 23:20:59 +01:00
(ert-with-temp-file histfile
(let ((eshell-history-ring (make-ring 2)))
(ring-insert eshell-history-ring
(propertize "echo foo" 'read-only t))
(ring-insert eshell-history-ring
(propertize "echo bar" 'read-only t))
(eshell-write-history histfile)
(em-hist-test/check-history-file histfile '("echo foo" "echo bar")))))
(ert-deftest em-hist-test/add-to-history/allow-dups ()
"Test adding to history, allowing dups."
(let ((eshell-hist-ignoredups nil))
(with-temp-eshell
(eshell-insert-command "echo hi")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo hi")
(should (equal (ring-elements eshell-history-ring)
'("echo hi" "echo bye" "echo bye" "echo hi"))))))
(ert-deftest em-hist-test/add-to-history/no-consecutive-dups ()
"Test adding to history, ignoring consecutive dups."
(let ((eshell-hist-ignoredups t))
(with-temp-eshell
(eshell-insert-command "echo hi")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo hi")
(should (equal (ring-elements eshell-history-ring)
'("echo hi" "echo bye" "echo hi"))))))
(ert-deftest em-hist-test/add-to-history/erase-dups ()
"Test adding to history, erasing any old dups."
(let ((eshell-hist-ignoredups 'erase))
(with-temp-eshell
(eshell-insert-command "echo hi")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo hi")
(should (equal (ring-elements eshell-history-ring)
'("echo hi" "echo bye"))))))
(ert-deftest em-hist-test/add-to-history/erase-existing-dups ()
"Test adding to history, erasing any old dups after switching to 'erase."
(let ((eshell-hist-ignoredups nil))
(with-temp-eshell
(eshell-insert-command "echo hi")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo bye")
(eshell-insert-command "echo hi")
(eshell-insert-command "echo bye")
(setq eshell-hist-ignoredups 'erase)
(eshell-insert-command "echo hi")
(should (equal (ring-elements eshell-history-ring)
'("echo hi" "echo bye" "echo bye" "echo bye")))
(eshell-insert-command "echo bye")
(should (equal (ring-elements eshell-history-ring)
'("echo bye" "echo hi"))))))
(provide 'em-hist-test)
;;; em-hist-tests.el ends here