documented and cleaned up tests, renamed "Script" to "Shell", etc

src/extension_set.rs

@@ -35,6 +35,7 @@ impl ExtensionSet {
 			.concat(),
 			Self::Documents => vec![
 				"pdf", "doc", "docx", "ppt", "pptx", "xls", "xlsx", "csv", "tsv", "odt", "ods", "odp", "oda", "rtf", "ps",
+				"pages", "key", "numbers",
 			],
 			Self::Text => mime_guess::get_mime_extensions_str("text/*").unwrap().to_vec(),
 			// many compressed file types follow the name scheme "application/x.+compressed.*" - maybe this can be used

src/formats.rs

@@ -110,9 +110,9 @@ pub trait Format {
 }
 
 /// Bourne-Shell compatible script.
-pub struct Script {}
+pub struct Shell {}
 
-impl Format for Script {
+impl Format for Shell {
 	fn new() -> Self {
 		Self {}
 	}

src/main.rs

@@ -29,7 +29,7 @@ use rayon::prelude::*;
 use walkdir::{DirEntry, WalkDir};
 
 use crate::findings::Findings;
-use crate::formats::{Format, PowerShell, Script};
+use crate::formats::{Format, PowerShell, Shell};
 use crate::mime_db::MimeDb;
 use crate::parameters::{OutputFormat, ScanOpts};
 use crate::scan_error::ScanError;
@@ -133,7 +133,7 @@ fn main() {
 	let mut buffered_stdout = BufWriter::new(stdout());
 
 	let result = match args.output_format {
-		OutputFormat::Sh => Script::new().write_all(&results, &mut buffered_stdout),
+		OutputFormat::Sh => Shell::new().write_all(&results, &mut buffered_stdout),
 		OutputFormat::PowerShell | OutputFormat::Powershell => PowerShell::new().write_all(&results, &mut buffered_stdout),
 		OutputFormat::Text => todo!(),
 	};

src/tests/mod.rs

@@ -1,19 +1,15 @@
+use crate::findings::Findings;
+use crate::formats::{Format, Shell};
 use crate::inspectors::{mime_extension_lookup, BUF_SIZE};
-use crate::{extension_from_path, init_db, scan_directory, scan_from_walkdir};
-
 use crate::mime_db::MimeDb;
-use crate::parameters::{Parameters, ScanOpts};
 use crate::string_type::String;
-use cfg_if::cfg_if;
+use crate::{extension_from_path, scan_directory, scan_from_walkdir};
+
 use mime_guess::mime::{APPLICATION_OCTET_STREAM, APPLICATION_PDF, IMAGE_JPEG, IMAGE_PNG};
 use mime_guess::Mime;
 
-use crate::findings::Findings;
-use crate::formats::{Format, Script};
-use std::borrow::Borrow;
 use std::collections::HashMap;
 use std::ffi::OsStr;
-use std::io::Read;
 use std::path::Path;
 
 const JPEG_BYTES: &[u8] = b"\xFF\xD8\xFF";
@@ -21,7 +17,7 @@ const PNG_BYTES: &[u8] = b"\x89\x50\x4E\x47\x0D\x0A\x1A\x0A";
 const PDF_BYTES: &[u8] = b"%PDF-";
 const ZIP_BYTES: &[u8] = b"PK\x03\x04";
 
-cfg_if! {
+cfg_if::cfg_if! {
 	if #[cfg(any(all(unix, feature = "infer-backend"), all(not(unix), not(feature = "xdg-mime-backend"))))] {
 		fn get_mime_db() -> crate::mime_db::InferDb {
 			crate::mime_db::InferDb::init()
@@ -39,6 +35,7 @@ fn application_zip() -> Mime {
 }
 
 #[test]
+/// Ensure that `extension_from_path` successfully returns the extension from a set of paths.
 fn get_ext() {
 	let mut ext_checks: HashMap<_, Option<&OsStr>> = HashMap::new();
 	ext_checks.insert(Path::new("test.txt"), Some(OsStr::new("txt")));
@@ -54,6 +51,7 @@ fn get_ext() {
 }
 
 #[test]
+/// Ensure that the mime types for JPEG, PNG, PDF, and ZIP are detected from their magic numbers.
 fn detect_type() {
 	let db = get_mime_db();
 	assert_eq!(db.get_type(JPEG_BYTES), Some(IMAGE_JPEG));
@@ -63,6 +61,8 @@ fn detect_type() {
 }
 
 #[test]
+/// Ensure that `mime_extension_lookup` works as expected, and that the set of extensions for JPEG, PNG, PDF, and ZIP
+/// contain "jpg", "png", "pdf", and "zip", respectively.
 fn recommend_ext() {
 	assert!(mime_extension_lookup(IMAGE_JPEG)
 		.unwrap()
@@ -77,11 +77,17 @@ fn recommend_ext() {
 }
 
 #[test]
+/// Create a simple directory with some files, run `scan_directory` on it, and ensure that the files have their
+/// associated mime types correctly deduced.
 fn simple_directory() {
+	use crate::parameters::ScanOpts;
+	use std::borrow::Borrow;
 	use std::fs::File;
 	use std::io::Write;
 	use tempfile::tempdir;
 
+	// set of files to scan. all but the last files have magic numbers corresponding to their extension, except for
+	// "wrong.jpg", which is actually a png.
 	let mut files = HashMap::new();
 	files.insert("test.jpg", JPEG_BYTES);
 	files.insert("test.jpeg", JPEG_BYTES);
@@ -107,41 +113,39 @@ fn simple_directory() {
 		follow_symlinks: false,
 	};
 
-	let entries = scan_directory(
+	let entries = scan_directory(&dir.path().to_path_buf(), None, &scan_opts).expect("Directory scan failed.");
-		&dir.path().to_path_buf(),
-		Some(&vec!["jpg", "jpeg", "png", "pdf", "zip"]),
-		&scan_opts,
-	)
-	.expect("Directory scan failed.");
 
 	assert_eq!(entries.len(), files.len());
 
-	// initialise global mime DB
+	// initialise global mime DB - this is needed because `scan_from_walkdir` expects it to be present.
-	init_db();
+	crate::init_db();
 
 	let results = scan_from_walkdir(&entries);
 	for result in results {
+		// there should be no IO errors during this test. any IO errors encountered are outside the scope of this test.
 		let result = result.expect("Error while scanning file");
 
 		if !result.valid {
-			// this should be "wrong.jpg", which is a misnamed png file
+			// the only invalid file detected should be "wrong.jpg", which is a misnamed png file
-			// 1. ensure extension is "png"
+			// 1. ensure detected extension is "jpg"
 			assert_eq!(extension_from_path(&*result.file).unwrap(), OsStr::new("jpg"));
-			// 2. ensure mime type detected is IMAGE_PNG
+			// 2. ensure detected mime type is IMAGE_PNG
 			assert_eq!(result.mime, IMAGE_PNG);
-			// 3. ensure recommended extension is in the list of known extensions for PNG files
+			// 3. ensure the recommended extension for "wrong.jpg" is "png"
-			assert!(mime_extension_lookup(IMAGE_PNG)
+			assert_eq!(&result.recommended_extension().unwrap(), &String::from("png"));
-				.unwrap()
-				.contains(&result.recommended_extension().unwrap()));
 			continue;
 		}
 
-		// check if the recommended extension for this file is in the list of known extensions for its mimetype
+		// check if the recommended extension for this file is in the list of known extensions for its mimetype - for
+		// example, if the file is determined to be an IMAGE_PNG, its recommended extension should be one of the extensions
+		// returned by `mime_extension_lookup(IMAGE_PNG)`.
 		assert!(mime_extension_lookup(result.mime.clone())
 			.unwrap()
 			.contains(&result.recommended_extension().unwrap()));
 
 		// make sure the guessed mimetype is correct based on the extension of the scanned file
+		// because we already know that the extensions match the mimetype (as we created these files ourselves earlier in
+		// the test), all files with the "jpg" extension should be IMAGE_JPEGs, etc.
 		let ext = extension_from_path(result.file);
 		assert!(ext.is_some());
 		assert_eq!(
@@ -161,7 +165,10 @@ fn simple_directory() {
 }
 
 #[test]
+/// Ensure that command line argument parsing works correctly - flags are interpreted, booleans are set, and so on.
 fn argument_parsing() {
+	use crate::parameters::{Parameters, ScanOpts};
+
 	use clap::Clap;
 
 	// pass `-f`, which enables following symlinks, and `-E images`, which scans files with image extensions
@@ -192,7 +199,10 @@ fn argument_parsing() {
 }
 
 #[test]
+/// Ensure that badly formed command line arguments are rejected.
 fn rejects_bad_args() {
+	use crate::parameters::Parameters;
+
 	use clap::Clap;
 	let tests = [
 		// Non-existent flags:
@@ -213,6 +223,8 @@ fn rejects_bad_args() {
 }
 
 #[test]
+/// Generate random series of bytes and try to identify them. This test makes no assertions and can only fail if the
+/// mime database somehow panics or hangs.
 fn identify_random_bytes() {
 	let db = get_mime_db();
 	let rng = fastrand::Rng::new();
@@ -233,7 +245,11 @@ fn identify_random_bytes() {
 }
 
 #[test]
+/// Ensure that, for a given file "wrong.bad", which should have extension "good", the shell output contains something
+/// like "mv wrong.bad wrong.good".
 fn outputs_move_commands() {
+	use std::io::Read;
+
 	// create an example finding stating that "misnamed_file.png" has been identified as a jpeg file
 	let entries = vec![Ok(Findings {
 		file: Path::new("misnamed_file.png"),
@@ -244,7 +260,7 @@ fn outputs_move_commands() {
 	let mut cursor = std::io::Cursor::new(Vec::new());
 	let mut contents = std::string::String::new();
 
-	Script::new()
+	Shell::new()
 		.write_all(&entries, &mut cursor)
 		.expect("Failed to write to cursor");
 	cursor.set_position(0);