Create TestContext

Author: ErikDeSmedt

Cargo.lock

@@ -4,4 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+bitcoin.workspace = true
+log.workspace = true
+rand.workspace = true
 tokio.workspace = true

ark-testing/Cargo.toml

@@ -0,0 +1,3 @@
+pub mod env {
+	pub const TEST_LEAVE_INTACT : &str = "TEST_LEAVE_INTACT";
+}

ark-testing/src/constants.rs

@@ -0,0 +1,62 @@
+use std::path::PathBuf;
+use std::fs;
+
+use crate::util::random_string;
+use crate::constants;
+
+pub struct TestContext {
+	#[allow(dead_code)]
+	name: String,
+	datadir: PathBuf
+}
+
+impl TestContext {
+
+	pub fn new(name: String, base_path: PathBuf) -> Self {
+		fs::create_dir_all(base_path.clone()).unwrap();
+		TestContext { name, datadir: base_path}
+	}
+
+	pub fn generate() -> Self {
+		let name = random_string();
+		let datadir = ["/tmp/ark-testing/", &name].iter().collect();
+		Self::new(name, datadir)
+	}
+}
+
+impl Drop for TestContext {
+	fn drop(&mut self) {
+		// Remove the data-directory
+		// If the user has set `LEAVE_INTACT` we don't delete any
+		// test-data.
+
+		if std::env::var(constants::env::TEST_LEAVE_INTACT).is_ok() {
+			return
+		}
+		if self.datadir.exists() {
+			log::info!("Test clean-up");
+			std::fs::remove_dir_all(self.datadir.clone()).unwrap();
+		}
+	}
+}
+
+#[cfg(test)]
+mod test {
+	use super::*;
+
+	#[test]
+	fn context_creates_and_deletes_datadir() {
+			let context = TestContext::generate();
+			let base_path = context.datadir.clone();
+
+			// The base-path is created
+			assert!(context.datadir.exists());
+			drop(context);
+
+			// The test cleans up after itself
+			match std::env::var(constants::env::TEST_LEAVE_INTACT) {
+				Ok(_) => assert!(base_path.exists()),
+				Err(_) => assert!(!base_path.exists())
+			}
+	}
+}

ark-testing/src/context.rs

@@ -1,7 +1,5 @@
-#[cfg(test)]
-mod tests {
-	#[test]
-	fn add_two() {
-		assert_eq!(1+1, 2);
-	}
-}
+mod context;
+mod constants;
+mod util;
+
+pub use context::TestContext;

ark-testing/src/lib.rs

@@ -0,0 +1,9 @@
+use rand::RngCore;
+
+pub fn random_string() -> String {
+	// Generate a few random bytes and base58 encode them
+	// The entropy should be sufficient to generate unique test-names
+	let mut entropy :[u8; 8] = [0; 8];
+	rand::thread_rng().fill_bytes(&mut entropy);
+	bitcoin::base58::encode(&entropy)
+}