add flag for verbose output

Author: code-inflation

README.md

@@ -4,7 +4,7 @@
 ## TODO
 - [ ] Dynamic payload sizing depending on network speed
 - [ ] Consider server processing time in measurements
-- [ ] CLI arguments (~~nr of tests~~, ~~payload sizes~~, verbosity)
+- [X] CLI arguments (~~nr of tests~~, ~~payload sizes~~, ~~verbosity~~)
 - [ ] Clean up outputs
 - [X] Boxplot for measurements
 - [ ] Asciinema recording in readme

src/main.rs

@@ -7,36 +7,33 @@ use clap::Parser;
 use speedtest::speed_test;
 use speedtest::PayloadSize;
 
-// pub const PAYLOAD_SIZES: [usize; 4] = [100_000, 1_000_000, 10_000_000, 25_000_000];
-
 /// Unofficial CLI for speed.cloudflare.com
 #[derive(Parser, Debug)]
 #[command(author, version, about, long_about = None)]
-struct Args {
-    #[arg(value_parser = parse_payload_size, short, long, default_value_t = PayloadSize::M10)]
-    /// The max payload size in bytes to use [100k, 1m, 10m, 25m or 100m]
-    max_payload_size: PayloadSize,
-
+pub(crate) struct SpeedTestOptions {
     /// Number of test runs per payload size. Needs to be at least 4
     #[arg(value_parser = clap::value_parser!(u32).range(4..1000), short, long, default_value_t = 10)]
     nr_tests: u32,
 
     /// Number of latency tests to run
     #[arg(long, default_value_t = 25)]
     nr_latency_tests: u32,
+
+    /// The max payload size in bytes to use [100k, 1m, 10m, 25m or 100m]
+    #[arg(value_parser = parse_payload_size, short, long, default_value_t = PayloadSize::M10)]
+    max_payload_size: PayloadSize,
+
+    /// Enable verbose output i.e. print out boxplots of the measurements
+    #[arg(short, long)]
+    verbose: bool,
 }
 
 fn main() {
     env_logger::init();
-    let args = Args::parse();
+    let options = SpeedTestOptions::parse();
     println!("Starting Cloudflare speed test");
     let client = reqwest::blocking::Client::new();
-    speed_test(
-        client,
-        args.max_payload_size,
-        args.nr_tests,
-        args.nr_latency_tests,
-    );
+    speed_test(client, options);
 }
 
 fn parse_payload_size(input_string: &str) -> Result<PayloadSize, String> {

src/measurements.rs

@@ -20,19 +20,26 @@ impl Display for Measurement {
     }
 }
 
-pub(crate) fn log_measurements(measurements: &[Measurement], payload_sizes: Vec<usize>) {
+pub(crate) fn log_measurements(
+    measurements: &[Measurement],
+    payload_sizes: Vec<usize>,
+    verbose: bool,
+) {
     println!("\n### STATS ###");
     measurements
         .iter()
         .map(|m| m.test_type)
         .collect::<HashSet<TestType>>()
         .iter()
-        .for_each(|t| log_measurements_by_test_type(measurements, payload_sizes.clone(), *t));
+        .for_each(|t| {
+            log_measurements_by_test_type(measurements, payload_sizes.clone(), verbose, *t)
+        });
 }
 
 fn log_measurements_by_test_type(
     measurements: &[Measurement],
     payload_sizes: Vec<usize>,
+    verbose: bool,
     test_type: TestType,
 ) {
     for payload_size in payload_sizes {
@@ -46,8 +53,10 @@ fn log_measurements_by_test_type(
 
         let formated_payload = format_bytes(payload_size);
         println!("{test_type:?} {formated_payload}: min {min:.2}, max {max:.2}, avg {avg:.2}");
-        let plot = boxplot::render_plot(min, q1, median, q3, max);
-        println!("{plot}\n");
+        if verbose {
+            let plot = boxplot::render_plot(min, q1, median, q3, max);
+            println!("{plot}\n");
+        }
     }
 }
 

src/speedtest.rs

@@ -2,6 +2,7 @@ use crate::measurements::format_bytes;
 use crate::measurements::log_measurements;
 use crate::measurements::Measurement;
 use crate::progress::print_progress;
+use crate::SpeedTestOptions;
 use log;
 use regex::Regex;
 use reqwest::{
@@ -13,6 +14,7 @@ use std::{
     fmt::Display,
     time::{Duration, Instant},
 };
+
 const BASE_URL: &str = "http://speed.cloudflare.com";
 const DOWNLOAD_URL: &str = "__down?bytes=";
 const UPLOAD_URL: &str = "__up";
@@ -82,31 +84,26 @@ impl Display for Metadata {
     }
 }
 
-pub(crate) fn speed_test(
-    client: Client,
-    max_payload_size: PayloadSize,
-    nr_tests: u32,
-    nr_latency_tests: u32,
-) {
+pub(crate) fn speed_test(client: Client, options: SpeedTestOptions) {
     let metadata = fetch_metadata(&client);
     println!("{metadata}");
-    run_latency_test(&client, nr_latency_tests);
-    let payload_sizes = PayloadSize::sizes_from_max(max_payload_size);
+    run_latency_test(&client, options.nr_latency_tests);
+    let payload_sizes = PayloadSize::sizes_from_max(options.max_payload_size);
     let mut measurements = run_tests(
         &client,
         test_download,
         TestType::Download,
         payload_sizes.clone(),
-        nr_tests,
+        options.nr_tests,
     );
     measurements.append(&mut run_tests(
         &client,
         test_upload,
         TestType::Upload,
         payload_sizes.clone(),
-        nr_tests,
+        options.nr_tests,
     ));
-    log_measurements(&measurements, payload_sizes);
+    log_measurements(&measurements, payload_sizes, options.verbose);
 }
 
 fn run_latency_test(client: &Client, nr_latency_tests: u32) -> (Vec<f64>, f64) {