netspeed-cli 0.10.3

Command-line interface for testing internet bandwidth using speedtest.net
Documentation
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
//! Usage check targets and real-world download time estimates.

#![allow(
    clippy::cast_precision_loss,
    clippy::cast_possible_truncation,
    clippy::cast_sign_loss
)]

use crate::common;
use crate::terminal;
use crate::theme::{Colors, Theme};

// ── Target benchmarks ────────────────────────────────────────────────

struct Target {
    name: &'static str,
    required_mbps: f64,
}

const TARGETS: &[Target] = &[
    Target {
        name: "Video calls (1080p)",
        required_mbps: 3.0,
    },
    Target {
        name: "HD streaming",
        required_mbps: 5.0,
    },
    Target {
        name: "4K streaming",
        required_mbps: 25.0,
    },
    Target {
        name: "Cloud gaming",
        required_mbps: 35.0,
    },
    Target {
        name: "Large file transfers",
        required_mbps: 100.0,
    },
];

/// Build target usage check output as a string.
#[must_use]
pub fn build_targets(download_bps: Option<f64>, nc: bool, theme: Theme) -> String {
    let targets: Vec<crate::profiles::UsageTarget> = TARGETS
        .iter()
        .map(|t| crate::profiles::UsageTarget {
            name: t.name,
            required_mbps: t.required_mbps,
            icon: "",
        })
        .collect();
    let dl_mbps = download_bps.map(|d| d / 1_000_000.0);
    build_profile_targets(download_bps, nc, theme, &targets, dl_mbps)
}

/// Build profile-specific target usage check output.
#[must_use]
pub fn build_profile_targets(
    download_bps: Option<f64>,
    nc: bool,
    theme: Theme,
    targets: &[crate::profiles::UsageTarget],
    dl_mbps: Option<f64>,
) -> String {
    let Some(dl) = download_bps else {
        return String::new();
    };
    let dl_mbps = dl_mbps.unwrap_or_else(|| dl / 1_000_000.0);

    let mut lines = Vec::new();

    if nc {
        lines.push("\n  ◈ USAGE CHECK".to_string());
    } else {
        lines.push(format!(
            "\n  {} {}",
            Colors::muted("", theme),
            Colors::header("USAGE CHECK", theme)
        ));
    }

    for target in targets {
        let met = dl_mbps >= target.required_mbps;
        let ratio = dl_mbps / target.required_mbps;
        let suffix = if ratio >= 10.0 {
            format!("{ratio:.0}x")
        } else {
            format!("{ratio:.1}x")
        };
        let hide_emoji = terminal::no_emoji();
        let icon = if target.icon.is_empty() {
            "🎯"
        } else {
            target.icon
        };
        if met {
            let status = if hide_emoji { "" } else { "" };
            let line = format!("{icon} {:<24} {status} {} above", target.name, suffix);
            if nc || hide_emoji {
                lines.push(format!("  {line}"));
            } else {
                lines.push(format!("  {}", Colors::good(&line, theme)));
            }
        } else {
            let shortfall = target.required_mbps - dl_mbps;
            let status = if hide_emoji { "" } else { "" };
            let line = format!(
                "{icon} {:<24} {status} {:.1} Mb/s short",
                target.name, shortfall
            );
            if nc || hide_emoji {
                lines.push(format!("  {line}"));
            } else {
                lines.push(format!("  {}", Colors::bad(&line, theme)));
            }
        }
    }

    lines.join("\n")
}

/// Format target usage check against download speed.
pub fn format_targets(download_bps: Option<f64>, nc: bool, theme: Theme) {
    let output = build_targets(download_bps, nc, theme);
    if !output.is_empty() {
        eprintln!("{output}");
    }
}

// ── Real-world download estimates ──────────────────────────────────────

struct FileEstimate {
    name: &'static str,
    size_bytes: u64,
}

const ESTIMATES: &[FileEstimate] = &[
    FileEstimate {
        name: "Song / Podcast episode",
        size_bytes: 8 * 1024 * 1024,
    },
    FileEstimate {
        name: "Photo (RAW)",
        size_bytes: 30 * 1024 * 1024,
    },
    FileEstimate {
        name: "App install",
        size_bytes: 300 * 1024 * 1024,
    },
    FileEstimate {
        name: "HD movie (1080p)",
        size_bytes: 8 * 1024 * 1024 * 1024,
    },
    FileEstimate {
        name: "4K movie (HDR)",
        size_bytes: 25 * 1024 * 1024 * 1024,
    },
    FileEstimate {
        name: "Game install (AAA)",
        size_bytes: 120 * 1024 * 1024 * 1024,
    },
];

