fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-06-16 11:31:22 +00:00
Code Issues Projects Releases Wiki Activity

protocols/autonat: Fix flaky test (#2660)

Browse Source 
Handle in test that a `OutboundProbeEvent::Response` can be reported
before the associated inbound connection event.
In rare cases (that only really happen in a test setup where both peers
run on the same device) the server may observe a connection and report
the response back to the client, before the connection event was
reported at the client.
This commit is contained in:
Elena Frank
2022-05-22 21:07:55 +02:00
committed by GitHub
parent 1d6b08b0b6
commit 48598fc1da
1 changed files with 17 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
protocols/autonat/tests/test_client.rs
View File

@ -189,15 +189,14 @@ async fn test_auto_probe() {
other => panic!("Unexpected behaviour event: {:?}.", other), other => panic!("Unexpected behaviour event: {:?}.", other),
}; };
let mut has_received_response = false; let mut had_connection_event = false;
// Expect inbound dial from server.
loop { loop {
match client.select_next_some().await { match client.select_next_some().await {
SwarmEvent::ConnectionEstablished { SwarmEvent::ConnectionEstablished {
endpoint, peer_id, .. endpoint, peer_id, ..
} if endpoint.is_listener() => { } if endpoint.is_listener() => {
assert_eq!(peer_id, server_id); assert_eq!(peer_id, server_id);
break; had_connection_event = true;
} }
SwarmEvent::Behaviour(Event::OutboundProbe(OutboundProbeEvent::Response { SwarmEvent::Behaviour(Event::OutboundProbe(OutboundProbeEvent::Response {
probe_id, probe_id,
@ -206,7 +205,13 @@ async fn test_auto_probe() {
})) => { })) => {
assert_eq!(peer, server_id); assert_eq!(peer, server_id);
assert_eq!(probe_id, id); assert_eq!(probe_id, id);
has_received_response = true; }
SwarmEvent::Behaviour(Event::StatusChanged { old, new }) => {
// Expect to flip status to public
assert_eq!(old, NatStatus::Private);
assert!(matches!(new, NatStatus::Public(_)));
assert!(new.is_public());
break;
} }
SwarmEvent::IncomingConnection { .. } SwarmEvent::IncomingConnection { .. }
| SwarmEvent::NewListenAddr { .. } | SwarmEvent::NewListenAddr { .. }
@ -215,30 +220,20 @@ async fn test_auto_probe() {
} }
} }
if !has_received_response { // It can happen that the server observed the established connection and
// returned a response before the inbound established connection was reported at the client.
// In this (rare) case the `ConnectionEstablished` event occurs after the `OutboundProbeEvent::Response`.
if !had_connection_event {
match client.select_next_some().await { match client.select_next_some().await {
SwarmEvent::Behaviour(Event::OutboundProbe(OutboundProbeEvent::Response { SwarmEvent::ConnectionEstablished {
probe_id, endpoint, peer_id, ..
peer, } if endpoint.is_listener() => {
.. assert_eq!(peer_id, server_id);
})) => {
assert_eq!(peer, server_id);
assert_eq!(probe_id, id);
} }
other => panic!("Unexpected swarm event: {:?}.", other), other => panic!("Unexpected swarm event: {:?}.", other),
} }
} }
// Expect to flip status to public
match next_event(&mut client).await {
Event::StatusChanged { old, new } => {
assert_eq!(old, NatStatus::Private);
assert!(matches!(new, NatStatus::Public(_)));
assert!(new.is_public());
}
other => panic!("Unexpected behaviour event: {:?}.", other),
}
assert_eq!(client.behaviour().confidence(), 0); assert_eq!(client.behaviour().confidence(), 0);
assert!(client.behaviour().nat_status().is_public()); assert!(client.behaviour().nat_status().is_public());
assert!(client.behaviour().public_address().is_some()); assert!(client.behaviour().public_address().is_some());