diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2026-05-18 22:16:46 +0100 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2026-05-18 22:16:46 +0100 |
| commit | 641754e8704bb73858657f960f8802f8ee4230fe (patch) | |
| tree | c9d62e714b946119130d0a0b6c65da870cf39faa /test | |
| parent | d4cb550dba6c01223167ca71b02698f452f3d141 (diff) | |
| parent | 28a13b01c7d7ccfd50e02cb34f5d119b28173df9 (diff) | |
Merge from origin/emacs-31
28a13b01c7d vc-refresh-state: Override default-directory for backend ...
389874c533b Eglot: unbreak for treesit-less builds
10e91e096d8 Get selected item in newsticker list view
6bd73af2413 ; * test/lisp/jsonrpc-tests.el: Adjust timeouts for CI EM...
eb90c528f38 ; * lisp/progmodes/eglot.el (eglot-code-action-indication...
1d7d6ffedbc ; * etc/PROBLEMS: Fix entries about display of Emoji on T...
6c1829bf4c5 Eglot: fix thinko in recent markdown-related commit (bug#...
36036e71c0c Jsonrpc: migrate more tests to Python subprocess fixtures
0977d5915d1 Eglot: add left-fringe code action indicator (bug#80326)
b7825c3a271 Fix auth-source-backends-parse
d89054627c4 Fix updates of embedded formulas by 'calc-embedded-update...
1832a93547b ; * src/fns.c (Fequal): Doc fix.
f68e7a0a411 ; Improve documentation of commands that move by compilat...
Diffstat (limited to 'test')
| -rw-r--r-- | test/lisp/jsonrpc-resources/common.py | 9 | ||||
| -rwxr-xr-x | test/lisp/jsonrpc-resources/server-anxious-nested.py | 6 | ||||
| -rw-r--r-- | test/lisp/jsonrpc-resources/server-emacsrpc.py | 54 | ||||
| -rwxr-xr-x | test/lisp/jsonrpc-resources/server-harakiri.py | 6 | ||||
| -rwxr-xr-x | test/lisp/jsonrpc-resources/server-remote-during-sync-1.py | 6 | ||||
| -rwxr-xr-x | test/lisp/jsonrpc-resources/server-remote-during-sync-2.py | 6 | ||||
| -rwxr-xr-x | test/lisp/jsonrpc-resources/server-remote-error.py | 6 | ||||
| -rw-r--r-- | test/lisp/jsonrpc-tests.el | 241 |
8 files changed, 153 insertions, 181 deletions
diff --git a/test/lisp/jsonrpc-resources/common.py b/test/lisp/jsonrpc-resources/common.py index 6bcc1db8bba..7b103aba0c3 100644 --- a/test/lisp/jsonrpc-resources/common.py +++ b/test/lisp/jsonrpc-resources/common.py @@ -30,3 +30,12 @@ def write_msg(msg): def log(text): """Write a log line to stderr.""" print(f'[test-server] {text}', file=sys.stderr, flush=True) + +def harakiri(msg): + """Maybe handle harakiri request/notif in msg.""" + if msg.get('method') == 'harakiri': + log('-> very clean harakiri') + if (mid := msg.get('id')) is not None: + write_msg({'jsonrpc': '2.0', 'id': mid, 'result': True}) + return True + return False diff --git a/test/lisp/jsonrpc-resources/server-anxious-nested.py b/test/lisp/jsonrpc-resources/server-anxious-nested.py index 8169b0936d1..970196e619c 100755 --- a/test/lisp/jsonrpc-resources/server-anxious-nested.py +++ b/test/lisp/jsonrpc-resources/server-anxious-nested.py @@ -15,7 +15,7 @@ LR2 should complete first, then RR1, then LR1. import os import sys sys.path.insert(0, os.path.dirname(__file__)) -from common import read_msg, write_msg, log +from common import read_msg, write_msg, log, harakiri def main(): @@ -26,9 +26,7 @@ def main(): mid = lr1.get('id') method = lr1.get('method') log(f'<- {method or "(response)"} id={mid}') - if method == 'harakiri': - log('-> very clean harakiri') - break + if harakiri(lr1): break elif method == 'LR1': # Send RR1, then immediately respond to LR1 without awaiting # anything. The response-to-LR1 will be queued as anxious on the diff --git a/test/lisp/jsonrpc-resources/server-emacsrpc.py b/test/lisp/jsonrpc-resources/server-emacsrpc.py new file mode 100644 index 00000000000..22923f5b5f2 --- /dev/null +++ b/test/lisp/jsonrpc-resources/server-emacsrpc.py @@ -0,0 +1,54 @@ +#!/usr/bin/env python3 +"""General-purpose JSONRPC server for jsonrpc.el tests. + +Handles arithmetic (+ - * /), sit-for, vconcat, append, and ignore, +mirroring the methods the in-process Emacs RPC server supports. +""" +import functools +import operator +import os +import sys +import time + +sys.path.insert(0, os.path.dirname(__file__)) +from common import log, read_msg, write_msg, harakiri + +HANDLERS = { + '+': lambda p: sum(p), + '-': lambda p: functools.reduce(operator.sub, p), + '*': lambda p: functools.reduce(operator.mul, p), + '/': lambda p: functools.reduce(operator.truediv, p), + 'vconcat': lambda p: sum(p, []), + 'append': lambda p: sum(p, []), + 'sit-for': lambda p: time.sleep(p[0]), + 'ignore': lambda _: None, +} + + +def main(): + while True: + msg = read_msg() + if msg is None: + break + mid = msg.get('id') + method = msg.get('method') + log(f'<- {method or "(response)"} id={mid}') + if harakiri(msg): break + if method is None or mid is None: + continue + handler = HANDLERS.get(method) + if handler is None: + write_msg({'jsonrpc': '2.0', 'id': mid, + 'error': {'code': -32601, 'message': 'Method not found'}}) + else: + try: + result = handler(msg.get('params', [])) + write_msg({'jsonrpc': '2.0', 'id': mid, 'result': result}) + log(f'-> (response {method}) id={mid}') + except Exception as exc: + write_msg({'jsonrpc': '2.0', 'id': mid, + 'error': {'code': -32603, 'message': str(exc)}}) + + +if __name__ == '__main__': + main() diff --git a/test/lisp/jsonrpc-resources/server-harakiri.py b/test/lisp/jsonrpc-resources/server-harakiri.py index c20a3fbdaee..ee7eae54073 100755 --- a/test/lisp/jsonrpc-resources/server-harakiri.py +++ b/test/lisp/jsonrpc-resources/server-harakiri.py @@ -5,7 +5,7 @@ Waits for a 'harakiri' notification and then exits cleanly. """ import os, sys sys.path.insert(0, os.path.dirname(__file__)) -from common import read_msg, log +from common import read_msg, log, harakiri def main(): @@ -15,9 +15,7 @@ def main(): break method = msg.get('method') log(f'<- {method or "(response)"} id={msg.get("id")}') - if method == 'harakiri': - log('-> very clean harakiri') - break + if harakiri(msg): break if __name__ == '__main__': diff --git a/test/lisp/jsonrpc-resources/server-remote-during-sync-1.py b/test/lisp/jsonrpc-resources/server-remote-during-sync-1.py index b8cb549bbd5..d9d116e256e 100755 --- a/test/lisp/jsonrpc-resources/server-remote-during-sync-1.py +++ b/test/lisp/jsonrpc-resources/server-remote-during-sync-1.py @@ -11,7 +11,7 @@ Choreography (tests bug#80623): import os import sys sys.path.insert(0, os.path.dirname(__file__)) -from common import read_msg, write_msg, log +from common import read_msg, write_msg, log, harakiri def main(): @@ -22,9 +22,7 @@ def main(): mid = msg.get('id') method = msg.get('method') log(f'<- {method or "(response)"} id={mid}') - if method == 'harakiri': - log('-> very clean harakiri') - break + if harakiri(msg): break elif method == 'LR1': # Send RR1 request write_msg({'jsonrpc': '2.0', 'id': 1000, diff --git a/test/lisp/jsonrpc-resources/server-remote-during-sync-2.py b/test/lisp/jsonrpc-resources/server-remote-during-sync-2.py index e6250a0553b..77e9a3eb005 100755 --- a/test/lisp/jsonrpc-resources/server-remote-during-sync-2.py +++ b/test/lisp/jsonrpc-resources/server-remote-during-sync-2.py @@ -11,7 +11,7 @@ Choreography (tests bug#80623): import os import sys sys.path.insert(0, os.path.dirname(__file__)) -from common import read_msg, write_msg, log +from common import read_msg, write_msg, log, harakiri def main(): @@ -22,9 +22,7 @@ def main(): mid = msg.get('id') method = msg.get('method') log(f'<- {method or "(response)"} id={mid}') - if method == 'harakiri': - log('-> very clean harakiri') - break + if harakiri(msg): break elif method == 'LR1': # Send RR1 request write_msg({'jsonrpc': '2.0', 'id': 1000, diff --git a/test/lisp/jsonrpc-resources/server-remote-error.py b/test/lisp/jsonrpc-resources/server-remote-error.py index 00c907e189b..ea1dfdc7e96 100755 --- a/test/lisp/jsonrpc-resources/server-remote-error.py +++ b/test/lisp/jsonrpc-resources/server-remote-error.py @@ -13,7 +13,7 @@ anxious continuation for LR1 must still fire and resolve to "ok". """ import os, sys sys.path.insert(0, os.path.dirname(__file__)) -from common import read_msg, write_msg, log +from common import read_msg, write_msg, log, harakiri def main(): @@ -24,9 +24,7 @@ def main(): mid = msg.get('id') method = msg.get('method') log(f'<- {method or "(response)"} id={mid}') - if method == 'harakiri': - log('-> very clean harakiri') - break + if harakiri(msg): break elif method == 'LR1': # Send badMethod BEFORE responding to LR1; the client # rdispatcher will signal a jsonrpc-error for it. diff --git a/test/lisp/jsonrpc-tests.el b/test/lisp/jsonrpc-tests.el index cdb4e04fc39..28f7740ab32 100644 --- a/test/lisp/jsonrpc-tests.el +++ b/test/lisp/jsonrpc-tests.el @@ -41,102 +41,74 @@ (defclass jsonrpc--test-client (jsonrpc--test-endpoint) ((hold-deferred :initform t :accessor jsonrpc--hold-deferred))) -(defun jsonrpc--call-with-emacsrpc-fixture (fn) - "Do work for `jsonrpc--with-emacsrpc-fixture'. Call FN." - (let* (listen-server endpoint) - (unwind-protect - (progn - (setq listen-server - (make-network-process - :name "Emacs RPC server" :server t :host "localhost" - :service (if (version<= emacs-version "26.1") - 44444 - ;; 26.1 can automatically find ports if - ;; one passes 0 here. - 0) - :log (lambda (listen-server client _message) - (push - (make-instance - 'jsonrpc--test-endpoint - :name (process-name client) - :process client - :request-dispatcher - (lambda (_endpoint method params) - (unless (memq method '(+ - * / vconcat append - sit-for ignore)) - (signal 'jsonrpc-error - '((jsonrpc-error-message - . "Sorry, this isn't allowed") - (jsonrpc-error-code . -32601)))) - (apply method (append params nil))) - :on-shutdown - (lambda (conn) - (setf (jsonrpc--shutdown-complete-p conn) t))) - (process-get listen-server 'handlers))))) - (setq endpoint - (make-instance - 'jsonrpc--test-client - :process - (open-network-stream "JSONRPC test tcp endpoint" - nil "localhost" - (process-contact listen-server - :service)) - :on-shutdown - (lambda (conn) - (setf (jsonrpc--shutdown-complete-p conn) t)))) - (funcall fn endpoint)) - (unwind-protect - (when endpoint - (kill-buffer (jsonrpc--events-buffer endpoint)) - (jsonrpc-shutdown endpoint)) - (when listen-server - (cl-loop do (delete-process listen-server) - while (progn (accept-process-output nil 0.1) - (process-live-p listen-server)) - do (jsonrpc--message - "test listen-server is still running, waiting")) - (cl-loop for handler in (process-get listen-server 'handlers) - do (ignore-errors (jsonrpc-shutdown handler))) - (mapc #'kill-buffer - (mapcar #'jsonrpc--events-buffer - (process-get listen-server 'handlers)))))))) -(cl-defmacro jsonrpc--with-emacsrpc-fixture ((endpoint-sym) &body body) +;;; Tests using Python subprocesses +;;; + +(defconst jsonrpc--test-dir + (file-name-directory (or load-file-name buffer-file-name)) + "Directory of this test file, captured at load time.") + +(cl-defmacro jsonrpc--with-python-fixture ((script conn &rest initargs) &body body) + "Start SCRIPT under python3 as a pipe subprocess, bind connection to CONN. +SCRIPT is a path relative to this file's directory. +INITARGS are passed to `make-instance' for `jsonrpc--test-client'." (declare (indent 1)) - `(jsonrpc--call-with-emacsrpc-fixture (lambda (,endpoint-sym) ,@body))) + `(let ((,conn nil)) + (skip-unless (executable-find "python3")) + (unwind-protect + (progn + (setq ,conn + (make-instance + 'jsonrpc--test-client + :name "jsonrpc-python-test" + :process (make-process + :name "jsonrpc-python-test" + :command (list "python3" + (expand-file-name + ,script + jsonrpc--test-dir)) + :connection-type 'pipe + :noquery t) + ,@initargs)) + (with-timeout (5 + (when ,conn + (let ((buf (jsonrpc--events-buffer ,conn))) + (when (buffer-live-p buf) + (if noninteractive + (progn + (message "contents of `%s':" (buffer-name buf)) + (princ (with-current-buffer buf (buffer-string)) + #'external-debugging-output)) + (message "Preserved for inspection: %s" + (buffer-name buf)))))) + (ert-fail "Test timed out after 5s")) + ,@body)) + (when ,conn + (ignore-errors + (jsonrpc-request ,conn 'harakiri nil :timeout 1) + (accept-process-output nil 0.1) + (kill-buffer (jsonrpc--events-buffer ,conn)) + (jsonrpc-shutdown ,conn)))))) + +(cl-defmethod jsonrpc-connection-ready-p + ((conn jsonrpc--test-client) what) + (and (cl-call-next-method) + (or (not (string-match "deferred" what)) + (not (jsonrpc--hold-deferred conn))))) (ert-deftest returns-3 () "A basic test for adding two numbers in our test RPC." (skip-when (eq system-type 'windows-nt)) - (jsonrpc--with-emacsrpc-fixture (conn) + (jsonrpc--with-python-fixture + ("jsonrpc-resources/server-emacsrpc.py" conn) (should (= 3 (jsonrpc-request conn '+ [1 2]))))) -(ert-deftest errors-with--32601 () - "Errors with -32601" - (skip-when (eq system-type 'windows-nt)) - (jsonrpc--with-emacsrpc-fixture (conn) - (condition-case err - (progn - (jsonrpc-request conn 'delete-directory "~/tmp") - (ert-fail "A `jsonrpc-error' should have been signaled!")) - (jsonrpc-error - (should (= -32601 (cdr (assoc 'jsonrpc-error-code (cdr err))))))))) - -(ert-deftest signals-an--32603-JSONRPC-error () - "Signals an -32603 JSONRPC error." - (skip-when (eq system-type 'windows-nt)) - (jsonrpc--with-emacsrpc-fixture (conn) - (condition-case err - (let ((jsonrpc-inhibit-debug-on-error t)) - (jsonrpc-request conn '+ ["a" 2]) - (ert-fail "A `jsonrpc-error' should have been signaled!")) - (jsonrpc-error - (should (= -32603 (cdr (assoc 'jsonrpc-error-code (cdr err))))))))) - (ert-deftest times-out () "Request for 3-sec sit-for with 1-sec timeout times out." (skip-when (eq system-type 'windows-nt)) - (jsonrpc--with-emacsrpc-fixture (conn) + (jsonrpc--with-python-fixture + ("jsonrpc-resources/server-emacsrpc.py" conn) (should-error (jsonrpc-request conn 'sit-for [3] :timeout 1)))) @@ -144,30 +116,27 @@ :tags '(:expensive-test) "Request for 1-sec sit-for with 2-sec timeout succeeds." (skip-when (eq system-type 'windows-nt)) - (jsonrpc--with-emacsrpc-fixture (conn) + (jsonrpc--with-python-fixture + ("jsonrpc-resources/server-emacsrpc.py" conn) (jsonrpc-request conn 'sit-for [1] :timeout 2))) (ert-deftest stretching-it-but-works () "Vector of numbers or vector of vector of numbers are serialized." (skip-when (eq system-type 'windows-nt)) - (jsonrpc--with-emacsrpc-fixture (conn) + (jsonrpc--with-python-fixture + ("jsonrpc-resources/server-emacsrpc.py" conn) ;; (vconcat [1 2 3] [3 4 5]) => [1 2 3 3 4 5] which can be ;; serialized. (should (equal [1 2 3 3 4 5] (jsonrpc-request conn 'vconcat [[1 2 3] [3 4 5]]))))) -(cl-defmethod jsonrpc-connection-ready-p - ((conn jsonrpc--test-client) what) - (and (cl-call-next-method) - (or (not (string-match "deferred" what)) - (not (jsonrpc--hold-deferred conn))))) - (ert-deftest deferred-action-toolate () :tags '(:expensive-test) "Deferred request fails because no one clears the flag." (skip-when (eq system-type 'windows-nt)) - (jsonrpc--with-emacsrpc-fixture (conn) + (jsonrpc--with-python-fixture + ("jsonrpc-resources/server-emacsrpc.py" conn) (should-error (jsonrpc-request conn '+ [1 2] :deferred "deferred-testing" :timeout 0.5) @@ -182,7 +151,8 @@ (skip-when (eq system-type 'windows-nt)) ;; Send an async request, which returns immediately. However the ;; success fun which sets the flag only runs after some time. - (jsonrpc--with-emacsrpc-fixture (conn) + (jsonrpc--with-python-fixture + ("jsonrpc-resources/server-emacsrpc.py" conn) (jsonrpc-async-request conn 'sit-for [0.5] :success-fn @@ -199,32 +169,34 @@ :tags '(:expensive-test) "Test a more complex situation with deferred requests." (skip-when (eq system-type 'windows-nt)) - (jsonrpc--with-emacsrpc-fixture (conn) + (jsonrpc--with-python-fixture + ("jsonrpc-resources/server-emacsrpc.py" conn) (let (n-deferred-1 n-deferred-2 second-deferred-went-through-p) ;; This returns immediately (jsonrpc-async-request conn - 'sit-for [0.1] + 'sit-for [0.01] :success-fn (lambda (_result) ;; this only gets runs after the "first deferred" is stashed. (setq n-deferred-1 (hash-table-count (jsonrpc--deferred-actions conn))))) (should-error - ;; This stashes the request and waits. It will error because - ;; no-one clears the "hold deferred" flag. + ;; This stashes the request and waits. It will error with a + ;; timeout after blocking for 1 sec because no-one clears the + ;; "hold deferred" flag. (jsonrpc-request conn 'ignore ["first deferred"] :deferred "first deferred" - :timeout 0.5) + :timeout 1.0) :type 'jsonrpc-error) ;; The error means the deferred actions stash is now empty (should (zerop (hash-table-count (jsonrpc--deferred-actions conn)))) ;; Again, this returns immediately. (jsonrpc-async-request conn - 'sit-for [0.1] + 'sit-for [0.01] :success-fn (lambda (_result) ;; This gets run while "third deferred" below is waiting for @@ -252,60 +224,11 @@ (should (eq 2 n-deferred-2)) (should (eq 0 (hash-table-count (jsonrpc--deferred-actions conn))))))) - -;;; Tests using Python subprocesses (scontrol / anxious mechanism) -;;; - -(defconst jsonrpc--test-dir - (file-name-directory (or load-file-name buffer-file-name)) - "Directory of this test file, captured at load time.") - -(cl-defmacro jsonrpc--with-python-fixture ((script conn &rest initargs) &body body) - "Start SCRIPT under python3 as a pipe subprocess, bind connection to CONN. -SCRIPT is a path relative to this file's directory. -INITARGS are passed to `make-instance' for `jsonrpc-process-connection'." - (declare (indent 1)) - `(let ((,conn nil)) - (unwind-protect - (progn - (setq ,conn - (make-instance - 'jsonrpc-process-connection - :name "jsonrpc-python-test" - :process (make-process - :name "jsonrpc-python-test" - :command (list "python3" - (expand-file-name - ,script - jsonrpc--test-dir)) - :connection-type 'pipe - :noquery t) - ,@initargs)) - (with-timeout (5 - (when ,conn - (let ((buf (jsonrpc--events-buffer ,conn))) - (when (buffer-live-p buf) - (if noninteractive - (progn - (message "contents of `%s':" (buffer-name buf)) - (princ (with-current-buffer buf (buffer-string)) - #'external-debugging-output)) - (message "Preserved for inspection: %s" - (buffer-name buf)))))) - (ert-fail "Test timed out after 5s")) - ,@body)) - (when ,conn - (ignore-errors - (jsonrpc-notify ,conn 'harakiri nil) - (kill-buffer (jsonrpc--events-buffer ,conn)) - (jsonrpc-shutdown ,conn)))))) - (ert-deftest scontrol-remote-during-sync-1 () "Anxious local continuations. Endpoint sends a remote request RR1 on LR1, then replies to LR1 immediately before waiting for RR1 to resolve. This is what JETLS does (bug#80623)." - (skip-unless (executable-find "python3")) (skip-when (eq system-type 'windows-nt)) (jsonrpc--with-python-fixture ("jsonrpc-resources/server-remote-during-sync-1.py" conn @@ -322,7 +245,6 @@ Exactly the same test as 2, but different endpoint, which now still sends RR1 on LR1 but now waits for RR1 to resolve before replying to LR1. This is what GoPls does (bug#80623)." - (skip-unless (executable-find "python3")) (skip-when (eq system-type 'windows-nt)) (jsonrpc--with-python-fixture ("jsonrpc-resources/server-remote-during-sync-2.py" conn @@ -337,7 +259,6 @@ This is what GoPls does (bug#80623)." "Nested anxious continuations Two local sync requests LR1 and LR2 with a remote RR1 in between. Vaguely similar to Julia's JETLS (bug#80623), but more complex." - (skip-unless (executable-find "python3")) (skip-when (eq system-type 'windows-nt)) (let (lr2-result completed) (jsonrpc--with-python-fixture @@ -349,7 +270,8 @@ Vaguely similar to Julia's JETLS (bug#80623), but more complex." (setq lr2-result (jsonrpc-request conn 'LR2 [] :timeout 5)) (push "lr2" completed) - (push "rr1" completed)) + (push "rr1" completed) + "rr1-ok") (_ (error "unexpected method: %s" method))))) (should (equal "lr1-ok" (jsonrpc-request conn 'LR1 [] :timeout 5))) (push "lr1" completed) @@ -358,7 +280,6 @@ Vaguely similar to Julia's JETLS (bug#80623), but more complex." (ert-deftest scontrol-remote-error () "Anxious continuation even when rdispatcher signals errors." - (skip-unless (executable-find "python3")) (skip-when (eq system-type 'windows-nt)) (jsonrpc--with-python-fixture ("jsonrpc-resources/server-remote-error.py" conn @@ -372,10 +293,9 @@ Vaguely similar to Julia's JETLS (bug#80623), but more complex." (_ (error "unexpected method: %s" method))))) (should (equal "ok" (jsonrpc-request conn 'LR1 [] :timeout 5))))) -(ert-deftest shutdown-clean-after-notification () - "Server exits cleanly after harakiri notification. +(ert-deftest shutdown-clean-after-request () + "Server exits cleanly after harakiri request. `jsonrpc-shutdown' should not emit a \"Sentinel hasn't run\" warning." - (skip-unless (executable-find "python3")) (skip-when (eq system-type 'windows-nt)) (let (warned) (cl-letf (((symbol-function 'jsonrpc--warn) @@ -383,10 +303,9 @@ Vaguely similar to Julia's JETLS (bug#80623), but more complex." (setq warned (apply #'format fmt args))))) (jsonrpc--with-python-fixture ("jsonrpc-resources/server-harakiri.py" conn) - (jsonrpc-notify conn 'harakiri nil) - ;; Give the server time to exit before shutdown checks the sentinel. - (accept-process-output nil 0.3) - (jsonrpc-shutdown conn))) + (jsonrpc-request conn 'harakiri nil :timeout 3) + (jsonrpc-shutdown conn) + (setq conn nil))) (should-not warned))) (provide 'jsonrpc-tests) |