fn format_time_estimate(secs: f64, _nc: bool) -> String {
    if secs < 1.0 {
        format!("{secs:.1}s")
    } else if secs < 60.0 {
        format!("{secs:.0}s")
    } else if secs < 3600.0 {
        // Safe: secs is 60..3600, results fit in u64.
        format!(
            "{}m {:02}s",
            (secs / 60.0).clamp(0.0, u64::MAX as f64) as u64,
            (secs % 60.0).clamp(0.0, u64::MAX as f64) as u64
        )
    } else {
        // Safe: secs is ≥3600 but bounded by test duration (minutes), fits u64.
        format!(
            "{}h {:02}m",
            (secs / 3600.0).clamp(0.0, u64::MAX as f64) as u64,
            ((secs % 3600.0) / 60.0).clamp(0.0, u64::MAX as f64) as u64
        )
    }
}

/// Build real-world download time estimates as a string.
#[must_use]
pub fn build(download_bps: Option<f64>, nc: bool, theme: Theme) -> String {
    let Some(dl) = download_bps else {
        return String::new();
    };
    let dl_bytes_per_sec = dl / 8.0;

    let mut lines = Vec::new();

    if nc {
        lines.push("\n  ◈ ESTIMATES".to_string());
    } else {
        lines.push(format!(
            "\n  {} {}",
            Colors::muted("", theme),
            Colors::header("ESTIMATES", theme)
        ));
    }

    for file in ESTIMATES {
        // Safe: file sizes are at most ~120 GB, well under 2^53 (~9 PB).
        let secs = file.size_bytes as f64 / dl_bytes_per_sec;
        let time_str = format_time_estimate(secs, nc);
        let size_str = common::format_data_size(file.size_bytes);
        let label = format!("{:<24} {:>8}   ~{time_str}", file.name, size_str);
        if nc {
            lines.push(format!("  {label}"));
        } else {
            lines.push(format!("  {}", Colors::good(&label, theme)));
        }
    }

    lines.join("\n")
}

