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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import json
import six
import pytest
from tinyrpc import MethodNotFoundError, InvalidRequestError, ServerError, \
RPCError, RPCResponse, InvalidReplyError
from tinyrpc.protocols.jsonrpc import JSONRPCParseError, \
JSONRPCInvalidRequestError, \
JSONRPCMethodNotFoundError, \
JSONRPCInvalidParamsError, \
JSONRPCInternalError
def _json_equal(a, b):
da = json.loads(a)
db = json.loads(b)
return da == db
@pytest.fixture
def prot():
from tinyrpc.protocols.jsonrpc import JSONRPCProtocol
return JSONRPCProtocol()
@pytest.mark.parametrize(('data', 'attrs'), [
# examples from the spec, parsing only
("""{"jsonrpc": "2.0", "method": "subtract",
"params": [42, 23], "id": 1}""",
{'method': 'subtract', 'args': [42, 23], 'unique_id': 1}
),
("""{"jsonrpc": "2.0", "method": "subtract", "params":
[23, 42], "id": 2}""",
{'method': 'subtract', 'args': [23, 42], 'unique_id': 2}
),
("""{"jsonrpc": "2.0", "method": "subtract", "params":
{"subtrahend": 23, "minuend": 42}, "id": 3}""",
{'method': 'subtract', 'kwargs': {'subtrahend': 23, 'minuend': 42},
'unique_id': 3}
),
("""{"jsonrpc": "2.0", "method": "subtract", "params": {"minuend": 42,
"subtrahend": 23}, "id": 4}""",
{'method': 'subtract', 'kwargs': {'minuend': 42, 'subtrahend': 23},
'unique_id': 4},
),
("""{"jsonrpc": "2.0", "method": "update", "params": [1,2,3,4,5]}""",
{'method': 'update', 'args': [1, 2, 3, 4, 5]}
),
("""{"jsonrpc": "2.0", "method": "foobar"}""",
{'method': 'foobar'}
),
])
def test_parsing_good_request_samples(prot, data, attrs):
req = prot.parse_request(data)
for k, v in six.iteritems(attrs):
assert getattr(req, k) == v
@pytest.mark.parametrize('invalid_json', [
'{"jsonrpc": "2.0", "method": "foobar, "params": "bar", "baz]',
'garbage',
])
def test_parsing_invalid_json(prot, invalid_json):
with pytest.raises(JSONRPCParseError):
prot.parse_request(invalid_json)
def test_parsing_invalid_arguments(prot):
with pytest.raises(JSONRPCInvalidParamsError):
prot.parse_request(
"""{"jsonrpc": "2.0", "method": "update", "params": 9}"""
)
@pytest.mark.parametrize(('data', 'id', 'result'), [
("""{"jsonrpc": "2.0", "result": 19, "id": 1}""",
1,
19,
),
("""{"jsonrpc": "2.0", "result": -19, "id": 2}""",
2,
-19,
),
("""{"jsonrpc": "2.0", "result": 19, "id": 3}""",
3,
19,
),
("""{"jsonrpc": "2.0", "result": 19, "id": 4}""",
4,
19,
),
])
def test_good_reply_samples(prot, data, id, result):
reply = prot.parse_reply(data)
assert reply.unique_id == id
assert reply.result == result
@pytest.mark.parametrize(('exc', 'code', 'message'), [
(JSONRPCParseError, -32700, 'Parse error'),
(JSONRPCInvalidRequestError, -32600, 'Invalid Request'),
(JSONRPCMethodNotFoundError, -32601, 'Method not found'),
(JSONRPCInvalidParamsError, -32602, 'Invalid params'),
(JSONRPCInternalError, -32603, 'Internal error'),
# generic errors
#(InvalidRequestError, -32600, 'Invalid Request'),
#(MethodNotFoundError, -32601, 'Method not found'),
#(ServerError, -32603, 'Internal error'),
])
def test_proper_construction_of_error_codes(prot, exc, code, message):
request = prot.parse_request(
"""{"jsonrpc": "2.0", "method": "sum", "params": [1,2,4],
"id": "1"}"""
)
reply = exc().error_respond().serialize()
err = json.loads(reply)
assert err['error']['code'] == code
assert err['error']['message'] == message
def test_notification_yields_None_response(prot):
data = """{"jsonrpc": "2.0", "method": "update", "params": [1,2,3,4,5]}"""
req = prot.parse_request(data)
# updates should never cause retries
assert req.respond(True) == None
def test_batch_empty_array(prot):
with pytest.raises(JSONRPCInvalidRequestError):
prot.parse_request("""[]""")
def test_batch_invalid_array(prot):
assert isinstance(prot.parse_request("""[1]""")[0],
JSONRPCInvalidRequestError)
def test_batch_invalid_batch(prot):
for r in prot.parse_request("""[1, 2, 3]"""):
assert isinstance(r, JSONRPCInvalidRequestError)
def test_batch_good_examples(prot):
data = """
[
{"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"},
{"jsonrpc": "2.0", "method": "notify_hello", "params": [7]},
{"jsonrpc": "2.0", "method": "subtract", "params": [42,23], "id": "2"},
{"foo": "boo"},
{"jsonrpc": "2.0", "method": "foo.get", "params": {"name": "myself"}, "id": "5"},
{"jsonrpc": "2.0", "method": "get_data", "id": "9"}
]
"""
results = prot.parse_request(data)
assert isinstance(results, list)
assert results[0].method == 'sum'
assert results[0].args == [1, 2, 4]
assert results[0].unique_id == "1"
assert results[1].method == 'notify_hello'
assert results[1].args == [7]
assert results[1].unique_id == None
assert results[2].method == 'subtract'
assert results[2].args == [42, 23]
assert results[2].unique_id == "2"
assert isinstance(results[3], JSONRPCInvalidRequestError)
assert results[4].method == 'foo.get'
assert results[4].kwargs == {'name': 'myself'}
assert results[4].unique_id == "5"
assert results[5].method == 'get_data'
assert results[5].args == []
assert results[5].kwargs == {}
assert results[5].unique_id == "9"
def test_unique_ids(prot):
req1 = prot.create_request('foo', [1, 2])
req2 = prot.create_request('foo', [1, 2])
assert req1.unique_id != req2.unique_id
def test_out_of_order(prot):
req = prot.create_request('foo', ['a', 'b'], None)
rep = req.respond(1)
assert req.unique_id == rep.unique_id
def test_request_generation(prot):
jdata = json.loads(prot.create_request('subtract', [42, 23]).serialize())
assert jdata['method'] == 'subtract'
assert jdata['params'] == [42, 23]
assert jdata['id'] != None
assert jdata['jsonrpc'] == '2.0'
def test_jsonrpc_spec_v2_example1(prot):
# reset id counter
prot._id_counter = 0
request = prot.create_request('subtract', [42, 23])
assert _json_equal(
"""{"jsonrpc": "2.0", "method": "subtract", "params": [42, 23], "id":
1}""",
request.serialize()
)
reply = request.respond(19)
assert _json_equal(
"""{"jsonrpc": "2.0", "result": 19, "id": 1}""",
reply.serialize()
)
request = prot.create_request('subtract', [23, 42])
assert _json_equal(
"""{"jsonrpc": "2.0", "method": "subtract", "params": [23, 42], "id": 2}""",
request.serialize()
)
reply = request.respond(-19)
assert _json_equal(
"""{"jsonrpc": "2.0", "result": -19, "id": 2}""",
reply.serialize()
)
def test_jsonrpc_spec_v2_example2(prot):
# reset id counter
prot._id_counter = 2
request = prot.create_request('subtract',
kwargs={'subtrahend': 23, 'minuend': 42})
assert _json_equal(
"""{"jsonrpc": "2.0", "method": "subtract", "params":
{"subtrahend": 23, "minuend": 42}, "id": 3}""",
request.serialize()
)
reply = request.respond(19)
assert _json_equal(
"""{"jsonrpc": "2.0", "result": 19, "id": 3}""",
reply.serialize()
)
request = prot.create_request('subtract',
kwargs={'subtrahend': 23, 'minuend': 42})
assert _json_equal(
"""{"jsonrpc": "2.0", "method": "subtract", "params": {"minuend":
42, "subtrahend": 23}, "id": 4}""",
request.serialize()
)
reply = request.respond(-19)
assert _json_equal(
"""{"jsonrpc": "2.0", "result": -19, "id": 4}""",
reply.serialize()
)
def test_jsonrpc_spec_v2_example3(prot):
request = prot.create_request('update', [1, 2, 3, 4, 5], one_way=True)
assert _json_equal(
"""{"jsonrpc": "2.0", "method": "update", "params": [1,2,3,4,5]}""",
request.serialize()
)
request = prot.create_request('foobar', one_way=True)
assert _json_equal(
"""{"jsonrpc": "2.0", "method": "foobar"}""",
request.serialize()
)
def test_jsonrpc_spec_v2_example4(prot):
request = prot.create_request('foobar')
request.unique_id = str(1)
assert _json_equal(
"""{"jsonrpc": "2.0", "method": "foobar", "id": "1"}""",
request.serialize()
)
response = request.error_respond(MethodNotFoundError('foobar'))
assert _json_equal(
"""{"jsonrpc": "2.0", "error": {"code": -32601, "message":
"Method not found"}, "id": "1"}""",
response.serialize()
)
def test_jsonrpc_spec_v2_example5(prot):
try:
prot.parse_request(
"""{"jsonrpc": "2.0", "method": "foobar, "params":
"bar", "baz]""")
assert False # parsing must fail
except JSONRPCParseError as error:
e = error
response = e.error_respond()
assert _json_equal(
"""{"jsonrpc": "2.0", "error": {"code": -32700, "message":
"Parse error"}, "id": null}""",
response.serialize()
)
def test_jsonrpc_spec_v2_example6(prot):
try:
prot.parse_request(
"""{"jsonrpc": "2.0", "method": 1, "params": "bar"}""")
assert False # parsing must fail
except JSONRPCInvalidRequestError as error:
e = error
response = e.error_respond()
assert _json_equal(
"""{"jsonrpc": "2.0", "error": {"code": -32600, "message":
"Invalid Request"}, "id": null}""",
response.serialize()
)
def test_jsonrpc_spec_v2_example7(prot):
try:
prot.parse_request("""[
{"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"},
{"jsonrpc": "2.0", "method" ]""")
assert False
except JSONRPCParseError as error:
e = error
response = e.error_respond()
assert _json_equal(
"""{"jsonrpc": "2.0", "error": {"code": -32700, "message":
"Parse error"}, "id": null}""",
response.serialize()
)
def test_jsonrpc_spec_v2_example8(prot):
try:
prot.parse_request("""[]""")
assert False
except JSONRPCInvalidRequestError as error:
e = error
response = e.error_respond()
assert _json_equal("""{"jsonrpc": "2.0", "error": {"code": -32600,
"message": "Invalid Request"}, "id": null}""",
response.serialize())
def test_jsonrpc_spec_v2_example9(prot):
requests = prot.parse_request("""[1]""")
assert isinstance(requests[0], JSONRPCInvalidRequestError)
responses = requests.create_batch_response()
responses.append(requests[0].error_respond())
assert _json_equal("""[ {"jsonrpc": "2.0", "error": {"code": -32600,
"message": "Invalid Request"}, "id": null} ]""",
responses.serialize())
def test_jsonrpc_spec_v2_example10(prot):
requests = prot.parse_request("""[1, 2, 3]""")
assert isinstance(requests[0], JSONRPCInvalidRequestError)
assert isinstance(requests[1], JSONRPCInvalidRequestError)
assert isinstance(requests[2], JSONRPCInvalidRequestError)
responses = requests.create_batch_response()
responses.append(requests[0].error_respond())
responses.append(requests[1].error_respond())
responses.append(requests[2].error_respond())
assert _json_equal("""[
{"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null},
{"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null},
{"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null}
]""",
responses.serialize())
def test_jsonrpc_spec_v2_example11(prot):
requests = prot.parse_request("""[
{"jsonrpc": "2.0", "method": "sum", "params": [1,2,4], "id": "1"},
{"jsonrpc": "2.0", "method": "notify_hello", "params": [7]},
{"jsonrpc": "2.0", "method": "subtract", "params": [42,23], "id": "2"},
{"foo": "boo"},
{"jsonrpc": "2.0", "method": "foo.get", "params": {"name": "myself"}, "id": "5"},
{"jsonrpc": "2.0", "method": "get_data", "id": "9"}
]""")
assert isinstance(requests[3], JSONRPCInvalidRequestError)
responses = requests.create_batch_response()
responses.append(requests[0].respond(7))
responses.append(requests[2].respond(19))
responses.append(requests[3].error_respond())
responses.append(requests[4].error_respond(MethodNotFoundError('foo.get')))
responses.append(requests[5].respond(['hello', 5]))
assert _json_equal("""[
{"jsonrpc": "2.0", "result": 7, "id": "1"},
{"jsonrpc": "2.0", "result": 19, "id": "2"},
{"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null},
{"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found"}, "id": "5"},
{"jsonrpc": "2.0", "result": ["hello", 5], "id": "9"}
]""",
responses.serialize())
def test_jsonrpc_spec_v2_example12(prot):
reqs = []
reqs.append(prot.create_request('notify_sum', [1, 2, 4], one_way=True))
reqs.append(prot.create_request('notify_hello', [7], one_way=True))
request = prot.create_batch_request(reqs)
assert request.create_batch_response() == None
def test_can_get_custom_error_messages_out(prot):
request = prot.create_request('foo')
custom_msg = 'join the army, they said. see the world, they said.'
e = Exception(custom_msg)
response = request.error_respond(e)
data = json.loads(response.serialize())
assert data['error']['message'] == custom_msg
def test_accepts_empty_but_not_none_args_kwargs(prot):
request = prot.create_request('foo', args=[], kwargs={})
def test_missing_jsonrpc_version_on_request(prot):
with pytest.raises(JSONRPCInvalidRequestError):
prot.parse_request('{"method": "sum", "params": [1,2,4], "id": "1"}')
def test_missing_jsonrpc_version_on_reply(prot):
with pytest.raises(InvalidReplyError):
prot.parse_reply('{"result": 7, "id": "1"}')
|