def test_batched_input_one_failure(self):
registry = Registry()
@registry.method(returns=int, x=int, y=int)
def add(x, y):
return x + y
json_data = [{
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": 1,
"y": 2,
},
"id": 1,
}, {
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": "2",
"y": 2,
},
"id": 2,
}]
fake_request = self._create_fake_request(json_data)
json_response = registry.dispatch(fake_request)
response = json.loads(json_response)
expected_response1 = {"jsonrpc": "2.0", "id": 1, "result": 3}
response_by_id = {msg["id"]: msg for msg in response}
assert len(response) == len(json_data)
assert response_by_id[1] == expected_response1
other_response = response_by_id[2]
assert sorted(other_response.keys()) == ["error", "id", "jsonrpc"]
TestDispatch.assert_error(other_response, 2, InvalidParamsError)
def test_batched_input_one_notification(self):
registry = Registry()
@registry.method(returns=int, x=int, y=int)
def add(x, y):
return x + y
json_data = [{
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": 1,
"y": 2,
},
"id": 1,
}, {
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": 2,
"y": 2,
},
}]
fake_request = self._create_fake_request(json_data)
json_response = registry.dispatch(fake_request)
response = json.loads(json_response)
expected_response_by_id = {1: {"jsonrpc": "2.0", "id": 1, "result": 3}}
response_by_id = {msg["id"]: msg for msg in response}
assert len(response) == 1
assert response_by_id == expected_response_by_id
def test_register():
registry = Registry()
def foo(x):
return x
registry.register("bar", foo)
assert registry._name_to_method_info["bar"].method == foo
def test_describe():
registry = Registry()
@registry.method(returns=str, x=int, y=str)
def foo(x, y):
return str(x) + y
foo_desc = {'params': [{'type': 'int', 'name': 'x'},
{'type': 'str', 'name': 'y'}],
'name': 'test_registry.foo',
'returns': 'str',
'description': None}
describe_desc = {'params': [],
'name': 'rpc.describe',
'returns': 'dict',
'description': registry.describe.__doc__}
assert registry.describe()["methods"] == [describe_desc, foo_desc]
docstring = "This is a test."
@registry.method(returns=int, a=int, b=int)
def bar(a, b):
return a + b
bar.__doc__ = docstring
bar_desc = {'params': [{'type': 'int', 'name': 'a'},
{'type': 'int', 'name': 'b'}],
'name': 'test_registry.bar',
'returns': 'int',
'description': docstring}
assert registry.describe()["methods"] == [describe_desc, bar_desc, foo_desc]
def test_register():
registry = Registry()
def foo(x):
return x
registry.register("bar", foo)
assert registry._name_to_method_info["bar"].method == foo
def test_batched_input_empty_array(self):
registry = Registry()
@registry.method(returns=int, x=int, y=int)
def add(x, y):
return x + y
fake_request = self._create_fake_request([])
assert registry.dispatch(fake_request) is None
def test_register_class_method():
registry = Registry()
class Foo(object):
def bar(self):
pass
baz = Foo()
with pytest.raises(Exception):
registry.register("42", baz.bar)
def test_batched_input_empty_array(self):
registry = Registry()
@registry.method(returns=int, x=int, y=int)
def add(x, y):
return x + y
fake_request = self._create_fake_request([])
assert registry.dispatch(fake_request) is None
def test_invalid_json(self):
registry = Registry()
class FakeRequest(object):
def get_data(self, as_text=False):
return '{ "jsonrpc": "2.0", "method":, "id":]'
fake_request = FakeRequest()
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, None, ParseError)
def test_invalid_request_no_method(self):
registry = Registry()
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"params": [1, 2],
"id": "test",
})
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, "test", InvalidRequestError)
def test_invalid_json(self):
registry = Registry()
class FakeRequest(object):
def get_data(self, as_text=False):
return '{ "jsonrpc": "2.0", "method":, "id":]'
fake_request = FakeRequest()
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, None, ParseError)
def test_error_in_function_unknown_id(self):
registry = Registry()
@registry.method(returns=int)
def foo():
raise Exception()
fake_request = self._create_fake_request(["foo"])
result = registry.dispatch(fake_request)
TestDispatch.assert_error(result, None, InvalidRequestError)
def test_invalid_request_no_method(self):
registry = Registry()
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"params": [1, 2],
"id": "test",
})
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, "test", InvalidRequestError)
def test_register_class_method():
registry = Registry()
class Foo(object):
def bar(self):
pass
baz = Foo()
with pytest.raises(Exception):
registry.register("42", baz.bar)
def test_error_in_function_unknown_id(self):
registry = Registry()
@registry.method(returns=int)
def foo():
raise Exception()
fake_request = self._create_fake_request(["foo"])
result = registry.dispatch(fake_request)
TestDispatch.assert_error(result, None, InvalidRequestError)
def test_invalid_method(self):
registry = Registry()
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "bogus",
"params": [1, 2],
"id": "bogus",
})
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, "bogus", MethodNotFoundError)
def test_invalid_method(self):
registry = Registry()
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "bogus",
"params": [1, 2],
"id": "bogus",
})
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, "bogus", MethodNotFoundError)
def test_id_notification(self):
registry = Registry()
@registry.method(returns=int)
def foo():
return 42
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.foo",
})
assert registry.dispatch(fake_request) is None
def test_id_notification(self):
registry = Registry()
@registry.method(returns=int)
def foo():
return 42
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.foo",
})
assert registry.dispatch(fake_request) is None
def test_id_int(self):
registry = Registry()
@registry.method(returns=int)
def foo():
return 42
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.foo",
"id": 1
})
assert json.loads(registry.dispatch(fake_request))["result"] == 42
def test_id_int(self):
registry = Registry()
@registry.method(returns=int)
def foo():
return 42
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.foo",
"id": 1
})
assert json.loads(registry.dispatch(fake_request))["result"] == 42
def test_invalid_request_no_jsonrpc(self):
registry = Registry()
@registry.method(returns=None)
def bogus(*args):
print(args)
fake_request = self._create_fake_request({
"method": "test_registry.bogus",
"params": [1, 2],
"id": "foo",
})
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, "foo", InvalidRequestError)
def test_id_float(self):
registry = Registry()
@registry.method(returns=int)
def foo():
return 42
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.foo",
"id": 4.0
})
result = registry.dispatch(fake_request)
TestDispatch.assert_error(result, 4.0, InvalidRequestError)
def test_id_float(self):
registry = Registry()
@registry.method(returns=int)
def foo():
return 42
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.foo",
"id": 4.0
})
result = registry.dispatch(fake_request)
TestDispatch.assert_error(result, 4.0, InvalidRequestError)
def test_invalid_request_no_jsonrpc(self):
registry = Registry()
@registry.method(returns=None)
def bogus(*args):
print(args)
fake_request = self._create_fake_request({
"method": "test_registry.bogus",
"params": [1, 2],
"id": "foo",
})
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, "foo", InvalidRequestError)
def test_describe():
registry = Registry()
@registry.method(returns=str, x=int, y=str)
def foo(x, y):
return str(x) + y
foo_desc = {
'params': [{
'type': 'int',
'name': 'x'
}, {
'type': 'str',
'name': 'y'
}],
'name': 'test_registry.foo',
'returns': 'str',
'description': None
}
describe_desc = {
'params': [],
'name': 'rpc.describe',
'returns': 'dict',
'description': registry.describe.__doc__
}
assert registry.describe()["methods"] == [describe_desc, foo_desc]
docstring = "This is a test."
@registry.method(returns=int, a=int, b=int)
def bar(a, b):
return a + b
bar.__doc__ = docstring
bar_desc = {
'params': [{
'type': 'int',
'name': 'a'
}, {
'type': 'int',
'name': 'b'
}],
'name': 'test_registry.bar',
'returns': 'int',
'description': docstring
}
assert registry.describe()["methods"] == [
describe_desc, bar_desc, foo_desc
]
def test_invalid_params(self):
registry = Registry()
@registry.method(returns=None)
def foo():
pass
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.foo",
"params": "Hello world",
"id": 42,
})
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, 42, InvalidRequestError)
def test_invalid_params(self):
registry = Registry()
@registry.method(returns=None)
def foo():
pass
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.foo",
"params": "Hello world",
"id": 42,
})
response = registry.dispatch(fake_request)
TestDispatch.assert_error(response, 42, InvalidRequestError)
def test_method_return_type_none():
registry = Registry()
@registry.method(returns=None)
def foo():
pass
foo()
@registry.method(returns=type(None))
def fun():
pass
fun()
@registry.method(returns=type(None), some_text=str)
def bar(some_text):
return some_text
with pytest.raises(InvalidReturnTypeError):
bar("Hello")
@registry.method(returns=None, some_number=int)
def stuff(some_number):
return 2 * some_number
with pytest.raises(InvalidReturnTypeError):
stuff(21)
def test_method_long_parameter():
registry = Registry()
@registry.method(returns=int, some_number=int)
def foo(some_number):
return 2 * some_number
foo(9999999999999999999999)
def test_method_parameter_named_returns():
registry = Registry()
with pytest.raises(Exception):
@registry.method(returns=str, some_number=int)
def foo(some_number, returns):
return str(some_number) + returns
def test_method_no_return_type():
registry = Registry()
with pytest.raises(Exception):
@registry.method(some_number=int)
def foo(some_number):
return some_number
def test_method_wrong_type_declarations():
registry = Registry()
with pytest.raises(Exception):
@registry.method(returns=str, some_text=str, some_number=int)
def foo(some_text, some_stuff):
return some_text + some_stuff
def test_current_request_passed_to_registry(self):
registry = Registry()
server = Server(registry)
def fake_dispatch(request):
assert current_request == request
return json.dumps({"jsonrpc": "2.0", "id": "foo", "result": "bar"})
registry.dispatch = fake_dispatch
environ = {
"SERVER_NAME": "localhost",
"SERVER_PORT": "5060",
"PATH_INFO": "/api",
"REQUEST_METHOD": "POST",
"wsgi.url_scheme": "http",
}
mock_start_response = mock.Mock()
server(environ, mock_start_response)
def test_method_defaults():
registry = Registry()
@registry.method(returns=str, some_number=int, some_text=str)
def foo(some_number, some_text="Test"):
return some_text
assert foo(5) == "Test"
assert foo(5, "Hello") == "Hello"
def test_method_wrong_return_type():
registry = Registry()
@registry.method(returns=str, some_number=int)
def foo(some_number):
return some_number
with pytest.raises(InvalidReturnTypeError):
foo(5)
def test_method():
registry = Registry()
@registry.method(returns=str, x=str)
def foo(x):
return x
expected_name = "{}.{}".format(foo.__module__, foo.__name__)
assert registry._name_to_method_info[expected_name].method == foo
def test_positional_args(self):
registry = Registry()
def add(x, y):
return x + y
registry.register("add", add)
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "add",
"params": [1, 2],
"id": "bogus",
})
response = registry.dispatch(fake_request)
assert response == json.dumps({
"jsonrpc": "2.0",
"id": "bogus",
"result": 3
})
def test_batched_input(self):
registry = Registry()
@registry.method(returns=int, x=int, y=int)
def add(x, y):
return x + y
json_data = [{
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": 1,
"y": 2,
},
"id": 1,
}, {
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": 2,
"y": 2,
},
"id": 2,
}]
fake_request = self._create_fake_request(json_data)
json_response = registry.dispatch(fake_request)
response = json.loads(json_response)
expected_response_by_id = {
1: {
"jsonrpc": "2.0",
"id": 1,
"result": 3
},
2: {
"jsonrpc": "2.0",
"id": 2,
"result": 4
}
}
response_by_id = {msg["id"]: msg for msg in response}
assert len(response) == len(json_data)
assert response_by_id == expected_response_by_id
def test_custom_encoder(self):
def custom_encode(input):
if "foo" in str(input):
return "42"
else:
return json.JSONEncoder().encode(input)
registry = Registry()
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "rpc.describe",
"params": [],
"id": "foo",
})
with mock.patch('typedjsonrpc.registry.Registry.json_encoder.encode', custom_encode):
response = json.loads(registry.dispatch(fake_request))
assert response == 42
def test_method_wrong_argument_order():
registry = Registry()
@registry.method(returns=str, some_text=str, some_number=int)
def foo(some_text, some_number):
return some_text + str(some_number)
assert foo("Answer", 42) == "Answer42"
with pytest.raises(InvalidParamsError):
foo(42, "Answer")
def test_custom_encoder(self):
def custom_encode(input):
if "foo" in str(input):
return "42"
else:
return json.JSONEncoder().encode(input)
registry = Registry()
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "rpc.describe",
"params": [],
"id": "foo",
})
with mock.patch('typedjsonrpc.registry.Registry.json_encoder.encode',
custom_encode):
response = json.loads(registry.dispatch(fake_request))
assert response == 42
def test_serializable_exception(self):
registry = Registry()
random_val = {"foo": "bar"}
@registry.method(returns=None)
def raise_exception():
e = Exception()
e.random = random_val
raise e
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.raise_exception",
"id": "bogus",
})
response = json.loads(registry.dispatch(fake_request))
assert isinstance(response, dict)
assert "error" in response
assert random_val == response["error"]["data"]["random"]
def test_serializable_exception(self):
registry = Registry()
random_val = {"foo": "bar"}
@registry.method(returns=None)
def raise_exception():
e = Exception()
e.random = random_val
raise e
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.raise_exception",
"id": "bogus",
})
response = json.loads(registry.dispatch(fake_request))
assert isinstance(response, dict)
assert "error" in response
assert random_val == response["error"]["data"]["random"]
def test_positional_args(self):
registry = Registry()
def add(x, y):
return x + y
registry.register("add", add)
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "add",
"params": [1, 2],
"id": "bogus",
})
response = registry.dispatch(fake_request)
assert response == json.dumps({
"jsonrpc": "2.0",
"id": "bogus",
"result": 3
})
def test_encoder_exception_batch(self):
registry = Registry()
original_encode = registry.json_encoder.encode
def custom_encode(input):
if "result" in input and input["id"] == "foo":
raise InternalError("Could not parse the input data.")
else:
return original_encode(input)
fake_batch_request = self._create_fake_request([{
"jsonrpc": "2.0",
"method": "rpc.describe",
"params": [],
"id": "foo",
}, {
"jsonrpc": "2.0",
"method": "rpc.describe",
"params": [],
"id": "bar",
}])
with mock.patch('typedjsonrpc.registry.Registry.json_encoder.encode',
custom_encode):
response = json.loads(registry.dispatch(fake_batch_request))
assert isinstance(response, list)
assert len(response) == 2
if response[0]["id"] == "foo":
foo_response = response[0]
bar_response = response[1]
else:
foo_response = response[1]
bar_response = response[0]
TestDispatch.assert_error(foo_response, "foo", InternalError)
assert foo_response["error"][
"data"] == "Could not parse the input data."
assert "error" not in bar_response
def test_batched_input_one_failure(self):
registry = Registry()
@registry.method(returns=int, x=int, y=int)
def add(x, y):
return x + y
json_data = [{
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": 1,
"y": 2,
},
"id": 1,
}, {
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": "2",
"y": 2,
},
"id": 2,
}]
fake_request = self._create_fake_request(json_data)
json_response = registry.dispatch(fake_request)
response = json.loads(json_response)
expected_response1 = {
"jsonrpc": "2.0",
"id": 1,
"result": 3
}
response_by_id = {msg["id"]: msg for msg in response}
assert len(response) == len(json_data)
assert response_by_id[1] == expected_response1
other_response = response_by_id[2]
assert sorted(other_response.keys()) == ["error", "id", "jsonrpc"]
TestDispatch.assert_error(other_response, 2, InvalidParamsError)
def test_non_serializable_exception(self):
registry = Registry()
class NonSerializableObject(object):
pass
@registry.method(returns=None)
def raise_exception():
e = Exception()
e.random = NonSerializableObject()
raise e
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "test_registry.raise_exception",
"id": "bogus",
})
response = json.loads(registry.dispatch(fake_request))
assert isinstance(response, dict)
assert "error" in response
assert isinstance(response["error"]["data"]["random"], six.string_types)
assert NonSerializableObject.__name__ in response["error"]["data"]["random"]
def test_encoder_exception_batch(self):
registry = Registry()
original_encode = registry.json_encoder.encode
def custom_encode(input):
if "result" in input and input["id"] == "foo":
raise InternalError("Could not parse the input data.")
else:
return original_encode(input)
fake_batch_request = self._create_fake_request([{
"jsonrpc": "2.0",
"method": "rpc.describe",
"params": [],
"id": "foo",
}, {
"jsonrpc": "2.0",
"method": "rpc.describe",
"params": [],
"id": "bar",
}])
with mock.patch('typedjsonrpc.registry.Registry.json_encoder.encode', custom_encode):
response = json.loads(registry.dispatch(fake_batch_request))
assert isinstance(response, list)
assert len(response) == 2
if response[0]["id"] == "foo":
foo_response = response[0]
bar_response = response[1]
else:
foo_response = response[1]
bar_response = response[0]
TestDispatch.assert_error(foo_response, "foo", InternalError)
assert foo_response["error"]["data"] == "Could not parse the input data."
assert "error" not in bar_response
def test_encoder_exception_single(self):
registry = Registry()
original_encode = registry.json_encoder.encode
def fake_encode(input):
if "result" in input:
raise InternalError("Could not parse the input data.")
else:
return original_encode(input)
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "rpc.describe",
"params": [],
"id": "foo",
})
with mock.patch('typedjsonrpc.registry.Registry.json_encoder.encode', fake_encode):
response = json.loads(registry.dispatch(fake_request))
assert isinstance(response, dict)
TestDispatch.assert_error(response, "foo", InternalError)
assert response["error"]["data"] == "Could not parse the input data."
def test_encoder_exception_single(self):
registry = Registry()
original_encode = registry.json_encoder.encode
def fake_encode(input):
if "result" in input:
raise InternalError("Could not parse the input data.")
else:
return original_encode(input)
fake_request = self._create_fake_request({
"jsonrpc": "2.0",
"method": "rpc.describe",
"params": [],
"id": "foo",
})
with mock.patch('typedjsonrpc.registry.Registry.json_encoder.encode',
fake_encode):
response = json.loads(registry.dispatch(fake_request))
assert isinstance(response, dict)
TestDispatch.assert_error(response, "foo", InternalError)
assert response["error"]["data"] == "Could not parse the input data."
def test_batched_input_all_notifications(self):
registry = Registry()
@registry.method(returns=int, x=int, y=int)
def add(x, y):
return x + y
json_data = [{
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": 1,
"y": 2,
},
}, {
"jsonrpc": "2.0",
"method": "test_registry.add",
"params": {
"x": 2,
"y": 2,
},
}]
fake_request = self._create_fake_request(json_data)
assert registry.dispatch(fake_request) is None