Merge pull request #477 from ethcore/temp-path

dev/test/build tools to separate crate

util/Cargo.toml

@@ -30,6 +30,7 @@ clippy = { version = "0.0.42", optional = true }
 json-tests = { path = "json-tests" }
 target_info = "0.1.0"
 igd = "0.4.2"
+ethcore-devtools = { path = "../devtools" }
 libc = "0.2.7"
 
 [features]

util/src/keys/directory.rs

@@ -1030,7 +1030,7 @@ mod file_tests {
 mod directory_tests {
 	use super::{KeyDirectory, new_uuid, uuid_to_string, KeyFileContent, KeyFileCrypto, MAX_CACHE_USAGE_TRACK};
 	use common::*;
-	use tests::helpers::*;
+	use devtools::*;
 
 	#[test]
 	fn key_directory_locates_keys() {
@@ -1110,7 +1110,7 @@ mod directory_tests {
 mod specs {
 	use super::*;
 	use common::*;
-	use tests::helpers::*;
+	use devtools::*;
 
 	#[test]
 	fn can_initiate_key_directory() {

util/src/keys/store.rs

@@ -70,7 +70,7 @@ impl SecretStore {
 	}
 
 	#[cfg(test)]
-	fn new_test(path: &::tests::helpers::RandomTempPath) -> SecretStore {
+	fn new_test(path: &::devtools::RandomTempPath) -> SecretStore {
 		SecretStore {
 			directory: KeyDirectory::new(path.as_path())
 		}
@@ -203,7 +203,7 @@ mod vector_tests {
 #[cfg(test)]
 mod tests {
 	use super::*;
-	use tests::helpers::*;
+	use devtools::*;
 	use common::*;
 
 	#[test]

util/src/lib.rs

@@ -106,6 +106,7 @@ extern crate serde;
 #[macro_use]
 extern crate log as rlog;
 extern crate igd;
+extern crate ethcore_devtools as devtools;
 extern crate libc;
 
 pub mod standard;
@@ -161,5 +162,3 @@ pub use network::*;
 pub use io::*;
 pub use log::*;
 
-#[cfg(test)]
-mod tests;

util/src/network/host.rs

@@ -174,8 +174,8 @@ pub struct NetworkContext<'s, Message> where Message: Send + Sync + Clone + 'sta
 
 impl<'s, Message> NetworkContext<'s, Message> where Message: Send + Sync + Clone + 'static, {
 	/// Create a new network IO access point. Takes references to all the data that can be updated within the IO handler.
-	fn new(io: &'s IoContext<NetworkIoMessage<Message>>, 
-		protocol: ProtocolId, 
+	fn new(io: &'s IoContext<NetworkIoMessage<Message>>,
+		protocol: ProtocolId,
 		session: Option<StreamToken>, sessions: Arc<RwLock<Slab<SharedSession>>>) -> NetworkContext<'s, Message> {
 		NetworkContext {
 			io: io,
@@ -337,9 +337,9 @@ impl<Message> Host<Message> where Message: Send + Sync + Clone {
 
 		// Setup the server socket
 		let tcp_listener = TcpListener::bind(&listen_address).unwrap();
-		let keys = if let Some(ref secret) = config.use_secret { 
-			KeyPair::from_secret(secret.clone()).unwrap() 
-		} else { 
+		let keys = if let Some(ref secret) = config.use_secret {
+			KeyPair::from_secret(secret.clone()).unwrap()
+		} else {
 			config.config_path.clone().and_then(|ref p| load_key(&Path::new(&p)))
 				.map_or_else(|| {
 				let key = KeyPair::create().unwrap();
@@ -351,7 +351,7 @@ impl<Message> Host<Message> where Message: Send + Sync + Clone {
 			|s| KeyPair::from_secret(s).expect("Error creating node secret key"))
 		};
 		let discovery = if config.discovery_enabled && !config.pin {
-			Some(Discovery::new(&keys, listen_address.clone(), public_endpoint.clone(), DISCOVERY)) 
+			Some(Discovery::new(&keys, listen_address.clone(), public_endpoint.clone(), DISCOVERY))
 		} else { None };
 		let path = config.config_path.clone();
 		let mut host = Host::<Message> {
@@ -546,7 +546,7 @@ impl<Message> Host<Message> where Message: Send + Sync + Clone {
 			if let Err(e) = h.writable(io, &self.info.read().unwrap()) {
 				debug!(target: "net", "Handshake write error: {}:{:?}", token, e);
 			}
-		} 
+		}
 	}
 
 	fn session_writable(&self, token: StreamToken, io: &IoContext<NetworkIoMessage<Message>>) {
@@ -557,7 +557,7 @@ impl<Message> Host<Message> where Message: Send + Sync + Clone {
 				debug!(target: "net", "Session write error: {}:{:?}", token, e);
 			}
 			io.update_registration(token).unwrap_or_else(|e| debug!(target: "net", "Session registration error: {:?}", e));
-		} 
+		}
 	}
 
 	fn connection_closed(&self, token: TimerToken, io: &IoContext<NetworkIoMessage<Message>>) {
@@ -619,7 +619,7 @@ impl<Message> Host<Message> where Message: Send + Sync + Clone {
 				},
 				Ok(SessionData::None) => {},
 			}
-		} 
+		}
 		if kill {
 			self.kill_connection(token, io, true); //TODO: mark connection as dead an check in kill_connection
 		}
@@ -639,7 +639,7 @@ impl<Message> Host<Message> where Message: Send + Sync + Clone {
 		if handshakes.get(token).is_none() {
 			return;
 		}
-		
+
 		// turn a handshake into a session
 		let mut sessions = self.sessions.write().unwrap();
 		let mut h = handshakes.remove(token).unwrap();
@@ -782,7 +782,7 @@ impl<Message> IoHandler<NetworkIoMessage<Message>> for Host<Message> where Messa
 				}
 				io.update_registration(DISCOVERY).expect("Error updating discovery registration");
 			},
-			TCP_ACCEPT => self.accept(io), 
+			TCP_ACCEPT => self.accept(io),
 			_ => panic!("Received unknown readable token"),
 		}
 	}
@@ -858,7 +858,7 @@ impl<Message> IoHandler<NetworkIoMessage<Message>> for Host<Message> where Messa
 				let session = { self.sessions.read().unwrap().get(*peer).cloned() };
 				if let Some(session) = session {
 					session.lock().unwrap().disconnect(DisconnectReason::DisconnectRequested);
-				} 
+				}
 				self.kill_connection(*peer, io, false);
 			},
 			NetworkIoMessage::User(ref message) => {
@@ -961,14 +961,14 @@ fn load_key(path: &Path) -> Option<Secret> {
 	let mut buf = String::new();
 	match file.read_to_string(&mut buf) {
 		Ok(_) => {},
-		Err(e) => { 
+		Err(e) => {
 			warn!("Error reading key file: {:?}", e);
 			return None;
 		}
 	}
 	match Secret::from_str(&buf) {
 		Ok(key) => Some(key),
-		Err(e) => { 
+		Err(e) => {
 			warn!("Error parsing key file: {:?}", e);
 			None
 		}
@@ -977,7 +977,7 @@ fn load_key(path: &Path) -> Option<Secret> {
 
 #[test]
 fn key_save_load() {
-	use tests::helpers::RandomTempPath;
+	use ::devtools::RandomTempPath;
 	let temp_path = RandomTempPath::create_dir();
 	let key = H256::random();
 	save_key(temp_path.as_path(), &key);

util/src/network/node_table.rs

@@ -159,7 +159,7 @@ impl Display for Node {
 		Ok(())
 	}
 }
-	
+
 impl FromStr for Node {
 	type Err = UtilError;
 	fn from_str(s: &str) -> Result<Self, Self::Err> {
@@ -265,7 +265,7 @@ impl NodeTable {
 			let node_ids = self.nodes();
 			for i in 0 .. node_ids.len() {
 				let node = self.nodes.get(&node_ids[i]).unwrap();
-				json.push_str(&format!("\t{{ \"url\": \"{}\", \"failures\": {} }}{}\n", node, node.failures, if i == node_ids.len() - 1 {""} else {","})) 
+				json.push_str(&format!("\t{{ \"url\": \"{}\", \"failures\": {} }}{}\n", node, node.failures, if i == node_ids.len() - 1 {""} else {","}))
 			}
 			json.push_str("]\n");
 			json.push_str("}");
@@ -297,14 +297,14 @@ impl NodeTable {
 			let mut buf = String::new();
 			match file.read_to_string(&mut buf) {
 				Ok(_) => {},
-				Err(e) => { 
+				Err(e) => {
 					warn!("Error reading node table file: {:?}", e);
 					return nodes;
 				}
 			}
 			let json = match Json::from_str(&buf) {
 				Ok(json) => json,
-				Err(e) => { 
+				Err(e) => {
 					warn!("Error parsing node table file: {:?}", e);
 					return nodes;
 				}
@@ -344,7 +344,7 @@ mod tests {
 	use std::str::FromStr;
 	use std::net::*;
 	use hash::*;
-	use tests::helpers::*;
+	use devtools::*;
 
 	#[test]
 	fn endpoint_parse() {

util/src/tests/helpers.rs

@@ -1,31 +0,0 @@
-use common::*;
-use std::path::PathBuf;
-use std::fs::{remove_dir_all};
-use std::env;
-
-pub struct RandomTempPath {
-	path: PathBuf
-}
-
-impl RandomTempPath {
-	pub fn create_dir() -> RandomTempPath {
-		let mut dir = env::temp_dir();
-		dir.push(H32::random().hex());
-		fs::create_dir_all(dir.as_path()).unwrap();
-		RandomTempPath {
-			path: dir.clone()
-		}
-	}
-
-	pub fn as_path(&self) -> &PathBuf {
-		&self.path
-	}
-}
-
-impl Drop for RandomTempPath {
-	fn drop(&mut self) {
-		if let Err(e) = remove_dir_all(self.as_path()) {
-			panic!("failed to remove temp directory, probably something failed to destroyed ({})", e);
-		}
-	}
-}

util/src/tests/mod.rs

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