Expand description
Reliable test network infrastructure for Freenet
This crate provides tools for spinning up and managing local Freenet test networks for integration testing.
Re-exports§
pub use docker::DockerNatBackend;pub use docker::DockerNatConfig;pub use docker::DockerPeerInfo;pub use docker::NatTopology;pub use docker::NatType;
Modules§
- docker
- Docker-based NAT simulation backend for testing Freenet in isolated networks.
Structs§
- Contract
Key - A complete key specification, that represents a cryptographic hash that identifies the contract.
- LogEntry
- A log entry from a peer with timestamp
- Network
Builder - Builder for configuring and creating a test network
- Network
Diagnostics Snapshot - Snapshot describing diagnostics collected across the network at a moment in time.
- Network
Topology - Network topology information
- Peer
Contract Status - Contract-specific status for a peer when a contract key is provided.
- Peer
Diagnostics Snapshot - Diagnostic information for a single peer.
- Remote
Machine - Configuration for a remote Linux machine accessible via SSH
- Ring
Peer Snapshot - Snapshot describing a peer’s ring metadata and adjacency.
- Ring
VizMetrics - Aggregated metrics that help reason about small-world properties.
- Test
Network - A test network consisting of gateways and peer nodes
- Test
Peer - Represents a single peer in the test network
Enums§
- Backend
- Backend for running the test network
- Build
Profile - Build profile for compiling freenet
- Error
- Errors that can occur when managing test networks
- Freenet
Binary - Specifies which freenet binary to use for the test network
- Peer
Location - Specifies where a peer should be spawned
Functions§
- ring_
nodes_ from_ diagnostics - Convert a diagnostics snapshot into the ring snapshot format used by the visualization.
- write_
ring_ visualization_ from_ diagnostics - Render a ring visualization from a saved diagnostics snapshot (e.g. a large soak run).
Type Aliases§
- Result
- Result type used throughout this crate