Struct TestNetwork 

pub struct TestNetwork { /* private fields */ }

A test network consisting of gateways and peer nodes

Implementations

impl TestNetwork

pub fn log_files(&self) -> Vec<(String, PathBuf)>

Get all log files from the network

pub fn read_logs(&self) -> Result<Vec<LogEntry>>

Read all logs in chronological order

For Docker containers, this fetches logs from the Docker API and caches them. For local processes, this reads directly from log files.

pub fn tail_logs(&self) -> Result<impl Iterator<Item = LogEntry> + '_>

Tail logs from all peers (blocking)

impl TestNetwork

pub fn builder() -> NetworkBuilder

Create a new network builder

pub fn gateway(&self, index: usize) -> &TestPeer

Get a gateway peer by index

pub fn peer(&self, index: usize) -> &TestPeer

Get a non-gateway peer by index

pub fn gateway_ws_urls(&self) -> Vec<String>

Get all gateway WebSocket URLs

pub fn peer_ws_urls(&self) -> Vec<String>

Get all peer WebSocket URLs

pub async fn wait_until_ready(&self) -> Result<()>

Wait until the network is ready for use

This checks that peers have formed connections and the network is sufficiently connected for testing.

pub async fn wait_until_ready_with_timeout( &self, timeout: Duration, ) -> Result<()>

Wait until the network is ready with a custom timeout

pub async fn check_connectivity_detailed(&self) -> ConnectivityStatus

Check current network connectivity with detailed status

pub async fn topology(&self) -> Result<NetworkTopology>

Get the current network topology

pub fn export_for_viz(&self) -> String

Export network information in JSON format for visualization tools

pub async fn collect_diagnostics(&self) -> Result<NetworkDiagnosticsSnapshot>

Collect diagnostics from every peer, returning a snapshot that can be serialized to JSON for offline analysis.

pub async fn ring_snapshot(&self) -> Result<Vec<RingPeerSnapshot>>

Collect per-peer ring data (locations + adjacency) for visualization/debugging.

pub async fn collect_ring_snapshot( &self, instance_id: Option<&ContractInstanceId>, ) -> Result<Vec<RingPeerSnapshot>>

Collect per-peer ring data with optional contract-specific subscription info.

When instance_id is provided, each RingPeerSnapshot will include PeerContractStatus with subscriber information for that contract.

pub async fn write_ring_visualization<P: AsRef<Path>>( &self, output_path: P, ) -> Result<()>

Generate an interactive HTML ring visualization for the current network.

pub async fn write_ring_visualization_for_contract<P: AsRef<Path>>( &self, output_path: P, contract_key: &ContractKey, contract_id: &str, ) -> Result<()>

Generate an interactive HTML ring visualization for a specific contract.

Note: This function now takes a ContractKey directly instead of a string, since freenet-stdlib 0.1.27 no longer supports ContractKey::from_id. The contract_id string is used for display purposes.

pub fn dump_logs(&self, filter: Option<&str>)

Dump logs from all peers, optionally filtered by a pattern

If filter is Some, only logs containing the pattern (case-insensitive) are printed. Logs are printed in chronological order with peer ID prefix.

This is useful for debugging test failures - call it before assertions or in error handlers.

pub fn dump_connection_logs(&self)

Dump logs related to connection establishment and NAT traversal

Filters for: hole punch, NAT, connect, acceptor, joiner, handshake

pub async fn dump_iptables(&self)

Dump iptables counters from all NAT routers (Docker NAT only)

Prints NAT table rules and FORWARD chain counters for debugging.

pub async fn dump_conntrack(&self)

Dump conntrack table from all NAT routers (Docker NAT only)

Shows active UDP connection tracking entries for debugging NAT issues.

pub async fn dump_peer_routes(&self)

Dump routing tables from all peer containers (Docker NAT only)

Shows ip route output for debugging routing issues.

impl TestNetwork

pub fn run_root(&self) -> &Path

Directory containing all peer state/logs for this test network run.