Merge #19727: test: Remove unused classes from p2p_leak.py

ed5cd12 test: Distinguish between nodes(bitcoind) and peers(mininodes) in p2p_leak.py (Dhruv Mehta)
f6f082b test: remove `CNodeNoVersionIdle` from p2p_leak.py (Dhruv Mehta)
45cf55c test: remove `CNodeNoVersionMisbehavior` from p2p_leak.py (Dhruv Mehta)

Pull request description:

  - Removes `CNodeNoVersionMisbehavior` per recommendation at bitcoin/bitcoin#19657 (comment)
  - Removes `CNodeNoVersionIdle` because it is similarly unnecessary
  - As someone new to the codebase, I found it easier to understand it if `no_version_disconnect_node` tries to overwhelm the peer with any message that is not version/verack.
  - Per recommendation at bitcoin/bitcoin#19727 (review), made a clear distinction between nodes(bitcoind) and peers(mininode interface implementations)

ACKs for top commit:
  jnewbery:
    tested ACK ed5cd12
  amitiuttarwar:
    utACK ed5cd12

Tree-SHA512: 310a24c91fd837e7f65177edb55fe6142fb3559fae7867c5cdd9c9a23b1a02202b935ca9a82633fa7649f3de2fa221f6da906a7b5e499fc20f7254085033757d

Author: fanquake

test/functional/p2p_leak.py

@@ -15,7 +15,6 @@
 from test_framework.messages import (
     msg_getaddr,
     msg_ping,
-    msg_verack,
     msg_version,
 )
 from test_framework.mininode import mininode_lock, P2PInterface
@@ -29,7 +28,7 @@
 DISCOURAGEMENT_THRESHOLD = 100
 
 
-class CLazyNode(P2PInterface):
+class LazyPeer(P2PInterface):
     def __init__(self):
         super().__init__()
         self.unexpected_msg = False
@@ -42,6 +41,7 @@ def bad_message(self, message):
     def on_open(self):
         self.ever_connected = True
 
+    # Does not respond to "version" with "verack"
     def on_version(self, message): self.bad_message(message)
     def on_verack(self, message): self.bad_message(message)
     def on_inv(self, message): self.bad_message(message)
@@ -64,21 +64,8 @@ def on_getblocktxn(self, message): self.bad_message(message)
     def on_blocktxn(self, message): self.bad_message(message)
 
 
-# Node that never sends a version. We'll use this to send a bunch of messages
-# anyway, and eventually get disconnected.
-class CNodeNoVersionMisbehavior(CLazyNode):
-    pass
-
-
-# Node that never sends a version. This one just sits idle and hopes to receive
-# any message (it shouldn't!)
-class CNodeNoVersionIdle(CLazyNode):
-    def __init__(self):
-        super().__init__()
-
-
-# Node that sends a version but not a verack.
-class CNodeNoVerackIdle(CLazyNode):
+# Peer that sends a version but not a verack.
+class NoVerackIdlePeer(LazyPeer):
     def __init__(self):
         self.version_received = False
         super().__init__()
@@ -97,6 +84,7 @@ class P2PVersionStore(P2PInterface):
     version_received = None
 
     def on_version(self, msg):
+        # Responds with an appropriate verack
         super().on_version(msg)
         self.version_received = msg
 
@@ -106,39 +94,45 @@ def set_test_params(self):
         self.num_nodes = 1
 
     def run_test(self):
-        no_version_disconnect_node = self.nodes[0].add_p2p_connection(
-            CNodeNoVersionMisbehavior(), send_version=False, wait_for_verack=False)
-        no_version_idlenode = self.nodes[0].add_p2p_connection(CNodeNoVersionIdle(), send_version=False, wait_for_verack=False)
-        no_verack_idlenode = self.nodes[0].add_p2p_connection(CNodeNoVerackIdle(), wait_for_verack=False)
+        # Peer that never sends a version. We will send a bunch of messages
+        # from this peer anyway and verify eventual disconnection.
+        no_version_disconnect_peer = self.nodes[0].add_p2p_connection(
+            LazyPeer(), send_version=False, wait_for_verack=False)
+
+        # Another peer that never sends a version, nor any other messages. It shouldn't receive anything from the node.
+        no_version_idle_peer = self.nodes[0].add_p2p_connection(LazyPeer(), send_version=False, wait_for_verack=False)
+
+        # Peer that sends a version but not a verack.
+        no_verack_idle_peer = self.nodes[0].add_p2p_connection(NoVerackIdlePeer(), wait_for_verack=False)
 
