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
|
# Copyright 2018 Palantir Technologies, Inc.
# pylint: disable=redefined-outer-name
from concurrent import futures
import time
from unittest import mock
import pytest
from pylsp_jsonrpc import exceptions
from pylsp_jsonrpc.endpoint import Endpoint
MSG_ID = 'id'
@pytest.fixture()
def dispatcher():
return {}
@pytest.fixture()
def consumer():
return mock.MagicMock()
@pytest.fixture()
def endpoint(dispatcher, consumer):
return Endpoint(dispatcher, consumer, id_generator=lambda: MSG_ID)
def test_bad_message(endpoint):
# Ensure doesn't raise for a bad message
endpoint.consume({'key': 'value'})
def test_notify(endpoint, consumer):
endpoint.notify('methodName', {'key': 'value'})
consumer.assert_called_once_with({
'jsonrpc': '2.0',
'method': 'methodName',
'params': {'key': 'value'}
})
def test_notify_none_params(endpoint, consumer):
endpoint.notify('methodName', None)
consumer.assert_called_once_with({
'jsonrpc': '2.0',
'method': 'methodName',
})
def test_request(endpoint, consumer):
future = endpoint.request('methodName', {'key': 'value'})
assert not future.done()
consumer.assert_called_once_with({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
# Send the response back to the endpoint
result = 1234
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'result': result
})
assert future.result(timeout=2) == result
def test_request_error(endpoint, consumer):
future = endpoint.request('methodName', {'key': 'value'})
assert not future.done()
consumer.assert_called_once_with({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
# Send an error back from the client
error = exceptions.JsonRpcInvalidRequest(data=1234)
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'error': error.to_dict()
})
# Verify the exception raised by the future is the same as the error the client serialized
with pytest.raises(exceptions.JsonRpcException) as exc_info:
assert future.result(timeout=2)
assert exc_info.type == exceptions.JsonRpcInvalidRequest
assert exc_info.value == error
def test_request_cancel(endpoint, consumer):
future = endpoint.request('methodName', {'key': 'value'})
assert not future.done()
consumer.assert_called_once_with({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
# Cancel the request
future.cancel()
consumer.assert_any_call({
'jsonrpc': '2.0',
'method': '$/cancelRequest',
'params': {'id': MSG_ID}
})
with pytest.raises((exceptions.JsonRpcException, futures.CancelledError)) as exc_info:
assert future.result(timeout=2)
assert exc_info.type in (exceptions.JsonRpcRequestCancelled, futures.CancelledError)
def test_consume_notification(endpoint, dispatcher):
handler = mock.Mock()
dispatcher['methodName'] = handler
endpoint.consume({
'jsonrpc': '2.0',
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
def test_consume_notification_error(endpoint, dispatcher):
handler = mock.Mock(side_effect=ValueError)
dispatcher['methodName'] = handler
# Verify the consume doesn't throw
endpoint.consume({
'jsonrpc': '2.0',
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
def test_consume_notification_method_not_found(endpoint):
# Verify consume doesn't throw for method not found
endpoint.consume({
'jsonrpc': '2.0',
'method': 'methodName',
'params': {'key': 'value'}
})
def test_consume_async_notification_error(endpoint, dispatcher):
def _async_handler():
raise ValueError()
handler = mock.Mock(return_value=_async_handler)
dispatcher['methodName'] = handler
# Verify the consume doesn't throw
endpoint.consume({
'jsonrpc': '2.0',
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
def test_consume_request(endpoint, consumer, dispatcher):
result = 1234
handler = mock.Mock(return_value=result)
dispatcher['methodName'] = handler
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
consumer.assert_called_once_with({
'jsonrpc': '2.0',
'id': MSG_ID,
'result': result
})
def test_consume_future_request(endpoint, consumer, dispatcher):
future_response = futures.ThreadPoolExecutor().submit(lambda: 1234)
handler = mock.Mock(return_value=future_response)
dispatcher['methodName'] = handler
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
await_assertion(lambda: consumer.assert_called_once_with({
'jsonrpc': '2.0',
'id': MSG_ID,
'result': 1234
}))
def test_consume_async_request(endpoint, consumer, dispatcher):
def _async_handler():
return 1234
handler = mock.Mock(return_value=_async_handler)
dispatcher['methodName'] = handler
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
await_assertion(lambda: consumer.assert_called_once_with({
'jsonrpc': '2.0',
'id': MSG_ID,
'result': 1234
}))
@pytest.mark.parametrize('exc_type, error', [
(ValueError, exceptions.JsonRpcInternalError(message='ValueError')),
(KeyError, exceptions.JsonRpcInternalError(message='KeyError')),
(exceptions.JsonRpcMethodNotFound, exceptions.JsonRpcMethodNotFound()),
])
def test_consume_async_request_error(exc_type, error, endpoint, consumer, dispatcher):
def _async_handler():
raise exc_type()
handler = mock.Mock(return_value=_async_handler)
dispatcher['methodName'] = handler
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
await_assertion(lambda: assert_consumer_error(consumer, error))
def test_consume_request_method_not_found(endpoint, consumer):
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
assert_consumer_error(consumer, exceptions.JsonRpcMethodNotFound.of('methodName'))
@pytest.mark.parametrize('exc_type, error', [
(ValueError, exceptions.JsonRpcInternalError(message='ValueError')),
(KeyError, exceptions.JsonRpcInternalError(message='KeyError')),
(exceptions.JsonRpcMethodNotFound, exceptions.JsonRpcMethodNotFound()),
])
def test_consume_request_error(exc_type, error, endpoint, consumer, dispatcher):
handler = mock.Mock(side_effect=exc_type)
dispatcher['methodName'] = handler
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
await_assertion(lambda: assert_consumer_error(consumer, error))
def test_consume_request_cancel(endpoint, dispatcher):
def async_handler():
time.sleep(3)
handler = mock.Mock(return_value=async_handler)
dispatcher['methodName'] = handler
endpoint.consume({
'jsonrpc': '2.0',
'id': MSG_ID,
'method': 'methodName',
'params': {'key': 'value'}
})
handler.assert_called_once_with({'key': 'value'})
endpoint.consume({
'jsonrpc': '2.0',
'method': '$/cancelRequest',
'params': {'id': MSG_ID}
})
# Because Python's Future cannot be cancelled once it's started, the request is never actually cancelled
# consumer.assert_called_once_with({
# 'jsonrpc': '2.0',
# 'id': MSG_ID,
# 'error': exceptions.JsonRpcRequestCancelled().to_dict()
# })
def test_consume_request_cancel_unknown(endpoint):
# Verify consume doesn't throw
endpoint.consume({
'jsonrpc': '2.0',
'method': '$/cancelRequest',
'params': {'id': 'unknown identifier'}
})
def assert_consumer_error(consumer_mock, exception):
"""Assert that the consumer mock has had once call with the given error message and code.
The error's data part is not compared since it contains the traceback.
"""
assert len(consumer_mock.mock_calls) == 1
_name, args, _kwargs = consumer_mock.mock_calls[0]
assert args[0]['error']['message'] == exception.message
assert args[0]['error']['code'] == exception.code
def await_assertion(condition, timeout=3.0, interval=0.1, exc=None):
if timeout <= 0:
raise exc if exc else AssertionError(f"Failed to wait for condition {condition}")
try:
condition()
except AssertionError as e:
time.sleep(interval)
await_assertion(condition, timeout=(timeout - interval), interval=interval, exc=e)
|
