forked from sublimelsp/LSP
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtest_single_document.py
423 lines (379 loc) · 17.1 KB
/
test_single_document.py
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
from copy import deepcopy
from LSP.plugin import apply_text_edits, Request
from LSP.plugin.core.protocol import UINT_MAX
from LSP.plugin.core.url import filename_to_uri
from LSP.plugin.core.views import entire_content
from LSP.plugin.hover import _test_contents
from setup import TextDocumentTestCase
from setup import TIMEOUT_TIME
from setup import YieldPromise
import os
import sublime
try:
from typing import Generator, Optional, Iterable, Tuple, List
assert Generator and Optional and Iterable and Tuple and List
except ImportError:
pass
SELFDIR = os.path.dirname(__file__)
TEST_FILE_PATH = os.path.join(SELFDIR, 'testfile.txt')
GOTO_RESPONSE = [
{
'uri': filename_to_uri(TEST_FILE_PATH),
'range':
{
'start':
{
# Put the cursor at the capital letter "F".
'character': 5,
'line': 1
},
'end':
{
'character': 5,
'line': 1
}
}
}
]
GOTO_RESPONSE_LOCATION_LINK = [
{
'originSelectionRange': {'start': {'line': 0, 'character': 0}},
'targetUri': GOTO_RESPONSE[0]['uri'],
'targetRange': GOTO_RESPONSE[0]['range'],
'targetSelectionRange': GOTO_RESPONSE[0]['range']
}
]
GOTO_CONTENT = r'''abcdefghijklmnopqrstuvwxyz
ABCDEFGHIJKLMNOPQRSTUVWXYZ
0123456789
'''
class SingleDocumentTestCase(TextDocumentTestCase):
def test_did_open(self) -> None:
# Just the existence of this method checks "initialize" -> "initialized" -> "textDocument/didOpen"
# -> "shutdown" -> client shut down
pass
def test_out_of_bounds_column_for_text_document_edit(self) -> None:
self.insert_characters("a\nb\nc\n")
apply_text_edits(self.view, [
{
'newText': 'hello there',
'range': {
'start': {
'line': 1,
'character': 0,
},
'end': {
'line': 1,
'character': 10000,
}
}
},
])
self.assertEqual(entire_content(self.view), "a\nhello there\nc\n")
def test_did_close(self) -> 'Generator':
self.assertTrue(self.view)
self.assertTrue(self.view.is_valid())
self.view.close()
yield from self.await_message("textDocument/didClose")
def test_sends_save_with_purge(self) -> 'Generator':
assert self.view
self.view.settings().set("lsp_format_on_save", False)
self.insert_characters("A")
self.view.run_command("lsp_save", {'async': True})
yield from self.await_message("textDocument/didChange")
yield from self.await_message("textDocument/didSave")
yield from self.await_clear_view_and_save()
def test_formats_on_save(self) -> 'Generator':
assert self.view
self.view.settings().set("lsp_format_on_save", True)
self.insert_characters("A")
yield from self.await_message("textDocument/didChange")
self.set_response('textDocument/formatting', [{
'newText': "BBB",
'range': {
'start': {'line': 0, 'character': 0},
'end': {'line': 0, 'character': 1}
}
}])
self.view.run_command("lsp_save", {'async': True})
yield from self.await_message("textDocument/formatting")
yield from self.await_message("textDocument/didChange")
yield from self.await_message("textDocument/didSave")
text = self.view.substr(sublime.Region(0, self.view.size()))
self.assertEquals("BBB", text)
yield from self.await_clear_view_and_save()
def test_hover_info(self) -> 'Generator':
assert self.view
self.set_response('textDocument/hover', {"contents": "greeting"})
self.view.run_command('insert', {"characters": "Hello Wrld"})
self.assertFalse(self.view.is_popup_visible())
self.view.run_command('lsp_hover', {'point': 3})
yield lambda: self.view.is_popup_visible()
last_content = _test_contents[-1]
self.assertTrue("greeting" in last_content)
def test_remove_line_and_then_insert_at_that_line_at_end(self) -> 'Generator':
original = (
'a\n'
'b\n'
'c'
)
file_changes = [
((2, 0), (3, 0), ''), # out-of-bounds end position, but this is fine
((3, 0), (3, 0), 'c\n') # out-of-bounds start and end, this line doesn't exist
]
expected = (
'a\n'
'b\n'
'c\n'
)
# Old behavior:
# 1) first we end up with ('a\n', 'b\n', 'cc\n')
# 2) then we end up with ('a\n', 'b\n', '')
# New behavior:
# 1) line index 3 is "created" ('a\n', 'b\n', 'c\n', c\n'))
# 2) deletes line index 2.
yield from self.__run_formatting_test(original, expected, file_changes)
def test_apply_formatting(self) -> 'Generator':
original = (
'<dom-module id="some-thing">\n'
'<style></style>\n'
'<template>\n'
'</template>\n'
'</dom-module>\n'
)
file_changes = [
((0, 28), (1, 0), ''), # delete first \n
((1, 0), (1, 15), ''), # delete second line (but not the \n)
((2, 10), (2, 10), '\n <style></style>'), # insert after <template>
]
expected = (
'<dom-module id="some-thing">\n'
'<template>\n'
' <style></style>\n'
'</template>\n'
'</dom-module>\n'
)
yield from self.__run_formatting_test(original, expected, file_changes)
def test_apply_formatting_and_preserve_order(self) -> 'Generator':
original = (
'abcde\n'
'fghij\n'
)
# Note that (1, 2) comes before (0, 1) in the text.
file_changes = [
((1, 2), (1, 2), '4'), # insert after the g
((1, 2), (1, 2), '5'),
((1, 2), (1, 3), '6'), # replace the h
((0, 1), (0, 1), '1'), # insert after a
((0, 1), (0, 1), '2'),
((0, 1), (0, 1), '3'),
]
expected = (
'a123bcde\n'
'fg456ij\n'
)
yield from self.__run_formatting_test(original, expected, file_changes)
def test_tabs_are_respected_even_when_translate_tabs_to_spaces_is_set_to_true(self) -> 'Generator':
original = ' ' * 4
file_changes = [((0, 0), (0, 4), '\t')]
expected = '\t'
assert self.view
self.view.settings().set("translate_tabs_to_spaces", True)
yield from self.__run_formatting_test(original, expected, file_changes)
# Make sure the user's settings haven't changed
self.assertTrue(self.view.settings().get("translate_tabs_to_spaces"))
def __run_formatting_test(
self,
original: 'Iterable[str]',
expected: 'Iterable[str]',
file_changes: 'List[Tuple[Tuple[int, int], Tuple[int, int], str]]'
) -> 'Generator':
assert self.view
original_change_count = self.insert_characters(''.join(original))
# self.assertEqual(original_change_count, 1)
self.set_response('textDocument/formatting', [{
'newText': new_text,
'range': {
'start': {'line': start[0], 'character': start[1]},
'end': {'line': end[0], 'character': end[1]}}} for start, end, new_text in file_changes])
self.view.run_command('lsp_format_document')
yield from self.await_message('textDocument/formatting')
yield from self.await_view_change(original_change_count + len(file_changes))
edited_content = self.view.substr(sublime.Region(0, self.view.size()))
self.assertEquals(edited_content, ''.join(expected))
def __run_goto_test(self, response: list, text_document_request: str, subl_command_suffix: str) -> 'Generator':
assert self.view
self.insert_characters(GOTO_CONTENT)
# Put the cursor back at the start of the buffer, otherwise is_at_word fails in goto.py.
self.view.sel().clear()
self.view.sel().add(sublime.Region(0, 0))
method = 'textDocument/{}'.format(text_document_request)
self.set_response(method, response)
self.view.run_command('lsp_symbol_{}'.format(subl_command_suffix))
yield from self.await_message(method)
def condition() -> bool:
nonlocal self
assert self.view
s = self.view.sel()
if len(s) != 1:
return False
return s[0].begin() > 0
yield {"condition": condition, "timeout": TIMEOUT_TIME}
first = self.view.sel()[0].begin()
self.assertEqual(self.view.substr(sublime.Region(first, first + 1)), "F")
def test_definition(self) -> 'Generator':
yield from self.__run_goto_test(GOTO_RESPONSE, 'definition', 'definition')
def test_definition_location_link(self) -> 'Generator':
yield from self.__run_goto_test(GOTO_RESPONSE_LOCATION_LINK, 'definition', 'definition')
def test_type_definition(self) -> 'Generator':
yield from self.__run_goto_test(GOTO_RESPONSE, 'typeDefinition', 'type_definition')
def test_type_definition_location_link(self) -> 'Generator':
yield from self.__run_goto_test(GOTO_RESPONSE_LOCATION_LINK, 'typeDefinition', 'type_definition')
def test_declaration(self) -> 'Generator':
yield from self.__run_goto_test(GOTO_RESPONSE, 'declaration', 'declaration')
def test_declaration_location_link(self) -> 'Generator':
yield from self.__run_goto_test(GOTO_RESPONSE_LOCATION_LINK, 'declaration', 'declaration')
def test_implementation(self) -> 'Generator':
yield from self.__run_goto_test(GOTO_RESPONSE, 'implementation', 'implementation')
def test_implementation_location_link(self) -> 'Generator':
yield from self.__run_goto_test(GOTO_RESPONSE_LOCATION_LINK, 'implementation', 'implementation')
def test_expand_selection(self) -> 'Generator':
self.insert_characters("abcba\nabcba\nabcba\n")
self.view.run_command("lsp_selection_set", {"regions": [(2, 2)]})
self.assertEqual(len(self.view.sel()), 1)
self.assertEqual(self.view.substr(self.view.sel()[0]), "")
self.assertEqual(self.view.substr(self.view.sel()[0].a), "c")
response = [{
"parent": {
"parent": {
"range": {"start": {"line": 0, "character": 0}, "end": {"line": 0, "character": 5}}
},
"range": {"start": {"line": 0, "character": 1}, "end": {"line": 0, "character": 3}}
},
"range": {"start": {"line": 0, "character": 2}, "end": {"line": 0, "character": 3}}
}]
def expand_and_check(a: int, b: int) -> 'Generator':
self.set_response("textDocument/selectionRange", response)
self.view.run_command("lsp_expand_selection")
yield from self.await_message("textDocument/selectionRange")
yield lambda: self.view.sel()[0] == sublime.Region(a, b)
yield from expand_and_check(2, 3)
yield from expand_and_check(1, 3)
yield from expand_and_check(0, 5)
def test_rename(self) -> 'Generator':
self.insert_characters("foo\nfoo\nfoo\n")
self.set_response("textDocument/rename", {
'changes': {
filename_to_uri(TEST_FILE_PATH): [
{
'range': {'start': {'character': 0, 'line': 0}, 'end': {'character': 3, 'line': 0}},
'newText': 'bar'
},
{
'range': {'start': {'character': 0, 'line': 1}, 'end': {'character': 3, 'line': 1}},
'newText': 'bar'
},
{
'range':
{
'start': {'character': 0, 'line': 2},
# Check that lsp_apply_document_edit guards for overflow over LSP spec limit of UINT_MAX
'end': {'character': UINT_MAX + 1, 'line': 2}
},
'newText': 'bar'
}
]
}
}
)
self.view.run_command("lsp_selection_set", {"regions": [(0, 0)]})
self.view.run_command("lsp_symbol_rename", {"new_name": "bar"})
yield from self.await_message("textDocument/rename")
yield from self.await_view_change(9)
self.assertEqual(self.view.substr(sublime.Region(0, self.view.size())), "bar\nbar\nbar\n")
def test_run_command(self) -> 'Generator':
self.set_response("workspace/executeCommand", {"canReturnAnythingHere": "asdf"})
promise = YieldPromise()
sublime.set_timeout_async(
lambda: self.session.execute_command(
{"command": "foo", "arguments": ["hello", "there", "general", "kenobi"]},
progress=False,
view=self.view,
).then(promise.fulfill)
)
yield from self.await_promise(promise)
yield from self.await_message("workspace/executeCommand")
self.assertEqual(promise.result(), {"canReturnAnythingHere": "asdf"})
def test_progress(self) -> 'Generator':
request = Request("foobar", {"hello": "world"}, self.view, progress=True)
self.set_response("foobar", {"general": "kenobi"})
promise = self.session.send_request_task(request)
yield lambda: "workDoneToken" in request.params
result = yield from self.await_promise(promise)
self.assertEqual(result, {"general": "kenobi"})
class SingleDocumentTestCase2(TextDocumentTestCase):
def test_did_change(self) -> 'Generator':
assert self.view
self.maxDiff = None
self.insert_characters("A")
yield from self.await_message("textDocument/didChange")
# multiple changes are batched into one didChange notification
self.insert_characters("B\n")
self.insert_characters("🙂\n")
self.insert_characters("D")
promise = YieldPromise()
yield from self.await_message("textDocument/didChange", promise)
self.assertEqual(promise.result(), {
'contentChanges': [
{'rangeLength': 0, 'range': {'start': {'line': 0, 'character': 1}, 'end': {'line': 0, 'character': 1}}, 'text': 'B'}, # noqa
{'rangeLength': 0, 'range': {'start': {'line': 0, 'character': 2}, 'end': {'line': 0, 'character': 2}}, 'text': '\n'}, # noqa
{'rangeLength': 0, 'range': {'start': {'line': 1, 'character': 0}, 'end': {'line': 1, 'character': 0}}, 'text': '🙂'}, # noqa
# Note that this is character offset (2) is correct (UTF-16).
{'rangeLength': 0, 'range': {'start': {'line': 1, 'character': 2}, 'end': {'line': 1, 'character': 2}}, 'text': '\n'}, # noqa
{'rangeLength': 0, 'range': {'start': {'line': 2, 'character': 0}, 'end': {'line': 2, 'character': 0}}, 'text': 'D'}], # noqa
'textDocument': {
'version': self.view.change_count(),
'uri': filename_to_uri(TEST_FILE_PATH)
}
})
class SingleDocumentTestCase3(TextDocumentTestCase):
@classmethod
def get_test_name(cls) -> str:
return "testfile2"
def test_did_change_before_did_close(self) -> 'Generator':
assert self.view
self.view.window().run_command("chain", {
"commands": [
["insert", {"characters": "TEST"}],
["save", {"async": False}],
["close", {}]
]
})
yield from self.await_message('textDocument/didChange')
# yield from self.await_message('textDocument/didSave') # TODO why is this not sent?
yield from self.await_message('textDocument/didClose')
class WillSaveWaitUntilTestCase(TextDocumentTestCase):
@classmethod
def get_test_server_capabilities(cls) -> dict:
capabilities = deepcopy(super().get_test_server_capabilities())
capabilities['capabilities']['textDocumentSync']['willSaveWaitUntil'] = True
return capabilities
def test_will_save_wait_until(self) -> 'Generator':
assert self.view
self.insert_characters("A")
yield from self.await_message("textDocument/didChange")
self.set_response('textDocument/willSaveWaitUntil', [{
'newText': "BBB",
'range': {
'start': {'line': 0, 'character': 0},
'end': {'line': 0, 'character': 1}
}
}])
self.view.settings().set("lsp_format_on_save", False)
self.view.run_command("lsp_save", {'async': True})
yield from self.await_message("textDocument/willSaveWaitUntil")
yield from self.await_message("textDocument/didChange")
yield from self.await_message("textDocument/didSave")
text = self.view.substr(sublime.Region(0, self.view.size()))
self.assertEquals("BBB", text)
yield from self.await_clear_view_and_save()