async def _unittest_output_session() -> None:
ts = Timestamp.now()
loop = asyncio.get_event_loop()
tx_timestamp: typing.Optional[Timestamp] = Timestamp.now()
tx_exception: typing.Optional[Exception] = None
last_sent_frames: typing.List[SerialFrame] = []
last_monotonic_deadline = 0.0
finalized = False
async def do_send(frames: typing.Sequence[SerialFrame],
monotonic_deadline: float) -> typing.Optional[Timestamp]:
nonlocal last_sent_frames
nonlocal last_monotonic_deadline
last_sent_frames = list(frames)
last_monotonic_deadline = monotonic_deadline
if tx_exception:
raise tx_exception
return tx_timestamp
def do_finalize() -> None:
nonlocal finalized
finalized = True
with raises(pyuavcan.transport.OperationNotDefinedForAnonymousNodeError):
SerialOutputSession(
specifier=OutputSessionSpecifier(
ServiceDataSpecifier(321, ServiceDataSpecifier.Role.REQUEST),
1111),
payload_metadata=PayloadMetadata(1024),
mtu=10,
local_node_id=None,
send_handler=do_send,
finalizer=do_finalize,
)
sos = SerialOutputSession(
specifier=OutputSessionSpecifier(MessageDataSpecifier(3210), None),
payload_metadata=PayloadMetadata(1024),
mtu=11,
local_node_id=None,
send_handler=do_send,
finalizer=do_finalize,
)
assert sos.specifier == OutputSessionSpecifier(MessageDataSpecifier(3210),
None)
assert sos.destination_node_id is None
assert sos.payload_metadata == PayloadMetadata(1024)
assert sos.sample_statistics() == SessionStatistics()
assert await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
999999999.999,
))
assert last_monotonic_deadline == approx(999999999.999)
assert len(last_sent_frames) == 1
with raises(pyuavcan.transport.OperationNotDefinedForAnonymousNodeError):
await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three four five")
],
),
loop.time() + 10.0,
))
last_feedback: typing.Optional[Feedback] = None
def feedback_handler(feedback: Feedback) -> None:
nonlocal last_feedback
last_feedback = feedback
sos.enable_feedback(feedback_handler)
assert last_feedback is None
assert await (sos.send(
Transfer(timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[]), 999999999.999))
assert last_monotonic_deadline == approx(999999999.999)
assert len(last_sent_frames) == 1
assert last_feedback is not None
assert last_feedback.original_transfer_timestamp == ts
assert last_feedback.first_frame_transmission_timestamp == tx_timestamp
sos.disable_feedback()
sos.disable_feedback() # Idempotency check
assert sos.sample_statistics() == SessionStatistics(transfers=2,
frames=2,
payload_bytes=11,
errors=0,
drops=0)
assert not finalized
sos.close()
assert finalized
finalized = False
sos = SerialOutputSession(
specifier=OutputSessionSpecifier(
ServiceDataSpecifier(321, ServiceDataSpecifier.Role.REQUEST),
2222),
payload_metadata=PayloadMetadata(1024),
mtu=10,
local_node_id=1234,
send_handler=do_send,
finalizer=do_finalize,
)
# Induced failure
tx_timestamp = None
assert not await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
999999999.999,
))
assert last_monotonic_deadline == approx(999999999.999)
assert len(last_sent_frames) == 2
assert sos.sample_statistics() == SessionStatistics(transfers=0,
frames=0,
payload_bytes=0,
errors=0,
drops=2)
tx_exception = RuntimeError()
with raises(RuntimeError):
_ = await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() + 10.0,
))
assert sos.sample_statistics() == SessionStatistics(transfers=0,
frames=0,
payload_bytes=0,
errors=1,
drops=2)
assert not finalized
sos.close()
assert finalized
sos.close() # Idempotency
with raises(pyuavcan.transport.ResourceClosedError):
await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() + 10.0,
))
async def _unittest_udp_transport() -> None:
from pyuavcan.transport import MessageDataSpecifier, ServiceDataSpecifier, PayloadMetadata, Transfer, TransferFrom
from pyuavcan.transport import Priority, Timestamp, InputSessionSpecifier, OutputSessionSpecifier
from pyuavcan.transport import ProtocolParameters
get_monotonic = asyncio.get_event_loop().time
with pytest.raises(ValueError):
_ = UDPTransport(ip_address='127.0.0.111/8', mtu=10)
with pytest.raises(ValueError):
_ = UDPTransport(ip_address='127.0.0.111/8',
service_transfer_multiplier=100)
tr = UDPTransport('127.0.0.111/8', mtu=9000)
tr2 = UDPTransport('127.0.0.222/8', service_transfer_multiplier=2)
assert tr.local_ip_address_with_netmask == '127.0.0.111/8'
assert tr2.local_ip_address_with_netmask == '127.0.0.222/8'
assert tr.loop is asyncio.get_event_loop()
assert tr.local_node_id == 111
assert tr2.local_node_id == 222
assert tr.input_sessions == []
assert tr.output_sessions == []
assert list(xml.etree.ElementTree.fromstring(
tr.descriptor).itertext()) == ['127.0.0.111/8']
assert tr.protocol_parameters == ProtocolParameters(
transfer_id_modulo=2**56,
max_nodes=2**UDPTransport.NODE_ID_BIT_LENGTH,
mtu=9000,
)
assert list(xml.etree.ElementTree.fromstring(
tr2.descriptor).itertext()) == ['127.0.0.222/8']
assert tr2.protocol_parameters == ProtocolParameters(
transfer_id_modulo=2**56,
max_nodes=2**UDPTransport.NODE_ID_BIT_LENGTH,
mtu=UDPTransport.DEFAULT_MTU,
)
assert tr.sample_statistics() == tr2.sample_statistics(
) == UDPTransportStatistics()
payload_single = [_mem('qwertyui'), _mem('01234567')
] * (UDPTransport.DEFAULT_MTU // 16)
assert sum(map(len, payload_single)) == UDPTransport.DEFAULT_MTU
payload_x3 = (payload_single * 3)[:-1]
payload_x3_size_bytes = UDPTransport.DEFAULT_MTU * 3 - 8
assert sum(map(len, payload_x3)) == payload_x3_size_bytes
#
# Instantiate session objects.
#
meta = PayloadMetadata(0x_bad_c0ffee_0dd_f00d, 10000)
broadcaster = tr2.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
assert broadcaster is tr2.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
subscriber_promiscuous = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
assert subscriber_promiscuous is tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
subscriber_selective = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), 123), meta)
assert subscriber_selective is tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), 123), meta)
server_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST),
None), meta)
assert server_listener is tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST),
None), meta)
server_responder = tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE),
222), meta)
assert server_responder is tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE),
222), meta)
client_requester = tr2.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST), 111),
meta)
assert client_requester is tr2.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST), 111),
meta)
client_listener = tr2.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE),
111), meta)
assert client_listener is tr2.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE),
111), meta)
print('tr :', tr.input_sessions, tr.output_sessions)
assert set(tr.input_sessions) == {
subscriber_promiscuous, subscriber_selective, server_listener
}
assert set(tr.output_sessions) == {server_responder}
print('tr2:', tr2.input_sessions, tr2.output_sessions)
assert set(tr2.input_sessions) == {client_listener}
assert set(tr2.output_sessions) == {broadcaster, client_requester}
assert tr.sample_statistics().demultiplexer[MessageDataSpecifier(
12345)].accepted_datagrams == {}
assert tr.sample_statistics().demultiplexer[ServiceDataSpecifier(
444, ServiceDataSpecifier.Role.REQUEST)].accepted_datagrams == {}
assert tr2.sample_statistics().demultiplexer[ServiceDataSpecifier(
444, ServiceDataSpecifier.Role.RESPONSE)].accepted_datagrams == {}
#
# Message exchange test.
#
assert await broadcaster.send_until(
Transfer(timestamp=Timestamp.now(),
priority=Priority.LOW,
transfer_id=77777,
fragmented_payload=payload_single),
monotonic_deadline=get_monotonic() + 5.0)
rx_transfer = await subscriber_promiscuous.receive_until(get_monotonic() +
5.0)
print('PROMISCUOUS SUBSCRIBER TRANSFER:', rx_transfer)
assert isinstance(rx_transfer, TransferFrom)
assert rx_transfer.priority == Priority.LOW
assert rx_transfer.transfer_id == 77777
assert rx_transfer.fragmented_payload == [b''.join(payload_single)
] # type: ignore
print('tr :', tr.sample_statistics())
assert tr.sample_statistics().demultiplexer[MessageDataSpecifier(
12345)].accepted_datagrams == {
222: 1
}
assert tr.sample_statistics().demultiplexer[ServiceDataSpecifier(
444, ServiceDataSpecifier.Role.REQUEST)].accepted_datagrams == {}
print('tr2:', tr2.sample_statistics())
assert tr2.sample_statistics().demultiplexer[ServiceDataSpecifier(
444, ServiceDataSpecifier.Role.RESPONSE)].accepted_datagrams == {}
assert None is await subscriber_selective.receive_until(get_monotonic() +
0.1)
assert None is await subscriber_promiscuous.receive_until(get_monotonic() +
0.1)
assert None is await server_listener.receive_until(get_monotonic() + 0.1)
assert None is await client_listener.receive_until(get_monotonic() + 0.1)
#
# Service exchange test.
#
assert await client_requester.send_until(
Transfer(timestamp=Timestamp.now(),
priority=Priority.HIGH,
transfer_id=88888,
fragmented_payload=payload_x3),
monotonic_deadline=get_monotonic() + 5.0)
rx_transfer = await server_listener.receive_until(get_monotonic() + 5.0)
print('SERVER LISTENER TRANSFER:', rx_transfer)
assert isinstance(rx_transfer, TransferFrom)
assert rx_transfer.priority == Priority.HIGH
assert rx_transfer.transfer_id == 88888
assert len(rx_transfer.fragmented_payload) == 3
assert b''.join(rx_transfer.fragmented_payload) == b''.join(payload_x3)
assert None is await subscriber_selective.receive_until(get_monotonic() +
0.1)
assert None is await subscriber_promiscuous.receive_until(get_monotonic() +
0.1)
assert None is await server_listener.receive_until(get_monotonic() + 0.1)
assert None is await client_listener.receive_until(get_monotonic() + 0.1)
print('tr :', tr.sample_statistics())
assert tr.sample_statistics().demultiplexer[MessageDataSpecifier(
12345)].accepted_datagrams == {
222: 1
}
assert tr.sample_statistics().demultiplexer[ServiceDataSpecifier(
444, ServiceDataSpecifier.Role.REQUEST
)].accepted_datagrams == {
222: 3 * 2
} # Deterministic data loss mitigation is enabled, multiplication factor 2
print('tr2:', tr2.sample_statistics())
assert tr2.sample_statistics().demultiplexer[ServiceDataSpecifier(
444, ServiceDataSpecifier.Role.RESPONSE)].accepted_datagrams == {}
#
# Termination.
#
assert set(tr.input_sessions) == {
subscriber_promiscuous, subscriber_selective, server_listener
}
assert set(tr.output_sessions) == {server_responder}
assert set(tr2.input_sessions) == {client_listener}
assert set(tr2.output_sessions) == {broadcaster, client_requester}
subscriber_promiscuous.close()
subscriber_promiscuous.close() # Idempotency.
assert set(tr.input_sessions) == {subscriber_selective, server_listener}
assert set(tr.output_sessions) == {server_responder}
assert set(tr2.input_sessions) == {client_listener}
assert set(tr2.output_sessions) == {broadcaster, client_requester}
broadcaster.close()
broadcaster.close() # Idempotency.
assert set(tr.input_sessions) == {subscriber_selective, server_listener}
assert set(tr.output_sessions) == {server_responder}
assert set(tr2.input_sessions) == {client_listener}
assert set(tr2.output_sessions) == {client_requester}
tr.close()
tr.close() # Idempotency.
tr2.close()
tr2.close() # Idempotency.
assert not set(tr.input_sessions)
assert not set(tr.output_sessions)
assert not set(tr2.input_sessions)
assert not set(tr2.output_sessions)
with pytest.raises(pyuavcan.transport.ResourceClosedError):
_ = tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
with pytest.raises(pyuavcan.transport.ResourceClosedError):
_ = tr2.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
def _unittest_frame_parse() -> None:
from pyuavcan.transport import Priority, MessageDataSpecifier, ServiceDataSpecifier
def get_crc(*blocks: typing.Union[bytes, memoryview]) -> bytes:
return pyuavcan.transport.commons.crc.CRC32C.new(*blocks).value_as_bytes
# Valid message with payload
header = bytes(
[
_VERSION,
int(Priority.LOW),
0x7B,
0x00, # Source NID 123
0xC8,
0x01, # Destination NID 456
0xE1,
0x10, # Data specifier 4321
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00, # Reserved
0xD2,
0x0A,
0x1F,
0xEB,
0x8C,
0xA9,
0x54,
0xAB, # Transfer ID 12345678901234567890
0x31,
0xD4,
0x00,
0x80, # Frame index, EOT 54321 with EOT flag set
]
)
header += get_crc(header)
assert len(header) == 32
payload = b"Squeeze mayonnaise onto a hamster"
f = SerialFrame.parse_from_unescaped_image(memoryview(header + payload + get_crc(payload)))
assert f == SerialFrame(
priority=Priority.LOW,
source_node_id=123,
destination_node_id=456,
data_specifier=MessageDataSpecifier(4321),
transfer_id=12345678901234567890,
index=54321,
end_of_transfer=True,
payload=memoryview(payload),
)
# Valid service with no payload
header = bytes(
[
_VERSION,
int(Priority.LOW),
0x01,
0x00,
0x00,
0x00,
0x10,
0xC0, # Response, service ID 16
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0xD2,
0x0A,
0x1F,
0xEB,
0x8C,
0xA9,
0x54,
0xAB,
0x31,
0xD4,
0x00,
0x00,
]
)
header += get_crc(header)
assert len(header) == 32
f = SerialFrame.parse_from_unescaped_image(memoryview(header + get_crc(b"")))
assert f == SerialFrame(
priority=Priority.LOW,
source_node_id=1,
destination_node_id=0,
data_specifier=ServiceDataSpecifier(16, ServiceDataSpecifier.Role.RESPONSE),
transfer_id=12345678901234567890,
index=54321,
end_of_transfer=False,
payload=memoryview(b""),
)
# Valid service with no payload
header = bytes(
[
_VERSION,
int(Priority.LOW),
0x01,
0x00,
0x00,
0x00,
0x10,
0x80, # Request, service ID 16
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0xD2,
0x0A,
0x1F,
0xEB,
0x8C,
0xA9,
0x54,
0xAB,
0x31,
0xD4,
0x00,
0x00,
]
)
header += get_crc(header)
assert len(header) == 32
f = SerialFrame.parse_from_unescaped_image(memoryview(header + get_crc(b"")))
assert f == SerialFrame(
priority=Priority.LOW,
source_node_id=1,
destination_node_id=0,
data_specifier=ServiceDataSpecifier(16, ServiceDataSpecifier.Role.REQUEST),
transfer_id=12345678901234567890,
index=54321,
end_of_transfer=False,
payload=memoryview(b""),
)
# Too short
assert SerialFrame.parse_from_unescaped_image(memoryview(header[1:] + get_crc(payload))) is None
# Bad CRC
assert SerialFrame.parse_from_unescaped_image(memoryview(header + payload + b"1234")) is None
# Bad version
header = bytes(
[
_VERSION + 1,
int(Priority.LOW),
0xFF,
0xFF,
0x00,
0x00,
0xE1,
0x10,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0xD2,
0x0A,
0x1F,
0xEB,
0x8C,
0xA9,
0x54,
0xAB,
0x31,
0xD4,
0x00,
0x00,
]
)
header += get_crc(header)
assert len(header) == 32
assert SerialFrame.parse_from_unescaped_image(memoryview(header + get_crc(b""))) is None
# Bad fields
header = bytes(
[
_VERSION,
0x88,
0xFF,
0xFF,
0x00,
0xFF,
0xE1,
0x10,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0x00,
0xD2,
0x0A,
0x1F,
0xEB,
0x8C,
0xA9,
0x54,
0xAB,
0x31,
0xD4,
0x00,
0x00,
]
)
header += get_crc(header)
assert len(header) == 32
assert SerialFrame.parse_from_unescaped_image(memoryview(header + get_crc(b""))) is None
def _unittest_frame_check() -> None:
from pytest import raises
from pyuavcan.transport import Priority, MessageDataSpecifier, ServiceDataSpecifier
_ = SerialFrame(
priority=Priority.HIGH,
source_node_id=123,
destination_node_id=456,
data_specifier=MessageDataSpecifier(2345),
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b"abcdef"),
)
with raises(ValueError):
SerialFrame(
priority=Priority.HIGH,
source_node_id=123456,
destination_node_id=456,
data_specifier=MessageDataSpecifier(2345),
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b"abcdef"),
)
with raises(ValueError):
SerialFrame(
priority=Priority.HIGH,
source_node_id=123,
destination_node_id=123456,
data_specifier=MessageDataSpecifier(2345),
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b"abcdef"),
)
with raises(ValueError):
SerialFrame(
priority=Priority.HIGH,
source_node_id=None,
destination_node_id=456,
data_specifier=ServiceDataSpecifier(123, ServiceDataSpecifier.Role.REQUEST),
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b"abcdef"),
)
with raises(ValueError):
SerialFrame(
priority=Priority.HIGH,
source_node_id=None,
destination_node_id=None,
data_specifier=MessageDataSpecifier(2345),
transfer_id=-1,
index=1234567,
end_of_transfer=False,
payload=memoryview(b"abcdef"),
)
with raises(ValueError):
SerialFrame(
priority=Priority.HIGH,
source_node_id=None,
destination_node_id=None,
data_specifier=MessageDataSpecifier(2345),
transfer_id=0,
index=-1,
end_of_transfer=False,
payload=memoryview(b"abcdef"),
)
async def _unittest_can_spoofing() -> None:
from pyuavcan.transport import MessageDataSpecifier, ServiceDataSpecifier, Priority, Timestamp
from pyuavcan.transport import AlienTransfer, AlienSessionSpecifier, AlienTransferMetadata
from pyuavcan.transport.can._identifier import CANID
from .media.mock import MockMedia
asyncio.get_running_loop().slow_callback_duration = 5.0
peers: typing.Set[MockMedia] = set()
peeper = MockMedia(peers, 64, 1)
tr = can.CANTransport(MockMedia(peers, 64, 1), None)
peeped: typing.List[can.media.DataFrame] = []
def on_peep(args: typing.Sequence[typing.Tuple[Timestamp, can.media.Envelope]]) -> None:
nonlocal peeped
peeped += [e.frame for _ts, e in args]
peeper.start(on_peep, no_automatic_retransmission=False)
peeper.configure_acceptance_filters([can.media.FilterConfiguration.new_promiscuous(None)])
transfer = AlienTransfer(
AlienTransferMetadata(
priority=Priority.FAST,
transfer_id=13107, # -> 19
session_specifier=AlienSessionSpecifier(
source_node_id=0x77,
destination_node_id=None,
data_specifier=MessageDataSpecifier(6666),
),
),
fragmented_payload=[_mem("123")],
)
assert await tr.spoof(transfer, tr.loop.time() + 1.0)
peep = peeped.pop()
assert not peeped
can_id = CANID.parse(peep.identifier)
assert can_id
assert can_id.data_specifier == MessageDataSpecifier(6666)
assert can_id.priority == Priority.FAST
assert can_id.source_node_id == 0x77
assert can_id.get_destination_node_id() is None
assert peep.data[:-1] == b"123"
assert peep.data[-1] == 0b1110_0000 | 19
transfer = AlienTransfer(
AlienTransferMetadata(
priority=Priority.SLOW,
transfer_id=1,
session_specifier=AlienSessionSpecifier(
source_node_id=0x77,
destination_node_id=0x66,
data_specifier=ServiceDataSpecifier(99, role=ServiceDataSpecifier.Role.REQUEST),
),
),
fragmented_payload=[_mem("321")],
)
assert await tr.spoof(transfer, tr.loop.time() + 1.0)
peep = peeped.pop()
assert not peeped
can_id = CANID.parse(peep.identifier)
assert can_id
assert can_id.data_specifier == transfer.metadata.session_specifier.data_specifier
assert can_id.priority == Priority.SLOW
assert can_id.source_node_id == 0x77
assert can_id.get_destination_node_id() == 0x66
assert peep.data[:-1] == b"321"
assert peep.data[-1] == 0b1110_0000 | 1
with pytest.raises(pyuavcan.transport.TransportError):
await tr.spoof(
AlienTransfer(
AlienTransferMetadata(
priority=Priority.FAST,
transfer_id=13107,
session_specifier=AlienSessionSpecifier(
source_node_id=123,
destination_node_id=123,
data_specifier=MessageDataSpecifier(6666),
),
),
fragmented_payload=[],
),
tr.loop.time() + 1.0,
)
with pytest.raises(pyuavcan.transport.TransportError):
await tr.spoof(
AlienTransfer(
AlienTransferMetadata(
priority=Priority.FAST,
transfer_id=13107,
session_specifier=AlienSessionSpecifier(
source_node_id=0x77,
destination_node_id=None,
data_specifier=ServiceDataSpecifier(99, role=ServiceDataSpecifier.Role.REQUEST),
),
),
fragmented_payload=[],
),
tr.loop.time() + 1.0,
)
with pytest.raises(pyuavcan.transport.TransportError):
await tr.spoof(
AlienTransfer(
AlienTransferMetadata(
priority=Priority.FAST,
transfer_id=13107,
session_specifier=AlienSessionSpecifier(
source_node_id=None,
destination_node_id=None,
data_specifier=MessageDataSpecifier(6666),
),
),
fragmented_payload=[memoryview(bytes(range(256)))],
),
tr.loop.time() + 1.0,
)
async def _unittest_output_session_no_listener() -> None:
"""
Test the Windows-specific corner case. Should be handled identically on all platforms.
"""
ts = Timestamp.now()
loop = asyncio.get_event_loop()
loop.slow_callback_duration = 5.0
def make_sock() -> socket_.socket:
sock = socket_.socket(socket_.AF_INET, socket_.SOCK_DGRAM)
sock.bind(("127.100.0.2", 0))
sock.connect(
("239.0.1.2", 33333)) # There is no listener on this endpoint.
sock.setsockopt(socket_.IPPROTO_IP, socket_.IP_MULTICAST_IF,
socket_.inet_aton("127.100.0.2"))
sock.setblocking(False)
return sock
sos = UDPOutputSession(
specifier=OutputSessionSpecifier(MessageDataSpecifier(3210), None),
payload_metadata=PayloadMetadata(1024),
mtu=11,
multiplier=1,
sock=make_sock(),
finalizer=lambda: None,
)
assert await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() + 10.0,
))
sos.close()
# Multi-frame with multiplication and feedback
last_feedback: typing.Optional[Feedback] = None
def feedback_handler(feedback: Feedback) -> None:
nonlocal last_feedback
assert last_feedback is None, "Unexpected feedback"
last_feedback = feedback
sos = UDPOutputSession(
specifier=OutputSessionSpecifier(
ServiceDataSpecifier(321, ServiceDataSpecifier.Role.REQUEST),
2222),
payload_metadata=PayloadMetadata(1024),
mtu=10,
multiplier=2,
sock=make_sock(),
finalizer=lambda: None,
)
sos.enable_feedback(feedback_handler)
assert last_feedback is None
assert await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.OPTIONAL,
transfer_id=54321,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() + 10.0,
))
print("last_feedback:", last_feedback)
assert isinstance(last_feedback, UDPFeedback)
# Ensure that the timestamp is populated even if the error suppression logic is activated.
assert last_feedback.original_transfer_timestamp == ts
assert Timestamp.now(
).monotonic >= last_feedback.first_frame_transmission_timestamp.monotonic >= ts.monotonic
assert Timestamp.now(
).system >= last_feedback.first_frame_transmission_timestamp.system >= ts.system
sos.close()
def _unittest_frame_check() -> None:
from pytest import raises
from pyuavcan.transport import Priority, MessageDataSpecifier, ServiceDataSpecifier, Timestamp
_ = SerialFrame(timestamp=Timestamp.now(),
priority=Priority.HIGH,
source_node_id=123,
destination_node_id=456,
data_specifier=MessageDataSpecifier(12345),
data_type_hash=0xdead_beef_bad_c0ffe,
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b'abcdef'))
with raises(ValueError):
SerialFrame(timestamp=Timestamp.now(),
priority=Priority.HIGH,
source_node_id=123456,
destination_node_id=456,
data_specifier=MessageDataSpecifier(12345),
data_type_hash=0xdead_beef_bad_c0ffe,
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b'abcdef'))
with raises(ValueError):
SerialFrame(timestamp=Timestamp.now(),
priority=Priority.HIGH,
source_node_id=123,
destination_node_id=123456,
data_specifier=MessageDataSpecifier(12345),
data_type_hash=0xdead_beef_bad_c0ffe,
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b'abcdef'))
with raises(ValueError):
SerialFrame(timestamp=Timestamp.now(),
priority=Priority.HIGH,
source_node_id=None,
destination_node_id=456,
data_specifier=ServiceDataSpecifier(123, ServiceDataSpecifier.Role.REQUEST),
data_type_hash=0xdead_beef_bad_c0ffe,
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b'abcdef'))
with raises(ValueError):
SerialFrame(timestamp=Timestamp.now(),
priority=Priority.HIGH,
source_node_id=None,
destination_node_id=None,
data_specifier=MessageDataSpecifier(12345),
data_type_hash=2 ** 64,
transfer_id=1234567890123456789,
index=1234567,
end_of_transfer=False,
payload=memoryview(b'abcdef'))
with raises(ValueError):
SerialFrame(timestamp=Timestamp.now(),
priority=Priority.HIGH,
source_node_id=None,
destination_node_id=None,
data_specifier=MessageDataSpecifier(12345),
data_type_hash=0xdead_beef_bad_c0ffe,
transfer_id=-1,
index=1234567,
end_of_transfer=False,
payload=memoryview(b'abcdef'))
with raises(ValueError):
SerialFrame(timestamp=Timestamp.now(),
priority=Priority.HIGH,
source_node_id=None,
destination_node_id=None,
data_specifier=MessageDataSpecifier(12345),
data_type_hash=0xdead_beef_bad_c0ffe,
transfer_id=0,
index=-1,
end_of_transfer=False,
payload=memoryview(b'abcdef'))
def _unittest_output_session() -> None:
from pytest import raises
from pyuavcan.transport import OutputSessionSpecifier, MessageDataSpecifier, ServiceDataSpecifier, Priority
from pyuavcan.transport import PayloadMetadata, SessionStatistics, Timestamp, Feedback, Transfer
ts = Timestamp.now()
loop = asyncio.get_event_loop()
run_until_complete = loop.run_until_complete
finalized = False
def do_finalize() -> None:
nonlocal finalized
finalized = True
def check_timestamp(t: pyuavcan.transport.Timestamp) -> bool:
now = pyuavcan.transport.Timestamp.now()
s = ts.system_ns <= t.system_ns <= now.system_ns
m = ts.monotonic_ns <= t.monotonic_ns <= now.system_ns
return s and m
destination_endpoint = '127.100.0.1', 25406
sock_rx = socket_.socket(socket_.AF_INET, socket_.SOCK_DGRAM)
sock_rx.bind(destination_endpoint)
sock_rx.settimeout(1.0)
def make_sock() -> socket_.socket:
sock = socket_.socket(socket_.AF_INET, socket_.SOCK_DGRAM)
sock.bind(('127.100.0.2', 0))
sock.connect(destination_endpoint)
sock.setblocking(False)
return sock
sos = UDPOutputSession(
specifier=OutputSessionSpecifier(MessageDataSpecifier(3210), None),
payload_metadata=PayloadMetadata(0xdead_beef_badc0ffe, 1024),
mtu=11,
multiplier=1,
sock=make_sock(),
loop=asyncio.get_event_loop(),
finalizer=do_finalize,
)
assert sos.specifier == OutputSessionSpecifier(MessageDataSpecifier(3210),
None)
assert sos.destination_node_id is None
assert sos.payload_metadata == PayloadMetadata(0xdead_beef_badc0ffe, 1024)
assert sos.sample_statistics() == SessionStatistics()
assert run_until_complete(
sos.send_until(
Transfer(timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b'one'),
memoryview(b'two'),
memoryview(b'three')
]),
loop.time() + 10.0))
rx_data, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == '127.100.0.2'
assert rx_data == (
b'\x00\x04\x00\x00\x00\x00\x00\x8040\x00\x00\x00\x00\x00\x00\xfe\x0f\xdc\xba\xef\xbe\xad\xde'
+ b'one'
b'two'
b'three')
with raises(socket_.timeout):
sock_rx.recvfrom(1000)
last_feedback: typing.Optional[Feedback] = None
def feedback_handler(feedback: Feedback) -> None:
nonlocal last_feedback
last_feedback = feedback
sos.enable_feedback(feedback_handler)
assert last_feedback is None
assert run_until_complete(
sos.send_until(
Transfer(timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[]),
loop.time() + 10.0))
assert last_feedback is not None
assert last_feedback.original_transfer_timestamp == ts
assert check_timestamp(last_feedback.first_frame_transmission_timestamp)
sos.disable_feedback()
sos.disable_feedback() # Idempotency check
_, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == '127.100.0.2'
with raises(socket_.timeout):
sock_rx.recvfrom(1000)
assert sos.sample_statistics() == SessionStatistics(transfers=2,
frames=2,
payload_bytes=11,
errors=0,
drops=0)
assert sos.socket.fileno() >= 0
assert not finalized
sos.close()
assert finalized
assert sos.socket.fileno() < 0 # The socket is supposed to be disposed of.
finalized = False
# Multi-frame with multiplication
sos = UDPOutputSession(
specifier=OutputSessionSpecifier(
ServiceDataSpecifier(321, ServiceDataSpecifier.Role.REQUEST),
2222),
payload_metadata=PayloadMetadata(0xdead_beef_badc0ffe, 1024),
mtu=10,
multiplier=2,
sock=make_sock(),
loop=asyncio.get_event_loop(),
finalizer=do_finalize,
)
assert run_until_complete(
sos.send_until(
Transfer(timestamp=ts,
priority=Priority.OPTIONAL,
transfer_id=54321,
fragmented_payload=[
memoryview(b'one'),
memoryview(b'two'),
memoryview(b'three')
]),
loop.time() + 10.0))
data_main_a, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == '127.100.0.2'
data_main_b, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == '127.100.0.2'
data_redundant_a, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == '127.100.0.2'
data_redundant_b, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == '127.100.0.2'
with raises(socket_.timeout):
sock_rx.recvfrom(1000)
print('data_main_a', data_main_a)
print('data_main_b', data_main_b)
print('data_redundant_a', data_redundant_a)
print('data_redundant_b', data_redundant_b)
assert data_main_a == data_redundant_a
assert data_main_b == data_redundant_b
assert data_main_a == (
b'\x00\x07\x00\x00\x00\x00\x00\x001\xd4\x00\x00\x00\x00\x00\x00\xfe\x0f\xdc\xba\xef\xbe\xad\xde'
+ b'one'
b'two'
b'three'[:-1])
assert data_main_b == (
b'\x00\x07\x00\x00\x01\x00\x00\x801\xd4\x00\x00\x00\x00\x00\x00\xfe\x0f\xdc\xba\xef\xbe\xad\xde'
+ b'e' + pyuavcan.transport.commons.crc.CRC32C.new(
b'one', b'two', b'three').value_as_bytes)
sos = UDPOutputSession(
specifier=OutputSessionSpecifier(
ServiceDataSpecifier(321, ServiceDataSpecifier.Role.REQUEST),
2222),
payload_metadata=PayloadMetadata(0xdead_beef_badc0ffe, 1024),
mtu=10,
multiplier=1,
sock=make_sock(),
loop=asyncio.get_event_loop(),
finalizer=do_finalize,
)
# Induced timeout
assert not run_until_complete(
sos.send_until(
Transfer(timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b'one'),
memoryview(b'two'),
memoryview(b'three')
]),
loop.time() - 0.1 # Expired on arrival
))
assert sos.sample_statistics() == SessionStatistics(
transfers=0,
frames=0,
payload_bytes=0,
errors=0,
drops=2 # Because multiframe
)
# Induced failure
sos.socket.close()
with raises(OSError):
assert not run_until_complete(
sos.send_until(
Transfer(timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b'one'),
memoryview(b'two'),
memoryview(b'three')
]),
loop.time() + 10.0))
assert sos.sample_statistics() == SessionStatistics(transfers=0,
frames=0,
payload_bytes=0,
errors=1,
drops=2)
assert not finalized
sos.close()
assert finalized
sos.close() # Idempotency
with raises(pyuavcan.transport.ResourceClosedError):
run_until_complete(
sos.send_until(
Transfer(timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b'one'),
memoryview(b'two'),
memoryview(b'three')
]),
loop.time() + 10.0))
sock_rx.close()
async def _unittest_serial_transport(caplog: typing.Any) -> None:
from pyuavcan.transport import MessageDataSpecifier, ServiceDataSpecifier, PayloadMetadata, Transfer, TransferFrom
from pyuavcan.transport import Priority, Timestamp, InputSessionSpecifier, OutputSessionSpecifier
from pyuavcan.transport import ProtocolParameters
get_monotonic = asyncio.get_event_loop().time
service_multiplication_factor = 2
with pytest.raises(ValueError):
_ = SerialTransport(serial_port="loop://", local_node_id=None, mtu=1)
with pytest.raises(ValueError):
_ = SerialTransport(serial_port="loop://",
local_node_id=None,
service_transfer_multiplier=10000)
with pytest.raises(pyuavcan.transport.InvalidMediaConfigurationError):
_ = SerialTransport(serial_port=serial.serial_for_url(
"loop://", do_not_open=True),
local_node_id=None)
tr = SerialTransport(serial_port="loop://", local_node_id=None, mtu=1024)
assert tr.local_node_id is None
assert tr.serial_port.is_open
assert tr.input_sessions == []
assert tr.output_sessions == []
assert tr.protocol_parameters == ProtocolParameters(
transfer_id_modulo=2**64,
max_nodes=4096,
mtu=1024,
)
assert tr.sample_statistics() == SerialTransportStatistics()
sft_capacity = 1024
payload_single = [_mem("qwertyui"), _mem("01234567")
] * (sft_capacity // 16)
assert sum(map(len, payload_single)) == sft_capacity
payload_x3 = (payload_single * 3)[:-1]
payload_x3_size_bytes = sft_capacity * 3 - 8
assert sum(map(len, payload_x3)) == payload_x3_size_bytes
#
# Instantiate session objects.
#
meta = PayloadMetadata(10000)
broadcaster = tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
assert broadcaster is tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
subscriber_promiscuous = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
assert subscriber_promiscuous is tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
subscriber_selective = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2345), 3210), meta)
assert subscriber_selective is tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2345), 3210), meta)
server_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
None), meta)
assert server_listener is tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
None), meta)
client_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
3210), meta)
assert client_listener is tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
3210), meta)
print("INPUTS:", tr.input_sessions)
print("OUTPUTS:", tr.output_sessions)
assert set(tr.input_sessions) == {
subscriber_promiscuous, subscriber_selective, server_listener,
client_listener
}
assert set(tr.output_sessions) == {broadcaster}
assert tr.sample_statistics() == SerialTransportStatistics()
#
# Message exchange test.
#
assert await broadcaster.send(
Transfer(timestamp=Timestamp.now(),
priority=Priority.LOW,
transfer_id=77777,
fragmented_payload=payload_single),
monotonic_deadline=get_monotonic() + 5.0,
)
rx_transfer = await subscriber_promiscuous.receive(get_monotonic() + 5.0)
print("PROMISCUOUS SUBSCRIBER TRANSFER:", rx_transfer)
assert isinstance(rx_transfer, TransferFrom)
assert rx_transfer.priority == Priority.LOW
assert rx_transfer.transfer_id == 77777
assert rx_transfer.fragmented_payload == [b"".join(payload_single)]
print(tr.sample_statistics())
assert tr.sample_statistics().in_bytes >= 32 + sft_capacity + 2
assert tr.sample_statistics().in_frames == 1
assert tr.sample_statistics().in_out_of_band_bytes == 0
assert tr.sample_statistics().out_bytes == tr.sample_statistics().in_bytes
assert tr.sample_statistics().out_frames == 1
assert tr.sample_statistics().out_transfers == 1
assert tr.sample_statistics().out_incomplete == 0
with pytest.raises(
pyuavcan.transport.OperationNotDefinedForAnonymousNodeError):
# Anonymous nodes can't send multiframe transfers.
assert await broadcaster.send(
Transfer(timestamp=Timestamp.now(),
priority=Priority.LOW,
transfer_id=77777,
fragmented_payload=payload_x3),
monotonic_deadline=get_monotonic() + 5.0,
)
assert None is await subscriber_selective.receive(get_monotonic() + 0.1)
assert None is await subscriber_promiscuous.receive(get_monotonic() + 0.1)
assert None is await server_listener.receive(get_monotonic() + 0.1)
assert None is await client_listener.receive(get_monotonic() + 0.1)
#
# Service exchange test.
#
with pytest.raises(
pyuavcan.transport.OperationNotDefinedForAnonymousNodeError):
# Anonymous nodes can't emit service transfers.
tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
3210), meta)
#
# Replace the transport with a different one where the local node-ID is not None.
#
tr = SerialTransport(serial_port="loop://", local_node_id=3210, mtu=1024)
assert tr.local_node_id == 3210
#
# Re-instantiate session objects because the transport instances have been replaced.
#
broadcaster = tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
assert broadcaster is tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
subscriber_promiscuous = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
subscriber_selective = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2345), 3210), meta)
server_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
None), meta)
server_responder = tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
3210), meta)
assert server_responder is tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
3210), meta)
client_requester = tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
3210), meta)
assert client_requester is tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
3210), meta)
client_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
3210), meta)
assert client_listener is tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
3210), meta)
assert set(tr.input_sessions) == {
subscriber_promiscuous, subscriber_selective, server_listener,
client_listener
}
assert set(tr.output_sessions) == {
broadcaster, server_responder, client_requester
}
assert tr.sample_statistics() == SerialTransportStatistics()
assert await client_requester.send(
Transfer(timestamp=Timestamp.now(),
priority=Priority.HIGH,
transfer_id=88888,
fragmented_payload=payload_x3),
monotonic_deadline=get_monotonic() + 5.0,
)
rx_transfer = await server_listener.receive(get_monotonic() + 5.0)
print("SERVER LISTENER TRANSFER:", rx_transfer)
assert isinstance(rx_transfer, TransferFrom)
assert rx_transfer.priority == Priority.HIGH
assert rx_transfer.transfer_id == 88888
assert len(rx_transfer.fragmented_payload) == 3
assert b"".join(rx_transfer.fragmented_payload) == b"".join(payload_x3)
assert None is await subscriber_selective.receive(get_monotonic() + 0.1)
assert None is await subscriber_promiscuous.receive(get_monotonic() + 0.1)
assert None is await server_listener.receive(get_monotonic() + 0.1)
assert None is await client_listener.receive(get_monotonic() + 0.1)
print(tr.sample_statistics())
assert tr.sample_statistics().in_bytes >= (
32 * 3 + payload_x3_size_bytes + 2) * service_multiplication_factor
assert tr.sample_statistics(
).in_frames == 3 * service_multiplication_factor
assert tr.sample_statistics().in_out_of_band_bytes == 0
assert tr.sample_statistics().out_bytes == tr.sample_statistics().in_bytes
assert tr.sample_statistics(
).out_frames == 3 * service_multiplication_factor
assert tr.sample_statistics(
).out_transfers == 1 * service_multiplication_factor
assert tr.sample_statistics().out_incomplete == 0
#
# Write timeout test.
#
assert not await broadcaster.send(
Transfer(timestamp=Timestamp.now(),
priority=Priority.IMMEDIATE,
transfer_id=99999,
fragmented_payload=payload_x3),
monotonic_deadline=get_monotonic() -
5.0, # The deadline is in the past.
)
assert None is await subscriber_selective.receive(get_monotonic() + 0.1)
assert None is await subscriber_promiscuous.receive(get_monotonic() + 0.1)
assert None is await server_listener.receive(get_monotonic() + 0.1)
assert None is await client_listener.receive(get_monotonic() + 0.1)
print(tr.sample_statistics())
assert tr.sample_statistics().in_bytes >= (
32 * 3 + payload_x3_size_bytes + 2) * service_multiplication_factor
assert tr.sample_statistics(
).in_frames == 3 * service_multiplication_factor
assert tr.sample_statistics().in_out_of_band_bytes == 0
assert tr.sample_statistics().out_bytes == tr.sample_statistics().in_bytes
assert tr.sample_statistics(
).out_frames == 3 * service_multiplication_factor
assert tr.sample_statistics(
).out_transfers == 1 * service_multiplication_factor
assert tr.sample_statistics().out_incomplete == 1 # INCREMENTED HERE
#
# Selective message exchange test.
#
assert await broadcaster.send(
Transfer(timestamp=Timestamp.now(),
priority=Priority.IMMEDIATE,
transfer_id=99999,
fragmented_payload=payload_x3),
monotonic_deadline=get_monotonic() + 5.0,
)
rx_transfer = await subscriber_promiscuous.receive(get_monotonic() + 5.0)
print("PROMISCUOUS SUBSCRIBER TRANSFER:", rx_transfer)
assert isinstance(rx_transfer, TransferFrom)
assert rx_transfer.priority == Priority.IMMEDIATE
assert rx_transfer.transfer_id == 99999
assert b"".join(rx_transfer.fragmented_payload) == b"".join(payload_x3)
rx_transfer = await subscriber_selective.receive(get_monotonic() + 1.0)
print("SELECTIVE SUBSCRIBER TRANSFER:", rx_transfer)
assert isinstance(rx_transfer, TransferFrom)
assert rx_transfer.priority == Priority.IMMEDIATE
assert rx_transfer.transfer_id == 99999
assert b"".join(rx_transfer.fragmented_payload) == b"".join(payload_x3)
assert None is await subscriber_selective.receive(get_monotonic() + 0.1)
assert None is await subscriber_promiscuous.receive(get_monotonic() + 0.1)
assert None is await server_listener.receive(get_monotonic() + 0.1)
assert None is await client_listener.receive(get_monotonic() + 0.1)
#
# Out-of-band data test.
#
with caplog.at_level(logging.CRITICAL,
logger=pyuavcan.transport.serial.__name__):
stats_reference = tr.sample_statistics()
# The frame delimiter is needed to force new frame into the state machine.
grownups = b"Aren't there any grownups at all? - No grownups!\x00"
tr.serial_port.write(grownups)
stats_reference.in_bytes += len(grownups)
stats_reference.in_out_of_band_bytes += len(grownups)
# Wait for the reader thread to catch up.
assert None is await subscriber_selective.receive(get_monotonic() +
0.2)
assert None is await subscriber_promiscuous.receive(get_monotonic() +
0.2)
assert None is await server_listener.receive(get_monotonic() + 0.2)
assert None is await client_listener.receive(get_monotonic() + 0.2)
print(tr.sample_statistics())
assert tr.sample_statistics() == stats_reference
# The frame delimiter is needed to force new frame into the state machine.
tr.serial_port.write(
bytes([0xFF, 0xFF, SerialFrame.FRAME_DELIMITER_BYTE]))
stats_reference.in_bytes += 3
stats_reference.in_out_of_band_bytes += 3
# Wait for the reader thread to catch up.
assert None is await subscriber_selective.receive(get_monotonic() +
0.2)
assert None is await subscriber_promiscuous.receive(get_monotonic() +
0.2)
assert None is await server_listener.receive(get_monotonic() + 0.2)
assert None is await client_listener.receive(get_monotonic() + 0.2)
print(tr.sample_statistics())
assert tr.sample_statistics() == stats_reference
#
# Termination.
#
assert set(tr.input_sessions) == {
subscriber_promiscuous, subscriber_selective, server_listener,
client_listener
}
assert set(tr.output_sessions) == {
broadcaster, server_responder, client_requester
}
subscriber_promiscuous.close()
subscriber_promiscuous.close() # Idempotency.
assert set(tr.input_sessions) == {
subscriber_selective, server_listener, client_listener
}
assert set(tr.output_sessions) == {
broadcaster, server_responder, client_requester
}
broadcaster.close()
broadcaster.close() # Idempotency.
assert set(tr.input_sessions) == {
subscriber_selective, server_listener, client_listener
}
assert set(tr.output_sessions) == {server_responder, client_requester}
tr.close()
tr.close() # Idempotency.
assert not set(tr.input_sessions)
assert not set(tr.output_sessions)
with pytest.raises(pyuavcan.transport.ResourceClosedError):
_ = tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
with pytest.raises(pyuavcan.transport.ResourceClosedError):
_ = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
await asyncio.sleep(
1
) # Let all pending tasks finalize properly to avoid stack traces in the output.
async def _unittest_serial_transport_capture(caplog: typing.Any) -> None:
from pyuavcan.transport import MessageDataSpecifier, ServiceDataSpecifier, PayloadMetadata, Transfer
from pyuavcan.transport import Priority, Timestamp, OutputSessionSpecifier
get_monotonic = asyncio.get_event_loop().time
tr = SerialTransport(serial_port="loop://",
local_node_id=42,
mtu=1024,
service_transfer_multiplier=2)
sft_capacity = 1024
payload_single = [_mem("qwertyui"), _mem("01234567")
] * (sft_capacity // 16)
assert sum(map(len, payload_single)) == sft_capacity
payload_x3 = (payload_single * 3)[:-1]
payload_x3_size_bytes = sft_capacity * 3 - 8
assert sum(map(len, payload_x3)) == payload_x3_size_bytes
broadcaster = tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(2345), None),
PayloadMetadata(10000))
client_requester = tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
3210),
PayloadMetadata(10000),
)
events: typing.List[SerialCapture] = []
events2: typing.List[pyuavcan.transport.Capture] = []
def append_events(cap: pyuavcan.transport.Capture) -> None:
assert isinstance(cap, SerialCapture)
events.append(cap)
tr.begin_capture(append_events)
tr.begin_capture(events2.append)
assert events == []
assert events2 == []
#
# Multi-frame message.
#
ts = Timestamp.now()
assert await broadcaster.send(
Transfer(timestamp=ts,
priority=Priority.LOW,
transfer_id=777,
fragmented_payload=payload_x3),
monotonic_deadline=get_monotonic() + 5.0,
)
await asyncio.sleep(0.1)
assert events == events2
# Send three, receive three.
# Sorting is required because the ordering of the events in the middle is not defined: arrival events
# may or may not be registered before the emission event depending on how the serial loopback is operating.
a, b, c, d, e, f = sorted(events, key=lambda x: not x.own)
assert isinstance(a, SerialCapture) and a.own
assert isinstance(b, SerialCapture) and b.own
assert isinstance(c, SerialCapture) and c.own
assert isinstance(d, SerialCapture) and not d.own
assert isinstance(e, SerialCapture) and not e.own
assert isinstance(f, SerialCapture) and not f.own
def parse(x: SerialCapture) -> SerialFrame:
out = SerialFrame.parse_from_cobs_image(x.fragment)
assert out is not None
return out
assert parse(a).transfer_id == 777
assert parse(b).transfer_id == 777
assert parse(c).transfer_id == 777
assert a.timestamp.monotonic >= ts.monotonic
assert b.timestamp.monotonic >= ts.monotonic
assert c.timestamp.monotonic >= ts.monotonic
assert parse(a).index == 0
assert parse(b).index == 1
assert parse(c).index == 2
assert not parse(a).end_of_transfer
assert not parse(b).end_of_transfer
assert parse(c).end_of_transfer
assert a.fragment.tobytes().strip(b"\x00") == d.fragment.tobytes().strip(
b"\x00")
assert b.fragment.tobytes().strip(b"\x00") == e.fragment.tobytes().strip(
b"\x00")
assert c.fragment.tobytes().strip(b"\x00") == f.fragment.tobytes().strip(
b"\x00")
events.clear()
events2.clear()
#
# Single-frame service request with dual frame duplication.
#
ts = Timestamp.now()
assert await client_requester.send(
Transfer(timestamp=ts,
priority=Priority.HIGH,
transfer_id=888,
fragmented_payload=payload_single),
monotonic_deadline=get_monotonic() + 5.0,
)
await asyncio.sleep(0.1)
assert events == events2
# Send two, receive two.
# Sorting is required because the order of the two events in the middle is not defined: the arrival event
# may or may not be registered before the emission event depending on how the serial loopback is operating.
a, b, c, d = sorted(events, key=lambda x: not x.own)
assert isinstance(a, SerialCapture) and a.own
assert isinstance(b, SerialCapture) and b.own
assert isinstance(c, SerialCapture) and not c.own
assert isinstance(d, SerialCapture) and not d.own
assert parse(a).transfer_id == 888
assert parse(b).transfer_id == 888
assert a.timestamp.monotonic >= ts.monotonic
assert b.timestamp.monotonic >= ts.monotonic
assert parse(a).index == 0
assert parse(b).index == 0
assert parse(a).end_of_transfer
assert parse(b).end_of_transfer
assert a.fragment.tobytes().strip(b"\x00") == c.fragment.tobytes().strip(
b"\x00")
assert b.fragment.tobytes().strip(b"\x00") == d.fragment.tobytes().strip(
b"\x00")
events.clear()
events2.clear()
#
# Out-of-band data.
#
grownups = b"Aren't there any grownups at all? - No grownups!\x00"
with caplog.at_level(logging.CRITICAL,
logger=pyuavcan.transport.serial.__name__):
# The frame delimiter is needed to force new frame into the state machine.
tr.serial_port.write(grownups)
await asyncio.sleep(1)
assert events == events2
(oob, ) = events
assert isinstance(oob, SerialCapture)
assert not oob.own
assert bytes(oob.fragment) == grownups
events.clear()
events2.clear()
def _unittest_can_identifier_parse() -> None:
from pytest import raises
from pyuavcan.transport import Priority, MessageDataSpecifier, ServiceDataSpecifier
with raises(ValueError):
CANID.parse(_CANID_EXT_MASK + 1)
with raises(ValueError):
MessageCANID(Priority.HIGH, None, 2**15)
with raises(ValueError):
MessageCANID(Priority.HIGH, 128, 123)
with raises(ValueError):
MessageCANID(Priority.HIGH, 123, -1)
with raises(ValueError):
MessageCANID(Priority.HIGH, -1, 123)
with raises(ValueError):
ServiceCANID(Priority.HIGH, -1, 123, 123, True)
with raises(ValueError):
ServiceCANID(Priority.HIGH, 128, 123, 123, True)
with raises(ValueError):
ServiceCANID(Priority.HIGH, 123, -1, 123, True)
with raises(ValueError):
ServiceCANID(Priority.HIGH, 123, 128, 123, True)
with raises(ValueError):
ServiceCANID(Priority.HIGH, 123, 123, -1, True)
with raises(ValueError):
ServiceCANID(Priority.HIGH, 123, 123, 512, True)
with raises(ValueError):
# noinspection PyTypeChecker
ServiceCANID(Priority.HIGH, None, 123, 512, True) # type: ignore
with raises(ValueError):
ServiceCANID(Priority.HIGH, 123, 123, 42,
True) # Same source and destination
assert CANID.parse(0b_010_0_0_0110100100101001_1_1111011) is None
reference_message = MessageCANID(Priority.FAST, 123, 2345)
assert CANID.parse(
0b_010_0_0_0110100100101001_0_1111011) == reference_message
assert CANID.parse(
0b_010_0_0_0100100100101001_0_1111011) == reference_message
assert CANID.parse(
0b_010_0_0_0010100100101001_0_1111011) == reference_message
assert CANID.parse(
0b_010_0_0_0000100100101001_0_1111011) == reference_message
assert 0b_010_0_0_0110100100101001_0_1111011 == reference_message.compile(
[])
assert reference_message.data_specifier == MessageDataSpecifier(2345)
assert CANID.parse(0b_010_0_1_0111000011100001_1_1111111) is None
reference_message = MessageCANID(Priority.FAST, None, 4321)
assert CANID.parse(
0b_010_0_1_0111000011100001_0_1111111) == reference_message
assert CANID.parse(
0b_010_0_1_0101000011100001_0_1111111) == reference_message
assert CANID.parse(
0b_010_0_1_0011000011100001_0_1111111) == reference_message
assert CANID.parse(
0b_010_0_1_0001000011100001_0_1111111) == reference_message
assert 0b_010_0_1_0111000011100001_0_1111111 == reference_message.compile(
[memoryview(bytes([100, 27]))])
assert reference_message.data_specifier == MessageDataSpecifier(4321)
reference_service = ServiceCANID(Priority.OPTIONAL, 123, 42, 300, True)
reference_service_id = 0b_111_1_1_0100101100_0101010_1111011
assert CANID.parse(reference_service_id) == reference_service
assert reference_service_id == reference_service.compile([])
assert reference_service.data_specifier == ServiceDataSpecifier(
300, ServiceDataSpecifier.Role.REQUEST)
reference_service = ServiceCANID(Priority.OPTIONAL, 42, 123, 255, False)
reference_service_id = 0b_111_1_0_0011111111_1111011_0101010
assert CANID.parse(reference_service_id) == reference_service
assert reference_service_id == reference_service.compile([])
assert reference_service.data_specifier == ServiceDataSpecifier(
255, ServiceDataSpecifier.Role.RESPONSE)
async def _unittest_udp_transport_ipv4() -> None:
from pyuavcan.transport import MessageDataSpecifier, ServiceDataSpecifier, PayloadMetadata, Transfer, TransferFrom
from pyuavcan.transport import Priority, Timestamp, InputSessionSpecifier, OutputSessionSpecifier
from pyuavcan.transport import ProtocolParameters
asyncio.get_running_loop().slow_callback_duration = 5.0
get_monotonic = asyncio.get_event_loop().time
with pytest.raises(ValueError):
_ = UDPTransport("127.0.0.111", mtu=10)
with pytest.raises(ValueError):
_ = UDPTransport("127.0.0.111", service_transfer_multiplier=100)
tr = UDPTransport("127.0.0.111", mtu=9000)
tr2 = UDPTransport("127.0.0.222", service_transfer_multiplier=2)
assert tr.local_ip_address == ipaddress.ip_address("127.0.0.111")
assert tr2.local_ip_address == ipaddress.ip_address("127.0.0.222")
assert tr.loop is asyncio.get_event_loop()
assert tr.local_node_id == 111
assert tr2.local_node_id == 222
assert tr.input_sessions == []
assert tr.output_sessions == []
assert "127.0.0.111" in repr(tr)
assert tr.protocol_parameters == ProtocolParameters(
transfer_id_modulo=2 ** 64,
max_nodes=65535,
mtu=9000,
)
default_mtu = min(UDPTransport.VALID_MTU_RANGE)
assert "127.0.0.222" in repr(tr2)
assert tr2.protocol_parameters == ProtocolParameters(
transfer_id_modulo=2 ** 64,
max_nodes=65535,
mtu=default_mtu,
)
assert tr.sample_statistics() == tr2.sample_statistics() == UDPTransportStatistics()
payload_single = [_mem("qwertyui"), _mem("01234567")] * (default_mtu // 16)
assert sum(map(len, payload_single)) == default_mtu
payload_x3 = (payload_single * 3)[:-1]
payload_x3_size_bytes = default_mtu * 3 - 8
assert sum(map(len, payload_x3)) == payload_x3_size_bytes
#
# Instantiate session objects.
#
meta = PayloadMetadata(10000)
broadcaster = tr2.get_output_session(OutputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
assert broadcaster is tr2.get_output_session(OutputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
subscriber_promiscuous = tr.get_input_session(InputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
assert subscriber_promiscuous is tr.get_input_session(InputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
subscriber_selective = tr.get_input_session(InputSessionSpecifier(MessageDataSpecifier(2345), 123), meta)
assert subscriber_selective is tr.get_input_session(InputSessionSpecifier(MessageDataSpecifier(2345), 123), meta)
server_listener = tr.get_input_session(
InputSessionSpecifier(ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST), None), meta
)
assert server_listener is tr.get_input_session(
InputSessionSpecifier(ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST), None), meta
)
server_responder = tr.get_output_session(
OutputSessionSpecifier(ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE), 222), meta
)
assert server_responder is tr.get_output_session(
OutputSessionSpecifier(ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE), 222), meta
)
client_requester = tr2.get_output_session(
OutputSessionSpecifier(ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST), 111), meta
)
assert client_requester is tr2.get_output_session(
OutputSessionSpecifier(ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST), 111), meta
)
client_listener = tr2.get_input_session(
InputSessionSpecifier(ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE), 111), meta
)
assert client_listener is tr2.get_input_session(
InputSessionSpecifier(ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE), 111), meta
)
print("tr :", tr.input_sessions, tr.output_sessions)
assert set(tr.input_sessions) == {subscriber_promiscuous, subscriber_selective, server_listener}
assert set(tr.output_sessions) == {server_responder}
print("tr2:", tr2.input_sessions, tr2.output_sessions)
assert set(tr2.input_sessions) == {client_listener}
assert set(tr2.output_sessions) == {broadcaster, client_requester}
assert tr.sample_statistics().received_datagrams[MessageDataSpecifier(2345)].accepted_datagrams == {}
assert (
tr.sample_statistics()
.received_datagrams[ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST)]
.accepted_datagrams
== {}
)
assert (
tr2.sample_statistics()
.received_datagrams[ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE)]
.accepted_datagrams
== {}
)
#
# Message exchange test.
#
assert await broadcaster.send(
Transfer(
timestamp=Timestamp.now(), priority=Priority.LOW, transfer_id=77777, fragmented_payload=payload_single
),
monotonic_deadline=get_monotonic() + 5.0,
)
rx_transfer = await subscriber_promiscuous.receive(get_monotonic() + 5.0)
print("PROMISCUOUS SUBSCRIBER TRANSFER:", rx_transfer)
assert isinstance(rx_transfer, TransferFrom)
assert rx_transfer.priority == Priority.LOW
assert rx_transfer.transfer_id == 77777
assert rx_transfer.fragmented_payload == [b"".join(payload_single)]
print("tr :", tr.sample_statistics())
assert tr.sample_statistics().received_datagrams[MessageDataSpecifier(2345)].accepted_datagrams == {222: 1}
assert (
tr.sample_statistics()
.received_datagrams[ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST)]
.accepted_datagrams
== {}
)
print("tr2:", tr2.sample_statistics())
assert (
tr2.sample_statistics()
.received_datagrams[ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE)]
.accepted_datagrams
== {}
)
assert None is await subscriber_selective.receive(get_monotonic() + 0.1)
assert None is await subscriber_promiscuous.receive(get_monotonic() + 0.1)
assert None is await server_listener.receive(get_monotonic() + 0.1)
assert None is await client_listener.receive(get_monotonic() + 0.1)
#
# Service exchange test.
#
assert await client_requester.send(
Transfer(timestamp=Timestamp.now(), priority=Priority.HIGH, transfer_id=88888, fragmented_payload=payload_x3),
monotonic_deadline=get_monotonic() + 5.0,
)
rx_transfer = await server_listener.receive(get_monotonic() + 5.0)
print("SERVER LISTENER TRANSFER:", rx_transfer)
assert isinstance(rx_transfer, TransferFrom)
assert rx_transfer.priority == Priority.HIGH
assert rx_transfer.transfer_id == 88888
assert len(rx_transfer.fragmented_payload) == 3
assert b"".join(rx_transfer.fragmented_payload) == b"".join(payload_x3)
assert None is await subscriber_selective.receive(get_monotonic() + 0.1)
assert None is await subscriber_promiscuous.receive(get_monotonic() + 0.1)
assert None is await server_listener.receive(get_monotonic() + 0.1)
assert None is await client_listener.receive(get_monotonic() + 0.1)
print("tr :", tr.sample_statistics())
assert tr.sample_statistics().received_datagrams[MessageDataSpecifier(2345)].accepted_datagrams == {222: 1}
assert tr.sample_statistics().received_datagrams[
ServiceDataSpecifier(444, ServiceDataSpecifier.Role.REQUEST)
].accepted_datagrams == {
222: 3 * 2
} # Deterministic data loss mitigation is enabled, multiplication factor 2
print("tr2:", tr2.sample_statistics())
assert (
tr2.sample_statistics()
.received_datagrams[ServiceDataSpecifier(444, ServiceDataSpecifier.Role.RESPONSE)]
.accepted_datagrams
== {}
)
#
# Termination.
#
assert set(tr.input_sessions) == {subscriber_promiscuous, subscriber_selective, server_listener}
assert set(tr.output_sessions) == {server_responder}
assert set(tr2.input_sessions) == {client_listener}
assert set(tr2.output_sessions) == {broadcaster, client_requester}
subscriber_promiscuous.close()
subscriber_promiscuous.close() # Idempotency.
assert set(tr.input_sessions) == {subscriber_selective, server_listener}
assert set(tr.output_sessions) == {server_responder}
assert set(tr2.input_sessions) == {client_listener}
assert set(tr2.output_sessions) == {broadcaster, client_requester}
broadcaster.close()
broadcaster.close() # Idempotency.
assert set(tr.input_sessions) == {subscriber_selective, server_listener}
assert set(tr.output_sessions) == {server_responder}
assert set(tr2.input_sessions) == {client_listener}
assert set(tr2.output_sessions) == {client_requester}
tr.close()
tr.close() # Idempotency.
tr2.close()
tr2.close() # Idempotency.
assert not set(tr.input_sessions)
assert not set(tr.output_sessions)
assert not set(tr2.input_sessions)
assert not set(tr2.output_sessions)
with pytest.raises(pyuavcan.transport.ResourceClosedError):
_ = tr.get_output_session(OutputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
with pytest.raises(pyuavcan.transport.ResourceClosedError):
_ = tr2.get_input_session(InputSessionSpecifier(MessageDataSpecifier(2345), None), meta)
await asyncio.sleep(1) # Let all pending tasks finalize properly to avoid stack traces in the output.
async def _unittest_loopback_tracer() -> None:
from pyuavcan.transport import AlienTransfer, AlienSessionSpecifier, AlienTransferMetadata, Timestamp, Priority
from pyuavcan.transport import MessageDataSpecifier, ServiceDataSpecifier, TransferTrace
from pyuavcan.transport.loopback import LoopbackCapture
tr = pyuavcan.transport.loopback.LoopbackTransport.make_tracer()
ts = Timestamp.now()
# MESSAGE
msg = AlienTransfer(
AlienTransferMetadata(
Priority.IMMEDIATE, 54321,
AlienSessionSpecifier(1234, None, MessageDataSpecifier(7777))),
[],
)
assert tr.update(LoopbackCapture(ts, msg)) == TransferTrace(
timestamp=ts,
transfer=msg,
transfer_id_timeout=0.0,
)
# REQUEST
req = AlienTransfer(
AlienTransferMetadata(
Priority.NOMINAL,
333333333,
AlienSessionSpecifier(
321, 123,
ServiceDataSpecifier(222, ServiceDataSpecifier.Role.REQUEST)),
),
[],
)
trace_req = tr.update(LoopbackCapture(ts, req))
assert isinstance(trace_req, TransferTrace)
assert trace_req == TransferTrace(
timestamp=ts,
transfer=req,
transfer_id_timeout=0.0,
)
# RESPONSE
res = AlienTransfer(
AlienTransferMetadata(
Priority.NOMINAL,
333333333,
AlienSessionSpecifier(
123, 444,
ServiceDataSpecifier(222, ServiceDataSpecifier.Role.RESPONSE)),
),
[],
)
assert tr.update(LoopbackCapture(ts, res)) == TransferTrace(
timestamp=ts,
transfer=res,
transfer_id_timeout=0.0,
)
# RESPONSE
res = AlienTransfer(
AlienTransferMetadata(
Priority.NOMINAL,
333333333,
AlienSessionSpecifier(
123, 321,
ServiceDataSpecifier(222, ServiceDataSpecifier.Role.RESPONSE)),
),
[],
)
assert tr.update(LoopbackCapture(ts, res)) == TransferTrace(
timestamp=ts,
transfer=res,
transfer_id_timeout=0.0,
)
# Unknown capture types should yield None.
assert tr.update(pyuavcan.transport.Capture(ts)) is None
async def _unittest_can_transport_anon() -> None:
from pyuavcan.transport import MessageDataSpecifier, ServiceDataSpecifier, PayloadMetadata, Transfer, TransferFrom
from pyuavcan.transport import UnsupportedSessionConfigurationError, Priority, SessionStatistics, Timestamp
from pyuavcan.transport import OperationNotDefinedForAnonymousNodeError
from pyuavcan.transport import InputSessionSpecifier, OutputSessionSpecifier
# noinspection PyProtectedMember
from pyuavcan.transport.can._identifier import MessageCANID
# noinspection PyProtectedMember
from pyuavcan.transport.can._frame import UAVCANFrame
from .media.mock import MockMedia, FrameCollector
asyncio.get_running_loop().slow_callback_duration = 1.0
with pytest.raises(pyuavcan.transport.InvalidTransportConfigurationError):
can.CANTransport(MockMedia(set(), 64, 0), None)
with pytest.raises(pyuavcan.transport.InvalidTransportConfigurationError):
can.CANTransport(MockMedia(set(), 7, 16), None)
peers: typing.Set[MockMedia] = set()
media = MockMedia(peers, 64, 10)
media2 = MockMedia(peers, 64, 3)
peeper = MockMedia(peers, 64, 10)
assert len(peers) == 3
tr = can.CANTransport(media, None)
tr2 = can.CANTransport(media2, None)
assert tr.protocol_parameters == pyuavcan.transport.ProtocolParameters(
transfer_id_modulo=32, max_nodes=128, mtu=63)
assert tr.local_node_id is None
assert tr.protocol_parameters == tr2.protocol_parameters
assert not media.automatic_retransmission_enabled
assert not media2.automatic_retransmission_enabled
assert tr.descriptor == f'<can><mock mtu="64">mock@{id(peers):08x}</mock></can>'
#
# Instantiate session objects
#
meta = PayloadMetadata(0x_bad_c0ffee_0dd_f00d, 10000)
with pytest.raises(Exception): # Can't broadcast service calls
tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(123, ServiceDataSpecifier.Role.RESPONSE),
None), meta)
with pytest.raises(
UnsupportedSessionConfigurationError): # Can't unicast messages
tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(1234), 123), meta)
broadcaster = tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
assert broadcaster is tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
subscriber_promiscuous = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2222), None), meta)
assert subscriber_promiscuous is tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2222), None), meta)
subscriber_selective = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2222), 123), meta)
assert subscriber_selective is tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2222), 123), meta)
server_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
None), meta)
assert server_listener is tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
None), meta)
server_responder = tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
123), meta)
assert server_responder is tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
123), meta)
client_requester = tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST), 123),
meta)
assert client_requester is tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST), 123),
meta)
client_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
123), meta)
assert client_listener is tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
123), meta)
assert broadcaster.destination_node_id is None
assert subscriber_promiscuous.source_node_id is None
assert subscriber_selective.source_node_id == 123
assert server_listener.source_node_id is None
assert client_listener.source_node_id == 123
base_ts = time.process_time()
inputs = tr.input_sessions
print(
f'INPUTS (sampled in {time.process_time() - base_ts:.3f}s): {inputs}')
assert set(inputs) == {
subscriber_promiscuous, subscriber_selective, server_listener,
client_listener
}
del inputs
print('OUTPUTS:', tr.output_sessions)
assert set(tr.output_sessions) == {
broadcaster, server_responder, client_requester
}
#
# Basic exchange test, no one is listening
#
media2.configure_acceptance_filters(
[can.media.FilterConfiguration.new_promiscuous()])
peeper.configure_acceptance_filters(
[can.media.FilterConfiguration.new_promiscuous()])
collector = FrameCollector()
peeper.start(collector.give, False)
assert tr.sample_statistics() == can.CANTransportStatistics()
assert tr2.sample_statistics() == can.CANTransportStatistics()
ts = Timestamp.now()
def validate_timestamp(timestamp: Timestamp) -> None:
assert ts.monotonic_ns <= timestamp.monotonic_ns <= time.monotonic_ns()
assert ts.system_ns <= timestamp.system_ns <= time.time_ns()
assert await broadcaster.send_until(
Transfer(
timestamp=ts,
priority=Priority.IMMEDIATE,
transfer_id=32 + 11, # Modulus 11
fragmented_payload=[_mem('abc'), _mem('def')]),
tr.loop.time() + 1.0)
assert broadcaster.sample_statistics() == SessionStatistics(
transfers=1, frames=1, payload_bytes=6)
assert tr.sample_statistics() == can.CANTransportStatistics(out_frames=1)
assert tr2.sample_statistics() == can.CANTransportStatistics(
in_frames=1, in_frames_uavcan=1)
assert tr.sample_statistics(
).media_acceptance_filtering_efficiency == pytest.approx(1)
assert tr2.sample_statistics(
).media_acceptance_filtering_efficiency == pytest.approx(0)
assert tr.sample_statistics().lost_loopback_frames == 0
assert tr2.sample_statistics().lost_loopback_frames == 0
assert collector.pop().is_same_manifestation(
UAVCANFrame(
identifier=MessageCANID(Priority.IMMEDIATE, None, 12345).compile(
[_mem('abcdef')]), # payload fragments joined
padded_payload=_mem('abcdef'),
transfer_id=11,
start_of_transfer=True,
end_of_transfer=True,
toggle_bit=True,
loopback=False).compile())
assert collector.empty
# Can't send anonymous service transfers
with pytest.raises(OperationNotDefinedForAnonymousNodeError):
assert await client_requester.send_until(
Transfer(timestamp=ts,
priority=Priority.IMMEDIATE,
transfer_id=0,
fragmented_payload=[]),
tr.loop.time() + 1.0,
)
assert client_requester.sample_statistics() == SessionStatistics(
) # Not incremented!
# Can't send multiframe anonymous messages
with pytest.raises(OperationNotDefinedForAnonymousNodeError):
assert await broadcaster.send_until(
Transfer(
timestamp=ts,
priority=Priority.SLOW,
transfer_id=2,
fragmented_payload=[_mem('qwe'), _mem('rty')] *
50 # Lots of data here, very multiframe
),
tr.loop.time() + 1.0)
#
# Broadcast exchange with input dispatch test
#
selective_m12345_5 = tr2.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), 5), meta)
selective_m12345_9 = tr2.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), 9), meta)
promiscuous_m12345 = tr2.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
assert await broadcaster.send_until(
Transfer(
timestamp=ts,
priority=Priority.IMMEDIATE,
transfer_id=32 + 11, # Modulus 11
fragmented_payload=[_mem('abc'), _mem('def')]),
tr.loop.time() + 1.0)
assert broadcaster.sample_statistics() == SessionStatistics(
transfers=2, frames=2, payload_bytes=12)
assert tr.sample_statistics() == can.CANTransportStatistics(out_frames=2)
assert tr2.sample_statistics() == can.CANTransportStatistics(
in_frames=2, in_frames_uavcan=2, in_frames_uavcan_accepted=1)
received = await promiscuous_m12345.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.transfer_id == 11
assert received.source_node_id is None # The sender is anonymous
assert received.priority == Priority.IMMEDIATE
validate_timestamp(received.timestamp)
assert received.fragmented_payload == [_mem('abcdef')]
assert selective_m12345_5.sample_statistics() == SessionStatistics(
) # Nothing
assert selective_m12345_9.sample_statistics() == SessionStatistics(
) # Nothing
assert promiscuous_m12345.sample_statistics() == SessionStatistics(
transfers=1, frames=1, payload_bytes=6)
assert not media.automatic_retransmission_enabled
assert not media2.automatic_retransmission_enabled
#
# Finalization.
#
print('str(CANTransport):', tr)
print('str(CANTransport):', tr2)
client_listener.close()
server_listener.close()
subscriber_promiscuous.close()
subscriber_selective.close()
tr.close()
tr2.close()
# Double-close has no effect:
client_listener.close()
server_listener.close()
subscriber_promiscuous.close()
subscriber_selective.close()
tr.close()
tr2.close()
def _unittest_socket_factory() -> None:
from pytest import raises
from ipaddress import ip_address
is_linux = sys.platform.startswith("linux")
fac = SocketFactory.new(ip_address("127.42.1.200"))
assert fac.max_nodes == 0xFFFF
assert str(fac.local_ip_address) == "127.42.1.200"
# SERVICE SOCKET TEST (unicast)
ds = ServiceDataSpecifier(100, ServiceDataSpecifier.Role.REQUEST)
test_u = socket.socket(socket.AF_INET, socket.SOCK_DGRAM,
socket.IPPROTO_UDP)
test_u.bind(("127.42.0.123", service_data_specifier_to_udp_port(ds)))
srv_o = fac.make_output_socket(123, ds)
srv_o.send(b"Goose")
rx = test_u.recvfrom(1024)
assert rx[0] == b"Goose"
assert rx[1][0] == "127.42.1.200"
srv_i = fac.make_input_socket(ds)
test_u.sendto(b"Duck",
("127.42.1.200", service_data_specifier_to_udp_port(ds)))
rx = srv_i.recvfrom(1024)
assert rx[0] == b"Duck"
assert rx[1][0] == "127.42.0.123"
test_u.close()
# MESSAGE SOCKET TEST (multicast)
# Note that Windows does not permit using the same socket for both sending to and receiving from a unicast group
# because in order to specify a particular output interface the socket must be bound to a unicast address.
# So we set up separate sockets for input and output.
test_i = socket.socket(socket.AF_INET, socket.SOCK_DGRAM,
socket.IPPROTO_UDP)
test_i.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
test_i.bind(("239.42.2.100" * is_linux, SUBJECT_PORT))
test_i.setsockopt(
socket.IPPROTO_IP, socket.IP_ADD_MEMBERSHIP,
socket.inet_aton("239.42.2.100") + socket.inet_aton("127.42.0.123"))
msg_o = fac.make_output_socket(
None, MessageDataSpecifier(612)) # 612 = (2 << 8) + 100
msg_o.send(b"Eagle")
rx = test_i.recvfrom(1024)
assert rx[0] == b"Eagle"
assert rx[1][0] == "127.42.1.200"
test_o = socket.socket(socket.AF_INET, socket.SOCK_DGRAM,
socket.IPPROTO_UDP)
test_o.bind(("127.42.0.123", 0))
test_o.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_IF,
socket.inet_aton("127.42.0.123"))
msg_i = fac.make_input_socket(MessageDataSpecifier(612))
test_o.sendto(b"Seagull", ("239.42.2.100", SUBJECT_PORT))
rx = msg_i.recvfrom(1024)
assert rx[0] == b"Seagull"
assert rx[1][0] == "127.42.0.123" # Same address we just bound to.
# ERRORS
with raises(InvalidMediaConfigurationError):
IPv4SocketFactory(ip_address("1.2.3.4")).make_input_socket(
ServiceDataSpecifier(0, ServiceDataSpecifier.Role.RESPONSE))
with raises(InvalidMediaConfigurationError):
IPv4SocketFactory(ip_address("1.2.3.4")).make_input_socket(
MessageDataSpecifier(0))
with raises(InvalidMediaConfigurationError):
IPv4SocketFactory(ip_address("1.2.3.4")).make_output_socket(
1, ServiceDataSpecifier(0, ServiceDataSpecifier.Role.RESPONSE))
with raises(InvalidMediaConfigurationError):
IPv4SocketFactory(ip_address("1.2.3.4")).make_output_socket(
1, MessageDataSpecifier(0))
with raises(UnsupportedSessionConfigurationError):
fac.make_output_socket(1, MessageDataSpecifier(0))
with raises(UnsupportedSessionConfigurationError):
fac.make_output_socket(
None, ServiceDataSpecifier(0, ServiceDataSpecifier.Role.RESPONSE))
# CLEAN UP
test_u.close()
test_i.close()
test_o.close()
srv_o.close()
srv_i.close()
msg_o.close()
msg_i.close()
async def _unittest_can_transport_non_anon(caplog: typing.Any) -> None:
from pyuavcan.transport import MessageDataSpecifier, ServiceDataSpecifier, PayloadMetadata, Transfer, TransferFrom
from pyuavcan.transport import UnsupportedSessionConfigurationError, Priority, SessionStatistics, Timestamp
from pyuavcan.transport import ResourceClosedError, InputSessionSpecifier, OutputSessionSpecifier
# noinspection PyProtectedMember
from pyuavcan.transport.can._identifier import MessageCANID, ServiceCANID
# noinspection PyProtectedMember
from pyuavcan.transport.can._frame import UAVCANFrame
from .media.mock import MockMedia, FrameCollector
asyncio.get_running_loop().slow_callback_duration = 1.0
peers: typing.Set[MockMedia] = set()
media = MockMedia(peers, 64, 10)
media2 = MockMedia(peers, 64, 3)
peeper = MockMedia(peers, 64, 10)
assert len(peers) == 3
tr = can.CANTransport(media, 5)
tr2 = can.CANTransport(media2, 123)
assert tr.protocol_parameters == pyuavcan.transport.ProtocolParameters(
transfer_id_modulo=32, max_nodes=128, mtu=63)
assert tr.local_node_id == 5
assert tr.protocol_parameters == tr2.protocol_parameters
assert media.automatic_retransmission_enabled
assert media2.automatic_retransmission_enabled
#
# Instantiate session objects
#
meta = PayloadMetadata(0x_bad_c0ffee_0dd_f00d, 10000)
with pytest.raises(Exception): # Can't broadcast service calls
tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(123, ServiceDataSpecifier.Role.RESPONSE),
None), meta)
with pytest.raises(
UnsupportedSessionConfigurationError): # Can't unicast messages
tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(1234), 123), meta)
broadcaster = tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
assert broadcaster is tr.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
subscriber_promiscuous = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2222), None), meta)
assert subscriber_promiscuous is tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2222), None), meta)
subscriber_selective = tr.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(2222), 123), meta)
server_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
None), meta)
server_responder = tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
123), meta)
client_requester = tr.get_output_session(
OutputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST), 123),
meta)
client_listener = tr.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
123), meta)
assert set(tr.input_sessions) == {
subscriber_promiscuous, subscriber_selective, server_listener,
client_listener
}
assert set(tr.output_sessions) == {
broadcaster, server_responder, client_requester
}
#
# Basic exchange test, no one is listening
#
media2.configure_acceptance_filters(
[can.media.FilterConfiguration.new_promiscuous()])
peeper.configure_acceptance_filters(
[can.media.FilterConfiguration.new_promiscuous()])
collector = FrameCollector()
peeper.start(collector.give, False)
assert tr.sample_statistics() == can.CANTransportStatistics()
assert tr2.sample_statistics() == can.CANTransportStatistics()
ts = Timestamp.now()
def validate_timestamp(timestamp: Timestamp) -> None:
assert ts.monotonic_ns <= timestamp.monotonic_ns <= time.monotonic_ns()
assert ts.system_ns <= timestamp.system_ns <= time.time_ns()
assert await broadcaster.send_until(
Transfer(
timestamp=ts,
priority=Priority.IMMEDIATE,
transfer_id=32 + 11, # Modulus 11
fragmented_payload=[_mem('abc'), _mem('def')]),
tr.loop.time() + 1.0)
assert broadcaster.sample_statistics() == SessionStatistics(
transfers=1, frames=1, payload_bytes=6)
assert tr.sample_statistics() == can.CANTransportStatistics(out_frames=1)
assert tr2.sample_statistics() == can.CANTransportStatistics(
in_frames=1, in_frames_uavcan=1)
assert tr.sample_statistics(
).media_acceptance_filtering_efficiency == pytest.approx(1)
assert tr2.sample_statistics(
).media_acceptance_filtering_efficiency == pytest.approx(0)
assert tr.sample_statistics().lost_loopback_frames == 0
assert tr2.sample_statistics().lost_loopback_frames == 0
assert collector.pop().is_same_manifestation(
UAVCANFrame(
identifier=MessageCANID(Priority.IMMEDIATE, 5, 12345).compile(
[_mem('abcdef')]), # payload fragments joined
padded_payload=_mem('abcdef'),
transfer_id=11,
start_of_transfer=True,
end_of_transfer=True,
toggle_bit=True,
loopback=False).compile())
assert collector.empty
#
# Broadcast exchange with input dispatch test
#
selective_m12345_5 = tr2.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), 5), meta)
selective_m12345_9 = tr2.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), 9), meta)
promiscuous_m12345 = tr2.get_input_session(
InputSessionSpecifier(MessageDataSpecifier(12345), None), meta)
assert await broadcaster.send_until(
Transfer(
timestamp=ts,
priority=Priority.IMMEDIATE,
transfer_id=32 + 11, # Modulus 11
fragmented_payload=[_mem('abc'), _mem('def')]),
tr.loop.time() + 1.0)
assert broadcaster.sample_statistics() == SessionStatistics(
transfers=2, frames=2, payload_bytes=12)
assert tr.sample_statistics() == can.CANTransportStatistics(out_frames=2)
assert tr2.sample_statistics() == can.CANTransportStatistics(
in_frames=2, in_frames_uavcan=2, in_frames_uavcan_accepted=1)
received = await promiscuous_m12345.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.transfer_id == 11
assert received.source_node_id == 5
assert received.priority == Priority.IMMEDIATE
validate_timestamp(received.timestamp)
assert received.fragmented_payload == [_mem('abcdef')]
assert selective_m12345_5.sample_statistics() == SessionStatistics(
) # Nothing
assert selective_m12345_9.sample_statistics() == SessionStatistics(
) # Nothing
assert promiscuous_m12345.sample_statistics() == SessionStatistics(
transfers=1, frames=1, payload_bytes=6)
assert media.automatic_retransmission_enabled
assert media2.automatic_retransmission_enabled
feedback_collector = _FeedbackCollector()
broadcaster.enable_feedback(feedback_collector.give)
assert await broadcaster.send_until(
Transfer(
timestamp=ts,
priority=Priority.SLOW,
transfer_id=2,
fragmented_payload=[_mem('qwe'), _mem('rty')] *
50 # Lots of data here, very multiframe
),
tr.loop.time() + 1.0)
assert broadcaster.sample_statistics() == SessionStatistics(
transfers=3, frames=7, payload_bytes=312)
broadcaster.disable_feedback()
assert tr.sample_statistics() == can.CANTransportStatistics(
out_frames=7, out_frames_loopback=1, in_frames_loopback=1)
assert tr2.sample_statistics() == can.CANTransportStatistics(
in_frames=7, in_frames_uavcan=7, in_frames_uavcan_accepted=6)
fb = feedback_collector.take()
assert fb.original_transfer_timestamp == ts
validate_timestamp(fb.first_frame_transmission_timestamp)
received = await promiscuous_m12345.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.transfer_id == 2
assert received.source_node_id == 5
assert received.priority == Priority.SLOW
validate_timestamp(received.timestamp)
assert b''.join(
received.fragmented_payload
) == b'qwerty' * 50 + b'\x00' * 13 # The 0x00 at the end is padding
assert await broadcaster.send_until(
Transfer(timestamp=ts,
priority=Priority.OPTIONAL,
transfer_id=3,
fragmented_payload=[_mem('qwe'), _mem('rty')]),
tr.loop.time() + 1.0)
assert broadcaster.sample_statistics() == SessionStatistics(
transfers=4, frames=8, payload_bytes=318)
received = await promiscuous_m12345.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.transfer_id == 3
assert received.source_node_id == 5
assert received.priority == Priority.OPTIONAL
validate_timestamp(received.timestamp)
assert list(received.fragmented_payload) == [_mem('qwerty')]
assert promiscuous_m12345.sample_statistics() == SessionStatistics(
transfers=3, frames=7, payload_bytes=325)
assert tr.sample_statistics() == can.CANTransportStatistics(
out_frames=8, out_frames_loopback=1, in_frames_loopback=1)
assert tr2.sample_statistics() == can.CANTransportStatistics(
in_frames=8, in_frames_uavcan=8, in_frames_uavcan_accepted=7)
broadcaster.close()
with pytest.raises(ResourceClosedError):
assert await broadcaster.send_until(
Transfer(timestamp=ts,
priority=Priority.LOW,
transfer_id=4,
fragmented_payload=[]),
tr.loop.time() + 1.0)
broadcaster.close() # Does nothing
# Final checks for the broadcaster - make sure nothing is left in the queue
assert (await promiscuous_m12345.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
# The selective listener was not supposed to pick up anything because it's selective for node 9, not 5
assert (await selective_m12345_9.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
# Now, there are a bunch of items awaiting in the selective input for node 5, collect them and check the stats
assert selective_m12345_5.source_node_id == 5
received = await selective_m12345_5.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.transfer_id == 11
assert received.source_node_id == 5
assert received.priority == Priority.IMMEDIATE
validate_timestamp(received.timestamp)
assert received.fragmented_payload == [_mem('abcdef')]
received = await selective_m12345_5.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.transfer_id == 2
assert received.source_node_id == 5
assert received.priority == Priority.SLOW
validate_timestamp(received.timestamp)
assert b''.join(
received.fragmented_payload
) == b'qwerty' * 50 + b'\x00' * 13 # The 0x00 at the end is padding
received = await selective_m12345_5.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.transfer_id == 3
assert received.source_node_id == 5
assert received.priority == Priority.OPTIONAL
validate_timestamp(received.timestamp)
assert list(received.fragmented_payload) == [_mem('qwerty')]
assert selective_m12345_5.sample_statistics(
) == promiscuous_m12345.sample_statistics()
#
# Unicast exchange test
#
selective_server_s333_5 = tr2.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST), 5),
meta)
selective_server_s333_9 = tr2.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST), 9),
meta)
promiscuous_server_s333 = tr2.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.REQUEST),
None), meta)
selective_client_s333_5 = tr2.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE), 5),
meta)
selective_client_s333_9 = tr2.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE), 9),
meta)
promiscuous_client_s333 = tr2.get_input_session(
InputSessionSpecifier(
ServiceDataSpecifier(333, ServiceDataSpecifier.Role.RESPONSE),
None), meta)
assert await client_requester.send_until(
Transfer(timestamp=ts,
priority=Priority.FAST,
transfer_id=11,
fragmented_payload=[]),
tr.loop.time() + 1.0)
assert client_requester.sample_statistics() == SessionStatistics(
transfers=1, frames=1, payload_bytes=0)
received = await selective_server_s333_5.receive_until(
tr.loop.time() + 1.0) # Same thing here
assert received is not None
assert received.transfer_id == 11
assert received.priority == Priority.FAST
validate_timestamp(received.timestamp)
assert list(map(bytes, received.fragmented_payload)) == [b'']
assert (await selective_server_s333_9.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
received = await promiscuous_server_s333.receive_until(
tr.loop.time() + 1.0) # Same thing here
assert received is not None
assert received.transfer_id == 11
assert received.priority == Priority.FAST
validate_timestamp(received.timestamp)
assert list(map(bytes, received.fragmented_payload)) == [b'']
assert selective_server_s333_5.sample_statistics() == SessionStatistics(
transfers=1, frames=1)
assert selective_server_s333_9.sample_statistics() == SessionStatistics()
assert promiscuous_server_s333.sample_statistics() == SessionStatistics(
transfers=1, frames=1)
assert (await selective_client_s333_5.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
assert (await selective_client_s333_9.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
assert (await promiscuous_client_s333.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
assert selective_client_s333_5.sample_statistics() == SessionStatistics()
assert selective_client_s333_9.sample_statistics() == SessionStatistics()
assert promiscuous_client_s333.sample_statistics() == SessionStatistics()
client_requester.enable_feedback(
feedback_collector.give) # FEEDBACK ENABLED HERE
# Will fail with an error; make sure it's counted properly. The feedback registry entry will remain pending!
media.raise_on_send_once(RuntimeError('Induced failure'))
with pytest.raises(RuntimeError, match='Induced failure'):
assert await client_requester.send_until(
Transfer(timestamp=ts,
priority=Priority.FAST,
transfer_id=12,
fragmented_payload=[]),
tr.loop.time() + 1.0)
assert client_requester.sample_statistics() == SessionStatistics(
transfers=1, frames=1, payload_bytes=0, errors=1)
# Some malformed feedback frames which will be ignored
media.inject_received([
UAVCANFrame(
identifier=ServiceCANID(priority=Priority.FAST,
source_node_id=5,
destination_node_id=123,
service_id=333,
request_not_response=True).compile(
[_mem('Ignored')]),
padded_payload=_mem('Ignored'),
start_of_transfer=False, # Ignored because not start-of-frame
end_of_transfer=False,
toggle_bit=True,
transfer_id=12,
loopback=True).compile()
])
media.inject_received([
UAVCANFrame(
identifier=ServiceCANID(priority=Priority.FAST,
source_node_id=5,
destination_node_id=123,
service_id=333,
request_not_response=True).compile(
[_mem('Ignored')]),
padded_payload=_mem('Ignored'),
start_of_transfer=True,
end_of_transfer=False,
toggle_bit=True,
transfer_id=
9, # Ignored because there is no such transfer-ID in the registry
loopback=True).compile()
])
# Now, this transmission will succeed, but a pending loopback registry entry will be overwritten, which will be
# reflected in the error counter.
with caplog.at_level(logging.CRITICAL,
logger=pyuavcan.transport.can.__name__):
assert await client_requester.send_until(
Transfer(
timestamp=ts,
priority=Priority.FAST,
transfer_id=12,
fragmented_payload=[
_mem(
'Until philosophers are kings, or the kings and princes of this world have the spirit and power '
'of philosophy, and political greatness and wisdom meet in one, and those commoner natures who '
'pursue either to the exclusion of the other are compelled to stand aside, cities will never '
'have rest from their evils '),
_mem('- no, nor the human race, as I believe - '),
_mem(
'and then only will this our State have a possibility of life and behold the light of day.'
),
]),
tr.loop.time() + 1.0)
client_requester.disable_feedback()
assert client_requester.sample_statistics() == SessionStatistics(
transfers=2, frames=8, payload_bytes=438, errors=2)
# The feedback is disabled, but we will send a valid loopback frame anyway to make sure it is silently ignored
media.inject_received([
UAVCANFrame(identifier=ServiceCANID(priority=Priority.FAST,
source_node_id=5,
destination_node_id=123,
service_id=333,
request_not_response=True).compile(
[_mem('Ignored')]),
padded_payload=_mem('Ignored'),
start_of_transfer=True,
end_of_transfer=False,
toggle_bit=True,
transfer_id=12,
loopback=True).compile()
])
client_requester.close()
with pytest.raises(ResourceClosedError):
assert await client_requester.send_until(
Transfer(timestamp=ts,
priority=Priority.LOW,
transfer_id=4,
fragmented_payload=[]),
tr.loop.time() + 1.0)
fb = feedback_collector.take()
assert fb.original_transfer_timestamp == ts
validate_timestamp(fb.first_frame_transmission_timestamp)
received = await promiscuous_server_s333.receive_until(tr.loop.time() +
1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.source_node_id == 5
assert received.transfer_id == 12
assert received.priority == Priority.FAST
validate_timestamp(received.timestamp)
assert len(received.fragmented_payload) == 7 # Equals the number of frames
assert sum(map(
len, received.fragmented_payload)) == 438 + 1 # Padding also included
assert b'Until philosophers are kings' in bytes(
received.fragmented_payload[0])
assert b'behold the light of day.' in bytes(
received.fragmented_payload[-1])
received = await selective_server_s333_5.receive_until(
tr.loop.time() + 1.0) # Same thing here
assert received is not None
assert received.transfer_id == 12
assert received.priority == Priority.FAST
validate_timestamp(received.timestamp)
assert len(received.fragmented_payload) == 7 # Equals the number of frames
assert sum(map(
len, received.fragmented_payload)) == 438 + 1 # Padding also included
assert b'Until philosophers are kings' in bytes(
received.fragmented_payload[0])
assert b'behold the light of day.' in bytes(
received.fragmented_payload[-1])
# Nothing is received - non-matching node ID selector
assert (await selective_server_s333_9.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
# Nothing is received - non-matching role (not server)
assert (await selective_client_s333_5.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
assert (await selective_client_s333_9.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
assert (await promiscuous_client_s333.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
assert selective_client_s333_5.sample_statistics() == SessionStatistics()
assert selective_client_s333_9.sample_statistics() == SessionStatistics()
assert promiscuous_client_s333.sample_statistics() == SessionStatistics()
# Final transport stats check; additional loopback frames are due to our manual tests above
assert tr.sample_statistics() == can.CANTransportStatistics(
out_frames=16, out_frames_loopback=2, in_frames_loopback=5)
assert tr2.sample_statistics() == can.CANTransportStatistics(
in_frames=16, in_frames_uavcan=16, in_frames_uavcan_accepted=15)
#
# Drop non-UAVCAN frames silently
#
media.inject_received([
can.media.DataFrame(
identifier=ServiceCANID(priority=Priority.FAST,
source_node_id=5,
destination_node_id=123,
service_id=333,
request_not_response=True).compile(
[_mem('')]),
data=bytearray(
b''
), # The CAN ID is valid for UAVCAN, but the payload is not - no tail byte
format=can.media.FrameFormat.EXTENDED,
loopback=False)
])
media.inject_received([
can.media.DataFrame(
identifier=0, # The CAN ID is not valid for UAVCAN
data=bytearray(b'123'),
format=can.media.FrameFormat.BASE,
loopback=False)
])
media.inject_received([
UAVCANFrame(
identifier=ServiceCANID(
priority=Priority.FAST,
source_node_id=5,
destination_node_id=123,
service_id=444, # No such service
request_not_response=True).compile([_mem('Ignored')]),
padded_payload=_mem('Ignored'),
start_of_transfer=True,
end_of_transfer=False,
toggle_bit=True,
transfer_id=12,
loopback=True).compile()
])
assert tr.sample_statistics() == can.CANTransportStatistics(
out_frames=16,
in_frames=2,
out_frames_loopback=2,
in_frames_loopback=6)
assert tr2.sample_statistics() == can.CANTransportStatistics(
in_frames=16, in_frames_uavcan=16, in_frames_uavcan_accepted=15)
#
# Reception logic test.
#
pub_m2222 = tr2.get_output_session(
OutputSessionSpecifier(MessageDataSpecifier(2222), None), meta)
# Transfer ID timeout configuration - one of them will be configured very short for testing purposes
subscriber_promiscuous.transfer_id_timeout = 1e-9 # Very low, basically zero timeout
with pytest.raises(ValueError):
subscriber_promiscuous.transfer_id_timeout = -1
with pytest.raises(ValueError):
subscriber_promiscuous.transfer_id_timeout = float('nan')
assert subscriber_promiscuous.transfer_id_timeout == pytest.approx(1e-9)
subscriber_selective.transfer_id_timeout = 1.0
with pytest.raises(ValueError):
subscriber_selective.transfer_id_timeout = -1
with pytest.raises(ValueError):
subscriber_selective.transfer_id_timeout = float('nan')
assert subscriber_selective.transfer_id_timeout == pytest.approx(1.0)
# Queue capacity configuration
assert subscriber_selective.frame_queue_capacity is None # Unlimited by default
subscriber_selective.frame_queue_capacity = 2
with pytest.raises(ValueError):
subscriber_selective.frame_queue_capacity = 0
assert subscriber_selective.frame_queue_capacity == 2
assert await pub_m2222.send_until(
Transfer(
timestamp=ts,
priority=Priority.EXCEPTIONAL,
transfer_id=7,
fragmented_payload=[
_mem('Finally, from so little sleeping and so much reading, '),
_mem(
'his brain dried up and he went completely out of his mind.'
), # Two frames.
]),
tr.loop.time() + 1.0)
assert tr.sample_statistics() == can.CANTransportStatistics(
out_frames=16,
in_frames=4,
in_frames_uavcan=2,
in_frames_uavcan_accepted=2,
out_frames_loopback=2,
in_frames_loopback=6)
assert tr2.sample_statistics() == can.CANTransportStatistics(
out_frames=2,
in_frames=16,
in_frames_uavcan=16,
in_frames_uavcan_accepted=15)
received = await subscriber_promiscuous.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.source_node_id == 123
assert received.priority == Priority.EXCEPTIONAL
assert received.transfer_id == 7
validate_timestamp(received.timestamp)
assert bytes(received.fragmented_payload[0]).startswith(b'Finally')
assert bytes(received.fragmented_payload[-1]).rstrip(b'\x00').endswith(
b'out of his mind.')
received = await subscriber_selective.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert received.priority == Priority.EXCEPTIONAL
assert received.transfer_id == 7
validate_timestamp(received.timestamp)
assert bytes(received.fragmented_payload[0]).startswith(b'Finally')
assert bytes(received.fragmented_payload[-1]).rstrip(b'\x00').endswith(
b'out of his mind.')
assert subscriber_selective.sample_statistics(
) == subscriber_promiscuous.sample_statistics()
assert subscriber_promiscuous.sample_statistics() == SessionStatistics(
transfers=1, frames=2, payload_bytes=124) # Includes padding!
assert await pub_m2222.send_until(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=
7, # Same transfer ID, will be accepted only by the instance with low TID timeout
fragmented_payload=[]),
tr.loop.time() + 1.0)
assert tr.sample_statistics() == can.CANTransportStatistics(
out_frames=16,
in_frames=5,
in_frames_uavcan=3,
in_frames_uavcan_accepted=3,
out_frames_loopback=2,
in_frames_loopback=6)
assert tr2.sample_statistics() == can.CANTransportStatistics(
out_frames=3,
in_frames=16,
in_frames_uavcan=16,
in_frames_uavcan_accepted=15)
received = await subscriber_promiscuous.receive_until(tr.loop.time() +
10.0)
assert received is not None
assert isinstance(received, TransferFrom)
assert received.source_node_id == 123
assert received.priority == Priority.NOMINAL
assert received.transfer_id == 7
validate_timestamp(received.timestamp)
assert b''.join(received.fragmented_payload) == b''
assert subscriber_promiscuous.sample_statistics() == SessionStatistics(
transfers=2, frames=3, payload_bytes=124)
# Discarded because of the same transfer ID
assert (await subscriber_selective.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
assert subscriber_selective.sample_statistics() == SessionStatistics(
transfers=1,
frames=3,
payload_bytes=124,
errors=1 # Error due to the repeated transfer ID
)
assert await pub_m2222.send_until(
Transfer(
timestamp=ts,
priority=Priority.HIGH,
transfer_id=8,
fragmented_payload=[
_mem('a' * 63),
_mem('b' * 63),
_mem('c' * 63),
_mem(
'd' * 62
), # Tricky case - one of the CRC bytes spills over into the fifth frame
]),
tr.loop.time() + 1.0)
# The promiscuous one is able to receive the transfer since its queue is large enough
received = await subscriber_promiscuous.receive_until(tr.loop.time() + 1.0)
assert received is not None
assert received.priority == Priority.HIGH
assert received.transfer_id == 8
validate_timestamp(received.timestamp)
assert list(map(bytes, received.fragmented_payload)) == [
b'a' * 63,
b'b' * 63,
b'c' * 63,
b'd' * 62,
]
assert subscriber_promiscuous.sample_statistics() == SessionStatistics(
transfers=3, frames=8, payload_bytes=375)
# The selective one is unable to do so since its RX queue is too small; it is reflected in the error counter
assert (await subscriber_selective.receive_until(tr.loop.time() +
_RX_TIMEOUT)) is None
assert subscriber_selective.sample_statistics() == SessionStatistics(
transfers=1, frames=5, payload_bytes=124, errors=1,
drops=3) # Overruns!
#
# Finalization.
#
print('str(CANTransport):', tr)
print('str(CANTransport):', tr2)
client_listener.close()
server_listener.close()
subscriber_promiscuous.close()
subscriber_selective.close()
tr.close()
tr2.close()
# Double-close has no effect:
client_listener.close()
server_listener.close()
subscriber_promiscuous.close()
subscriber_selective.close()
tr.close()
tr2.close()
await asyncio.sleep(
1
) # Let all pending tasks finalize properly to avoid stack traces in the output.
async def _unittest_output_session() -> None:
ts = Timestamp.now()
loop = asyncio.get_event_loop()
loop.slow_callback_duration = 5.0 # TODO use asyncio socket read and remove this thing.
finalized = False
def do_finalize() -> None:
nonlocal finalized
finalized = True
def check_timestamp(t: Timestamp) -> bool:
now = Timestamp.now()
s = ts.system_ns <= t.system_ns <= now.system_ns
m = ts.monotonic_ns <= t.monotonic_ns <= now.system_ns
return s and m
destination_endpoint = "127.100.0.1", 25406
sock_rx = socket_.socket(socket_.AF_INET, socket_.SOCK_DGRAM)
sock_rx.bind(destination_endpoint)
sock_rx.settimeout(1.0)
def make_sock() -> socket_.socket:
sock = socket_.socket(socket_.AF_INET, socket_.SOCK_DGRAM)
sock.bind(("127.100.0.2", 0))
sock.connect(destination_endpoint)
sock.setblocking(False)
return sock
sos = UDPOutputSession(
specifier=OutputSessionSpecifier(MessageDataSpecifier(3210), None),
payload_metadata=PayloadMetadata(1024),
mtu=11,
multiplier=1,
sock=make_sock(),
finalizer=do_finalize,
)
assert sos.specifier == OutputSessionSpecifier(MessageDataSpecifier(3210),
None)
assert sos.destination_node_id is None
assert sos.payload_metadata == PayloadMetadata(1024)
assert sos.sample_statistics() == SessionStatistics()
assert await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() + 10.0,
))
rx_data, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == "127.100.0.2"
assert rx_data == (
b"\x00\x04\x00\x00\x00\x00\x00\x8040\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+ b"one" + b"two" + b"three")
with raises(socket_.timeout):
sock_rx.recvfrom(1000)
last_feedback: typing.Optional[Feedback] = None
def feedback_handler(feedback: Feedback) -> None:
nonlocal last_feedback
last_feedback = feedback
sos.enable_feedback(feedback_handler)
assert last_feedback is None
assert await (sos.send(
Transfer(timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[]),
loop.time() + 10.0,
))
assert last_feedback is not None
assert last_feedback.original_transfer_timestamp == ts
assert check_timestamp(last_feedback.first_frame_transmission_timestamp)
sos.disable_feedback()
sos.disable_feedback() # Idempotency check
_, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == "127.100.0.2"
with raises(socket_.timeout):
sock_rx.recvfrom(1000)
assert sos.sample_statistics() == SessionStatistics(transfers=2,
frames=2,
payload_bytes=11,
errors=0,
drops=0)
assert sos.socket.fileno() >= 0
assert not finalized
sos.close()
assert finalized
assert sos.socket.fileno() < 0 # The socket is supposed to be disposed of.
finalized = False
# Multi-frame with multiplication
sos = UDPOutputSession(
specifier=OutputSessionSpecifier(
ServiceDataSpecifier(321, ServiceDataSpecifier.Role.REQUEST),
2222),
payload_metadata=PayloadMetadata(1024),
mtu=10,
multiplier=2,
sock=make_sock(),
finalizer=do_finalize,
)
assert await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.OPTIONAL,
transfer_id=54321,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() + 10.0,
))
data_main_a, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == "127.100.0.2"
data_main_b, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == "127.100.0.2"
data_redundant_a, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == "127.100.0.2"
data_redundant_b, endpoint = sock_rx.recvfrom(1000)
assert endpoint[0] == "127.100.0.2"
with raises(socket_.timeout):
sock_rx.recvfrom(1000)
print("data_main_a", data_main_a)
print("data_main_b", data_main_b)
print("data_redundant_a", data_redundant_a)
print("data_redundant_b", data_redundant_b)
assert data_main_a == data_redundant_a
assert data_main_b == data_redundant_b
assert data_main_a == (
b"\x00\x07\x00\x00\x00\x00\x00\x001\xd4\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+ b"one" + b"two" + b"three"[:-1])
assert data_main_b == (
b"\x00\x07\x00\x00\x01\x00\x00\x801\xd4\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
+ b"e" + pyuavcan.transport.commons.crc.CRC32C.new(
b"one", b"two", b"three").value_as_bytes)
sos.socket.close() # This is to prevent resource warning
sos = UDPOutputSession(
specifier=OutputSessionSpecifier(
ServiceDataSpecifier(321, ServiceDataSpecifier.Role.REQUEST),
2222),
payload_metadata=PayloadMetadata(1024),
mtu=10,
multiplier=1,
sock=make_sock(),
finalizer=do_finalize,
)
# Induced timeout
assert not await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() - 0.1, # Expired on arrival
))
assert sos.sample_statistics() == SessionStatistics(
transfers=0,
frames=0,
payload_bytes=0,
errors=0,
drops=2 # Because multiframe
)
# Induced failure
sos.socket.close()
with raises(OSError):
assert not await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() + 10.0,
))
assert sos.sample_statistics() == SessionStatistics(transfers=0,
frames=0,
payload_bytes=0,
errors=1,
drops=2)
assert not finalized
sos.close()
assert finalized
sos.close() # Idempotency
with raises(pyuavcan.transport.ResourceClosedError):
await (sos.send(
Transfer(
timestamp=ts,
priority=Priority.NOMINAL,
transfer_id=12340,
fragmented_payload=[
memoryview(b"one"),
memoryview(b"two"),
memoryview(b"three")
],
),
loop.time() + 10.0,
))
sock_rx.close()
async def _unittest_redundant_transport_capture() -> None:
from threading import Lock
from pyuavcan.transport import Capture, Trace, TransferTrace, Priority, ServiceDataSpecifier
from pyuavcan.transport import AlienTransfer, AlienTransferMetadata, AlienSessionSpecifier
from pyuavcan.transport.redundant import RedundantDuplicateTransferTrace, RedundantCapture
from tests.transport.can.media.mock import MockMedia as CANMockMedia
asyncio.get_event_loop().slow_callback_duration = 5.0
tracer = RedundantTransport.make_tracer()
traces: typing.List[typing.Optional[Trace]] = []
lock = Lock()
def handle_capture(cap: Capture) -> None:
with lock:
# Drop TX frames, they are not interesting for this test.
assert isinstance(cap, RedundantCapture)
if isinstance(cap.inferior, pyuavcan.transport.serial.SerialCapture
) and cap.inferior.own:
return
if isinstance(
cap.inferior,
pyuavcan.transport.can.CANCapture) and cap.inferior.own:
return
print("CAPTURE:", cap)
traces.append(tracer.update(cap))
async def wait(how_many: int) -> None:
for _ in range(10):
await asyncio.sleep(0.1)
with lock:
if len(traces) >= how_many:
return
assert False, "No traces received"
# Setup capture -- one is added before capture started, the other is added later.
# Make sure they are treated identically.
tr = RedundantTransport()
inf_a: pyuavcan.transport.Transport = SerialTransport(SERIAL_URI, 1234)
inf_b: pyuavcan.transport.Transport = SerialTransport(SERIAL_URI, 1234)
tr.attach_inferior(inf_a)
assert not tr.capture_active
assert not inf_a.capture_active
assert not inf_b.capture_active
tr.begin_capture(handle_capture)
assert tr.capture_active
assert inf_a.capture_active
assert not inf_b.capture_active
tr.attach_inferior(inf_b)
assert tr.capture_active
assert inf_a.capture_active
assert inf_b.capture_active
# Send a transfer and make sure it is handled and deduplicated correctly.
transfer = AlienTransfer(
AlienTransferMetadata(
priority=Priority.IMMEDIATE,
transfer_id=1234,
session_specifier=AlienSessionSpecifier(
source_node_id=321,
destination_node_id=222,
data_specifier=ServiceDataSpecifier(
77, ServiceDataSpecifier.Role.REQUEST),
),
),
[memoryview(b"hello")],
)
assert await tr.spoof(transfer,
monotonic_deadline=asyncio.get_event_loop().time() +
1.0)
await wait(2)
with lock:
# Check the status of the deduplication process. We should get two: one transfer, one duplicate.
assert len(traces) == 2
trace = traces.pop(0)
assert isinstance(trace, TransferTrace)
assert trace.transfer == transfer
# This is the duplicate.
assert isinstance(traces.pop(0), RedundantDuplicateTransferTrace)
assert not traces
# Spoof the same thing again, get nothing out: transfers discarded by the inferior's own reassemblers.
# WARNING: this will fail if too much time has passed since the previous transfer due to TID timeout.
assert await tr.spoof(transfer,
monotonic_deadline=asyncio.get_event_loop().time() +
1.0)
await wait(2)
with lock:
assert None is traces.pop(0)
assert None is traces.pop(0)
assert not traces
# But if we change ONLY destination, deduplication will not take place.
transfer = AlienTransfer(
AlienTransferMetadata(
priority=Priority.IMMEDIATE,
transfer_id=1234,
session_specifier=AlienSessionSpecifier(
source_node_id=321,
destination_node_id=333,
data_specifier=ServiceDataSpecifier(
77, ServiceDataSpecifier.Role.REQUEST),
),
),
[memoryview(b"hello")],
)
assert await tr.spoof(transfer,
monotonic_deadline=asyncio.get_event_loop().time() +
1.0)
await wait(2)
with lock:
# Check the status of the deduplication process. We should get two: one transfer, one duplicate.
assert len(traces) == 2
trace = traces.pop(0)
assert isinstance(trace, TransferTrace)
assert trace.transfer == transfer
# This is the duplicate.
assert isinstance(traces.pop(0), RedundantDuplicateTransferTrace)
assert not traces
# Change the inferior configuration and make sure it is handled properly.
tr.detach_inferior(inf_a)
tr.detach_inferior(inf_b)
inf_a.close()
inf_b.close()
# The new inferiors use cyclic transfer-ID; the tracer should reconfigure itself automatically!
can_peers: typing.Set[CANMockMedia] = set()
inf_a = CANTransport(CANMockMedia(can_peers, 64, 2), 111)
inf_b = CANTransport(CANMockMedia(can_peers, 64, 2), 111)
tr.attach_inferior(inf_a)
tr.attach_inferior(inf_b)
# Capture should have been launched automatically.
assert inf_a.capture_active
assert inf_b.capture_active
# Send transfer over CAN and observe that it is handled well.
transfer = AlienTransfer(
AlienTransferMetadata(
priority=Priority.IMMEDIATE,
transfer_id=19,
session_specifier=AlienSessionSpecifier(
source_node_id=111,
destination_node_id=22,
data_specifier=ServiceDataSpecifier(
77, ServiceDataSpecifier.Role.REQUEST),
),
),
[memoryview(b"hello")],
)
assert await tr.spoof(transfer,
monotonic_deadline=asyncio.get_event_loop().time() +
1.0)
await wait(2)
with lock:
# Check the status of the deduplication process. We should get two: one transfer, one duplicate.
assert len(traces) == 2
trace = traces.pop(0)
assert isinstance(trace, TransferTrace)
assert trace.transfer == transfer
# This is the duplicate.
assert isinstance(traces.pop(0), RedundantDuplicateTransferTrace)
assert not traces
# Dispose of everything.
tr.close()
await asyncio.sleep(1.0)
def _unittest_udp_tracer() -> None:
import socket
from pytest import approx
from ipaddress import ip_address
from pyuavcan.transport import Priority, ServiceDataSpecifier
from pyuavcan.transport.udp import UDPTransport
from ._ip import service_data_specifier_to_udp_port
tr = UDPTransport.make_tracer()
ts = Timestamp.now()
ds = ServiceDataSpecifier(11, ServiceDataSpecifier.Role.RESPONSE)
# VALID SERVICE FRAME
llp = LinkLayerPacket(
protocol=socket.AF_INET,
source=memoryview(b""),
destination=memoryview(b""),
payload=memoryview(
b"".join(
[
# IPv4
b"\x45\x00",
(20 + 8 + 24 + 12).to_bytes(2, "big"), # Total length (incl. the 20 bytes of the IP header)
b"\x7e\x50\x40\x00\x40", # ID, flags, fragment offset, TTL
b"\x11", # Protocol (UDP)
b"\x00\x00", # IP checksum (unset)
ip_address("127.0.0.42").packed, # Source
ip_address("127.0.0.63").packed, # Destination
# UDP/IP
(12345).to_bytes(2, "big"), # Source port
service_data_specifier_to_udp_port(ds).to_bytes(2, "big"), # Destination port
(8 + 24 + 12).to_bytes(2, "big"), # Total length (incl. the 8 bytes of the UDP header)
b"\x00\x00", # UDP checksum (unset)
# UAVCAN/UDP
b"".join(
UDPFrame(
priority=Priority.SLOW,
transfer_id=1234567890,
index=0,
end_of_transfer=True,
payload=memoryview(b"Hello world!"),
).compile_header_and_payload()
),
]
)
),
)
ip_packet = IPPacket.parse(llp)
assert ip_packet is not None
assert ip_packet.source_destination == (ip_address("127.0.0.42"), ip_address("127.0.0.63"))
assert ip_packet.protocol == 0x11
udp_packet = UDPIPPacket.parse(ip_packet)
assert udp_packet is not None
assert udp_packet.source_port == 12345
assert udp_packet.destination_port == service_data_specifier_to_udp_port(ds)
trace = tr.update(UDPCapture(ts, llp))
assert isinstance(trace, TransferTrace)
assert trace.timestamp == ts
assert trace.transfer_id_timeout == approx(2.0) # Initial value.
assert trace.transfer.metadata.transfer_id == 1234567890
assert trace.transfer.metadata.priority == Priority.SLOW
assert trace.transfer.metadata.session_specifier.source_node_id == 42
assert trace.transfer.metadata.session_specifier.destination_node_id == 63
assert trace.transfer.metadata.session_specifier.data_specifier == ds
assert trace.transfer.fragmented_payload == [memoryview(b"Hello world!")]
# ANOTHER TRANSPORT, IGNORED
assert None is tr.update(pyuavcan.transport.Capture(ts))
# MALFORMED - UAVCAN/UDP IS EMPTY
llp = LinkLayerPacket(
protocol=socket.AF_INET,
source=memoryview(b""),
destination=memoryview(b""),
payload=memoryview(
b"".join(
[
# IPv4
b"\x45\x00",
(20 + 8 + 24 + 12).to_bytes(2, "big"), # Total length (incl. the 20 bytes of the IP header)
b"\x7e\x50\x40\x00\x40", # ID, flags, fragment offset, TTL
b"\x11", # Protocol (UDP)
b"\x00\x00", # IP checksum (unset)
ip_address("127.0.0.42").packed, # Source
ip_address("127.0.0.63").packed, # Destination
# UDP/IP
(1).to_bytes(2, "big"), # Source port
(1).to_bytes(2, "big"), # Destination port
(8).to_bytes(2, "big"), # Total length (incl. the 8 bytes of the UDP header)
b"\x00\x00", # UDP checksum (unset)
# UAVCAN/UDP is missing
]
)
),
)
ip_packet = IPPacket.parse(llp)
assert ip_packet is not None
assert ip_packet.source_destination == (ip_address("127.0.0.42"), ip_address("127.0.0.63"))
assert ip_packet.protocol == 0x11
udp_packet = UDPIPPacket.parse(ip_packet)
assert udp_packet is not None
assert udp_packet.source_port == 1
assert udp_packet.destination_port == 1
assert None is tr.update(UDPCapture(ts, llp))
