Version bump to v0.2.1

.woodpecker.yml

@@ -0,0 +1,25 @@
+pipeline:
+  test_build:
+    image: rust:1.62
+    commands:
+      - cargo build
+
+  build_release:
+    image: rust:1.62
+    commands:
+      - cargo build --release
+      - "mv target/release/bgbench target/release/bgbench-${CI_COMMIT_TAG}-linux-x86_64"
+    when:
+      event: tag
+
+  gitea_release:
+    image: plugins/gitea-release
+    settings:
+      api_key:
+        from_secret: gitea_api_key
+      base_url: https://git.metaunix.net
+      files:
+        - "target/release/*${CI_COMMIT_TAG}-linux-x86_64"
+      title: "${CI_COMMIT_TAG}"
+    when:
+      event: tag

Cargo.toml

@@ -1,18 +1,14 @@
 [package]
 name = "hardware-tests"
-version = "0.1.0"
+version = "0.2.1"
 edition = "2021"
 
 [[bin]]
-name = "hdtest"
-path = "src/hdtest.rs"
-
-[[bin]]
-name = "nettest"
-path = "src/nettest.rs"
+name = "bgbench"
+path = "src/main.rs"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-chrono = "0.4.19"
-clap = { version = "3.1.2", features = ["derive"] }
+chrono = "0.4.20"
+clap = { version = "3.2.16", features = ["derive"] }

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) <year> <owner> 
+Copyright (c) 2022 Bit Goblin 
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

README.md

@@ -1,3 +1,17 @@
-# test-scripts
+# Bit Goblin Hardware Tests
 