-        # Send enough veracks without a message to reach the peer discouragement
-        # threshold. This should get us disconnected.
+        # Send enough ping messages (any non-version message will do) prior to sending
+        # version to reach the peer discouragement threshold. This should get us disconnected.
         for _ in range(DISCOURAGEMENT_THRESHOLD):
-            no_version_disconnect_node.send_message(msg_verack())
+            no_version_disconnect_peer.send_message(msg_ping())
 
-        # Wait until we got the verack in response to the version. Though, don't wait for the other node to receive the
+        # Wait until we got the verack in response to the version. Though, don't wait for the node to receive the
         # verack, since we never sent one
-        no_verack_idlenode.wait_for_verack()
+        no_verack_idle_peer.wait_for_verack()
 
-        wait_until(lambda: no_version_disconnect_node.ever_connected, timeout=10, lock=mininode_lock)
-        wait_until(lambda: no_version_idlenode.ever_connected, timeout=10, lock=mininode_lock)
-        wait_until(lambda: no_verack_idlenode.version_received, timeout=10, lock=mininode_lock)
+        wait_until(lambda: no_version_disconnect_peer.ever_connected, timeout=10, lock=mininode_lock)
+        wait_until(lambda: no_version_idle_peer.ever_connected, timeout=10, lock=mininode_lock)
+        wait_until(lambda: no_verack_idle_peer.version_received, timeout=10, lock=mininode_lock)
 
-        # Mine a block and make sure that it's not sent to the connected nodes
-        self.nodes[0].generatetoaddress(1, self.nodes[0].get_deterministic_priv_key().address)
+        # Mine a block and make sure that it's not sent to the connected peers
+        self.nodes[0].generate(nblocks=1)
 
         #Give the node enough time to possibly leak out a message
         time.sleep(5)
 
-        # Expect this node to be disconnected for misbehavior
-        assert not no_version_disconnect_node.is_connected
+        # Expect this peer to be disconnected for misbehavior
+        assert not no_version_disconnect_peer.is_connected
 
         self.nodes[0].disconnect_p2ps()
 
         # Make sure no unexpected messages came in
-        assert no_version_disconnect_node.unexpected_msg == False
-        assert no_version_idlenode.unexpected_msg == False
-        assert no_verack_idlenode.unexpected_msg == False
+        assert no_version_disconnect_peer.unexpected_msg == False
+        assert no_version_idle_peer.unexpected_msg == False
+        assert no_verack_idle_peer.unexpected_msg == False
 
         self.log.info('Check that the version message does not leak the local address of the node')
         p2p_version_store = self.nodes[0].add_p2p_connection(P2PVersionStore())
@@ -151,13 +145,13 @@ def run_test(self):
         assert_equal(ver.nStartingHeight, 201)
         assert_equal(ver.nRelay, 1)
 
-        self.log.info('Check that old nodes are disconnected')
-        p2p_old_node = self.nodes[0].add_p2p_connection(P2PInterface(), send_version=False, wait_for_verack=False)
+        self.log.info('Check that old peers are disconnected')
+        p2p_old_peer = self.nodes[0].add_p2p_connection(P2PInterface(), send_version=False, wait_for_verack=False)
         old_version_msg = msg_version()
         old_version_msg.nVersion = 31799
         with self.nodes[0].assert_debug_log(['peer=4 using obsolete version 31799; disconnecting']):
-            p2p_old_node.send_message(old_version_msg)
-            p2p_old_node.wait_for_disconnect()
+            p2p_old_peer.send_message(old_version_msg)
+            p2p_old_peer.wait_for_disconnect()
 
 
 if __name__ == '__main__':