1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-09 15:50:40 -08:00
emacs/test/lisp/erc/erc-scenarios-log.el
F. Jason Park 9cd47017c7 Fix overlapping logs from erc-truncate-buffer-on-save
* lisp/erc/erc-button.el (erc-button--display-error-notice-with-keys):
Currently, internal "error notices" do not have timestamps.  However,
this causes alignment issues for non-`fill-wrap' users of left-sided
stamps.  The heuristic used by this change for detecting such stamps
is weak and prone to false negatives.
* lisp/erc/erc-log.el (erc-log-mode, erc-log-enable): Set explicit
depth for `erc--pre-clear-functions' to 50.
(erc-save-buffer-in-logs): Fix partial regression in which redundant
text would appear in logs that have undergone truncation via an
interactive call to this command when the deprecated option
`erc-truncate-on-save' is non-nil.
* lisp/erc/erc-stamp.el (erc-stamp-mode, erc-stamp-enable): Set
depth for `erc--pre-clear-functions' to 40.
(erc-stamp--reset-on-clear): Only add `erc-stamp--insert-date-hook'
when `erc-stamp--date-mode' is active.
* lisp/erc/erc.el (erc-cmd-CLEAR): Rework to honor but improve upon
the old behavior when called from lisp.  Do this by attempting to find
the beginning of the current message and excluding it from the
truncated portion of the buffer.  A NEWS entry describing this
behavior already exists for 5.6.
* test/lisp/erc/erc-scenarios-log.el
(erc-scenarios-log--save-buffer-in-logs/truncate-on-save): New test.
These changes originate from bug#60936.
2023-12-23 06:46:33 -08:00

264 lines
10 KiB
EmacsLisp