-Scripts used for testing hardware in Bit Goblin's videos
+Scripts used for testing hardware in Bit Goblin's videos.
+
+## Download & Installation
+
+Check out the [Releases page](https://git.metaunix.net/BitGoblin/hardware-tests/releases) to find the latest compiled binaries.
+
+Currently there is no installation method other than downloading the provided release binaries. In the future I want to build Linux package repositories for this, and have a Windows installer.
+
+## Building
+
+The easiest way to build the program is using the official Rust image from Docker Hub, for which there's a wrapper script at `bin/docker-build.sh` that can be used to build the test programs. These will be available under `target/debug/`.
+
+## License
+
+The Bit Goblin hardware test suite is available via the BSD 2-Clause license, so feel free to hack away at it!

src/hdtest.rs

@@ -1,25 +0,0 @@
-use std::fs;
-use std::process::Command;
-
-fn main() {
-    // run the dd command with a block size of 1 MB, 10K times (10GB file)
-    let output = Command::new("dd")
-        .arg("bs=1M")
-        .arg("count=10240")
-        .arg("if=/dev/zero")
-        .arg("of=./speed-test")
-        .output()
-        .expect("Failed to execute command");
-
-    // check that the command succeeded
-    assert!(output.status.success());
-
-    // for whatever reason, `dd` output ends up in stderr
-    println!("{}", String::from_utf8_lossy(&output.stderr));
-
-    // remove the test file
-    match fs::remove_file("./speed-test") {
-        Ok(()) => println!("Cleaning up..."),
-        Err(e) => println!("There was a problem during cleanup - {}", e),
-    }
-}

src/main.rs

@@ -0,0 +1,90 @@
+mod tests;
+
+use clap::{Parser, Subcommand};
+
+#[derive(Parser)]
+#[clap(name = "Bit Goblin Benchmark", author, version, about = "Bit Goblin's hardware benchmarking tool.", long_about = None)]
+#[clap(propagate_version = true)]
+struct Cli {
+    #[clap(subcommand)]
+    command: Commands,
+}
+
+#[derive(Subcommand)]
+enum Commands {
+    // disk tests subcommand
+    #[clap(name = "disk", about = "Hard drive and SSD benchmarks.")]
+    Disk(Disk),
+    // network tests subcommand
+    #[clap(name = "network", about = "Test various aspects of your network.")]
+    Net(Net),
+}
+
+#[derive(Parser)]
+struct Disk {
+    #[structopt(subcommand)]
+    disk_commands: DiskCommands,
+}
+
+#[derive(Subcommand)]
+enum DiskCommands {
+    // disk read subcommand
+    #[clap(name = "read-test", about = "Read from /dev/zero to determine sequential disk read speeds.")]
+    ReadTest {
+        #[clap(short = 's', default_value_t = 15)]
+        size: u8,
+    },
+
+    // disk write subcommand
+    #[clap(name = "write-test", about = "Write a large file to determine sequential disk write speeds.")]
+    WriteTest {
+        #[clap(short = 't', default_value_t = String::from("/tmp/disk-test.tmp"))]
+        tempfile: String,
+        #[clap(short = 's', default_value_t = 5)]
+        size: u8,
+    },
+}
+
+#[derive(Parser)]
+struct Net {
+    #[structopt(subcommand)]
+    net_commands: NetCommands,
+}
+
+#[derive(Subcommand)]
+enum NetCommands {
+    // ping subcommand
+    #[clap(name = "ping", about = "Ping a host to determine network latency.")]
+    Ping {
+        #[clap(short = 't', default_value_t = String::from("8.8.8.8"))]
+        host: String,
+        #[clap(short = 'c', default_value_t = 30)]
+        count: u16,
+    },
+
+    // bandwidth test subcommand
+    #[clap(name = "bandwidth", about = "Downloads a remote file to determine network bandwidth.")]
+    Bandwidth {
+        #[clap(short = 'd', default_value_t = String::from("https://www.bitgoblin.tech/hardware-tests/export-01.mp4"))]
+        download: String,
+        #[clap(short = 'o', default_value_t = String::from("./tempfile"))]
+        output: String,
+    },
+}
+
+fn main() {
+    let cli = Cli::parse();
+
+    // map subcommands back to the main command
+    match &cli.command {
+        Commands::Disk(args) => match &args.disk_commands {
+            DiskCommands::ReadTest { size } => tests::disk::disk_read_test(size),
+            DiskCommands::WriteTest { tempfile, size } => tests::disk::disk_write_test(tempfile, size),
+        }
+
+        Commands::Net(args) => match &args.net_commands {
+            NetCommands::Ping { host, count } => tests::network::ping_host(host, count),
+            NetCommands::Bandwidth { download, output } => tests::network::bandwidth_test(download, output),
+        },
+    }
+}

src/nettest.rs

@@ -1,78 +0,0 @@
-use chrono::prelude::*;
-use clap::{Parser, Subcommand};
-use std::{fs,process};
-
-#[derive(Parser)]
-#[clap(name = "Bit Goblin Network Tester", author, version, about = "Network testing app.", long_about = None)]
-#[clap(propagate_version = true)]
-struct Cli {
-    #[clap(subcommand)]
-    command: Commands,
-}
-
-#[derive(Subcommand)]
-enum Commands {
-    // ping subcommand
-    Ping {
-        #[clap(default_value_t = String::from("8.8.8.8"))]
-        host: String
-    },
-
-    // bandwidth test subcommand
-    Bandwidth {
-        #[clap(default_value_t = String::from("https://www.bitgoblin.tech/hardware-tests/export-01.mp4"))]
-        download: String,
-        #[clap(default_value_t = String::from("./tempfile"))]
-        output: String,
-    },
-}
-
-fn main() {
-    let cli = Cli::parse();
-
-    // map subcommands back to the main command
-    match &cli.command {
-        Commands::Ping { host } => ping_host(host),
-        Commands::Bandwidth { download, output } => bandwidth_test(download, output)
-    }
-}
-
-// ping a host
-fn ping_host(host: &str) {
-    println!("Pinging host {}", host);
-
-    // run the ping command with 100 pings
-    let output = process::Command::new("ping")
-        .arg(host)
-        .arg("-c 100")
-        .output()
-        .expect("Failed to execute command");
-
-    // check that the command succeeded
-    assert!(output.status.success());
-
-    // print out the ping results from stdout
-    println!("{}", String::from_utf8_lossy(&output.stdout));
-}
-
-// timed file copy test to guage bandwidth speeds
-fn bandwidth_test(download: &str, output: &str) {
-    println!("Testing network bandwidth by downloading {}.", download);
-
-    // get start time so we can track how long it takes to complete
-    let start_time = Utc::now();
-
-    // do the download
-
-    // get finish time
-    let finish_time = Utc::now();
-    // compute time to complete
-    let comp_time = finish_time - start_time;
-    println!("{}", comp_time.num_milliseconds());
-
-    // clean up the test file
-    match fs::remove_file(output) {
-        Ok(()) => println!("Cleaning up..."),
-        Err(e) => println!("There was a problem during cleanup - {}", e),
-    }
-}

src/tests/disk.rs

@@ -0,0 +1,56 @@
+use std::fs;
+use std::process::Command;
+
+// test disk read speeds by reading for /dev/zero and writing it to /dev/null
+pub fn disk_read_test(size: &u8) {
+    // convert size in Gigabytes down to Megabytes
+    let size_gigs: u32 = (*size as u32 * 1024 * 8).into();
+
+    // run sync to clear out any disk caches prior to running
+    Command::new("sync");
+
+    // run the dd command
+    let output = Command::new("dd")
+        .arg("bs=128k")
+        .arg(format!("count={}", size_gigs))
+        .arg("if=/dev/zero")
+        .arg("of=/dev/null")
+        .output()
+        .expect("Failed to execute command");
+
+    // check that the command succeeded
+    assert!(output.status.success());
+
+    // dd's output ends up in stderr
+    println!("{}", String::from_utf8_lossy(&output.stderr));
+
+    // run another sync to clear out the disk's cache
+    Command::new("sync");
+}
+
+// test disk write speeds by continually writing zeroes to it
+pub fn disk_write_test(tempfile: &str, size: &u8) {
+    // convert size in Gigabytes down to Megabytes
+    let size_gigs: u32 = (*size as u32 * 1024).into();
+
+    // run the dd command with a block size of 1 MB
+    let output = Command::new("dd")
+        .arg("bs=1M")
+        .arg(format!("count={}", size_gigs))
+        .arg("if=/dev/zero")
+        .arg(format!("of={}", tempfile))
+        .output()
+        .expect("Failed to execute command");
+
+    // check that the command succeeded
+    assert!(output.status.success());
+
+    // for whatever reason, `dd` output ends up in stderr
+    println!("{}", String::from_utf8_lossy(&output.stderr));
+
+    // remove the test file
+    match fs::remove_file(tempfile) {
+        Ok(()) => println!("Cleaning up..."),
+        Err(e) => println!("There was a problem during cleanup - {}", e),
+    }
+}

src/tests/mod.rs

@@ -0,0 +1,2 @@
+pub mod disk;
+pub mod network;

src/tests/network.rs

@@ -0,0 +1,42 @@
+use chrono::prelude::*;
+use std::{fs,process};
+
+// ping a host
+pub fn ping_host(host: &str, count: &u16) {
+    println!("Pinging host {}, {} times.", host, count);
+
+    // run the ping command
+    let output = process::Command::new("ping")
+        .arg(host)
+        .arg(format!("-c {}", count))
+        .output()
+        .expect("Failed to execute command");
+
+    // check that the command succeeded
+    assert!(output.status.success());
+
+    // print out the ping results from stdout
+    println!("{}", String::from_utf8_lossy(&output.stdout));
+}
+
+// timed file copy test to guage bandwidth speeds
+pub fn bandwidth_test(download: &str, output: &str) {
+    println!("Testing network bandwidth by downloading {}.", download);
+
+    // get start time so we can track how long it takes to complete
+    let start_time = Utc::now();
+
+    // do the download
+
+    // get finish time
+    let finish_time = Utc::now();
+    // compute time to complete
+    let comp_time = finish_time - start_time;
+    println!("{}", comp_time.num_milliseconds());
+
+    // clean up the test file
+    match fs::remove_file(output) {
+        Ok(()) => println!("Cleaning up..."),
+        Err(e) => println!("There was a problem during cleanup - {}", e),
+    }
+}