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
|
import json
import pytest
from unittest import mock
import jsonrpc_base
from jsonrpc_base import Server, ProtocolError, TransportError
pytestmark = pytest.mark.asyncio
class MockTransportError(ValueError):
"""Test exception representing a transport library error."""
class MockServer(Server):
def __init__(self, url):
super(MockServer, self).__init__()
self._url = url
self._handler = None
def send_message(self, message):
"""Issue the request to the server and return the method result"""
try:
if isinstance(message, jsonrpc_base.Request):
data = jsonrpc_base.Request.parse(
json.loads(message.serialize()))
else:
data = message.serialize()
response = json.loads(json.dumps(self._handler(data)))
except Exception as requests_exception:
raise TransportError(
'Transport Error', message, requests_exception)
return message.parse_response(response)
def assertSameJSON(json1, json2):
"""Tells whether two json strings, once decoded, are the same dictionary"""
assert json.loads(json1) == json.loads(json2)
@pytest.fixture
def server():
"""Get the mock server object"""
return MockServer('http://mock/xmlrpc')
def test_dumps(server):
# test no args
assertSameJSON(
'''{"jsonrpc": "2.0", "method": "my_method_name", "id": 1}''',
jsonrpc_base.Request(
'my_method_name', params=None, msg_id=1).serialize()
)
# test zero message ID
assertSameJSON(
'''{"jsonrpc": "2.0", "method": "my_method_name", "id": 0}''',
jsonrpc_base.Request(
'my_method_name', params=None, msg_id=0).serialize()
)
# test empty args dict
assertSameJSON(
'''{"jsonrpc": "2.0", "method": "my_method_name", "id": 1}''',
jsonrpc_base.Request(
'my_method_name', params={}, msg_id=1).serialize()
)
# test empty args array
assertSameJSON(
'''{"jsonrpc": "2.0", "method": "my_method_name", "id": 1}''',
jsonrpc_base.Request(
'my_method_name', params=[], msg_id=1).serialize()
)
# test keyword args
assertSameJSON(
'''{"params": {"foo": "bar"}, "jsonrpc": "2.0", "method":
"my_method_name", "id": 1}''',
jsonrpc_base.Request(
'my_method_name', params={'foo': 'bar'}, msg_id=1).serialize()
)
# test positional args
assertSameJSON(
'''{"params": ["foo", "bar"], "jsonrpc": "2.0", "method":
"my_method_name", "id": 1}''',
jsonrpc_base.Request(
'my_method_name', params=('foo', 'bar'), msg_id=1).serialize()
)
# test notification
assertSameJSON(
'''{"params": ["foo", "bar"], "jsonrpc": "2.0", "method":
"my_method_name"}''',
jsonrpc_base.Request(
'my_method_name', params=('foo', 'bar'), msg_id=None).serialize()
)
def test_parse_result(server):
request = jsonrpc_base.Request('my_message', msg_id=1)
with pytest.raises(ProtocolError, match='Response is not a dictionary'):
request.parse_response([])
with pytest.raises(ProtocolError, match='Response without a result field'):
request.parse_response({})
with pytest.raises(ProtocolError) as protoerror:
body = {
"jsonrpc": "2.0", "error": {
"code": -32601, "message": "Method not found"
}, "id": "1"
}
request.parse_response(body)
assert protoerror.value.args[0] == -32601
assert protoerror.value.args[1] == 'Method not found'
def test_send_message(server):
empty_server = Server()
with pytest.raises(NotImplementedError):
empty_server.send_message(jsonrpc_base.Request('my_method', msg_id=1))
# catch non-json responses
with pytest.raises(TransportError) as transport_error:
def handler(message):
raise MockTransportError("Transport Error")
server._handler = handler
server.send_message(jsonrpc_base.Request('my_method', msg_id=1))
assert transport_error.value.args[0] == (
"Error calling method 'my_method': Transport Error")
assert isinstance(transport_error.value.args[1], MockTransportError)
# a notification
def handler(message):
return 'we dont care about this'
server._handler = handler
server.send_message(jsonrpc_base.Request('my_notification', msg_id=None))
def test_exception_passthrough(server):
with pytest.raises(TransportError) as transport_error:
def handler(message):
raise MockTransportError("Transport Error")
server._handler = handler
server.foo()
assert transport_error.value.args[0] == (
"Error calling method 'foo': Transport Error")
assert isinstance(transport_error.value.args[1], MockTransportError)
def test_transport_error_constructor(server):
with pytest.raises(TransportError, match='Test Message'):
raise TransportError('Test Message')
def test_forbid_private_methods(server):
"""Test that we can't call private class methods"""
with pytest.raises(AttributeError):
server._foo()
# nested private method call
with pytest.raises(AttributeError):
server.foo.bar._baz()
def test_method_call(server):
"""mixing *args and **kwargs is forbidden by the spec"""
with pytest.raises(
ProtocolError,
match='JSON-RPC spec forbids mixing arguments and keyword '
'arguments'):
server.testmethod(1, 2, a=1, b=2)
def test_method_nesting(server):
"""Test that we correctly nest namespaces"""
def handler(message):
return {
"jsonrpc": "2.0",
"result": True if message.params[0] == message.method else False,
"id": 1,
}
server._handler = handler
assert server.nest.testmethod("nest.testmethod")
assert server.nest.testmethod.some.other.method(
"nest.testmethod.some.other.method")
def test_calls(server):
# rpc call with positional parameters:
def handler1(message):
assert message.msg_id == "abcd-1234"
assert message.params == [42, 23]
return {
"jsonrpc": "2.0",
"result": 19,
"id": 1,
}
server._handler = handler1
with mock.patch("uuid.uuid4", return_value="abcd-1234"):
assert server.subtract(42, 23) == 19
# rpc call with named parameters
def handler2(message):
assert message.params == {'y': 23, 'x': 42}
return {
"jsonrpc": "2.0",
"result": 19,
"id": 1,
}
server._handler = handler2
assert server.subtract(x=42, y=23) == 19
# rpc call with a mapping type
def handler3(message):
assert message.params == [{'foo': 'bar'}]
return {
"jsonrpc": "2.0",
"result": None,
"id": 1,
}
server._handler = handler3
server.foobar({'foo': 'bar'})
# rpc call with direct dict params
def handler3(message):
assert message.params == {'foo': 'bar'}
return {
"jsonrpc": "2.0",
"result": None,
"id": 1,
}
server._handler = handler3
server.foobar(**{'foo': 'bar'})
def test_notification(server):
# Verify that we ignore the server response
def handler(message):
return {
"jsonrpc": "2.0",
"result": 19,
"id": 3,
}
server._handler = handler
assert server.subtract(42, 23, _notification=True) is None
def test_receive_server_requests(server):
def event_handler(*args, **kwargs):
return args, kwargs
server.on_server_event = event_handler
server.namespace.on_server_event = event_handler
response = server.receive_request(jsonrpc_base.Request(
'on_server_event', msg_id=1))
args, kwargs = response.result
assert len(args) == 0
assert len(kwargs) == 0
# Test with a zero message ID
response = server.receive_request(jsonrpc_base.Request(
'on_server_event', msg_id=0))
args, kwargs = response.result
assert len(args) == 0
assert len(kwargs) == 0
response = server.receive_request(jsonrpc_base.Request(
'namespace.on_server_event', msg_id=1))
args, kwargs = response.result
assert len(args) == 0
assert len(kwargs) == 0
response = server.receive_request(jsonrpc_base.Request(
'on_server_event', params=['foo', 'bar'], msg_id=1))
args, kwargs = response.result
assert args == ('foo', 'bar')
assert len(kwargs) == 0
response = server.receive_request(jsonrpc_base.Request(
'on_server_event', params={'foo': 'bar'}, msg_id=1))
args, kwargs = response.result
assert len(args) == 0
assert kwargs == {'foo': 'bar'}
with pytest.raises(ProtocolError):
response = server.receive_request(jsonrpc_base.Request(
'on_server_event', params="string_params", msg_id=1))
response = server.receive_request(jsonrpc_base.Request(
'missing_event', params={'foo': 'bar'}, msg_id=1))
assert response.error['code'] == -32601
assert response.error['message'] == 'Method not found'
response = server.receive_request(jsonrpc_base.Request(
'on_server_event'))
assert response is None
def bad_handler():
raise Exception("Bad Server Handler")
server.on_bad_handler = bad_handler
# receive_request will normally print traceback when an exception is caught
# This isn't necessary for the test
response = server.receive_request(jsonrpc_base.Request(
'on_bad_handler', msg_id=1))
assert response.error['code'] == -32000
assert response.error['message'] == 'Server Error: Bad Server Handler'
async def async_event_handler(*args, **kwargs):
return args, kwargs
server.on_async_server_event = async_event_handler
response = server.receive_request(jsonrpc_base.Request(
'on_async_server_event', msg_id=1))
assert response.error['code'] == -32000
assert response.error['message'] == (
'Server Error: Async handlers are not'
' supported in synchronous sever implementations')
async def test_async_receive_server_requests(server):
def event_handler(*args, **kwargs):
return args, kwargs
server.on_server_event = event_handler
server.namespace.on_server_event = event_handler
response = await server.async_receive_request(jsonrpc_base.Request(
'on_server_event', msg_id=1))
args, kwargs = response.result
assert len(args) == 0
assert len(kwargs) == 0
async def async_event_handler(*args, **kwargs):
return args, kwargs
server.on_async_server_event = async_event_handler
response = await server.async_receive_request(jsonrpc_base.Request(
'on_async_server_event', msg_id=1))
args, kwargs = response.result
assert len(args) == 0
assert len(kwargs) == 0
response = await server.async_receive_request(jsonrpc_base.Request(
'missing_event', params={'foo': 'bar'}, msg_id=1))
assert response.error['code'] == -32601
assert response.error['message'] == 'Method not found'
response = await server.async_receive_request(jsonrpc_base.Request(
'on_server_event'))
assert response is None
async def test_server_responses(server):
def handler(message):
handler.response = message
server._handler = handler
def subtract(foo, bar):
return foo - bar
server.subtract = subtract
response = server.receive_request(jsonrpc_base.Request(
'subtract', params={'foo': 5, 'bar': 3}, msg_id=1))
server.send_message(response)
assertSameJSON(
'''{"jsonrpc": "2.0", "result": 2, "id": 1}''',
handler.response
)
response = server.receive_request(jsonrpc_base.Request(
'subtract', params=[11, 7], msg_id=1))
server.send_message(response)
assertSameJSON(
'''{"jsonrpc": "2.0", "result": 4, "id": 1}''',
handler.response
)
response = server.receive_request(jsonrpc_base.Request(
'missing_method', msg_id=1))
server.send_message(response)
assertSameJSON(
'''{"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method'''
''' not found"}, "id": 1}''',
handler.response
)
def bad_handler(self):
raise MockTransportError("Transport Error")
server._handler = bad_handler
def good_method():
return True
server.good_method = good_method
response = server.receive_request(jsonrpc_base.Request(
'good_method', msg_id=1))
with pytest.raises(
TransportError,
match="Error responding to server method 'good_method': "
"Transport Error"):
server.send_message(response)
async def async_bad_method():
raise ValueError("Mock server error")
server.async_bad_method = async_bad_method
response = await server.async_receive_request(jsonrpc_base.Request(
'async_bad_method', msg_id=1))
with pytest.raises(
TransportError,
match="Error responding to server method 'async_bad_method': "
"Transport Error"):
server.send_message(response)
def test_base_message(server):
message = jsonrpc_base.Message()
assert message.response_id is None
with pytest.raises(NotImplementedError):
message.serialize()
with pytest.raises(NotImplementedError):
message.parse_response(None)
with pytest.raises(NotImplementedError):
message.transport_error_text
with pytest.raises(NotImplementedError):
str(message)
def test_request(server):
with pytest.raises(
ProtocolError,
match='Request from server does not contain method'):
jsonrpc_base.Request.parse({})
with pytest.raises(
ProtocolError,
match='Parameters must either be a positional list or named dict.'
):
jsonrpc_base.Request.parse(
{'method': 'test_method', 'params': 'string_params'})
request = jsonrpc_base.Request('test_method', msg_id=1)
assert request.response_id == 1
def test_jsonrpc_1_0_call(server):
# JSON-RPC 1.0 spec needs "error" to be present (with `null` value) when no
# error occured
def handler(message):
assert message.params == [42, 23]
return {
"result": 19,
"id": 1,
"error": None,
}
server._handler = handler
assert server.subtract(42, 23) == 19
|