-
Notifications
You must be signed in to change notification settings - Fork 202
/
Copy patheglot-tests.el
1500 lines (1394 loc) · 65.6 KB
/
eglot-tests.el
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; eglot-tests.el --- Tests for eglot.el -*- lexical-binding: t; -*-
;; Copyright (C) 2018-2025 Free Software Foundation, Inc.
;; Author: João Távora <[email protected]>
;; Keywords: tests
;; 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 lisp/progmodes/eglot.el
;;
;; Many of these tests rely on the availability of third-party LSP
;; servers. They are automatically skipped if the program is not
;; available.
;;
;; Some of these tests rely on the GNU ELPA package company.el and
;; yasnippet.el being available.
;; Some of the tests require access to a remote host files, which is
;; mocked in the simplest case. If you want to test a real Tramp
;; connection, override $REMOTE_TEMPORARY_FILE_DIRECTORY to a suitable
;; value (FIXME: like what?) in order to overwrite the default value.
;;
;; IMPORTANT: Since Eglot is a :core ELPA package, these tests are
;; supposed to run on Emacsen down to 26.3. Do not use bleeding-edge
;; functionality not compatible with that Emacs version.
;;; Code:
(require 'eglot)
(require 'cl-lib)
(require 'ert)
(require 'tramp)
(require 'ert-x) ; ert-simulate-command
(require 'edebug)
(require 'cc-mode) ; c-mode-hook
(require 'company nil t)
(require 'yasnippet nil t)
(require 'subr-x)
(require 'flymake) ; project-diagnostics
;;; Helpers
(defun eglot--test-message (format &rest args)
"Message out with FORMAT with ARGS."
(message "[eglot-tests] %s"
(apply #'format format args)))
(defmacro eglot--with-fixture (fixture &rest body)
"Set up FIXTURE, call BODY, tear down FIXTURE.
FIXTURE is a list. Its elements are of the form (FILE . CONTENT)
to create a readable FILE with CONTENT. FILE may be a directory
name and CONTENT another (FILE . CONTENT) list to specify a
directory hierarchy."
(declare (indent 1) (debug t))
`(eglot--call-with-fixture ,fixture (lambda () ,@body)))
(defun eglot--make-file-or-dir (ass)
(let ((file-or-dir-name (expand-file-name (car ass)))
(content (cdr ass)))
(cond ((listp content)
(make-directory file-or-dir-name 'parents)
(let ((default-directory (file-name-as-directory file-or-dir-name)))
(mapcan #'eglot--make-file-or-dir content)))
((stringp content)
(with-temp-file file-or-dir-name
(insert content))
(list file-or-dir-name))
(t
(eglot--error "Expected a string or a directory spec")))))
(defun eglot--call-with-fixture (fixture fn)
"Helper for `eglot--with-fixture'. Run FN under FIXTURE."
(let* ((fixture-directory (make-nearby-temp-file "eglot--fixture-" t))
(default-directory (file-name-as-directory fixture-directory))
created-files
new-servers
test-body-successful-p)
(eglot--test-message "[%s]: test start" (ert-test-name (ert-running-test)))
(unwind-protect
(let ((process-environment
`(;; Set XDG_CONFIG_HOME to /dev/null to prevent
;; user-configuration influencing language servers
;; (see github#441).
,(format "XDG_CONFIG_HOME=%s" null-device)
;; ... on the flip-side, a similar technique in
;; Emacs's `test/Makefile' spoofs HOME as
;; /nonexistent (and as `temporary-file-directory' in
;; `ert-remote-temporary-file-directory').
;; This breaks some common installations for LSP
;; servers like rust-analyzer, making these tests
;; mostly useless, so we hack around it here with a
;; great big hack.
,(format "HOME=%s"
(expand-file-name (format "~%s" (user-login-name))))
,@process-environment))
(eglot-server-initialized-hook
(lambda (server) (push server new-servers))))
(setq created-files (mapcan #'eglot--make-file-or-dir fixture))
(prog1 (funcall fn)
(setq test-body-successful-p t)))
(eglot--test-message "[%s]: %s" (ert-test-name (ert-running-test))
(if test-body-successful-p "OK" "FAILED"))
(unwind-protect
(let ((eglot-autoreconnect nil))
(dolist (server new-servers)
(when (jsonrpc-running-p server)
(condition-case oops
(eglot-shutdown
server nil 3 (not test-body-successful-p))
(error
(eglot--test-message "Non-critical cleanup error: %S" oops))))
(when (not test-body-successful-p)
;; We want to do this after the sockets have
;; shut down such that any pending data has been
;; consumed and is available in the process
;; buffers.
(let ((buffers (delq nil (list
;; FIXME: Accessing "internal" symbol here.
(process-buffer (jsonrpc--process server))
(jsonrpc-stderr-buffer server)
(jsonrpc-events-buffer server)))))
(cond (noninteractive
(dolist (buffer buffers)
(eglot--test-message "contents of `%s' %S:" (buffer-name buffer) buffer)
(if (buffer-live-p buffer)
(princ (with-current-buffer buffer (buffer-string))
'external-debugging-output)
(princ "Killed\n" #'external-debugging-output))))
(t
(eglot--test-message "Preserved for inspection: %s"
(mapconcat #'buffer-name buffers ", "))))))))
(eglot--cleanup-after-test fixture-directory created-files)))))
(defun eglot--cleanup-after-test (fixture-directory created-files)
(let ((buffers-to-delete
(delq nil (mapcar #'find-buffer-visiting created-files))))
(eglot--test-message "Killing %s, wiping %s"
buffers-to-delete
fixture-directory)
(dolist (buf buffers-to-delete) ;; Have to save otherwise will get prompted.
(with-current-buffer buf (save-buffer) (kill-buffer)))
(delete-directory fixture-directory 'recursive)
;; Delete Tramp buffers if needed.
(when (file-remote-p temporary-file-directory)
(tramp-cleanup-connection
(tramp-dissect-file-name temporary-file-directory) nil 'keep-password))))
(cl-defmacro eglot--with-timeout (timeout &body body)
(declare (indent 1) (debug t))
`(eglot--call-with-timeout ,timeout (lambda () ,@body)))
(defun eglot--call-with-timeout (timeout fn)
(let* ((tag (gensym "eglot-test-timeout"))
(timed-out (make-symbol "timeout"))
(timeout-and-message
(if (listp timeout) timeout
(list timeout "waiting for test to finish")))
(timeout (car timeout-and-message))
(message (cadr timeout-and-message))
(timer)
(retval))
(unwind-protect
(setq retval
(catch tag
(setq timer
(run-with-timer timeout nil
(lambda ()
(unless edebug-active
(throw tag timed-out)))))
(funcall fn)))
(cancel-timer timer)
(when (eq retval timed-out)
(error "%s" (concat "Timed out " message))))))
(defun eglot--find-file-noselect (file &optional noerror)
(unless (or noerror
(file-readable-p file)) (error "%s does not exist" file))
(find-file-noselect file))
(cl-defmacro eglot--sniffing ((&key server-requests
server-notifications
server-replies
client-requests
client-notifications
client-replies)
&rest body)
"Run BODY saving LSP JSON messages in variables, most recent first."
(declare (indent 1) (debug (sexp &rest form)))
(let ((log-event-hook-sym (make-symbol "eglot--event-sniff")))
`(let* (,@(delq nil (list server-requests
server-notifications
server-replies
client-requests
client-notifications
client-replies)))
(cl-flet ((,log-event-hook-sym (_connection
origin
&key _json kind message _foreign-message
&allow-other-keys)
(let ((req-p (eq kind 'request))
(notif-p (eq kind 'notification))
(reply-p (eql kind 'reply)))
(cond
((eq origin 'server)
(cond (req-p ,(when server-requests
`(push message ,server-requests)))
(notif-p ,(when server-notifications
`(push message ,server-notifications)))
(reply-p ,(when server-replies
`(push message ,server-replies)))))
((eq origin 'client)
(cond (req-p ,(when client-requests
`(push message ,client-requests)))
(notif-p ,(when client-notifications
`(push message ,client-notifications)))
(reply-p ,(when client-replies
`(push message ,client-replies)))))))))
(unwind-protect
(progn
(add-hook 'jsonrpc-event-hook #',log-event-hook-sym t)
,@body)
(remove-hook 'jsonrpc-event-hook #',log-event-hook-sym))))))
(cl-defmacro eglot--wait-for ((events-sym &optional (timeout 1) message) args &body body)
(declare (indent 2) (debug (sexp sexp sexp &rest form)))
`(eglot--with-timeout '(,timeout ,(or message
(format "waiting for:\n%s" (pp-to-string body))))
(eglot--test-message "waiting for `%s'" (with-output-to-string
(mapc #'princ ',body)))
(let ((events
(cl-loop thereis (cl-loop for json in ,events-sym
for method = (plist-get json :method)
when (keywordp method)
do (plist-put json :method
(substring
(symbol-name method)
1))
when (funcall
(jsonrpc-lambda ,args ,@body) json)
return (cons json before)
collect json into before)
for i from 0
when (zerop (mod i 5))
;; do (eglot--test-message "still struggling to find in %s"
;; ,events-sym)
do
;; `read-event' is essential to have the file
;; watchers come through.
(cond ((fboundp 'flush-standard-output)
(read-event nil nil 0.1) (princ ".")
(flush-standard-output))
(t
(read-event "." nil 0.1)))
(accept-process-output nil 0.1))))
(setq ,events-sym (cdr events))
(cl-destructuring-bind (&key method id &allow-other-keys) (car events)
(eglot--test-message "detected: %s"
(or method (and id (format "id=%s" id))))))))
;; `rust-mode' is not a part of Emacs, so we define these two shims
;; which should be more than enough for testing.
(unless (functionp 'rust-mode)
(define-derived-mode rust-mode prog-mode "Rust")
(add-to-list 'auto-mode-alist '("\\.rs\\'" . rust-mode)))
;; `typescript-mode' is not a part of Emacs, so we define these two
;; shims which should be more than enough for testing.
(unless (functionp 'typescript-mode)
(define-derived-mode typescript-mode prog-mode "TypeScript")
(add-to-list 'auto-mode-alist '("\\.ts\\'" . typescript-mode)))
(defun eglot--tests-connect (&optional timeout)
(let* ((timeout (or timeout 10))
(eglot-sync-connect t)
(eglot-connect-timeout timeout))
(apply #'eglot--connect (eglot--guess-contact))))
(defun eglot--simulate-key-event (char)
"Like (execute-kbd-macro (vector char)), but with `call-interactively'."
;; Also, this is a bit similar to what electric-tests.el does.
(setq last-input-event char)
(setq last-command-event char)
(call-interactively (key-binding (vector char))))
(defun eglot--clangd-version ()
"Report on the clangd version used in various tests."
(let ((version (shell-command-to-string "clangd --version")))
(when (string-match "version[[:space:]]+\\([0-9.]*\\)"
version)
(match-string 1 version))))
;;; Unit tests
(ert-deftest eglot-test-eclipse-connect ()
"Connect to eclipse.jdt.ls server."
(skip-unless (executable-find "jdtls"))
(eglot--with-fixture
'(("project/src/main/java/foo" . (("Main.java" . ""))))
(with-current-buffer
(eglot--find-file-noselect "project/src/main/java/foo/Main.java")
(eglot--sniffing (:server-notifications s-notifs)
(should (eglot--tests-connect 20))
(eglot--wait-for (s-notifs 10)
(&key _id method &allow-other-keys)
(string= method "language/status"))))))
(defun eglot-tests--auto-detect-running-server-1 ()
(let (server)
(eglot--with-fixture
`(("project" . (("coiso.c" . "bla")
("merdix.c" . "bla")))
("anotherproject" . (("cena.c" . "bla"))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(should (setq server (eglot--tests-connect)))
(should (eglot-current-server)))
(with-current-buffer
(eglot--find-file-noselect "project/merdix.c")
(should (eglot-current-server))
(should (eq (eglot-current-server) server)))
(with-current-buffer
(eglot--find-file-noselect "anotherproject/cena.c")
(should-error (eglot--current-server-or-lose))))))
(ert-deftest eglot-test-auto-detect-running-server ()
"Visit a file and \\[eglot], then visit a neighbor."
(skip-unless (executable-find "clangd"))
(eglot-tests--auto-detect-running-server-1))
(ert-deftest eglot-test-auto-shutdown ()
"Visit a file and \\[eglot], then kill buffer."
(skip-unless (executable-find "clangd"))
(let (server
buffer)
(eglot--with-fixture
`(("project" . (("thingy.c" . "int main() {return 0;}"))))
(with-current-buffer
(setq buffer (eglot--find-file-noselect "project/thingy.c"))
(should (setq server (eglot--tests-connect)))
(should (eglot-current-server))
(let ((eglot-autoshutdown nil)) (kill-buffer buffer))
(should (jsonrpc-running-p server))
;; re-find file...
(setq buffer (eglot--find-file-noselect (buffer-file-name buffer)))
;; ;; but now kill it with `eglot-autoshutdown' set to t
(let ((eglot-autoshutdown t)) (kill-buffer buffer))
(should (not (jsonrpc-running-p server)))))))
(ert-deftest eglot-test-auto-reconnect ()
"Start a server. Kill it. Watch it reconnect."
(skip-unless (executable-find "clangd"))
(let (server (eglot-autoreconnect 1))
(eglot--with-fixture
`(("project" . (("thingy.c" . "bla")
("thingy2.c" . "bla"))))
(with-current-buffer
(eglot--find-file-noselect "project/thingy.c")
(should (setq server (eglot--tests-connect)))
;; In 1.2 seconds > `eglot-autoreconnect' kill servers. We
;; should have a automatic reconnection.
(run-with-timer 1.2 nil (lambda () (delete-process
(jsonrpc--process server))))
(while (jsonrpc-running-p server) (accept-process-output nil 0.5))
(should (eglot-current-server))
;; Now try again too quickly
(setq server (eglot-current-server))
(let ((proc (jsonrpc--process server)))
(run-with-timer 0.5 nil (lambda () (delete-process proc)))
(while (process-live-p proc) (accept-process-output nil 0.5)))
(should (not (eglot-current-server)))))))
(ert-deftest eglot-test-rust-analyzer-watches-files ()
"Start rust-analyzer. Notify it when a critical file changes."
(skip-unless (executable-find "rust-analyzer"))
(skip-unless (executable-find "cargo"))
(let ((eglot-autoreconnect 1))
(eglot--with-fixture
'(("watch-project" . (("coiso.rs" . "bla")
("merdix.rs" . "bla"))))
(with-current-buffer
(eglot--find-file-noselect "watch-project/coiso.rs")
(should (zerop (shell-command "cargo init")))
(eglot--sniffing (
:server-requests s-requests
:client-notifications c-notifs
:client-replies c-replies
)
(should (eglot--tests-connect))
(let (register-id)
(eglot--wait-for (s-requests 3)
(&key id method &allow-other-keys)
(setq register-id id)
(string= method "client/registerCapability"))
(eglot--wait-for (c-replies 1)
(&key id error &allow-other-keys)
(and (eq id register-id) (null error))))
(delete-file "Cargo.toml")
(eglot--wait-for
(c-notifs 3 "waiting for didChangeWatchedFiles notification")
(&key method params &allow-other-keys)
(and (string= method "workspace/didChangeWatchedFiles")
(cl-destructuring-bind (&key uri type)
(elt (plist-get params :changes) 0)
(and (string= (eglot-path-to-uri "Cargo.toml") uri)
(= type 3))))))))))
(ert-deftest eglot-test-basic-diagnostics ()
"Test basic diagnostics."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("diag-project" .
(("main.c" . "int main(){froat a = 42.2; return 0;}"))))
(with-current-buffer
(eglot--find-file-noselect "diag-project/main.c")
(eglot--sniffing (:server-notifications s-notifs)
(eglot--tests-connect)
(eglot--wait-for (s-notifs 10)
(&key _id method &allow-other-keys)
(string= method "textDocument/publishDiagnostics"))
(flymake-start)
(goto-char (point-min))
(flymake-goto-next-error 1 '() t)
(should (eq 'flymake-error (face-at-point)))))))
(ert-deftest eglot-test-basic-symlink ()
"Test basic symlink support."
(skip-unless (executable-find "clangd"))
;; MS-Windows either fails symlink creation or pops up UAC prompts.
(skip-unless (not (eq system-type 'windows-nt)))
(eglot--with-fixture
`(("symlink-project" .
(("main.cpp" . "#include\"foo.h\"\nint main() { return foo(); }")
("foo.h" . "int foo();"))))
(with-current-buffer
(find-file-noselect "symlink-project/main.cpp")
(make-symbolic-link "main.cpp" "mainlink.cpp")
(eglot--tests-connect)
(eglot--sniffing (:client-notifications c-notifs)
(let ((eglot-autoshutdown nil)) (kill-buffer (current-buffer)))
(eglot--wait-for (c-notifs 10)
(&key method &allow-other-keys)
(and (string= method "textDocument/didClose")))))
(eglot--sniffing (:client-notifications c-notifs)
(with-current-buffer
(find-file-noselect "symlink-project/main.cpp")
(should (eglot-current-server)))
(eglot--wait-for (c-notifs 10)
(&rest whole &key params method &allow-other-keys)
(and (string= method "textDocument/didOpen")
(string-match "main.cpp$"
(plist-get (plist-get params :textDocument)
:uri)))))
;; This last segment is deactivated, because it's likely not needed.
;; The only way the server would answer with '3' references is if we
;; had erroneously sent a 'didOpen' for anything other than
;; `main.cpp', but if we got this far is because we've just asserted
;; that we didn't.
(when nil
(with-current-buffer
(find-file-noselect "symlink-project/foo.h")
;; Give clangd some time to settle its analysis so it can
;; accurately respond to `textDocument/references'
(sleep-for 3)
(search-forward "foo")
(eglot--sniffing (:server-replies s-replies)
(call-interactively 'xref-find-references)
(eglot--wait-for (s-replies 10)
(&key method result &allow-other-keys)
;; Expect xref buffer to not contain duplicate references to
;; main.cpp and mainlink.cpp. If it did, 'result's length
;; would be 3.
(and (string= method "textDocument/references")
(= (length result) 2))))))))
(ert-deftest eglot-test-diagnostic-tags-unnecessary-code ()
"Test rendering of diagnostics tagged \"unnecessary\"."
(skip-unless (executable-find "clangd"))
(skip-unless (version<= "14" (eglot--clangd-version)))
(eglot--with-fixture
`(("diag-project" .
(("main.cpp" . "int main(){float a = 42.2; return 0;}"))))
(with-current-buffer
(eglot--find-file-noselect "diag-project/main.cpp")
(eglot--make-file-or-dir '(".git"))
(eglot--make-file-or-dir
`("compile_commands.json" .
,(jsonrpc--json-encode
`[(:directory ,default-directory :command "/usr/bin/c++ -Wall -c main.cpp"
:file ,(expand-file-name "main.cpp"))])))
(let ((eglot-server-programs '((c++-mode . ("clangd")))))
(eglot--sniffing (:server-notifications s-notifs)
(eglot--tests-connect)
(eglot--wait-for (s-notifs 10)
(&key _id method &allow-other-keys)
(string= method "textDocument/publishDiagnostics"))
(flymake-start)
(goto-char (point-min))
(flymake-goto-next-error 1 '() t)
(should (eq 'eglot-diagnostic-tag-unnecessary-face (face-at-point))))))))
(defun eglot--eldoc-on-demand ()
;; Trick ElDoc 1.1.0 into accepting on-demand calls.
(eldoc t))
(defun eglot--tests-force-full-eldoc ()
;; FIXME: This uses some ElDoc implementation details.
(when (buffer-live-p eldoc--doc-buffer)
(with-current-buffer eldoc--doc-buffer
(let ((inhibit-read-only t))
(erase-buffer))))
(eglot--eldoc-on-demand)
(cl-loop
repeat 10
for retval = (and (buffer-live-p eldoc--doc-buffer)
(with-current-buffer eldoc--doc-buffer
(let ((bs (buffer-string)))
(unless (zerop (length bs)) bs))))
when retval return retval
do (sit-for 0.5)
finally (error "eglot--tests-force-full-eldoc didn't deliver")))
(ert-deftest eglot-test-rust-analyzer-hover-after-edit ()
"Hover and highlightChanges."
(skip-unless (executable-find "rust-analyzer"))
(skip-unless (executable-find "cargo"))
(eglot--with-fixture
'(("hover-project" .
(("main.rs" .
"fn test() -> i32 { let test=3; return te; }"))))
(with-current-buffer
(eglot--find-file-noselect "hover-project/main.rs")
(should (zerop (shell-command "cargo init")))
(eglot--sniffing (
:server-replies s-replies
:client-requests c-reqs
)
(eglot--tests-connect)
(goto-char (point-min))
(search-forward "return te")
(insert "st")
(progn
;; simulate these two which don't happen when buffer isn't
;; visible in a window.
(eglot--signal-textDocument/didChange)
(eglot--eldoc-on-demand))
(let (pending-id)
(eglot--wait-for (c-reqs 2)
(&key id method &allow-other-keys)
(setq pending-id id)
(string= method "textDocument/documentHighlight"))
(eglot--wait-for (s-replies 2)
(&key id &allow-other-keys)
(eq id pending-id)))))))
(ert-deftest eglot-test-rename-a-symbol ()
"Test basic symbol renaming."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("rename-project"
. (("main.c" .
"int foo() {return 42;} int main() {return foo();}"))))
(with-current-buffer
(eglot--find-file-noselect "rename-project/main.c")
(eglot--tests-connect)
(goto-char (point-min)) (search-forward "foo")
(eglot-rename "bar")
(should (equal (buffer-string)
"int bar() {return 42;} int main() {return bar();}")))))
(defun eglot--wait-for-clangd ()
(eglot--sniffing (:server-notifications s-notifs)
(should (eglot--tests-connect))
(eglot--wait-for (s-notifs 20) (&key method &allow-other-keys)
(string= method "textDocument/publishDiagnostics"))))
(defun eglot--wait-for-rust-analyzer ()
(eglot--sniffing (:server-notifications s-notifs)
(should (eglot--tests-connect))
(eglot--wait-for (s-notifs 20) (&key method params &allow-other-keys)
(and
(string= method "$/progress")
(equal (plist-get params :token) "rustAnalyzer/Roots Scanned")
(equal (plist-get (plist-get params :value) :kind) "end")))
;; Annoyingly, waiting for that special progress report is still not
;; enough to make sure the server is ready to provide completions,
;; so here's two extra seconds.
(sit-for 2)))
(ert-deftest eglot-test-basic-completions ()
"Test basic autocompletion in a clangd LSP."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" . "#include <stdio.h>\nint main () {fprin"))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(eglot--wait-for-clangd)
(goto-char (point-max))
(completion-at-point)
(message (buffer-string))
(should (looking-back "fprintf.?")))))
(ert-deftest eglot-test-non-unique-completions ()
"Test completion resulting in 'Complete, but not unique'."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" .
,(concat "int foo; int fooey;"
"int main() {foo")))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(eglot--wait-for-clangd)
(goto-char (point-max))
(completion-at-point)
;; FIXME: `current-message' doesn't work here :-(
(with-current-buffer (messages-buffer)
(save-excursion
(goto-char (point-max))
(forward-line -1)
(should (looking-at "Complete, but not unique")))))))
(ert-deftest eglot-test-stop-completion-on-nonprefix ()
"Test completion also resulting in 'Complete, but not unique'."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" .
,(concat "int foot; int footer; int fo_obar;"
"int main() {foo")))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(eglot--wait-for-clangd)
(goto-char (point-max))
(completion-at-point)
(should (looking-back "foo")))))
(defun eglot--kill-completions-buffer ()
(when (buffer-live-p (get-buffer "*Completions*"))
(kill-buffer "*Completions*")))
(ert-deftest eglot-test-try-completion-nomatch ()
"Test completion table with non-matching input, returning nil."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" .
,(concat "int main() {abc")))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(eglot--wait-for-clangd)
(eglot--kill-completions-buffer)
(goto-char (point-max))
(completion-at-point)
(should (looking-back "abc"))
(should-not (get-buffer "*Completions*")))))
(ert-deftest eglot-test-try-completion-inside-symbol ()
"Test completion table inside symbol, with only prefix matching."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" .
,(concat
"int foobar;"
"int foobarbaz;"
"int main() {foo123")))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(eglot--wait-for-clangd)
(goto-char (- (point-max) 3))
(eglot--kill-completions-buffer)
(completion-at-point)
(should (looking-back "foo"))
(should (looking-at "123"))
(should (get-buffer "*Completions*")))))
(ert-deftest eglot-test-try-completion-inside-symbol-2 ()
"Test completion table inside symbol, with only prefix matching."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" .
,(concat
"int foobar;"
"int main() {foo123")))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(eglot--wait-for-clangd)
(goto-char (- (point-max) 3))
(completion-at-point)
(should (looking-back "foobar"))
(should (looking-at "123")))))
(ert-deftest eglot-test-rust-completion-exit-function ()
"Ensure rust-analyzer exit function creates the expected contents."
:tags '(:expensive-test)
;; This originally appeared in github#1339
(skip-unless (executable-find "rust-analyzer"))
(skip-unless (executable-find "cargo"))
(eglot--with-fixture
'(("cmpl-project" .
(("main.rs" .
"fn test() -> i32 { let v: usize = 1; v.count_on1234.1234567890;"))))
(with-current-buffer
(eglot--find-file-noselect "cmpl-project/main.rs")
(should (zerop (shell-command "cargo init")))
(search-forward "v.count_on")
(eglot--wait-for-rust-analyzer)
(completion-at-point)
(should
(equal
(if (bound-and-true-p yas-minor-mode)
"fn test() -> i32 { let v: usize = 1; v.count_ones().1234567890;"
"fn test() -> i32 { let v: usize = 1; v.count_ones.1234567890;")
(buffer-string))))))
(ert-deftest eglot-test-zig-insert-replace-completion ()
"Test zls's use of 'InsertReplaceEdit'."
(skip-unless (functionp 'zig-ts-mode))
(eglot--with-fixture
`(("project" .
(("main.zig" .
,(concat "const Foo = struct {correct_name: u32,\n};\n"
"fn example(foo: Foo) u32 {return foo.correc_name; }")))))
(with-current-buffer
(eglot--find-file-noselect "project/main.zig")
(should (eglot--tests-connect))
(search-forward "foo.correc")
(completion-at-point)
(should (looking-back "correct_name")))))
(ert-deftest eglot-test-basic-xref ()
"Test basic xref functionality in a clangd LSP."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" .
,(concat "int foo=42; int fooey;"
"int main() {foo=82;}")))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(should (eglot--tests-connect))
(search-forward "{foo")
(call-interactively 'xref-find-definitions)
(should (looking-at "foo=42")))))
(defvar eglot--test-c-buffer
"\
void foobarquux(int a, int b, int c){};
void foobazquuz(int a, int b, int f){};
int main() {
")
(declare-function yas-minor-mode nil)
(ert-deftest eglot-test-snippet-completions ()
"Test simple snippet completion in a clangd LSP."
(skip-unless (and (executable-find "clangd")
(functionp 'yas-minor-mode)))
(eglot--with-fixture
`(("project" . (("coiso.c" . ,eglot--test-c-buffer))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(yas-minor-mode 1)
(eglot--wait-for-clangd)
(goto-char (point-max))
(insert "foobar")
(completion-at-point)
(should (looking-back "foobarquux("))
(should (looking-at "int a, int b, int c)")))))
(defvar company-candidates)
(declare-function company-mode nil)
(declare-function company-complete nil)
(ert-deftest eglot-test-snippet-completions-with-company ()
"Test simple snippet completion in a clangd LSP."
(skip-unless (and (executable-find "clangd")
(functionp 'yas-minor-mode)
(functionp 'company-complete)))
(eglot--with-fixture
`(("project" . (("coiso.c" . ,eglot--test-c-buffer))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(yas-minor-mode 1)
(eglot--wait-for-clangd)
(goto-char (point-max))
(insert "foo")
(company-mode)
(company-complete)
(should (= 2 (length company-candidates)))
;; this last one is brittle, since there it is possible that
;; clangd will change the representation of this candidate
(should (member "foobazquuz(int a, int b, int f)" company-candidates)))))
(ert-deftest eglot-test-eldoc-after-completions ()
"Test documentation echo in a clangd LSP."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" . "#include <stdio.h>\nint main () {fprin"))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(eglot--wait-for-clangd)
(goto-char (point-max))
(completion-at-point)
(message (buffer-string))
(should (looking-back "fprintf(?"))
(unless (= (char-before) ?\() (insert "()") (backward-char))
(eglot--signal-textDocument/didChange)
(should (string-match "^fprintf" (eglot--tests-force-full-eldoc))))))
(ert-deftest eglot-test-multiline-eldoc ()
"Test ElDoc documentation from multiple osurces."
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" .
"#include <stdio.h>\nint main () {fprintf(blergh);}"))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(search-forward "fprintf(ble")
(eglot--wait-for-clangd)
(flymake-start nil t) ;; thing brings in the "unknown identifier blergh"
(let* ((captured-message (eglot--tests-force-full-eldoc)))
;; check for signature and error message in the result
(should (string-match "fprintf" captured-message))
(should (string-match "blergh" captured-message))
(should (cl-find ?\n captured-message))))))
(ert-deftest eglot-test-formatting ()
"Test formatting in the clangd server."
;; Beware, default autopep rules can change over time, which may
;; affect this test.
(skip-unless (executable-find "clangd"))
(eglot--with-fixture
`(("project" . (("coiso.c" . ,(concat "#include <stdio.h>\n"
"int main(){fprintf(blergh);}"
"int ble{\n\nreturn 0;}")))))
(with-current-buffer
(eglot--find-file-noselect "project/coiso.c")
(eglot--wait-for-clangd)
(forward-line)
;; Try to format just the second line
(eglot-format (line-beginning-position) (line-end-position))
(should (looking-at "int main() { fprintf(blergh); }"))
;; ;; now format the whole buffer
(eglot-format-buffer)
(should
(string= (buffer-string)
"#include <stdio.h>\nint main() { fprintf(blergh); }\nint ble { return 0; }")))))
(ert-deftest eglot-test-rust-on-type-formatting ()
"Test textDocument/onTypeFormatting against rust-analyzer."
(skip-unless (executable-find "rust-analyzer"))
(skip-unless (executable-find "cargo"))
(eglot--with-fixture
'(("on-type-formatting-project" .
(("main.rs" .
"fn main() -> () {\n foo\n .bar()\n "))))
(with-current-buffer
(eglot--find-file-noselect "on-type-formatting-project/main.rs")
(let ((eglot-server-programs '((rust-mode . ("rust-analyzer")))))
(should (zerop (shell-command "cargo init")))
(eglot--sniffing (:server-notifications s-notifs)
(should (eglot--tests-connect))
(eglot--wait-for (s-notifs 20) (&key method &allow-other-keys)
(string= method "textDocument/publishDiagnostics")))
(goto-char (point-max))
(eglot--simulate-key-event ?.)
(should (looking-back "^ \\."))))))
(ert-deftest eglot-test-javascript-basic ()
"Test basic autocompletion in a JavaScript LSP."
:tags '(:expensive-test)
(skip-unless (and (executable-find "typescript-language-server")
(executable-find "tsserver")))
(eglot--with-fixture
'(("project" . (("hello.js" . "console.log('Hello world!');"))))
(with-current-buffer
(eglot--find-file-noselect "project/hello.js")
(let ((eglot-server-programs
'((js-mode . ("typescript-language-server" "--stdio")))))
(goto-char (point-max))
(eglot--sniffing (:server-notifications
s-notifs
:client-notifications
c-notifs)
(should (eglot--tests-connect))
(eglot--wait-for (s-notifs 10) (&key method &allow-other-keys)
(string= method "textDocument/publishDiagnostics"))
(should (not (eq 'flymake-error (face-at-point))))
(insert "{")
(eglot--signal-textDocument/didChange)
(eglot--wait-for (c-notifs 1) (&key method &allow-other-keys)
(string= method "textDocument/didChange"))
(eglot--wait-for (s-notifs 10) (&key params method &allow-other-keys)
(and (string= method "textDocument/publishDiagnostics")
(cl-destructuring-bind (&key _uri diagnostics) params
(cl-find-if (jsonrpc-lambda (&key severity &allow-other-keys)
(= severity 1))
diagnostics)))))))))
(ert-deftest eglot-test-project-wide-diagnostics-typescript ()
"Test diagnostics through multiple files in a TypeScript LSP."
(skip-unless (and (executable-find "typescript-language-server")
(executable-find "tsserver")))
(eglot--with-fixture
'(("project" . (("hello.ts" . "const thing = 5;\nexport { thin }")
("hello2.ts" . "import { thing } from './hello'"))))
(eglot--make-file-or-dir '(".git"))
(let ((eglot-server-programs
'((typescript-mode . ("typescript-language-server" "--stdio")))))
;; Check both files because typescript-language-server doesn't
;; report all errors on startup, at least not with such a simple
;; setup.
(with-current-buffer (eglot--find-file-noselect "project/hello2.ts")
(eglot--sniffing (:server-notifications s-notifs)
(eglot--tests-connect)
(flymake-start)
(eglot--wait-for (s-notifs 10)
(&key _id method &allow-other-keys)
(string= method "textDocument/publishDiagnostics"))
(should (= 2 (length (flymake--project-diagnostics)))))
(with-current-buffer (eglot--find-file-noselect "hello.ts")
(eglot--sniffing (:server-notifications s-notifs)
(flymake-start)
(eglot--wait-for (s-notifs 10)
(&key _id method &allow-other-keys)
(string= method "textDocument/publishDiagnostics"))
(should (= 4 (length (flymake--project-diagnostics))))))))))
(ert-deftest eglot-test-project-wide-diagnostics-rust-analyzer ()
"Test diagnostics through multiple files in rust-analyzer."
(skip-unless (executable-find "rust-analyzer"))
(skip-unless (executable-find "cargo"))
(skip-unless (executable-find "git"))
(eglot--with-fixture
'(("project" .
(("main.rs" .
"fn main() -> i32 { return 42.2;}")
("other-file.rs" .
"fn foo() -> () { let hi=3; }"))))
(let ((eglot-server-programs '((rust-mode . ("rust-analyzer")))))
;; Open other-file.rs, and see diagnostics arrive for main.rs,
;; which we didn't open.
(with-current-buffer (eglot--find-file-noselect "project/other-file.rs")
(should (zerop (shell-command "git init")))
(should (zerop (shell-command "cargo init")))
(eglot--sniffing (:server-notifications s-notifs)
(eglot--tests-connect)
(flymake-start)
(eglot--wait-for (s-notifs 20)
(&key _id method params &allow-other-keys)
(and (string= method "textDocument/publishDiagnostics")
(string-suffix-p "main.rs" (plist-get params :uri))))
(let* ((diags (flymake--project-diagnostics)))
(should (cl-some (lambda (diag)
(let ((locus (flymake-diagnostic-buffer diag)))
(and (stringp (flymake-diagnostic-buffer diag))
(string-suffix-p "main.rs" locus))))
diags))))))))
(ert-deftest eglot-test-json-basic ()
"Test basic autocompletion in vscode-json-languageserver."
(skip-unless (executable-find "vscode-json-languageserver"))
(skip-unless (fboundp 'yas-minor-mode))
(eglot--with-fixture
'(("project" .
(("p.json" . "{\"foo.b")
("s.json" . "{\"properties\":{\"foo.bar\":{\"default\":\"fb\"}}}")
(".git" . nil))))
(with-current-buffer
(eglot--find-file-noselect "project/p.json")
(yas-minor-mode)
(goto-char 2)
(insert "\"$schema\": \"file://"
(file-name-directory buffer-file-name) "s.json\",")
(let ((eglot-server-programs
'((js-mode . ("vscode-json-languageserver" "--stdio")))))
(goto-char (point-max))
(should (eglot--tests-connect))
(completion-at-point)
(should (looking-back "\"foo.bar\": \""))
(should (looking-at "fb\"$"))))))
(defun eglot-tests--get (object path)
(dolist (op path)
(setq object (if (natnump op) (aref object op)
(plist-get object op))))
object)