pub fn show(download_bps: Option<f64>, nc: bool, theme: Theme) {
    let output = build(download_bps, nc, theme);
    if !output.is_empty() {
        eprintln!("{output}");
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::profiles::UsageTarget;
    use crate::theme::Theme;

    #[test]
    fn test_format_time_estimate() {
        assert!(format_time_estimate(0.5, false).contains("0.5s"));
        assert!(format_time_estimate(30.0, false).contains("30s"));
        assert!(format_time_estimate(120.0, false).contains("2m"));
    }

    #[test]
    fn test_format_time_estimate_sub_second() {
        // Sub-second times should show 1 decimal
        assert_eq!(format_time_estimate(0.1, false), "0.1s");
        assert_eq!(format_time_estimate(0.9, false), "0.9s");
    }

    #[test]
    fn test_format_time_estimate_seconds() {
        // 1 to 59 seconds should show whole number
        assert_eq!(format_time_estimate(1.0, false), "1s");
        assert_eq!(format_time_estimate(45.5, false), "46s");
        assert_eq!(format_time_estimate(59.9, false), "60s");
    }

    #[test]
    fn test_format_time_estimate_minutes() {
        // 60+ seconds should show minutes and seconds
        let result = format_time_estimate(90.0, false);
        assert!(result.contains('m'));

        let result = format_time_estimate(125.5, false);
        assert!(result.contains('m'));
        assert!(result.contains('s'));
    }

    #[test]
    fn test_format_time_estimate_hours() {
        // 3600+ seconds should show hours and minutes
        let result = format_time_estimate(3661.0, false);
        assert!(result.contains('h'));
        assert!(result.contains('m'));
    }

    #[test]
    fn test_build_targets_none_download() {
        // Should return empty string when download is None
        let result = build_targets(None, false, Theme::Dark);
        assert_eq!(result, "");
    }

    #[test]
    fn test_build_targets_with_download() {
        // 100 Mbps download
        let result = build_targets(Some(100_000_000.0), false, Theme::Dark);
        assert!(!result.is_empty());
        assert!(result.contains("USAGE CHECK"));
    }

    #[test]
    fn test_build_targets_all_targets_present() {
        let result = build_targets(Some(100_000_000.0), false, Theme::Dark);
        // All target names should be present
        assert!(result.contains("Video calls"));
        assert!(result.contains("HD streaming"));
        assert!(result.contains("4K streaming"));
        assert!(result.contains("Cloud gaming"));
        assert!(result.contains("Large file transfers"));
    }

    #[test]
    fn test_build_targets_excellent_speed() {
        // 500 Mbps should meet all targets
        let result = build_targets(Some(500_000_000.0), false, Theme::Dark);
        // Should show passing indicators for all targets (or error count)
        assert!(!result.is_empty());
    }

    #[test]
    fn test_build_targets_poor_speed() {
        // 1 Mbps should fail most targets
        let result = build_targets(Some(1_000_000.0), false, Theme::Dark);
        assert!(!result.is_empty());
    }

    #[test]
    fn test_build_profile_targets_custom_targets() {
        let targets = vec![
            UsageTarget {
                name: "Custom Target",
                required_mbps: 25.0,
                icon: "🎯",
            },
            UsageTarget {
                name: "Another Target",
                required_mbps: 50.0,
                icon: "",
            },
        ];

        let result = build_profile_targets(
            Some(100_000_000.0),
            false,
            Theme::Dark,
            &targets,
            Some(100.0),
        );

        assert!(result.contains("Custom Target"));
        assert!(result.contains("Another Target"));
    }

    #[test]
    fn test_build_profile_targets_calculates_ratio() {
        // Test that ratio is calculated and displayed
        let targets = vec![UsageTarget {
            name: "Test",
            required_mbps: 50.0,
            icon: "",
        }];

        let result = build_profile_targets(
            Some(200_000_000.0),
            false,
            Theme::Dark,
            &targets,
            Some(200.0),
        );

        // Should show 4.0x ratio for 200/50 = 4 (format is {:.1}x for <10x)
        assert!(result.contains("4.0x"));
    }

    #[test]
    fn test_build_profile_targets_shortfall() {
        // When speed is below requirement, show shortfall
        let targets = vec![UsageTarget {
            name: "Test",
            required_mbps: 100.0,
            icon: "",
        }];

        let result =
            build_profile_targets(Some(30_000_000.0), false, Theme::Dark, &targets, Some(30.0));

        // Should show 70 Mb/s short (100 - 30)
        assert!(result.contains("short"));
    }

    #[test]
    fn test_build_profile_targets_no_download() {
        let targets = vec![UsageTarget {
            name: "Test",
            required_mbps: 50.0,
            icon: "",
        }];

        let result = build_profile_targets(None, false, Theme::Dark, &targets, None);
        assert_eq!(result, "");
    }

    #[test]
    fn test_build_targets_nc_mode() {
        // No color mode should still produce output
        let result = build_targets(Some(100_000_000.0), true, Theme::Dark);
        assert!(!result.is_empty());
        // Should have the header
        assert!(result.contains("USAGE CHECK"));
    }

    #[test]
    fn test_build_profile_targets_nc_mode() {
        let targets = vec![UsageTarget {
            name: "Test Target",
            required_mbps: 50.0,
            icon: "",
        }];

        let result = build_profile_targets(
            Some(100_000_000.0),
            true,
            Theme::Dark,
            &targets,
            Some(100.0),
        );

        assert!(result.contains("Test Target"));
    }

    #[test]
    fn test_build_none_download() {
        let result = build(None, false, Theme::Dark);
        assert_eq!(result, "");
    }

    #[test]
    fn test_build_with_download() {
        let result = build(Some(100_000_000.0), false, Theme::Dark);
        assert!(!result.is_empty());
        assert!(result.contains("ESTIMATES"));
    }

    #[test]
    fn test_build_all_file_types() {
        let result = build(Some(100_000_000.0), false, Theme::Dark);
        // All file estimate names should be present
        assert!(result.contains("Song / Podcast"));
        assert!(result.contains("Photo"));
        assert!(result.contains("App install"));
        assert!(result.contains("HD movie"));
        assert!(result.contains("4K movie"));
        assert!(result.contains("Game install"));
    }

    #[test]
    fn test_build_gigabit_speed() {
        // 1 Gbps should show fast download times
        let result = build(Some(1_000_000_000.0), false, Theme::Dark);
        assert!(!result.is_empty());
    }

    #[test]
    fn test_build_slow_speed() {
        // 1 Mbps should show slow download times
        let result = build(Some(1_000_000.0), false, Theme::Dark);
        assert!(!result.is_empty());
    }

    #[test]
    fn test_build_nc_mode() {
        // No color mode should still produce output
        let result = build(Some(100_000_000.0), true, Theme::Dark);
        assert!(!result.is_empty());
        assert!(result.contains("ESTIMATES"));
    }

    #[test]
    fn test_format_targets_function() {
        // Should not panic and produces output
        format_targets(Some(100_000_000.0), false, Theme::Dark);
    }

    #[test]
    fn test_format_targets_none() {
        // Should not panic with None
        format_targets(None, false, Theme::Dark);
    }

    #[test]
    fn test_show_function() {
        // Should not panic
        show(Some(100_000_000.0), false, Theme::Dark);
    }

    #[test]
    fn test_show_none() {
        // Should not panic with None
        show(None, false, Theme::Dark);
    }

    #[test]
    fn test_build_profile_targets_no_dl_mbps() {
        // When download is set but dl_mbps is None, should calculate from download
        let targets = vec![UsageTarget {
            name: "Test",
            required_mbps: 50.0,
            icon: "",
        }];

        // Pass None for dl_mbps but Some for download_bps - should still work
        let result = build_profile_targets(
            Some(100_000_000.0),
            false,
            Theme::Dark,
            &targets,
            None, // dl_mbps is None
        );

        assert!(!result.is_empty());
    }

    #[test]
    fn test_high_ratio_rounds_correctly() {
        // Test that 10x+ shows integer only
        let targets = vec![UsageTarget {
            name: "Test",
            required_mbps: 10.0,
            icon: "",
        }];

        let result = build_profile_targets(
            Some(500_000_000.0),
            false,
            Theme::Dark,
            &targets,
            Some(500.0),
        );

        // 50x should show "50x" not "50.0x"
        assert!(result.contains("50x"));
    }
}