improve error on remove directory failiure

this should fix issue #43

Author: Skgland

src/build.rs

@@ -146,7 +146,7 @@ impl BuildDirectory {
     ) -> Result<R, Error> {
         let source_dir = self.source_dir();
         if source_dir.exists() {
-            remove_dir_all(&source_dir)?;
+            remove_dir_all(&source_dir).map_err(|error|crate::utils::improve_remove_dir_error(error, &source_dir))?;
         }
 
         let mut prepare = Prepare::new(&self.workspace, toolchain, krate, &source_dir, patches);
@@ -159,15 +159,15 @@ impl BuildDirectory {
             sandbox,
         })?;
 
-        remove_dir_all(&source_dir)?;
+        remove_dir_all(&source_dir).map_err(|error|crate::utils::improve_remove_dir_error(error, &source_dir))?;
         Ok(res)
     }
 
     /// Remove all the contents of the build directory, freeing disk space.
     pub fn purge(&mut self) -> Result<(), Error> {
         let build_dir = self.build_dir();
         if build_dir.exists() {
-            remove_dir_all(build_dir)?;
+            remove_dir_all(&build_dir).map_err(|error|crate::utils::improve_remove_dir_error(error, &build_dir))?;
         }
         Ok(())
     }

src/crates/git.rs

@@ -121,7 +121,7 @@ impl CrateTrait for GitRepo {
     fn purge_from_cache(&self, workspace: &Workspace) -> Result<(), Error> {
         let path = self.cached_path(workspace);
         if path.exists() {
-            remove_dir_all::remove_dir_all(&path)?;
+            remove_dir_all::remove_dir_all(&path).map_err(|error|crate::utils::improve_remove_dir_error(error, &path))?;
         }
         Ok(())
     }

src/crates/mod.rs

@@ -69,7 +69,7 @@ impl Crate {
                 "crate source directory {} already exists, cleaning it up",
                 dest.display()
             );
-            remove_dir_all(dest)?;
+            remove_dir_all(dest).map_err(|error|crate::utils::improve_remove_dir_error(error, dest))?;
         }
         self.as_trait().copy_source_to(workspace, dest)
     }

src/utils.rs

@@ -50,6 +50,38 @@ fn strip_verbatim_from_prefix(prefix: &PrefixComponent<'_>) -> Option<PathBuf> {
     Some(ret)
 }
 
+#[derive(Debug)]
+struct DirRemoveError {
+    kind: std::io::ErrorKind,
+    path: String,
+}
+
+impl std::error::Error for DirRemoveError {}
+
+impl std::fmt::Display for DirRemoveError {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.write_fmt(format_args!("failed to remove directory '{}' : {:?}",self.path, self.kind))
+    }
+}
+
+pub(crate) fn improve_remove_dir_error(error: std::io::Error, path: &Path) -> std::io::Error {
+    std::io::Error::new(error.kind(), DirRemoveError{kind: error.kind(),path: path.display().to_string()})
+}
+
+#[test]
+fn custom_remove_dir_error() {
+
+    let path = "test/path".as_ref();
+
+    let expected = "failed to remove directory 'test/path' : PermissionDenied";
+    let tested = format!("{}", improve_remove_dir_error(std::io::Error::from(std::io::ErrorKind::PermissionDenied), path));
+    assert_eq!(expected, tested);
+
+    let expected = "Custom { kind: PermissionDenied, error: DirRemoveError { kind: PermissionDenied, path: \"test/path\" } }";
+    let tested = format!("{:?}",improve_remove_dir_error(std::io::Error::from(std::io::ErrorKind::PermissionDenied), path));
+    assert_eq!(expected, tested);
+}
+
 pub(crate) fn normalize_path(path: &Path) -> PathBuf {
     let mut p = std::fs::canonicalize(path).unwrap_or_else(|_| path.to_path_buf());
 

src/workspace.rs

@@ -213,7 +213,7 @@ impl Workspace {
     pub fn purge_all_build_dirs(&self) -> Result<(), Error> {
         let dir = self.builds_dir();
         if dir.exists() {
-            remove_dir_all(&dir)?;
+            remove_dir_all(&dir).map_err(|error|crate::utils::improve_remove_dir_error(error, &dir))?;
         }
         Ok(())
     }
@@ -236,7 +236,7 @@ impl Workspace {
 
         for path in &paths {
             if path.exists() {
-                remove_dir_all(&path)?;
+                remove_dir_all(&path).map_err(|error|crate::utils::improve_remove_dir_error(error, &path))?;
             }
         }