Skip to content

[Matthew D'Alonzo] initial commit #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stevenhartley merged 8 commits into from
Mar 5, 2024
Merged

[Matthew D'Alonzo] initial commit #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3326b81
[Matthew D'Alonzo] initial commit
matthewd0123 Feb 23, 2024
2070209
[Matthew D'Alonzo] Removed protos from repository, added proto compil…
matthewd0123 Mar 1, 2024
b834790
Re-Added cloudevents_pb2.py
matthewd0123 Mar 1, 2024
5d156e3
Add missing dependencies and fix uri serializer test
neelam-kushwah Mar 1, 2024
1134cf9
Resolved PR comments: removed javadoc references, changed send api to…
matthewd0123 Mar 3, 2024
1c26b1d
Made on_receive receive uMessages, removed payload reference in rpcma…
matthewd0123 Mar 3, 2024
586252c
Fixed rpcmapper tests
matthewd0123 Mar 3, 2024
980e9f3
Bug fix
neelam-kushwah Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ python -m pip install .

*This will install the up-python, making its classes and modules available for import in your python code.*

=== Using The Sdk
=== Using The Library

The SDK is broken up into different packages that are described in <<sdk-packages>> below. Each package contains a README.adoc file that describes the purpose of the package and how to use it. Packages are organized into the following directories:
The Library is broken up into different packages that are described in <<sdk-packages>> below. Each package contains a README.adoc file that describes the purpose of the package and how to use it. Packages are organized into the following directories:

.Package Folders
[#pkg-folders,width=100%,cols="20%,80%",options="header"]
Expand Down
75 changes: 43 additions & 32 deletions tests/test_rpc/test_rpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,26 @@
from concurrent.futures import Future
from google.protobuf.any_pb2 import Any
from google.protobuf.wrappers_pb2 import Int32Value
from uprotocol.rpc.calloptions import CallOptions

from uprotocol.cloudevent.cloudevents_pb2 import CloudEvent
from uprotocol.proto.uattributes_pb2 import UPriority
from uprotocol.proto.upayload_pb2 import UPayload, UPayloadFormat
from uprotocol.proto.uri_pb2 import UUri, UEntity
from uprotocol.proto.uri_pb2 import UUri, UEntity, UAuthority
from uprotocol.proto.ustatus_pb2 import UStatus, UCode
from uprotocol.rpc.rpcclient import RpcClient
from uprotocol.rpc.rpcmapper import RpcMapper
from uprotocol.rpc.rpcresult import RpcResult
from uprotocol.transport.builder.uattributesbuilder import UAttributesBuilder
from uprotocol.uri.serializer.longuriserializer import LongUriSerializer
from uprotocol.uri.factory.uresource_builder import UResourceBuilder
from uprotocol.proto.umessage_pb2 import UMessage


def build_source():
return UUri(authority=UAuthority(name="vcu.someVin.veh.ultifi.gm.com"),
entity=UEntity(name="petapp.ultifi.gm.com", version_major=1),
resource=UResourceBuilder.for_rpc_request(None))


def build_cloud_event():
Expand All @@ -55,77 +65,77 @@ def build_topic():
return LongUriSerializer().deserialize("//vcu.vin/hartley/1/rpc.Raise")


def build_uattributes():
return UAttributesBuilder.request(UPriority.UPRIORITY_CS4, UUri(entity=UEntity(name="hartley")), 1000).build()
def build_calloptions():
return CallOptions()


class ReturnsNumber3(RpcClient):
def invoke_method(self, topic, payload, attributes):
def invoke_method(self, topic: UUri, payload: UPayload, options: CallOptions):
future = Future()
any_obj = Any()
any_obj.Pack(Int32Value(value=3))
data = UPayload(format=UPayloadFormat.UPAYLOAD_FORMAT_PROTOBUF, value=any_obj.SerializeToString())
future.set_result(data)
future.set_result(UMessage(payload=data))
return future


class HappyPath(RpcClient):
def invoke_method(self, topic, payload, attributes):
def invoke_method(self, topic: UUri, payload: UPayload, options: CallOptions):
future = Future()
data = build_upayload()
future.set_result(data)
future.set_result(UMessage(payload=data))
return future


class WithUStatusCodeInsteadOfHappyPath(RpcClient):
def invoke_method(self, topic, payload, attributes):
def invoke_method(self, topic: UUri, payload: UPayload, options: CallOptions):
future = Future()
status = UStatus(code=UCode.INVALID_ARGUMENT, message="boom")
any_value = Any()
any_value.Pack(status)
data = UPayload(format=UPayloadFormat.UPAYLOAD_FORMAT_PROTOBUF, value=any_value.SerializeToString())
future.set_result(data)
future.set_result(UMessage(payload=data))
return future


class WithUStatusCodeHappyPath(RpcClient):
def invoke_method(self, topic, payload, attributes):
def invoke_method(self, topic: UUri, payload: UPayload, options: CallOptions):
future = Future()
status = UStatus(code=UCode.OK, message="all good")
any_value = Any()
any_value.Pack(status)
data = UPayload(format=UPayloadFormat.UPAYLOAD_FORMAT_PROTOBUF, value=any_value.SerializeToString())
future.set_result(data)
future.set_result(UMessage(payload=data))
return future


class ThatBarfsCrapyPayload(RpcClient):
def invoke_method(self, topic, payload, attributes):
def invoke_method(self, topic: UUri, payload: UPayload, options: CallOptions):
future = Future()
response = UPayload(format=UPayloadFormat.UPAYLOAD_FORMAT_RAW, value=bytes([0]))
future.set_result(response)
future.set_result(UMessage(payload=response))
return future


class ThatCompletesWithAnException(RpcClient):
def invoke_method(self, topic, payload, attributes):
def invoke_method(self, topic: UUri, payload: UPayload, options: CallOptions):
future = Future()
future.set_exception(RuntimeError("Boom"))
return future


class ThatReturnsTheWrongProto(RpcClient):
def invoke_method(self, topic, payload, attributes):
def invoke_method(self, topic: UUri, payload: UPayload, options: CallOptions):
future = Future()
any_value = Any()
any_value.Pack(Int32Value(value=42))
data = UPayload(format=UPayloadFormat.UPAYLOAD_FORMAT_PROTOBUF, value=any_value.SerializeToString())
future.set_result(data)
future.set_result(UMessage(payload=data))
return future


class WithNullInPayload(RpcClient):
def invoke_method(self, topic, payload, attributes):
def invoke_method(self, topic: UUri, payload: UPayload, options: CallOptions):
future = Future()
future.set_result(None)
return future
Expand Down Expand Up @@ -170,14 +180,14 @@ class TestRpc(unittest.TestCase):

def test_compose_happy_path(self):
rpc_response = RpcMapper.map_response_to_result(
ReturnsNumber3().invoke_method(build_topic(), build_upayload(), build_uattributes()), Int32Value)
ReturnsNumber3().invoke_method(build_topic(), build_upayload(), build_calloptions()), Int32Value)
mapped = rpc_response.map(lambda x: x.value + 5)
self.assertTrue(rpc_response.isSuccess())
self.assertEqual(8, mapped.successValue())

def test_compose_that_returns_status(self):
rpc_response = RpcMapper.map_response_to_result(
WithUStatusCodeInsteadOfHappyPath().invoke_method(build_topic(), build_upayload(), build_uattributes()),
WithUStatusCodeInsteadOfHappyPath().invoke_method(build_topic(), build_upayload(), build_calloptions()),
Int32Value)
mapped = rpc_response.map(lambda x: x.value + 5)
self.assertTrue(rpc_response.isFailure())
Expand All @@ -186,7 +196,7 @@ def test_compose_that_returns_status(self):

def test_compose_with_failure(self):
rpc_response = RpcMapper.map_response_to_result(
ThatCompletesWithAnException().invoke_method(build_topic(), build_upayload(), build_uattributes()),
ThatCompletesWithAnException().invoke_method(build_topic(), build_upayload(), build_calloptions()),
Int32Value)
mapped = rpc_response.map(lambda x: x.value + 5)
self.assertTrue(rpc_response.isFailure())
Expand All @@ -195,47 +205,48 @@ def test_compose_with_failure(self):

def test_success_invoke_method_happy_flow_using_mapResponseToRpcResponse(self):
rpc_response = RpcMapper.map_response_to_result(
HappyPath().invoke_method(build_topic(), build_upayload(), build_uattributes()),
HappyPath().invoke_method(build_topic(), build_upayload(), build_calloptions()),
CloudEvent)
self.assertTrue(rpc_response.isSuccess())
self.assertEqual(build_cloud_event(), rpc_response.successValue())

def test_fail_invoke_method_when_invoke_method_returns_a_status_using_mapResponseToRpcResponse(self):
rpc_response = RpcMapper.map_response_to_result(
WithUStatusCodeInsteadOfHappyPath().invoke_method(build_topic(), build_upayload(), build_uattributes()),
WithUStatusCodeInsteadOfHappyPath().invoke_method(build_topic(), build_upayload(), build_calloptions()),
CloudEvent)
self.assertTrue(rpc_response.isFailure())
self.assertEqual(UCode.INVALID_ARGUMENT, rpc_response.failureValue().code)
self.assertEqual("boom", rpc_response.failureValue().message)

def test_fail_invoke_method_when_invoke_method_threw_an_exception_using_mapResponseToRpcResponse(self):
rpc_response = RpcMapper.map_response_to_result(
ThatCompletesWithAnException().invoke_method(build_topic(), build_upayload(), build_uattributes()),
ThatCompletesWithAnException().invoke_method(build_topic(), build_upayload(), build_calloptions()),
CloudEvent)
self.assertTrue(rpc_response.isFailure())
self.assertEqual(UCode.UNKNOWN, rpc_response.failureValue().code)
self.assertEqual("Boom", rpc_response.failureValue().message)

def test_fail_invoke_method_when_invoke_method_returns_a_bad_proto_using_mapResponseToRpcResponse(self):
rpc_response = RpcMapper.map_response_to_result(
ThatReturnsTheWrongProto().invoke_method(build_topic(), build_upayload(), build_uattributes()),
ThatReturnsTheWrongProto().invoke_method(build_topic(), build_upayload(), build_calloptions()),
CloudEvent)
self.assertTrue(rpc_response.isFailure())
self.assertEqual(UCode.UNKNOWN, rpc_response.failureValue().code)
self.assertEqual("Unknown payload type [type.googleapis.com/google.protobuf.Int32Value]. Expected [io.cloudevents.v1.CloudEvent]", rpc_response.failureValue().message)
self.assertEqual(
"Unknown payload type [type.googleapis.com/google.protobuf.Int32Value]. Expected ["
"io.cloudevents.v1.CloudEvent]",
rpc_response.failureValue().message)

def test_success_invoke_method_happy_flow_using_mapResponse(self):
rpc_response = RpcMapper.map_response(
HappyPath().invoke_method(build_topic(), build_upayload(), build_uattributes()),
HappyPath().invoke_method(build_topic(), build_upayload(), build_calloptions()),
CloudEvent)
self.assertEqual(build_cloud_event(), rpc_response.result())

def test_fail_invoke_method_when_invoke_method_returns_a_status_using_mapResponse(self):
rpc_response = RpcMapper.map_response(
WithUStatusCodeInsteadOfHappyPath().invoke_method(build_topic(), build_upayload(), build_uattributes()),
WithUStatusCodeInsteadOfHappyPath().invoke_method(build_topic(), build_upayload(), build_calloptions()),
CloudEvent)
exception=RuntimeError("Unknown payload type [type.googleapis.com/uprotocol.v1.UStatus]. Expected [CloudEvent]")
self.assertEqual(str(exception),str(rpc_response.exception()))



exception = RuntimeError(
"Unknown payload type [type.googleapis.com/uprotocol.v1.UStatus]. Expected [CloudEvent]")
self.assertEqual(str(exception), str(rpc_response.exception()))
22 changes: 16 additions & 6 deletions tests/test_transport/test_builder/test_uattributesbuilder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,14 @@
from uprotocol.transport.builder.uattributesbuilder import UAttributesBuilder
from uprotocol.proto.uattributes_pb2 import UPriority, UMessageType
from uprotocol.proto.uri_pb2 import UUri, UAuthority, UEntity
from uprotocol.uri.builder.uresource_builder import UResourceBuilder
from uprotocol.uri.factory.uresource_builder import UResourceBuilder
from uprotocol.uuid.factory.uuidfactory import Factories

def build_source():
return UUri(authority=UAuthority(name="vcu.someVin.veh.ultifi.gm.com"),
entity=UEntity(name="petapp.ultifi.gm.com", version_major=1),
resource=UResourceBuilder.for_rpc_request(None))


def build_sink():
return UUri(authority=UAuthority(name="vcu.someVin.veh.ultifi.gm.com"),
Expand All @@ -46,16 +51,18 @@ def get_uuid():
class TestUAttributesBuilder(unittest.TestCase):

def test_publish(self):
builder = UAttributesBuilder.publish(UPriority.UPRIORITY_CS1)
source = build_source()
builder = UAttributesBuilder.publish(source, UPriority.UPRIORITY_CS1)
self.assertIsNotNone(builder)
attributes = builder.build()
self.assertIsNotNone(attributes)
self.assertEqual(UMessageType.UMESSAGE_TYPE_PUBLISH, attributes.type)
self.assertEqual(UPriority.UPRIORITY_CS1, attributes.priority)

def test_notification(self):
source = build_source()
sink = build_sink()
builder = UAttributesBuilder.notification(UPriority.UPRIORITY_CS1, sink)
builder = UAttributesBuilder.notification(source, sink, UPriority.UPRIORITY_CS1)
self.assertIsNotNone(builder)
attributes = builder.build()
self.assertIsNotNone(attributes)
Expand All @@ -64,9 +71,10 @@ def test_notification(self):
self.assertEqual(sink, attributes.sink)

def test_request(self):
source = build_source()
sink = build_sink()
ttl = 1000
builder = UAttributesBuilder.request(UPriority.UPRIORITY_CS4, sink, ttl)
builder = UAttributesBuilder.request(source, sink, UPriority.UPRIORITY_CS4, ttl)
self.assertIsNotNone(builder)
attributes = builder.build()
self.assertIsNotNone(attributes)
Expand All @@ -76,9 +84,10 @@ def test_request(self):
self.assertEqual(ttl, attributes.ttl)

def test_response(self):
source = build_source()
sink = build_sink()
req_id = get_uuid()
builder = UAttributesBuilder.response(UPriority.UPRIORITY_CS6, sink, req_id)
builder = UAttributesBuilder.response(source, sink, UPriority.UPRIORITY_CS6, req_id)
self.assertIsNotNone(builder)
attributes = builder.build()
self.assertIsNotNone(attributes)
Expand All @@ -89,14 +98,15 @@ def test_response(self):

def test_build(self):
req_id = get_uuid()
builder = UAttributesBuilder.publish(UPriority.UPRIORITY_CS1).withTtl(1000).withToken("test_token").withSink(
builder = UAttributesBuilder.publish(build_source(), UPriority.UPRIORITY_CS1).withTtl(1000).withToken("test_token").withSink(
build_sink()).withPermissionLevel(2).withCommStatus(1).withReqId(req_id)
attributes = builder.build()
self.assertIsNotNone(attributes)
self.assertEqual(UMessageType.UMESSAGE_TYPE_PUBLISH, attributes.type)
self.assertEqual(UPriority.UPRIORITY_CS1, attributes.priority)
self.assertEqual(1000, attributes.ttl)
self.assertEqual("test_token", attributes.token)
self.assertEqual(build_source(), attributes.source)
self.assertEqual(build_sink(), attributes.sink)
self.assertEqual(2, attributes.permission_level)
self.assertEqual(1, attributes.commstatus)
Expand Down
Loading