chore: replace print statements with logging in tests (libp2p#1253)

* test: replace print statements with logging

Addresses libp2p#1207. Replaces bare print() calls in test files with
proper logging calls using the existing logger pattern
(logging.getLogger(__name__)). Functional prints in IPC scripts
are left unchanged.

* lint: fixes

* chore: add newsfragment for issue 1207

* test: remove forced DEBUG logging in multiplexer selection test

Author: laciferin2024

newsfragments/1207.internal.rst

@@ -0,0 +1 @@
+Replaced bare ``print()`` calls in test modules with logger-based output so test verbosity is configurable and consistent with project conventions.

tests/core/bitswap/test_integration.py

@@ -1,5 +1,6 @@
 """Integration tests for Bitswap file transfer between nodes."""
 
+import logging
 from pathlib import Path
 import tempfile
 
@@ -15,6 +16,8 @@
 from libp2p.crypto.secp256k1 import create_new_key_pair
 from libp2p.peer.peerinfo import info_from_p2p_addr
 
+logger = logging.getLogger(__name__)
+
 
 class TestBitswapIntegration:
     """Integration tests for Bitswap protocol."""
@@ -447,9 +450,8 @@ async def test_dont_have_response(self):
 
                     # Step 4: Request a non-existent block and verify we
                     # get a DontHave response
-                    print(
-                        "\n--- Step 4: Request nonexistent block and "
-                        "verify DontHave response ---"
+                    logger.debug(
+                        "Step 4: Request nonexistent block and verify DontHave response"
                     )
 
                     # Start the request in the background (will eventually
@@ -475,8 +477,9 @@ async def request_nonexistent():
 
                         # The ACTUAL test: Did we receive a DontHave
                         # response?
-                        print(
-                            f"DontHave responses: {client_bitswap._dont_have_responses}"
+                        logger.debug(
+                            "DontHave responses: %s",
+                            client_bitswap._dont_have_responses,
                         )
                         assert (
                             parse_cid(nonexistent_cid)
@@ -491,7 +494,7 @@ async def request_nonexistent():
                                 parse_cid(nonexistent_cid)
                             ]
                         ), "Provider should have sent the DontHave response"
-                        print("✓ DontHave response received from provider!")
+                        logger.debug("DontHave response received from provider")
 
                         # Cancel the background request
                         test_nursery.cancel_scope.cancel()

tests/core/discovery/rendezvous/test_integration.py

@@ -2,6 +2,7 @@
 Integration tests for rendezvous discovery functionality.
 """
 
+import logging
 import secrets
 from unittest.mock import AsyncMock, Mock
 
@@ -19,6 +20,8 @@
 from libp2p.peer.id import ID
 from libp2p.peer.peerinfo import PeerInfo
 
+logger = logging.getLogger(__name__)
+
 
 def create_test_host(port: int = 0):
     """Create a test host with random key pair."""
@@ -140,13 +143,13 @@ async def test_full_rendezvous_workflow():
 
                     except Exception as e:
                         # Log the error for debugging
-                        print(f"Integration test error: {e}")
+                        logger.error("Integration test error: %s", e)
                         # Don't fail the test for connection issues in unit tests
                         raise
 
     except Exception as e:
         # Handle any startup/shutdown errors gracefully
-        print(f"Host management error: {e}")
+        logger.error("Host management error: %s", e)
         raise
 
 
@@ -267,7 +270,7 @@ async def test_rendezvous_registration_refresh():
 
         except Exception as e:
             # Handle mock-related issues gracefully
-            print(f"Refresh test error: {e}")
+            logger.error("Refresh test error: %s", e)
 
         # Cancel nursery
         nursery.cancel_scope.cancel()

tests/core/kad_dht/test_kad_dht.py

@@ -277,9 +277,12 @@ async def test_put_and_get_value(dht_pair: tuple[KadDHT, KadDHT]):
     local_value_record = dht_a.value_store.get(key_bytes)
     assert local_value_record is not None
     assert local_value_record.value == value, "Local value storage failed"
-    print("number of nodes in peer store", dht_a.host.get_peerstore().peer_ids())
+    logger.debug(
+        "Number of nodes in peer store: %s",
+        dht_a.host.get_peerstore().peer_ids(),
+    )
     await dht_a.routing_table.add_peer(peer_b_info)
-    print("Routing table of a has ", dht_a.routing_table.get_peer_ids())
+    logger.debug("Routing table of a has: %s", dht_a.routing_table.get_peer_ids())
 
     # An extra FIND_NODE req is sent between the 2 nodes while dht creation,
     # so both the nodes will have records of each other before PUT_VALUE req is sent
@@ -330,7 +333,7 @@ async def test_put_and_get_value(dht_pair: tuple[KadDHT, KadDHT]):
     # Retrieve the value using the second node
     with trio.fail_after(TEST_TIMEOUT):
         retrieved_value = await dht_b.get_value(key)
-        print("the value stored in node b is", dht_b.get_value_store_size())
+        logger.debug("Value store size in node b: %s", dht_b.get_value_store_size())
         logger.debug("Retrieved value: %s", retrieved_value)
 
     # These are the records that were sent between the peers during the PUT_VALUE req

tests/core/pubsub/test_dummyaccount_demo.py

@@ -1,6 +1,7 @@
 from collections.abc import (
     Callable,
 )
+import logging
 
 import pytest
 import trio
@@ -12,6 +13,8 @@
     DummyAccountNode,
 )
 
+logger = logging.getLogger(__name__)
+
 
 async def wait_for_convergence(
     nodes: tuple[DummyAccountNode, ...],
@@ -48,7 +51,7 @@ async def wait_for_convergence(
         if not failed_indices:
             elapsed = trio.current_time() - start_time
             if log_success:
-                print(f"✓ Converged in {elapsed:.3f}s with {len(nodes)} nodes")
+                logger.debug("Converged in %.3fs with %d nodes", elapsed, len(nodes))
             return
 
         elapsed = trio.current_time() - start_time

tests/core/pubsub/test_gossipsub_direct_peers.py

@@ -1,3 +1,5 @@
+import logging
+
 import pytest
 import trio
 
@@ -14,6 +16,8 @@
     PubsubFactory,
 )
 
+logger = logging.getLogger(__name__)
+
 
 @pytest.mark.trio
 async def test_attach_peer_records():
@@ -41,15 +45,15 @@ async def test_attach_peer_records():
                 peer_ids_0 = peer_store_0.peer_ids()
                 peer_ids_1 = peer_store_1.peer_ids()
 
-                print(f"Peer store 0 IDs: {peer_ids_0}")
-                print(f"Peer store 1 IDs: {peer_ids_1}")
-                print(f"Host 0 ID: {host_0.get_id()}")
-                print(f"Host 1 ID: {host_1.get_id()}")
+                logger.debug("Peer store 0 IDs: %s", peer_ids_0)
+                logger.debug("Peer store 1 IDs: %s", peer_ids_1)
+                logger.debug("Host 0 ID: %s", host_0.get_id())
+                logger.debug("Host 1 ID: %s", host_1.get_id())
 
                 assert host_0.get_id() in peer_ids_1, "Peer 0 not found in peer store 1"
 
             except Exception as e:
-                print(f"Test failed with error: {e}")
+                logger.error("Test failed with error: %s", e)
                 raise
 
 
@@ -114,7 +118,7 @@ async def test_reject_graft():
                 )
 
             except Exception as e:
-                print(f"Test failed with error: {e}")
+                logger.error("Test failed with error: %s", e)
                 raise
 
 
@@ -171,5 +175,5 @@ async def test_heartbeat_reconnect():
                 )
 
             except Exception as e:
-                print(f"Test failed with error: {e}")
+                logger.error("Test failed with error: %s", e)
                 raise

tests/core/security/test_security_multistream.py

@@ -1,3 +1,5 @@
+import logging
+
 import pytest
 import trio
 
@@ -19,6 +21,8 @@
     host_pair_factory,
 )
 
+logger = logging.getLogger(__name__)
+
 initiator_key_pair = create_new_key_pair()
 
 noninitiator_key_pair = create_new_key_pair()
@@ -64,7 +68,7 @@ def get_secured_conn(conn):
                 return muxed_conn._connection
             # Last resort - warn but return the muxed_conn itself for type checking
             else:
-                print(f"Warning: Cannot find secured connection in {type(muxed_conn)}")
+                logger.warning("Cannot find secured connection in %s", type(muxed_conn))
                 return muxed_conn
 
         # Get secured connections for both peers

tests/core/stream_muxer/test_multiplexer_selection.py

@@ -15,8 +15,7 @@
 from libp2p.custom_types import TProtocol
 from libp2p.peer.peerinfo import PeerInfo
 
-# Enable logging for debugging
-logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
 
 
 # Fixture to create hosts with a specified muxer preference
@@ -88,7 +87,7 @@ async def echo_handler(stream):
                     await stream.write(data)
                     await stream.close()
                 except Exception as e:
-                    print(f"Error in echo handler: {e}")
+                    logger.error("Error in echo handler: %s", e)
 
             host_a.set_stream_handler(ECHO_PROTOCOL, echo_handler)
 
@@ -165,7 +164,7 @@ async def echo_handler(stream):
                     await stream.write(data)
                     await stream.close()
                 except Exception as e:
-                    print(f"Error in echo handler: {e}")
+                    logger.error("Error in echo handler: %s", e)
 
             host_a.set_stream_handler(ECHO_PROTOCOL, echo_handler)
 
@@ -235,7 +234,7 @@ async def echo_handler(stream):
                     await stream.write(data)
                     await stream.close()
                 except Exception as e:
-                    print(f"Error in echo handler: {e}")
+                    logger.error("Error in echo handler: %s", e)
 
             host_a.set_stream_handler(ECHO_PROTOCOL, echo_handler)
 

tests/core/transport/quic/test_listener.py

@@ -1,3 +1,4 @@
+import logging
 from unittest.mock import AsyncMock, Mock, patch
 
 import pytest
@@ -20,6 +21,8 @@
     create_quic_multiaddr,
 )
 
+logger = logging.getLogger(__name__)
+
 
 class TestQUICListener:
     """Test suite for QUIC listener functionality."""
@@ -137,7 +140,7 @@ async def test_listener_port_binding(self, listener: QUICListener):
 
         # By the time we get here, the listener and its tasks have been fully
         # shut down, allowing the nursery to exit without hanging.
-        print("TEST COMPLETED SUCCESSFULLY.")
+        logger.debug("Test completed successfully.")
 
     @pytest.mark.trio
     async def test_listener_stats_tracking(self, listener):

tests/core/transport/test_tcp.py

@@ -154,10 +154,10 @@ async def ping_stream(i: int):
                     if response == b"\x01" * PING_LENGTH:
                         latency_ms = int((trio.current_time() - start) * 1000)
                         latencies.append(latency_ms)
-                        print(f"[TCP Ping #{i}] Latency: {latency_ms} ms")
+                        logger.debug("[TCP Ping #%d] Latency: %d ms", i, latency_ms)
                     await stream.close()
                 except Exception as e:
-                    print(f"[TCP Ping #{i}] Failed: {e}")
+                    logger.warning("[TCP Ping #%d] Failed: %s", i, e)
                     failures.append(i)
                     if stream:
                         try: