speed-cli 1.0.0

Comprehensive multi-protocol network performance testing CLI (TCP, UDP, QUIC, HTTP/1.1, HTTP/2, h2c, HTTP/3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! Smoke test for the UDP blaster: latency, upload, and download
//! against a server bound on an ephemeral port.

use std::time::Duration;

use eyre::Result;
use speed_cli::TestType;
use speed_cli::performance::udp::client::run_udp_client;
use speed_cli::performance::udp::server::run_udp_server;
use speed_cli::report::{NetworkProtocol, TestResult, UdpTestConfig};
use tokio_util::sync::CancellationToken;

async fn pick_port() -> Result<u16> {
    let s = tokio::net::UdpSocket::bind("127.0.0.1:0").await?;
    Ok(s.local_addr()?.port())
}

#[tokio::test]
async fn upload_and_download_roundtrip() -> Result<()> {
    let port = pick_port().await?;
    let cancel = CancellationToken::new();
    let server_cancel = cancel.clone();
    let server =
        tokio::spawn(
            async move { run_udp_server(format!("127.0.0.1:{port}"), server_cancel).await },
        );
    tokio::time::sleep(Duration::from_millis(100)).await;

    let config = UdpTestConfig::new(
        "127.0.0.1".to_string(),
        Some(port),
        2, // 2-second test
        1,
        TestType::Bidirectional,
        vec![1024usize],
    )
    .with_warmup(Duration::from_millis(0))
    .with_target_rate_bps(10_000_000); // 10 Mbps - paceable on most boxes

    let report = run_udp_client(config).await?;

    let net = match &report.result {
        TestResult::Network(n) => {
            assert!(matches!(n.protocol, NetworkProtocol::Udp));
            n
        }
        _ => panic!("expected network result"),
    };

    let dl = net.download.values().next().expect("download");
    let ul = net.upload.values().next().expect("upload");
    assert!(
        dl.bytes_transferred() > 0,
        "download bytes must be > 0 (got {})",
        dl.bytes_transferred()
    );
    assert!(
        ul.bytes_transferred() > 0,
        "upload bytes must be > 0 (got {})",
        ul.bytes_transferred()
    );

    cancel.cancel();
    let _ = tokio::time::timeout(Duration::from_secs(5), server).await;
    Ok(())
}

#[tokio::test]
async fn latency_runs() -> Result<()> {
    let port = pick_port().await?;
    let cancel = CancellationToken::new();
    let server_cancel = cancel.clone();
    let server =
        tokio::spawn(
            async move { run_udp_server(format!("127.0.0.1:{port}"), server_cancel).await },
        );
    tokio::time::sleep(Duration::from_millis(100)).await;

    let config = UdpTestConfig::new(
        "127.0.0.1".to_string(),
        Some(port),
        2,
        1,
        TestType::LatencyOnly,
        Vec::<usize>::new(),
    )
    .with_warmup(Duration::from_millis(0));

    let report = run_udp_client(config).await?;
    let net = match &report.result {
        TestResult::Network(n) => n,
        _ => panic!("expected network result"),
    };
    let latency = net.latency.as_ref().expect("latency present");
    assert!(
        latency.successful_count() > 0,
        "got at least one RTT sample"
    );

    cancel.cancel();
    let _ = tokio::time::timeout(Duration::from_secs(5), server).await;
    Ok(())
}