Version bump to v0.3.1

Reviewed-on: #1

.gitignore

@@ -14,3 +14,8 @@ Cargo.lock
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
 
+
+
+# Added by cargo
+
+/target

.woodpecker.yml

@@ -0,0 +1,30 @@
+pipeline:
+  test_build:
+    image: rust:1.62
+    commands:
+      - "cargo build"
+
+  build_release:
+    image: rust:1.62
+    commands:
+      - "cargo install cargo-deb cargo-generate-rpm"
+      - "cargo build --release"
+      - "cargo deb"
+      - "cargo generate-rpm"
+      - "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"
+        - "target/debian/hardware-tests*.deb"
+        - "target/generate-rpm/hardware-tests*.rpm"
+      title: "${CI_COMMIT_TAG}"
+    when:
+      event: tag

Cargo.toml

@@ -0,0 +1,27 @@
+[package]
+name = "hardware-tests"
+description = "Bit Goblin PC hardware test suite."
+version = "0.3.1"
+edition = "2021"
+readme = "README.md"
+license = "BSD 2-Clause"
+authors = ["Gregory Ballantine <gballantine@bitgoblin.tech>"]
+
+[[bin]]
+name = "bgbench"
+path = "src/main.rs"
+
+[dependencies]
+chrono = "0.4.20"
+clap = { version = "3.2.16", features = ["derive"] }
+sysinfo = "0.25.1"
+
+[package.metadata.deb]
+depends = "fio"
+
+[package.metadata.generate-rpm]
+assets = [
+	{ source = "target/release/bgbench", dest = "/usr/bin/bgbench", mode = "755" },
+]
+[package.metadata.generate-rpm.requires]
+fio = "*"

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,24 @@
-# test-scripts
+# Bit Goblin Hardware Tests
 
-Scripts used for testing hardware in Bit Goblin's videos
+Benchmarking suite 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.
+
+## Running
+
+Simply run the tool with `./bgbench` and you'll be presented with the available subcommands.
+
+### Runtime requirements:
+* disk - requires `fio`.
+
+## 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 program. These will be available under `target/debug/`. Else you can just run a `cargo build` to compile the program.
+
+## License
+
+The Bit Goblin hardware test suite is available via the BSD 2-Clause license, so feel free to hack away at it!

bin/docker-build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+docker run --rm --user "$(id -u)":"$(id -g)" -v "$PWD":/usr/src/hardware-tests -w /usr/src/hardware-tests rust:1.62 cargo build

src/benchmarks/disk.rs

@@ -0,0 +1,109 @@
+use std::process::Command;
+
+// test disk sequential read speeds w/ fio
+pub fn disk_read_seq_test(tempfile: &str, size: &u8) {
+    // run the fio command
+    let output = Command::new("fio")
+        .arg("--name=TEST")
+        .arg(format!("--filename={}", tempfile))
+        .arg("--rw=read")
+        .arg("--size=2g")
+        .arg(format!("--io_size={}g", size))
+        .arg("--blocksize=1024k")
+        .arg("--ioengine=libaio")
+        .arg("--fsync=10000")
+        .arg("--iodepth=32")
+        .arg("--direct=1")
+        .arg("--numjobs=1")
+        .arg("--runtime=60")
+        .arg("--group_reporting")
+        .output()
+        .expect("Failed to execute command");
+
+    // check that the command succeeded
+    assert!(output.status.success());
+
+    // print the test's output
+    println!("{}", String::from_utf8_lossy(&output.stdout));
+}
+
+// test disk 4K random read speeds w/ fio
+pub fn disk_read_rand_test(tempfile: &str, size: &u8) {
+    // run the fio command
+    let output = Command::new("fio")
+        .arg("--name=TEST")
+        .arg(format!("--filename={}", tempfile))
+        .arg("--rw=randread")
+        .arg("--size=2g")
+        .arg(format!("--io_size={}g", size))
+        .arg("--blocksize=4k")
+        .arg("--ioengine=libaio")
+        .arg("--fsync=1")
+        .arg("--iodepth=1")
+        .arg("--direct=1")
+        .arg("--numjobs=32")
+        .arg("--runtime=60")
+        .arg("--group_reporting")
+        .output()
+        .expect("Failed to execute command");
+
+    // check that the command succeeded
+    assert!(output.status.success());
+
+    // print the test's output
+    println!("{}", String::from_utf8_lossy(&output.stdout));
+}
+
+// test sequential disk write speeds w/ fio
+pub fn disk_write_seq_test(tempfile: &str, size: &u8) {
+    // run the fio command
+    let output = Command::new("fio")
+        .arg("--name=TEST")
+        .arg(format!("--filename={}", tempfile))
+        .arg("--rw=write")
+        .arg("--size=2g")
+        .arg(format!("--io_size={}g", size))
+        .arg("--blocksize=1024k")
+        .arg("--ioengine=libaio")
+        .arg("--fsync=10000")
+        .arg("--iodepth=32")
+        .arg("--direct=1")
+        .arg("--numjobs=1")
+        .arg("--runtime=60")
+        .arg("--group_reporting")
+        .output()
+        .expect("Failed to execute command");
+
+    // check that the command succeeded
+    assert!(output.status.success());
+
+    // print the test's output
+    println!("{}", String::from_utf8_lossy(&output.stdout));
+}
+
+// test random 4K disk write speeds w/ fio
+pub fn disk_write_rand_test(tempfile: &str, size: &u8) {
+    // run the fio command
+    let output = Command::new("fio")
+        .arg("--name=TEST")
+        .arg(format!("--filename={}", tempfile))
+        .arg("--rw=randrw")
+        .arg("--size=2g")
+        .arg(format!("--io_size={}g", size))
+        .arg("--blocksize=4k")
+        .arg("--ioengine=libaio")
+        .arg("--fsync=1")
+        .arg("--iodepth=1")
+        .arg("--direct=1")
+        .arg("--numjobs=32")
+        .arg("--runtime=60")
+        .arg("--group_reporting")
+        .output()
+        .expect("Failed to execute command");
+
+    // check that the command succeeded
+    assert!(output.status.success());
+
+    // print the test's output
+    println!("{}", String::from_utf8_lossy(&output.stdout));
+}