;;; erc-scenarios-log.el --- erc-log scenarios -*- lexical-binding: t -*-
;; Copyright (C) 2023 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:
;;; Code:
(require 'ert-x)
(eval-and-compile
(let ((load-path (cons (ert-resource-directory) load-path)))
(require 'erc-scenarios-common)))
(require 'erc-log)
(require 'erc-truncate)
(defvar erc-timestamp-format-left)
(ert-deftest erc-scenarios-log--kill-hook ()
:tags '(:expensive-test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "base/assoc/bouncer-history")
(dumb-server (erc-d-run "localhost" t 'foonet))
(tempdir (make-temp-file "erc-tests-log." t nil nil))
(erc-log-channels-directory tempdir)
(erc-modules (cons 'log erc-modules))
(port (process-contact dumb-server :service))
(logfile (expand-file-name (format "#chan!tester@127.0.0.1:%d.txt" port)
tempdir))
(erc-server-flood-penalty 0.1)
(expect (erc-d-t-make-expecter)))
(ert-info ("Connect to foonet")
(with-current-buffer (erc :server "127.0.0.1"
:port port
:nick "tester"
:password "foonet:changeme"
:full-name "tester")
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))
(funcall expect 5 "foonet")))
(with-current-buffer (erc-d-t-wait-for 5 (get-buffer "#chan"))
(funcall expect 10 "was created on")
(funcall expect 10 "please your lordship")
(with-current-buffer "foonet"
(delete-process erc-server-process)
(funcall expect 5 "failed"))
(should-not (file-exists-p logfile))
(kill-buffer)
(should (file-exists-p logfile)))
(with-temp-buffer
(insert-file-contents logfile)
(funcall expect 1 "You have joined")
(funcall expect 1 "Playback Complete.")
(funcall expect 1 "please your lordship"))
(erc-log-mode -1)
(if noninteractive
(delete-directory tempdir :recursive)
(add-hook 'kill-emacs-hook
(lambda () (delete-directory tempdir :recursive))))))
;; This shows that, in addition to truncating the buffer, /clear also
;; syncs the log.
(ert-deftest erc-scenarios-log--clear-stamp ()
:tags '(:expensive-test)
(require 'erc-stamp)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "base/assoc/bouncer-history")
(dumb-server (erc-d-run "localhost" t 'foonet))
(tempdir (make-temp-file "erc-tests-log." t nil nil))
(erc-log-channels-directory tempdir)
(erc-modules (cons 'log erc-modules))
(erc-timestamp-format-left "\n[%a %b %e %Y @@STAMP@@]\n")
(port (process-contact dumb-server :service))
(logfile (expand-file-name (format "#chan!tester@127.0.0.1:%d.txt" port)
tempdir))
(erc-server-flood-penalty 0.1)
(expect (erc-d-t-make-expecter)))
(unless noninteractive
(add-hook 'kill-emacs-hook
(lambda () (delete-directory tempdir :recursive))))
(ert-info ("Connect to foonet")
(with-current-buffer (erc :server "127.0.0.1"
:port port
:nick "tester"
:password "foonet:changeme"
:full-name "tester")
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))
(funcall expect 5 "foonet")))
(with-current-buffer (erc-d-t-wait-for 5 (get-buffer "#chan"))
(funcall expect 10 "@@STAMP@@")
(funcall expect 10 "Grows, lives")
(should-not (file-exists-p logfile))
(goto-char (point-max))
(erc-cmd-CLEAR)
(should (file-exists-p logfile))
(funcall expect 10 "please your lordship")
(ert-info ("Buffer truncated")
(goto-char (point-min))
(funcall expect 10 "@@STAMP@@" (point)) ; reset
(funcall expect -0.1 "Grows, lives")
(funcall expect 1 "For these two")))
(ert-info ("Current contents saved")
(with-temp-buffer
(insert-file-contents logfile)
(funcall expect 1 "@@STAMP@@")
(funcall expect 1 "You have joined")
(funcall expect 1 "Playback Complete.")
(funcall expect 1 "Grows, lives")
(funcall expect -0.01 "please your lordship")))
(ert-info ("Remainder saved, timestamp printed when option non-nil")
(with-current-buffer "foonet"
(delete-process erc-server-process)
(funcall expect 5 "failed"))
(kill-buffer "#chan")
(with-temp-buffer
(insert-file-contents logfile)
(funcall expect 1 "@@STAMP@@")
(funcall expect 1 "Grows, lives")
(funcall expect -0.01 "@@STAMP@@")
(forward-line 1) ; no blank, no timestamp
(should (looking-at (rx "<bob> alice: For these two hours,")))
(funcall expect 1 "please your lordship")))
(erc-log-mode -1)
(when noninteractive (delete-directory tempdir :recursive))))
(ert-deftest erc-scenarios-log--truncate ()
:tags '(:expensive-test :unstable)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "base/assoc/bouncer-history")
(dumb-server (erc-d-run "localhost" t 'foonet))
(tempdir (make-temp-file "erc-tests-log." t nil nil))
(erc-log-channels-directory tempdir)
(erc-modules (cons 'truncate (cons 'log erc-modules)))
(erc-max-buffer-size 512)
(port (process-contact dumb-server :service))
(logchan (expand-file-name (format "#chan!tester@127.0.0.1:%d.txt" port)
tempdir))
(logserv (expand-file-name
(format "127.0.0.1:%d!tester@127.0.0.1:%d.txt" port port)
tempdir))
(erc-server-flood-penalty 0.1)
(expect (erc-d-t-make-expecter)))
(unless noninteractive
(add-hook 'kill-emacs-hook
(lambda () (delete-directory tempdir :recursive))))
(ert-info ("Connect to foonet")
(with-current-buffer (erc :server "127.0.0.1"
:port port
:nick "tester"
:password "foonet:changeme"
:full-name "tester")
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))
(should-not (file-exists-p logserv))
(should-not (file-exists-p logchan))
(funcall expect 10 "*** MAXLIST=beI:60")
(should (= (pos-bol) (point-min)))
(should (file-exists-p logserv))))
(ert-info ("Log file ahead of truncation point")
;; Log contains lines still present in buffer.
(with-temp-buffer
(insert-file-contents logserv)
(funcall expect 10 "*** MAXLIST=beI:60")))
(with-current-buffer (erc-d-t-wait-for 5 (get-buffer "#chan"))
(funcall expect 10 "please your lordship")
(should (file-exists-p logchan))
(funcall expect -0.1 "[07:04:37] alice: Here," (point-min)))
(ert-info ("Log ahead of truncation point")
(with-temp-buffer
(insert-file-contents logchan)
(funcall expect 1 "You have joined")
(funcall expect 1 "[07:04:37] alice: Here,")
(funcall expect 1 "loathed enemy")
(funcall expect -0.1 "please your lordship")))
(erc-log-mode -1)
(erc-truncate-mode -1)
(when noninteractive (delete-directory tempdir :recursive))))
(defvar erc-insert-timestamp-function)
(declare-function erc-insert-timestamp-left "erc-stamp" (string))
(ert-deftest erc-scenarios-log--save-buffer-in-logs/truncate-on-save ()
:tags '(:expensive-test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "base/assoc/bouncer-history")
(dumb-server (erc-d-run "localhost" t 'foonet))
(tempdir (make-temp-file "erc-tests-log." t nil nil))
(erc-log-channels-directory tempdir)
(erc-modules (cons 'log erc-modules))
(port (process-contact dumb-server :service))
(erc-truncate-buffer-on-save t)
(logchan (expand-file-name (format "#chan!tester@127.0.0.1:%d.txt" port)
tempdir))
(erc-server-flood-penalty 0.1)
(erc-insert-timestamp-function #'erc-insert-timestamp-left)
(expect (erc-d-t-make-expecter)))
(unless noninteractive
(add-hook 'kill-emacs-hook
(lambda () (delete-directory tempdir :recursive))))
(ert-info ("Connect to foonet")
(with-current-buffer (erc :server "127.0.0.1"
:port port
:nick "tester"
:password "foonet:changeme"
:full-name "tester")
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))))
(with-current-buffer (erc-d-t-wait-for 5 (get-buffer "#chan"))
(funcall expect 10 "<someone> [07:04:10] hi everyone")
(should-not (file-exists-p logchan))
;; Simulate an M-x erc-save-buffer-in-logs RET
(cl-letf (((symbol-function 'called-interactively-p) #'always))
(call-interactively #'erc-save-buffer-in-logs))
(should (file-exists-p logchan))
(funcall expect 10 "<alice> bob: As't please your lordship")
(erc-save-buffer-in-logs)
;; Not truncated when called by lisp code.
(should (> (buffer-size) 400)))
(ert-info ("No double entries")
(with-temp-buffer
(insert-file-contents logchan)
(funcall expect 0.1 "hi everyone")
(funcall expect -0.1 "hi everyone")
(funcall expect 0.1 "Playback Complete")
(funcall expect -0.1 "Playback Complete")
(funcall expect 10 "<alice> bob: As't")))
(erc-log-mode -1)
(when noninteractive (delete-directory tempdir :recursive))))
;;; erc-scenarios-log.el ends here