def sendAndReceive(self, factory):
self.sent = Message()
self.sent.ParseFromString(
factory.setId(555).setSessionId("555").build())
if len(self.reply_with) > 0:
return self.reply_with.pop(0)
else:
return None
def message(self):
"""
Extracts the Message from a Frame by parsing the payload into a Message
object.
"""
message = Message()
message.ParseFromString(self.payload)
return message
def buildErrorReply(self, error_message):
message = Message(id=555, type=Message.REFLECTION_RESPONSE)
message.reflection_response.session_id = "555"
message.reflection_response.status = Message.ReflectionResponse.ERROR
message.reflection_response.errormessage = error_message
return message
def testItShouldBuildNullFromArgument(self):
argument = Message.Argument(type=Message.Argument.NULL)
type = reflection.types.ReflectedType.fromArgument(
argument, reflector=self.reflector)
assert isinstance(type, reflection.types.ReflectedNull)
def _pb(self):
"""
Get the Argument representation of the String, as defined in the Mercury
protocol.
"""
return Message.Argument(type=Message.Argument.DATA, data=self._native)
def buildObjectReply(self, ref):
message = Message(id=555, type=Message.REFLECTION_RESPONSE)
message.reflection_response.session_id = "555"
message.reflection_response.status = Message.ReflectionResponse.SUCCESS
message.reflection_response.result.type = Message.Argument.OBJECT
message.reflection_response.result.object.reference = ref
return message
def buildPrimitiveReply(self, type, int):
message = Message(id=555, type=Message.REFLECTION_RESPONSE)
message.reflection_response.session_id = "555"
message.reflection_response.status = Message.ReflectionResponse.SUCCESS
message.reflection_response.result.type = Message.Argument.PRIMITIVE
message.reflection_response.result.primitive.type = type
message.reflection_response.result.primitive.int = int
return message
def testItShouldBuildStringFromArgument(self):
argument = Message.Argument(type=Message.Argument.STRING)
argument.string = "Hello, World!"
type = reflection.types.ReflectedType.fromArgument(
argument, reflector=self.reflector)
assert isinstance(type, reflection.types.ReflectedString)
assert type.native() == "Hello, World!"
def testItShouldBuildObjectFromArgument(self):
argument = Message.Argument(type=Message.Argument.OBJECT)
argument.object.reference = 987654321
type = reflection.types.ReflectedType.fromArgument(
argument, reflector=self.reflector)
assert isinstance(type, reflection.types.ReflectedObject)
assert type._ref == 987654321
def testItShouldBuildPrimitiveFromArgument(self):
argument = Message.Argument(type=Message.Argument.PRIMITIVE)
argument.primitive.type = Message.Primitive.BOOL
argument.primitive.bool = True
type = reflection.types.ReflectedType.fromArgument(
argument, reflector=self.reflector)
assert isinstance(type, reflection.types.ReflectedPrimitive)
assert type.type() == "boolean"
assert type.native() == True
def _pb(self):
"""
Get an Argument representation of the Object, as defined in the Mercury
protocol.
"""
argument = Message.Argument(type=Message.Argument.OBJECT)
argument.object.reference = self._ref
return argument
class MockReflector(reflection.Reflector):
def __init__(self, session):
reflection.Reflector.__init__(self, session)
self.sent = None
self.reply_with = []
def buildErrorReply(self, error_message):
message = Message(id=555, type=Message.REFLECTION_RESPONSE)
message.reflection_response.session_id = "555"
message.reflection_response.status = Message.ReflectionResponse.ERROR
message.reflection_response.errormessage = error_message
return message
def buildObjectReply(self, ref):
message = Message(id=555, type=Message.REFLECTION_RESPONSE)
message.reflection_response.session_id = "555"
message.reflection_response.status = Message.ReflectionResponse.SUCCESS
message.reflection_response.result.type = Message.Argument.OBJECT
message.reflection_response.result.object.reference = ref
return message
def buildPrimitiveReply(self, type, int):
message = Message(id=555, type=Message.REFLECTION_RESPONSE)
message.reflection_response.session_id = "555"
message.reflection_response.status = Message.ReflectionResponse.SUCCESS
message.reflection_response.result.type = Message.Argument.PRIMITIVE
message.reflection_response.result.primitive.type = type
message.reflection_response.result.primitive.int = int
return message
def buildSuccessReply(self):
message = Message(id=555, type=Message.REFLECTION_RESPONSE)
message.reflection_response.session_id = "555"
message.reflection_response.status = Message.ReflectionResponse.SUCCESS
return message
def replyWith(self, message):
self.reply_with.append(message)
def sendAndReceive(self, factory):
self.sent = Message()
self.sent.ParseFromString(
factory.setId(555).setSessionId("555").build())
if len(self.reply_with) > 0:
return self.reply_with.pop(0)
else:
return None
def testItShouldBuildObjectArrayFromArgument(self):
argument = Message.Argument(type=Message.Argument.ARRAY)
argument.array.type = Message.Array.OBJECT
for i in range(0, 3):
element = argument.array.element.add(type=Message.Argument.OBJECT)
element.object.reference = i
type = reflection.types.ReflectedType.fromArgument(
argument, reflector=self.reflector)
assert isinstance(type, reflection.types.ReflectedArray)
assert len(type.native()) == 3
for i in range(0, 3):
assert isinstance(type.native()[i],
reflection.types.ReflectedObject)
assert type.native()[i]._ref == i
def testItShouldBuildStringArrayFromArgument(self):
argument = Message.Argument(type=Message.Argument.ARRAY)
argument.array.type = Message.Array.STRING
for i in range(0, 3):
element = argument.array.element.add(type=Message.Argument.STRING)
element.string = "Hello, World! (" + str(i) + ")"
type = reflection.types.ReflectedType.fromArgument(
argument, reflector=self.reflector)
assert isinstance(type, reflection.types.ReflectedArray)
assert len(type.native()) == 3
for i in range(0, 3):
assert isinstance(type.native()[i],
reflection.types.ReflectedString)
assert type.native()[i].native(
) == "Hello, World! (" + str(i) + ")"
def testItShouldBuildPrimitiveArrayFromArgument(self):
argument = Message.Argument(type=Message.Argument.ARRAY)
argument.array.type = Message.Array.PRIMITIVE
for i in range(0, 3):
element = argument.array.element.add(
type=Message.Argument.PRIMITIVE)
element.primitive.type = Message.Primitive.BOOL
element.primitive.bool = True
type = reflection.types.ReflectedType.fromArgument(
argument, reflector=self.reflector)
assert isinstance(type, reflection.types.ReflectedArray)
assert len(type.native()) == 3
for i in range(0, 3):
assert isinstance(type.native()[i],
reflection.types.ReflectedPrimitive)
assert type.native()[i].type() == "boolean"
def testItShouldRaiseTypeErrorIfArrayIsMixedTypes(self):
argument = Message.Argument(type=Message.Argument.ARRAY)
argument.array.type = Message.Array.PRIMITIVE
for i in range(0, 3):
element = argument.array.element.add(
type=Message.Argument.PRIMITIVE)
element.primitive.type = Message.Primitive.BOOL
element.primitive.bool = True
for i in range(0, 3):
element = argument.array.element.add(type=Message.Argument.OBJECT)
element.object.reference = i
try:
type = reflection.types.ReflectedType.fromArgument(
argument, reflector=self.reflector)
assert False, "should have caused a TypeError building a mixed array"
except TypeError as e:
assert e.message == "mismatched array element types"
def _pb(self):
"""
Get an Argument representation of the Array, as defined in the Mercury
protocol.
"""
argument = Message.Argument(type=Message.Argument.ARRAY)
if self._native[0]._pb().type == Message.Argument.ARRAY:
argument.array.type = Message.Array.ARRAY
elif self._native[0]._pb().type == Message.Argument.NULL:
argument.array.type = Message.Array.OBJECT
elif self._native[0]._pb().type == Message.Argument.OBJECT:
argument.array.type = Message.Array.OBJECT
elif self._native[0]._pb().type == Message.Argument.STRING:
argument.array.type = Message.Array.STRING
elif self._native[0]._pb().type == Message.Argument.PRIMITIVE:
argument.array.type = Message.Array.PRIMITIVE
for e in self._native:
element = argument.array.element.add()
element.MergeFrom(ReflectedType.fromNative(e, reflector=self._reflector)._pb())
return argument
def buildSuccessReply(self):
message = Message(id=555, type=Message.REFLECTION_RESPONSE)
message.reflection_response.session_id = "555"
message.reflection_response.status = Message.ReflectionResponse.SUCCESS
return message
class ReflectionResponseFactory:
"""
The ReflectionResponseFactory provides a DSL for building ReflectionResponse
messages.
"""
def __init__(self):
self.builder = Message(type=Message.REFLECTION_RESPONSE)
self.builder.reflection_response.status = Message.ReflectionResponse.SUCCESS
def build(self):
"""
Serialize the built Message to a String, using the Protocol Buffer
format.
"""
return self.builder.SerializeToString()
@classmethod
def error(cls, message):
"""
Helper method to build an error response.
"""
builder = ReflectionResponseFactory()
builder.isError()
builder.setErrorMessage(message)
return builder
@classmethod
def fatal(cls, message):
"""
Helper method to build a fatal error response.
"""
builder = ReflectionResponseFactory()
builder.isFatal()
builder.setErrorMessage(message)
return builder
def inReplyTo(self, message):
"""
Tag the response as a reply to another message, by setting the message
identifiers to be equal and setting the session to keep the flow
intact.
"""
self.builder.id = message.id
self.builder.reflection_response.session_id = message.reflection_request.session_id
return self
def isError(self):
"""
Indicate an error in the response status code.
"""
self.builder.reflection_response.status = Message.ReflectionResponse.ERROR
def isFatal(self):
"""
Indicate a fatal error in the response status code.
"""
self.builder.reflection_response.status = Message.ReflectionResponse.FATAL
def isSuccess(self):
"""
Indicate success in the response status code.
"""
self.builder.reflection_response.status = Message.ReflectionResponse.SUCCESS
def setErrorMessage(self, message):
"""
Set the error message associated with this response.
"""
self.builder.reflection_response.errormessage = message
return self
def __init__(self):
self.builder = Message(type=Message.REFLECTION_RESPONSE)
self.builder.reflection_response.status = Message.ReflectionResponse.SUCCESS
class ReflectionRequestFactory:
"""
The ReflectionRequestFactory provides a DSL for building ReflectionRequest
messages.
"""
def __init__(self, request_type):
self.builder = Message(type=Message.REFLECTION_REQUEST)
self.builder.reflection_request.type = request_type
def build(self):
"""
Serialize the built Message to a String, using the Protocol Buffer
format.
"""
return self.builder.SerializeToString()
@classmethod
def construct(cls, ref):
"""
Helper method to build a CONSTRUCT request, to build a new object
instance.
"""
builder = ReflectionRequestFactory(Message.ReflectionRequest.CONSTRUCT)
builder.builder.reflection_request.construct.object.reference = ref
return builder
@classmethod
def delete(cls, ref):
"""
Helper method to build a DELETE request, to remove a cached object from
the ObjectStore.
"""
builder = ReflectionRequestFactory(Message.ReflectionRequest.DELETE)
builder.builder.reflection_request.delete.object.reference = ref
return builder
@classmethod
def deleteAll(cls):
"""
Helper method to build a DELETE_ALL request, to clear the ObjectStore.
"""
builder = ReflectionRequestFactory(
Message.ReflectionRequest.DELETE_ALL)
return builder
def getId(self):
"""
Get the Identifier assigned to the message.
"""
return self.builder.id
@classmethod
def getProperty(cls, ref, property_name):
"""
Helper method to build a GET_PROPERTY request, to get the value of an
object's field.
"""
builder = ReflectionRequestFactory(
Message.ReflectionRequest.GET_PROPERTY)
builder.builder.reflection_request.get_property.object.reference = ref
builder.builder.reflection_request.get_property.property = property_name
return builder
@classmethod
def invoke(cls, ref, method_name):
"""
Helper method to build an INVOKE request, to call a method on an object.
"""
builder = ReflectionRequestFactory(Message.ReflectionRequest.INVOKE)
builder.builder.reflection_request.invoke.object.reference = ref
builder.builder.reflection_request.invoke.method = method_name
return builder
@classmethod
def resolve(cls, class_name):
"""
Helper method to build a RESOLVE request, to get a reference to a class
given its name.
"""
builder = ReflectionRequestFactory(Message.ReflectionRequest.RESOLVE)
builder.builder.reflection_request.resolve.classname = class_name
return builder
def setArguments(self, arguments):
"""
Adds an array of Arguments to an INVOKE or a CONSTRUCT request.
"""
if self.builder.reflection_request.type == Message.ReflectionRequest.INVOKE:
request = self.builder.reflection_request.invoke
elif self.builder.reflection_request.type == Message.ReflectionRequest.CONSTRUCT:
request = self.builder.reflection_request.construct
else:
request = None
if request is not None:
for argument in arguments:
request.argument.add().MergeFrom(argument._pb())
return self
def setId(self, message_id):
"""
Set the identifier of the message.
"""
self.builder.id = message_id
return self
@classmethod
def setProperty(cls, ref, property_name, value):
"""
Helper method to build a SET_PROPERTY request, to assign the value of
an object's field.
"""
builder = ReflectionRequestFactory(
Message.ReflectionRequest.SET_PROPERTY)
builder.builder.reflection_request.set_property.object.reference = ref
builder.builder.reflection_request.set_property.property = property_name
builder.builder.reflection_request.set_property.value.MergeFrom(
value._pb())
return builder
def setSessionId(self, session_id):
"""
Set session identifier, to route a message correctly on the Agent.
"""
self.builder.reflection_request.session_id = session_id
return self
def __init__(self, request_type):
self.builder = Message(type=Message.REFLECTION_REQUEST)
self.builder.reflection_request.type = request_type
def testItShouldShowTheMessageTypeAsReflectionResponse(self):
message = Message(
id=1, type=Message.REFLECTION_RESPONSE).SerializeToString()
assert frame.Frame(2, len(message),
message).messageType() == "REFLECTION_RESPONSE"
def testItShouldShowTheMessageTypeAsSystemResponse(self):
message = Message(id=1,
type=Message.SYSTEM_RESPONSE).SerializeToString()
assert frame.Frame(2, len(message),
message).messageType() == "SYSTEM_RESPONSE"
def testItShouldExtractTheMessage(self):
message = Message(id=1,
type=Message.REFLECTION_REQUEST).SerializeToString()
assert isinstance(
frame.Frame(2, len(message), message).message(), Message)
def testItShouldBuildFrameFromMessage(self):
message = Message(id=1,
type=Message.REFLECTION_REQUEST).SerializeToString()
assert frame.Frame.fromMessage(message).length == len(message)
def _pb(self):
"""
Get an Argument representation of the null, as defined in the Mercury
protocol.
"""
return Message.Argument(type=Message.Argument.NULL)
def __init__(self, response_type):
self.builder = Message(type=Message.SYSTEM_RESPONSE)
self.builder.system_response.type = response_type
self.builder.system_response.status = Message.SystemResponse.SUCCESS
class SystemResponseFactory:
"""
The SystemResponseFactory provides a DSL for building SystemResponse
messages.
"""
def __init__(self, response_type):
self.builder = Message(type=Message.SYSTEM_RESPONSE)
self.builder.system_response.type = response_type
self.builder.system_response.status = Message.SystemResponse.SUCCESS
def addDevice(self, device):
"""
Add a Device to the list of devices within the message.
"""
d = self.builder.system_response.devices.add()
d.id = device.device_id
d.manufacturer = device.manufacturer
d.model = device.model
d.software = device.software
return d
def add_session(self, session):
"""
Add a Session to the list of Sessions within the message.
"""
s = self.builder.system_response.sessions.add()
s.id = session.session_id
s.device_id = session.device.device_id
@classmethod
def bound(cls, device):
"""
Helper method to build a message to indicate a Device has successfully
bound to the server.
"""
builder = SystemResponseFactory(Message.SystemResponse.BOUND)
builder.addDevice(device)
return builder
def build(self):
"""
Serialize the built Message to a String, using the Protocol Buffer
format.
"""
return self.builder.SerializeToString()
@classmethod
def error(cls, error_type, message):
"""
Helper method to build an error message, with a particular type and an
error message.
"""
builder = SystemResponseFactory(error_type)
builder.isError()
builder.setErrorMessage(message)
return builder
def inReplyTo(self, message):
"""
Tag the response as a reply to another message, by setting the message
identifiers to be equal.
"""
self.builder.id = message.id
return self
def isError(self):
"""
Indicate an error in the response status code.
"""
self.builder.system_response.status = Message.SystemResponse.ERROR
def isSuccess(self):
"""
Indicate success in the response status code.
"""
self.builder.system_response.status = Message.SystemResponse.SUCCESS
@classmethod
def listDevices(cls, devices):
"""
Helper method to build a DEVICE_LIST response, with a list of devices
built from a collection.
"""
builder = SystemResponseFactory(Message.SystemResponse.DEVICE_LIST)
for device in devices:
builder.addDevice(device)
return builder
@classmethod
def listSessions(cls, sessions):
"""
Helper method to build a SESSION_LIST response, with a list of sessions
build from a collection.
"""
builder = SystemResponseFactory(Message.SystemResponse.SESSION_LIST)
#for session in sessions:
# builder.add_session(session)
return builder
def setErrorMessage(self, message):
"""
Set the error message associated with this response.
"""
self.builder.system_response.error_message = message
return self
@classmethod
def unbound(cls, device):
"""
Helper method to build a message to indicate a device has successfully
unbound from the Server.
"""
builder = SystemResponseFactory(Message.SystemResponse.UNBOUND)
builder.addDevice(device)
return builder