src/benchmarks/mod.rs

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

src/benchmarks/network.rs

@@ -0,0 +1,48 @@
+use chrono::prelude::*;
+use std::{fs,process};
+
+use crate::text;
+
+// ping a host
+pub fn ping_host(address: &str, count: &u16) {
+    println!("Pinging host {}, {} times.", address, count);
+
+    // run the ping command
+    let output = process::Command::new("ping")
+        .arg(address)
+        .arg(format!("-c {}", count))
+        .output()
+        .expect("Failed to execute command");
+
+    // check that the command succeeded
+    assert!(output.status.success());
+
+    // grab the ping results from stdout
+    let results_raw = &String::from_utf8_lossy(&output.stdout);
+    let results = text::format::trim_output(results_raw, 4);
+    for line in results {
+        println!("{}", line);
+    }
+}
+
+// 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),
+    }
+}

src/main.rs

@@ -0,0 +1,172 @@
+mod benchmarks;
+mod stress;
+mod text;
+
+use clap::{Args, 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,
+
+    #[clap(short = 'l', long, default_value_t = 1, help = "Number of times to run test. Default = 1", global = true)]
+    loopcount: u8,
+}
+
+#[derive(Subcommand)]
+enum Commands {
+    // CPU benchmarks subcommand
+    #[clap(name = "cpu", about = "CPU benchmarks and stress tests.")]
+    Cpu(Cpu),
+    // disk benchmarks subcommand
+    #[clap(name = "disk", about = "Hard drive and SSD benchmarks.")]
+    Disk(Disk),
+    // network benchmarks subcommand
+    #[clap(name = "network", about = "Test various aspects of your network.")]
+    Net(Net),
+}
+
+#[derive(Args)]
+struct Cpu {
+    #[clap(subcommand)]
+    cpu_commands: CpuCommands,
+}
+
+#[derive(Subcommand)]
+enum CpuCommands {
+    // CPU stress test subcommand
+    #[clap(name = "stress", about = "Stress test the CPU with math!")]
+    StressTest {
+        #[clap(short = 'r', long, default_value_t = 5, help = "Length of time (in minutes) to run the stress test. Defaults to 5")]
+        runtime: u16,
+        #[clap(short = 't', long, default_value_t = 0, help = "Number of threads to use; defaults to CPU's max thread count. Defaults to 0 (automatic)")]
+        threads: usize,
+    },
+}
+
+#[derive(Args)]
+struct Disk {
+    #[clap(subcommand)]
+    disk_commands: DiskCommands,
+}
+
+#[derive(Subcommand)]
+enum DiskCommands {
+    // sequential disk read subcommand
+    #[clap(name = "read_seq", about = "Sequential disk read speed test.")]
+    ReadSeqTest {
+        #[clap(short = 't', long, default_value_t = String::from("/tmp/disk-test.tmp"))]
+        tempfile: String,
+        #[clap(short = 's', long, default_value_t = 15)]
+        size: u8,
+    },
+
+    // random disk read subcommand
+    #[clap(name = "read_rand", about = "Random 4K disk read speed test.")]
+    ReadRandTest {
+        #[clap(short = 't', long, default_value_t = String::from("/tmp/disk-test.tmp"))]
+        tempfile: String,
+        #[clap(short = 's', long, default_value_t = 15)]
+        size: u8,
+    },
+
+    // sequential disk write subcommand
+    #[clap(name = "write_seq", about = "Write a large file to determine sequential disk write speeds.")]
+    WriteSeqTest {
+        #[clap(short = 't', long, default_value_t = String::from("/tmp/disk-test.tmp"))]
+        tempfile: String,
+        #[clap(short = 's', long, default_value_t = 15)]
+        size: u8,
+    },
+
+    // random 4K disk write subcommand
+    #[clap(name = "write_rand", about = "Write a bunch of smallfiles to determine random disk write speeds.")]
+    WriteRandTest {
+        #[clap(short = 't', long, default_value_t = String::from("/tmp/disk-test.tmp"))]
+        tempfile: String,
+        #[clap(short = 's', long, default_value_t = 15)]
+        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 = 'a', long, default_value_t = String::from("8.8.8.8"))]
+        address: String,
+        #[clap(short = 'c', long, 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', long, default_value_t = String::from("https://www.bitgoblin.tech/hardware-tests/export-01.mp4"))]
+        download: String,
+        #[clap(short = 't', long, default_value_t = String::from("/tmp/bw-test.tmp"))]
+        output: String,
+    },
+}
+
+fn main() {
+    let cli = Cli::parse();
+
+    // map subcommands back to the main command
+    match &cli.command {
+        Commands::Cpu(args) => match &args.cpu_commands {
+            CpuCommands::StressTest { runtime, threads } => stress::cpu::cpu_stress_math(*runtime, *threads),
+        },
+
+        Commands::Disk(args) => match &args.disk_commands {
+            DiskCommands::ReadSeqTest { tempfile, size } => {
+                for i in 0..cli.loopcount {
+                    println!("Test run number {}.", i + 1);
+                    benchmarks::disk::disk_read_seq_test(tempfile, size);
+                }
+            },
+            DiskCommands::ReadRandTest { tempfile, size } => {
+                for i in 0..cli.loopcount {
+                    println!("Test run number {}.", i + 1);
+                    benchmarks::disk::disk_read_rand_test(tempfile, size);
+                }
+            },
+            DiskCommands::WriteSeqTest { tempfile, size } => {
+                for i in 0..cli.loopcount {
+                    println!("Test run number {}.", i + 1);
+                    benchmarks::disk::disk_write_seq_test(tempfile, size);
+                }
+            },
+            DiskCommands::WriteRandTest { tempfile, size } => {
+                for i in 0..cli.loopcount {
+                    println!("Test run number {}.", i + 1);
+                    benchmarks::disk::disk_write_rand_test(tempfile, size);
+                }
+            },
+        }
+
+        Commands::Net(args) => match &args.net_commands {
+            NetCommands::Ping { address, count } => {
+                for i in 0..cli.loopcount {
+                    println!("Test run number {}.", i + 1);
+                    benchmarks::network::ping_host(address, count);
+                }
+            },
+            NetCommands::Bandwidth { download, output } => {
+                for i in 0..cli.loopcount {
+                    println!("Test run number {}.", i + 1);
+                    benchmarks::network::bandwidth_test(download, output);
+                }
+            },
+        },
+    }
+}

