def test_serialisation_fipa(self):
"""Tests a Value Error flag for wrong CFP query."""
with pytest.raises(ValueError):
msg = FipaMessage(
performative=FipaMessage.Performative.CFP,
message_id=1,
dialogue_reference=(str(0), ""),
target=0,
query=Query([Constraint("something", ConstraintType(">", 1))]),
)
with mock.patch(
"packages.fetchai.protocols.fipa.message.FipaMessage.Performative"
) as mock_performative_enum:
mock_performative_enum.CFP.value = "unknown"
FipaSerializer().encode(msg), "Raises Value Error"
with pytest.raises(EOFError):
cfp_msg = FipaMessage(
message_id=1,
dialogue_reference=(str(0), ""),
target=0,
performative=FipaMessage.Performative.CFP,
query=Query([Constraint("something", ConstraintType(">", 1))]),
)
cfp_msg.set("query", "hello")
fipa_msg = fipa_pb2.FipaMessage()
fipa_msg.message_id = cfp_msg.message_id
dialogue_reference = cast(Dict[str, str], cfp_msg.dialogue_reference)
fipa_msg.dialogue_starter_reference = dialogue_reference[0]
fipa_msg.dialogue_responder_reference = dialogue_reference[1]
fipa_msg.target = cfp_msg.target
performative = fipa_pb2.FipaMessage.Cfp_Performative()
fipa_msg.cfp.CopyFrom(performative)
fipa_bytes = fipa_msg.SerializeToString()
# The encoded message is not a valid FIPA message.
FipaSerializer().decode(fipa_bytes)
with pytest.raises(ValueError):
cfp_msg = FipaMessage(
message_id=1,
dialogue_reference=(str(0), ""),
target=0,
performative=FipaMessage.Performative.CFP,
query=Query([Constraint("something", ConstraintType(">", 1))]),
)
with mock.patch(
"packages.fetchai.protocols.fipa.message.FipaMessage.Performative"
) as mock_performative_enum:
mock_performative_enum.CFP.value = "unknown"
fipa_msg = fipa_pb2.FipaMessage()
fipa_msg.message_id = cfp_msg.message_id
dialogue_reference = cast(Dict[str, str], cfp_msg.dialogue_reference)
fipa_msg.dialogue_starter_reference = dialogue_reference[0]
fipa_msg.dialogue_responder_reference = dialogue_reference[1]
fipa_msg.target = cfp_msg.target
performative = fipa_pb2.FipaMessage.Cfp_Performative()
fipa_msg.cfp.CopyFrom(performative)
fipa_bytes = fipa_msg.SerializeToString()
# The encoded message is not a FIPA message
FipaSerializer().decode(fipa_bytes)
def _encode_fipa_cfp(msg: FipaMessage) -> bytes:
"""Helper function to serialize FIPA CFP message."""
message_pb = ProtobufMessage()
dialogue_message_pb = DialogueMessage()
fipa_msg = fipa_pb2.FipaMessage()
dialogue_message_pb.message_id = msg.message_id
dialogue_reference = msg.dialogue_reference
dialogue_message_pb.dialogue_starter_reference = dialogue_reference[
0]
dialogue_message_pb.dialogue_responder_reference = dialogue_reference[
1]
dialogue_message_pb.target = msg.target
performative = fipa_pb2.FipaMessage.Cfp_Performative(
) # type: ignore
# the following are commented to make the decoding to fail.
# query = msg.query # noqa: E800
# Query.encode(performative.query, query) # noqa: E800
fipa_msg.cfp.CopyFrom(performative)
dialogue_message_pb.content = fipa_msg.SerializeToString()
message_pb.dialogue_message.CopyFrom(dialogue_message_pb)
fipa_bytes = message_pb.SerializeToString()
return fipa_bytes
def decode(obj: bytes) -> Message:
"""
Decode bytes into a 'Fipa' message.
:param obj: the bytes object.
:return: the 'Fipa' message.
"""
message_pb = ProtobufMessage()
fipa_pb = fipa_pb2.FipaMessage()
message_pb.ParseFromString(obj)
message_id = message_pb.dialogue_message.message_id
dialogue_reference = (
message_pb.dialogue_message.dialogue_starter_reference,
message_pb.dialogue_message.dialogue_responder_reference,
)
target = message_pb.dialogue_message.target
fipa_pb.ParseFromString(message_pb.dialogue_message.content)
performative = fipa_pb.WhichOneof("performative")
performative_id = FipaMessage.Performative(str(performative))
performative_content = dict() # type: Dict[str, Any]
if performative_id == FipaMessage.Performative.CFP:
pb2_query = fipa_pb.cfp.query
query = Query.decode(pb2_query)
performative_content["query"] = query
elif performative_id == FipaMessage.Performative.PROPOSE:
pb2_proposal = fipa_pb.propose.proposal
proposal = Description.decode(pb2_proposal)
performative_content["proposal"] = proposal
elif performative_id == FipaMessage.Performative.ACCEPT_W_INFORM:
info = fipa_pb.accept_w_inform.info
info_dict = dict(info)
performative_content["info"] = info_dict
elif performative_id == FipaMessage.Performative.MATCH_ACCEPT_W_INFORM:
info = fipa_pb.match_accept_w_inform.info
info_dict = dict(info)
performative_content["info"] = info_dict
elif performative_id == FipaMessage.Performative.INFORM:
info = fipa_pb.inform.info
info_dict = dict(info)
performative_content["info"] = info_dict
elif performative_id == FipaMessage.Performative.ACCEPT:
pass
elif performative_id == FipaMessage.Performative.DECLINE:
pass
elif performative_id == FipaMessage.Performative.MATCH_ACCEPT:
pass
elif performative_id == FipaMessage.Performative.END:
pass
else:
raise ValueError("Performative not valid: {}.".format(performative_id))
return FipaMessage(
message_id=message_id,
dialogue_reference=dialogue_reference,
target=target,
performative=performative,
**performative_content
)
def encode(msg: Message) -> bytes:
"""
Encode a 'Fipa' message into bytes.
:param msg: the message object.
:return: the bytes.
"""
msg = cast(FipaMessage, msg)
message_pb = ProtobufMessage()
dialogue_message_pb = DialogueMessage()
fipa_msg = fipa_pb2.FipaMessage()
dialogue_message_pb.message_id = msg.message_id
dialogue_reference = msg.dialogue_reference
dialogue_message_pb.dialogue_starter_reference = dialogue_reference[0]
dialogue_message_pb.dialogue_responder_reference = dialogue_reference[1]
dialogue_message_pb.target = msg.target
performative_id = msg.performative
if performative_id == FipaMessage.Performative.CFP:
performative = fipa_pb2.FipaMessage.Cfp_Performative() # type: ignore
query = msg.query
Query.encode(performative.query, query)
fipa_msg.cfp.CopyFrom(performative)
elif performative_id == FipaMessage.Performative.PROPOSE:
performative = fipa_pb2.FipaMessage.Propose_Performative() # type: ignore
proposal = msg.proposal
Description.encode(performative.proposal, proposal)
fipa_msg.propose.CopyFrom(performative)
elif performative_id == FipaMessage.Performative.ACCEPT_W_INFORM:
performative = fipa_pb2.FipaMessage.Accept_W_Inform_Performative() # type: ignore
info = msg.info
performative.info.update(info)
fipa_msg.accept_w_inform.CopyFrom(performative)
elif performative_id == FipaMessage.Performative.MATCH_ACCEPT_W_INFORM:
performative = fipa_pb2.FipaMessage.Match_Accept_W_Inform_Performative() # type: ignore
info = msg.info
performative.info.update(info)
fipa_msg.match_accept_w_inform.CopyFrom(performative)
elif performative_id == FipaMessage.Performative.INFORM:
performative = fipa_pb2.FipaMessage.Inform_Performative() # type: ignore
info = msg.info
performative.info.update(info)
fipa_msg.inform.CopyFrom(performative)
elif performative_id == FipaMessage.Performative.ACCEPT:
performative = fipa_pb2.FipaMessage.Accept_Performative() # type: ignore
fipa_msg.accept.CopyFrom(performative)
elif performative_id == FipaMessage.Performative.DECLINE:
performative = fipa_pb2.FipaMessage.Decline_Performative() # type: ignore
fipa_msg.decline.CopyFrom(performative)
elif performative_id == FipaMessage.Performative.MATCH_ACCEPT:
performative = fipa_pb2.FipaMessage.Match_Accept_Performative() # type: ignore
fipa_msg.match_accept.CopyFrom(performative)
elif performative_id == FipaMessage.Performative.END:
performative = fipa_pb2.FipaMessage.End_Performative() # type: ignore
fipa_msg.end.CopyFrom(performative)
else:
raise ValueError("Performative not valid: {}".format(performative_id))
dialogue_message_pb.content = fipa_msg.SerializeToString()
message_pb.dialogue_message.CopyFrom(dialogue_message_pb)
message_bytes = message_pb.SerializeToString()
return message_bytes