1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
emacs/test/lisp/erc/erc-scenarios-base-reconnect.el
F. Jason Park 959fbcf34b Favor network identities in erc-join
* lisp/erc/erc-join.el (erc-autojoin-server-match): Favor network
identities, falling back on old definition.
(erc-autojoin--join): Add new helper containing common code from
hookees `erc-autojoin-after-ident' and `erc-autojoin-channels'.
(erc-autojoin-after-ident, erc-autojoin-channels): No longer make a
point of returning nil because the hooks they're registered on,
`erc-nickserv-identified-hook' and `erc-after-connect', don't stop on
success.
(erc-autojoin--mutate): Add helper for `erc-autojoin-add' and
`erc-autojoin-remove'.
(erc-autojoin-add, erc-autojoin-remove): Favor given network
identities, over networks, when matching keys for
`erc-autojoin-channels-alist'.

* test/lisp/erc/erc-scenarios-base-reconnect.el: New file.
* test/lisp/erc/erc-scenarios-join-netid-newcmd-id.el: New file.
* test/lisp/erc/erc-scenarios-join-netid-newcmd.el: New file.
* test/lisp/erc/erc-scenarios-join-netid-recon-id.el: New file.
* test/lisp/erc/erc-scenarios-join-netid-recon.el: New file.
* test/lisp/erc/resources/erc-scenarios-common.el: New file.
* test/lisp/erc/resources/join/legacy/foonet.eld: New file.
* test/lisp/erc/resources/join/network-id/barnet.eld: New file.
* test/lisp/erc/resources/join/network-id/foonet-again.eld: New file.
* test/lisp/erc/resources/join/network-id/foonet.eld: New file.
* test/lisp/erc/resources/join/reconnect/foonet-again.eld: New file.
* test/lisp/erc/resources/join/reconnect/foonet.eld: New file.
2022-06-30 15:17:47 -07:00

226 lines
8.7 KiB
EmacsLisp

;;; erc-scenarios-base-reconnect.el --- Base-reconnect scenarios -*- lexical-binding: t -*-
;; Copyright (C) 2022 Free Software Foundation, Inc.
;;
;; This file is part of GNU Emacs.
;;
;; This program 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.
;;
;; This program 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 this program. If not, see
;; <https://www.gnu.org/licenses/>.
(require 'ert-x)
(eval-and-compile
(let ((load-path (cons (ert-resource-directory) load-path)))
(require 'erc-scenarios-common)))
(eval-when-compile (require 'erc-join))
;; This ensures we only reconnect `erc-server-reconnect-attempts'
;; (rather than infinitely many) times, which can easily happen when
;; tweaking code related to process sentinels in erc-backend.el.
(ert-deftest erc-scenarios-base-reconnect-timer ()
:tags '(:expensive-test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "base/reconnect")
(dumb-server (erc-d-run "localhost" t 'timer 'timer 'timer-last))
(port (process-contact dumb-server :service))
(expect (erc-d-t-make-expecter))
(erc-server-auto-reconnect t)
erc-autojoin-channels-alist
erc-server-buffer)
(ert-info ("Connect to foonet")
(setq erc-server-buffer (erc :server "127.0.0.1"
:port port
:nick "tester"
:password "changeme"
:full-name "tester"))
(with-current-buffer erc-server-buffer
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))))
(ert-info ("Server tries to connect thrice (including initial attempt)")
(with-current-buffer erc-server-buffer
(dotimes (n 3)
(ert-info ((format "Attempt %d" n))
(funcall expect 3 "Opening connection")
(funcall expect 2 "Password incorrect")
(funcall expect 2 "Connection failed!")
(funcall expect 2 "Re-establishing connection")))
(ert-info ("Prev attempt was final")
(erc-d-t-absent-for 1 "Opening connection" (point)))))
(ert-info ("Server buffer is unique and temp name is absent")
(should (equal (list (get-buffer (format "127.0.0.1:%d" port)))
(erc-scenarios-common-buflist "127.0.0.1"))))))
(defun erc-scenarios-common--base-reconnect-options (test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "base/reconnect")
(dumb-server (erc-d-run "localhost" t 'options 'options-again))
(port (process-contact dumb-server :service))
(expect (erc-d-t-make-expecter))
(erc-server-flood-penalty 0.1)
(erc-server-auto-reconnect t)
erc-autojoin-channels-alist
erc-server-buffer)
(should (memq 'autojoin erc-modules))
(ert-info ("Connect to foonet")
(setq erc-server-buffer (erc :server "127.0.0.1"
:port port
:nick "tester"
:password "changeme"
:full-name "tester"))
(with-current-buffer erc-server-buffer
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))
(funcall expect 10 "debug mode")))
(ert-info ("Wait for some output in channels")
(with-current-buffer (erc-d-t-wait-for 10 (get-buffer "#chan"))
(funcall expect 10 "welcome")))
(ert-info ("Server buffer shows connection failed")
(with-current-buffer erc-server-buffer
(funcall expect 10 "Connection failed! Re-establishing")))
(should (equal erc-autojoin-channels-alist '((FooNet "#chan"))))
(funcall test)
(with-current-buffer "FooNet" (erc-cmd-JOIN "#spam"))
(erc-d-t-wait-for 5 "Channel #spam shown when autojoined"
(eq (window-buffer) (get-buffer "#spam")))
(ert-info ("Wait for auto reconnect")
(with-current-buffer erc-server-buffer
(funcall expect 10 "still in debug mode")))
(ert-info ("Wait for activity to recommence in channels")
(with-current-buffer (erc-d-t-wait-for 10 (get-buffer "#chan"))
(funcall expect 10 "forest of Arden"))
(with-current-buffer (erc-d-t-wait-for 10 (get-buffer "#spam"))
(funcall expect 10 "her elves come here anon")))))
(ert-deftest erc-scenarios-base-reconnect-options--default ()
:tags '(:expensive-test)
(should (eq erc-join-buffer 'buffer))
(should-not erc-reconnect-display)
;; FooNet (the server buffer) is not switched to because it's
;; already current (but not shown) when `erc-open' is called. See
;; related conditional guard towards the end of that function.
(erc-scenarios-common--base-reconnect-options
(lambda ()
(pop-to-buffer-same-window "*Messages*")
(erc-d-t-ensure-for 1 "Server buffer not shown"
(not (eq (window-buffer) (get-buffer "FooNet"))))
(erc-d-t-wait-for 5 "Channel #chan shown when autojoined"
(eq (window-buffer) (get-buffer "#chan"))))))
(ert-deftest erc-scenarios-base-reconnect-options--bury ()
:tags '(:expensive-test)
(should (eq erc-join-buffer 'buffer))
(should-not erc-reconnect-display)
(let ((erc-reconnect-display 'bury))
(erc-scenarios-common--base-reconnect-options
(lambda ()
(pop-to-buffer-same-window "*Messages*")
(erc-d-t-ensure-for 1 "Server buffer not shown"
(not (eq (window-buffer) (get-buffer "FooNet"))))
(erc-d-t-ensure-for 3 "Channel #chan not shown"
(not (eq (window-buffer) (get-buffer "#chan"))))
(eq (window-buffer) (messages-buffer))))))
;; Upon reconnecting, playback for channel and target buffers is
;; routed correctly. Autojoin is irrelevant here, but for the
;; skeptical, see `erc-scenarios-common--join-network-id', which
;; overlaps with this and includes spurious JOINs ignored by the
;; server.
(ert-deftest erc-scenarios-base-association-reconnect-playback ()
:tags '(:expensive-test)
(erc-scenarios-common-with-cleanup
((erc-scenarios-common-dialog "base/assoc/reconplay")
(erc-server-flood-penalty 0.1)
(erc-server-flood-margin 30)
(dumb-server (erc-d-run "localhost" t 'foonet 'again))
(port (process-contact dumb-server :service))
(expect (erc-d-t-make-expecter))
erc-autojoin-channels-alist
erc-server-buffer-foo)
(ert-info ("Connect to foonet")
(setq erc-server-buffer-foo (erc :server "127.0.0.1"
:port port
:nick "tester"
:password "changeme"
:full-name "tester"))
(with-current-buffer erc-server-buffer-foo
(should (string= (buffer-name) (format "127.0.0.1:%d" port)))))
(ert-info ("Setup")
(ert-info ("Server buffer is unique and temp name is absent")
(erc-d-t-wait-for 3 (get-buffer "foonet"))
(should-not (erc-scenarios-common-buflist "127.0.0.1")))
(ert-info ("Channel buffer #chan playback received")
(with-current-buffer (erc-d-t-wait-for 8 (get-buffer "#chan"))
(funcall expect 10 "But purgatory")))
(ert-info ("Ask for help from services or bouncer bot")
(with-current-buffer erc-server-buffer-foo
(erc-cmd-MSG "*status help")))
(ert-info ("Help received")
(with-current-buffer (erc-d-t-wait-for 5 (get-buffer "*status"))
(funcall expect 10 "Rehash")))
(ert-info ("#chan convo done")
(with-current-buffer "#chan"
(funcall expect 10 "most egregious indignity"))))
;; KLUDGE (see note above test)
(should erc-autojoin-channels-alist)
(setq erc-autojoin-channels-alist nil)
(with-current-buffer erc-server-buffer-foo
(erc-cmd-QUIT "")
(erc-d-t-wait-for 4 (not (erc-server-process-alive)))
(erc-cmd-RECONNECT))
(ert-info ("Channel buffer found and associated")
(with-current-buffer "#chan"
(funcall expect 10 "Wilt thou rest damned")))
(ert-info ("Help buffer found and associated")
(with-current-buffer "*status"
(erc-scenarios-common-say "help")
(funcall expect 10 "Restart ZNC")))
(ert-info ("#chan convo done")
(with-current-buffer "#chan"
(funcall expect 10 "here comes the lady")))))
;;; erc-scenarios-base-reconnect.el ends here