src/stress/cpu.rs

@@ -0,0 +1,38 @@
+use std::{thread, time};
+use std::process::exit;
+use sysinfo::{System,SystemExt};
+
+pub fn cpu_stress_math(runtime: u16, threads: usize) {
+    // fetch system information
+    let mut sys = System::new_all();
+    sys.refresh_all();
+    let num_cpus = sys.cpus().len();
+
+    let mut num_threads = threads;
+    if num_threads == 0 {
+        println!("Number of threads not specified, defaulting to CPU's thread count of {}.", num_cpus);
+        num_threads = num_cpus;
+    } else {
+        println!("Using specified thread count of {}", num_threads);
+    }
+
+    for i in 0..num_threads {
+        println!("Spawning thread number {}", i + 1);
+        thread::spawn (|| {
+            worker();
+        });
+    }
+
+    println!("Sleeping main thread for the allotted runtime of {} minute(s).", runtime);
+    let duration = time::Duration::from_secs((runtime * 60).into());
+    thread::sleep(duration);
+    exit(0);
+}
+
+fn worker() {
+    let mut _x = 0;
+    loop {
+        _x += 1;
+        _x -= 1;
+    }
+}

src/stress/mod.rs

@@ -0,0 +1 @@
+pub mod cpu;

src/text/format.rs

@@ -0,0 +1,8 @@
+use std::vec::Vec;
+
+pub fn trim_output(text: &str, linecount: u16) -> Vec<&str> {
+    let text_vec: Vec<&str> = text.split("\n").collect();
+    let text_start = text_vec.len() - (linecount as usize);
+    let text_trim = text_vec.as_slice()[text_start..].to_vec();
+    return text_trim;
+}

src/text/mod.rs

@@ -0,0 +1 @@
+pub mod format;