Skip to content

Commit 19d1559

Browse files
committed
fix sniffer ambiguity
1 parent 0a8c17e commit 19d1559

File tree

2 files changed

+28
-22
lines changed

2 files changed

+28
-22
lines changed

roles/tests-integration/tests/common/sniffer.rs

+17-17
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ enum SnifferError {
3737
/// The downstream (or client) role connects to the [`Sniffer`] `listening_address` and the
3838
/// [`Sniffer`] connects to the `upstream` server. This way, the Sniffer can intercept messages sent
3939
/// between the downstream and upstream roles. The downstream will send its messages to the
40-
/// [`Sniffer`] which will save those in the `downstream_messages` aggregator and forward them to
41-
/// the upstream role. When a response is received it is saved in `upstream_messages` and
42-
/// forwarded to the downstream role. Both `downstream_messages` and `upstream_messages` can be
40+
/// [`Sniffer`] which will save those in the `messages_from_downstream` aggregator and forward them to
41+
/// the upstream role. When a response is received it is saved in `messages_from_upstream` and
42+
/// forwarded to the downstream role. Both `messages_from_downstream` and `messages_from_upstream` can be
4343
/// accessed as FIFO queues.
4444
///
4545
/// It is useful for testing purposes, as it allows to assert that the roles have sent specific
@@ -48,8 +48,8 @@ enum SnifferError {
4848
pub struct Sniffer {
4949
listening_address: SocketAddr,
5050
upstream_address: SocketAddr,
51-
downstream_messages: MessagesAggregator,
52-
upstream_messages: MessagesAggregator,
51+
messages_from_downstream: MessagesAggregator,
52+
messages_from_upstream: MessagesAggregator,
5353
}
5454

5555
impl Sniffer {
@@ -59,8 +59,8 @@ impl Sniffer {
5959
Self {
6060
listening_address,
6161
upstream_address,
62-
downstream_messages: MessagesAggregator::new(),
63-
upstream_messages: MessagesAggregator::new(),
62+
messages_from_downstream: MessagesAggregator::new(),
63+
messages_from_upstream: MessagesAggregator::new(),
6464
}
6565
}
6666

@@ -80,8 +80,8 @@ impl Sniffer {
8080
)
8181
.await
8282
.expect("Failed to create upstream");
83-
let downstream_messages = self.downstream_messages.clone();
84-
let upstream_messages = self.upstream_messages.clone();
83+
let downstream_messages = self.messages_from_downstream.clone();
84+
let upstream_messages = self.messages_from_upstream.clone();
8585
let _ = select! {
8686
r = Self::recv_from_down_send_to_up(downstream_receiver, upstream_sender, downstream_messages) => r,
8787
r = Self::recv_from_up_send_to_down(upstream_receiver, downstream_sender, upstream_messages) => r,
@@ -95,8 +95,8 @@ impl Sniffer {
9595
/// This can be used to assert that the downstream sent:
9696
/// - specific message types
9797
/// - specific message fields
98-
pub fn next_downstream_message(&self) -> Option<(MsgType, AnyMessage<'static>)> {
99-
self.downstream_messages.next_message()
98+
pub fn next_message_from_downstream(&self) -> Option<(MsgType, AnyMessage<'static>)> {
99+
self.messages_from_downstream.next_message()
100100
}
101101

102102
/// Returns the oldest message sent by upstream.
@@ -106,8 +106,8 @@ impl Sniffer {
106106
/// This can be used to assert that the upstream sent:
107107
/// - specific message types
108108
/// - specific message fields
109-
pub fn next_upstream_message(&self) -> Option<(MsgType, AnyMessage<'static>)> {
110-
self.upstream_messages.next_message()
109+
pub fn next_message_from_upstream(&self) -> Option<(MsgType, AnyMessage<'static>)> {
110+
self.messages_from_upstream.next_message()
111111
}
112112

113113
async fn create_downstream(
@@ -433,17 +433,17 @@ impl Drop for Sniffer {
433433
std::panic::set_hook(Box::new(|_| {
434434
println!();
435435
}));
436-
if !self.downstream_messages.is_empty() {
436+
if !self.messages_from_downstream.is_empty() {
437437
println!(
438438
"You didn't handle all downstream messages: {:?}",
439-
self.downstream_messages
439+
self.messages_from_downstream
440440
);
441441
panic!();
442442
}
443-
if !self.upstream_messages.is_empty() {
443+
if !self.messages_from_upstream.is_empty() {
444444
println!(
445445
"You didn't handle all upstream messages: {:?}",
446-
self.upstream_messages
446+
self.messages_from_upstream
447447
);
448448
panic!();
449449
}

roles/tests-integration/tests/pool_integration.rs

+11-5
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ async fn success_pool_template_provider_connection() {
2222
// macro can take any number of arguments after the message argument, but the order is
2323
// important where a property should be followed by its value.
2424
assert_common_message!(
25-
&sniffer.next_downstream_message(),
25+
&sniffer.next_message_from_downstream(),
2626
SetupConnection,
2727
protocol,
2828
Protocol::TemplateDistributionProtocol,
@@ -33,8 +33,14 @@ async fn success_pool_template_provider_connection() {
3333
max_version,
3434
2
3535
);
36-
assert_common_message!(&sniffer.next_upstream_message(), SetupConnectionSuccess);
37-
assert_tp_message!(&sniffer.next_downstream_message(), CoinbaseOutputDataSize);
38-
assert_tp_message!(&sniffer.next_upstream_message(), NewTemplate);
39-
assert_tp_message!(sniffer.next_upstream_message(), SetNewPrevHash);
36+
assert_common_message!(
37+
&sniffer.next_message_from_upstream(),
38+
SetupConnectionSuccess
39+
);
40+
assert_tp_message!(
41+
&sniffer.next_message_from_downstream(),
42+
CoinbaseOutputDataSize
43+
);
44+
assert_tp_message!(&sniffer.next_message_from_upstream(), NewTemplate);
45+
assert_tp_message!(sniffer.next_message_from_upstream(), SetNewPrevHash);
4046
}

0 commit comments

Comments
 (0)