migrate from failure to anyhow

Author: syphar

CHANGELOG.md

@@ -12,6 +12,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- **BREAKING** migrated generic error return types from `failure::Error` to `anyhow::Error`.
+- **BREAKING** `prepare::PrepareError` is now based on `thiserror::Error`, and not `failure::Fail` any more.
+- **BREAKING** `toolchain::ToolchainError` is now based on `thiserror::Error`, and not `failure::Fail` any more.
 - Update `attohttpc` dependency to 0.28
 - Update `base64` dependency to 0.22
 - Update `env_logger` dependency to 0.11

Cargo.toml

@@ -18,7 +18,7 @@ unstable-toolchain-ci = []
 
 [dependencies]
 http = "1.1.0"
-failure = "0.1.3"
+anyhow = { version = "1.0.68", features = ["backtrace"]}
 futures-util = "0.3.5"
 log = "0.4.6"
 tokio = { version = "1.0", features = ["process", "time", "io-util", "rt", "rt-multi-thread"] }

src/build.rs

@@ -1,7 +1,7 @@
 use crate::cmd::{Command, MountKind, Runnable, SandboxBuilder};
 use crate::prepare::Prepare;
 use crate::{Crate, Toolchain, Workspace};
-use failure::Error;
+use anyhow::Result;
 use std::path::PathBuf;
 use std::vec::Vec;
 
@@ -131,7 +131,7 @@ impl<'a> BuildBuilder<'a> {
     /// })?;
     /// # Ok(())
     /// # }
-    pub fn run<R, F: FnOnce(&Build) -> Result<R, Error>>(self, f: F) -> Result<R, Error> {
+    pub fn run<R, F: FnOnce(&Build) -> Result<R>>(self, f: F) -> Result<R> {
         self.build_dir
             .run(self.toolchain, self.krate, self.sandbox, self.patches, f)
     }
@@ -181,14 +181,14 @@ impl BuildDirectory {
         }
     }
 
-    pub(crate) fn run<R, F: FnOnce(&Build) -> Result<R, Error>>(
+    pub(crate) fn run<R, F: FnOnce(&Build) -> Result<R>>(
         &mut self,
         toolchain: &Toolchain,
         krate: &Crate,
         sandbox: SandboxBuilder,
         patches: Vec<CratePatch>,
         f: F,
-    ) -> Result<R, Error> {
+    ) -> Result<R> {
         let source_dir = self.source_dir();
         if source_dir.exists() {
             crate::utils::remove_dir_all(&source_dir)?;
@@ -209,7 +209,7 @@ impl BuildDirectory {
     }
 
     /// Remove all the contents of the build directory, freeing disk space.
-    pub fn purge(&mut self) -> Result<(), Error> {
+    pub fn purge(&mut self) -> Result<()> {
         let build_dir = self.build_dir();
         if build_dir.exists() {
             crate::utils::remove_dir_all(&build_dir)?;
@@ -322,7 +322,7 @@ impl<'ws> Build<'ws> {
     /// networking is disabled.
     #[cfg(any(feature = "unstable", doc))]
     #[cfg_attr(docs_rs, doc(cfg(feature = "unstable")))]
-    pub fn fetch_build_std_dependencies(&self, targets: &[&str]) -> Result<(), Error> {
+    pub fn fetch_build_std_dependencies(&self, targets: &[&str]) -> Result<()> {
         crate::prepare::fetch_deps(
             &self.dir.workspace,
             self.toolchain,

src/crates/git.rs

@@ -2,7 +2,7 @@ use super::CrateTrait;
 use crate::cmd::{Command, ProcessLinesActions};
 use crate::prepare::PrepareError;
 use crate::Workspace;
-use failure::{Error, ResultExt};
+use anyhow::{Context as _, Result};
 use log::{info, warn};
 use std::path::{Path, PathBuf};
 
@@ -63,7 +63,7 @@ impl GitRepo {
 }
 
 impl CrateTrait for GitRepo {
-    fn fetch(&self, workspace: &Workspace) -> Result<(), Error> {
+    fn fetch(&self, workspace: &Workspace) -> Result<()> {
         // The credential helper that suppresses the password prompt shows this message when a
         // repository requires authentication:
         //
@@ -86,7 +86,7 @@ impl CrateTrait for GitRepo {
                 .cd(&path)
                 .process_lines(&mut detect_private_repositories)
                 .run()
-                .with_context(|_| format!("failed to update {}", self.url))
+                .with_context(|| format!("failed to update {}", self.url))
         } else {
             info!("cloning repository {}", self.url);
             Command::new(workspace, "git")
@@ -95,7 +95,7 @@ impl CrateTrait for GitRepo {
                 .args(&[&path])
                 .process_lines(&mut detect_private_repositories)
                 .run()
-                .with_context(|_| format!("failed to clone {}", self.url))
+                .with_context(|| format!("failed to clone {}", self.url))
         };
 
         if private_repository && res.is_err() {
@@ -105,20 +105,20 @@ impl CrateTrait for GitRepo {
         }
     }
 
-    fn purge_from_cache(&self, workspace: &Workspace) -> Result<(), Error> {
+    fn purge_from_cache(&self, workspace: &Workspace) -> Result<()> {
         let path = self.cached_path(workspace);
         if path.exists() {
             crate::utils::remove_dir_all(&path)?;
         }
         Ok(())
     }
 
-    fn copy_source_to(&self, workspace: &Workspace, dest: &Path) -> Result<(), Error> {
+    fn copy_source_to(&self, workspace: &Workspace, dest: &Path) -> Result<()> {
         Command::new(workspace, "git")
             .args(&["clone"])
             .args(&[self.cached_path(workspace).as_path(), dest])
             .run()
-            .with_context(|_| format!("failed to checkout {}", self.url))?;
+            .with_context(|| format!("failed to checkout {}", self.url))?;
         Ok(())
     }
 }

src/crates/local.rs

@@ -1,6 +1,6 @@
 use super::CrateTrait;
 use crate::Workspace;
-use failure::Error;
+use anyhow::Result;
 use log::info;
 use std::path::{Path, PathBuf};
 use walkdir::WalkDir;
@@ -16,17 +16,17 @@ impl Local {
 }
 
 impl CrateTrait for Local {
-    fn fetch(&self, _workspace: &Workspace) -> Result<(), Error> {
+    fn fetch(&self, _workspace: &Workspace) -> Result<()> {
         // There is no fetch to do for a local crate.
         Ok(())
     }
 
-    fn purge_from_cache(&self, _workspace: &Workspace) -> Result<(), Error> {
+    fn purge_from_cache(&self, _workspace: &Workspace) -> Result<()> {
         // There is no cache to purge for a local crate.
         Ok(())
     }
 
-    fn copy_source_to(&self, _workspace: &Workspace, dest: &Path) -> Result<(), Error> {
+    fn copy_source_to(&self, _workspace: &Workspace, dest: &Path) -> Result<()> {
         info!(
             "copying local crate from {} to {}",
             self.path.display(),
@@ -43,7 +43,7 @@ impl std::fmt::Display for Local {
     }
 }
 
-fn copy_dir(src: &Path, dest: &Path) -> Result<(), Error> {
+fn copy_dir(src: &Path, dest: &Path) -> Result<()> {
     let src = crate::utils::normalize_path(src);
     let dest = crate::utils::normalize_path(dest);
 
@@ -75,10 +75,10 @@ fn copy_dir(src: &Path, dest: &Path) -> Result<(), Error> {
 
 #[cfg(test)]
 mod tests {
-    use failure::Error;
+    use anyhow::Result;
 
     #[test]
-    fn test_copy_dir() -> Result<(), Error> {
+    fn test_copy_dir() -> Result<()> {
         let tmp_src = tempfile::tempdir()?;
         let tmp_dest = tempfile::tempdir()?;
 
@@ -99,7 +99,7 @@ mod tests {
     }
 
     #[test]
-    fn test_no_copy_target() -> Result<(), Error> {
+    fn test_no_copy_target() -> Result<()> {
         let (src, dest) = (tempfile::tempdir()?, tempfile::tempdir()?);
         std::fs::create_dir(src.path().join("target"))?;
         std::fs::write(
@@ -116,7 +116,7 @@ mod tests {
     }
 
     #[test]
-    fn test_copy_symlinks() -> Result<(), Error> {
+    fn test_copy_symlinks() -> Result<()> {
         use std::{fs, os, path::Path};
 
         let tmp_src = tempfile::tempdir()?;

src/crates/mod.rs

@@ -3,16 +3,16 @@ mod local;
 mod registry;
 
 use crate::Workspace;
-use failure::Error;
+use anyhow::Result;
 use log::info;
 use std::path::Path;
 
 pub use registry::AlternativeRegistry;
 
 trait CrateTrait: std::fmt::Display {
-    fn fetch(&self, workspace: &Workspace) -> Result<(), Error>;
-    fn purge_from_cache(&self, workspace: &Workspace) -> Result<(), Error>;
-    fn copy_source_to(&self, workspace: &Workspace, dest: &Path) -> Result<(), Error>;
+    fn fetch(&self, workspace: &Workspace) -> Result<()>;
+    fn purge_from_cache(&self, workspace: &Workspace) -> Result<()>;
+    fn copy_source_to(&self, workspace: &Workspace, dest: &Path) -> Result<()>;
 }
 
 enum CrateType {
@@ -56,12 +56,12 @@ impl Crate {
 
     /// Fetch the crate's source code and cache it in the workspace. This method will reach out to
     /// the network for some crate types.
-    pub fn fetch(&self, workspace: &Workspace) -> Result<(), Error> {
+    pub fn fetch(&self, workspace: &Workspace) -> Result<()> {
         self.as_trait().fetch(workspace)
     }
 
     /// Remove the cached copy of this crate. The method will do nothing if the crate isn't cached.
-    pub fn purge_from_cache(&self, workspace: &Workspace) -> Result<(), Error> {
+    pub fn purge_from_cache(&self, workspace: &Workspace) -> Result<()> {
         self.as_trait().purge_from_cache(workspace)
     }
 
@@ -75,7 +75,7 @@ impl Crate {
         }
     }
 
-    pub(crate) fn copy_source_to(&self, workspace: &Workspace, dest: &Path) -> Result<(), Error> {
+    pub(crate) fn copy_source_to(&self, workspace: &Workspace, dest: &Path) -> Result<()> {
         if dest.exists() {
             info!(
                 "crate source directory {} already exists, cleaning it up",

src/crates/registry.rs

@@ -1,6 +1,6 @@
 use super::CrateTrait;
 use crate::Workspace;
-use failure::{Error, ResultExt};
+use anyhow::{Context as _, Result};
 use flate2::read::GzDecoder;
 use log::info;
 use std::fs::File;
@@ -88,7 +88,7 @@ impl RegistryCrate {
             .join(format!("{}-{}.crate", self.name, self.version))
     }
 
-    fn fetch_url(&self, workspace: &Workspace) -> Result<String, Error> {
+    fn fetch_url(&self, workspace: &Workspace) -> Result<String> {
         match &self.registry {
             Registry::CratesIo => Ok(format!(
                 "{0}/{1}/{1}-{2}.crate",
@@ -122,7 +122,7 @@ impl RegistryCrate {
                     git2::build::RepoBuilder::new()
                         .fetch_options(fo)
                         .clone(url, &index_path)
-                        .with_context(|_| format!("unable to update_index at {}", url))?;
+                        .with_context(|| format!("unable to update_index at {}", url))?;
                     info!("cloned registry index");
                 }
                 let config = std::fs::read_to_string(index_path.join("config.json"))?;
@@ -151,7 +151,7 @@ impl RegistryCrate {
 }
 
 impl CrateTrait for RegistryCrate {
-    fn fetch(&self, workspace: &Workspace) -> Result<(), Error> {
+    fn fetch(&self, workspace: &Workspace) -> Result<()> {
         let local = self.cache_path(workspace);
         if local.exists() {
             info!("crate {} {} is already in cache", self.name, self.version);
@@ -173,15 +173,15 @@ impl CrateTrait for RegistryCrate {
         Ok(())
     }
 
-    fn purge_from_cache(&self, workspace: &Workspace) -> Result<(), Error> {
+    fn purge_from_cache(&self, workspace: &Workspace) -> Result<()> {
         let path = self.cache_path(workspace);
         if path.exists() {
             crate::utils::remove_file(&path)?;
         }
         Ok(())
     }
 
-    fn copy_source_to(&self, workspace: &Workspace, dest: &Path) -> Result<(), Error> {
+    fn copy_source_to(&self, workspace: &Workspace, dest: &Path) -> Result<()> {
         let cached = self.cache_path(workspace);
         let mut file = File::open(cached)?;
         let mut tar = Archive::new(GzDecoder::new(BufReader::new(&mut file)));
@@ -194,12 +194,10 @@ impl CrateTrait for RegistryCrate {
         );
         if let Err(err) = unpack_without_first_dir(&mut tar, dest) {
             let _ = crate::utils::remove_dir_all(dest);
-            Err(err
-                .context(format!(
-                    "unable to download {} version {}",
-                    self.name, self.version
-                ))
-                .into())
+            Err(err.context(format!(
+                "unable to download {} version {}",
+                self.name, self.version
+            )))
         } else {
             Ok(())
         }
@@ -218,7 +216,7 @@ impl std::fmt::Display for RegistryCrate {
     }
 }
 
-fn unpack_without_first_dir<R: Read>(archive: &mut Archive<R>, path: &Path) -> Result<(), Error> {
+fn unpack_without_first_dir<R: Read>(archive: &mut Archive<R>, path: &Path) -> Result<()> {
     let entries = archive.entries()?;
     for entry in entries {
         let mut entry = entry?;

src/inside_docker.rs

@@ -1,7 +1,7 @@
 use crate::cmd::Command;
 use crate::workspace::Workspace;
+use anyhow::Result;
 use base64::{engine::general_purpose::STANDARD as b64, Engine};
-use failure::Error;
 use getrandom::getrandom;
 use log::info;
 
@@ -12,7 +12,7 @@ pub(crate) struct CurrentContainer {
 }
 
 impl CurrentContainer {
-    pub(crate) fn detect(workspace: &Workspace) -> Result<Option<Self>, Error> {
+    pub(crate) fn detect(workspace: &Workspace) -> Result<Option<Self>> {
         if let Some(id) = probe_container_id(workspace)? {
             info!("inspecting the current container");
             let inspect = Command::new(workspace, "docker")
@@ -23,7 +23,7 @@ impl CurrentContainer {
             let content = inspect.stdout_lines().join("\n");
             let mut metadata: Vec<Metadata> = serde_json::from_str(&content)?;
             if metadata.len() != 1 {
-                failure::bail!("invalid output returned by `docker inspect`");
+                anyhow::bail!("invalid output returned by `docker inspect`");
             }
             Ok(Some(CurrentContainer {
                 metadata: metadata.pop().unwrap(),
@@ -45,7 +45,7 @@ impl CurrentContainer {
 /// This function uses a simpler but slower method to get the ID: a file with a random string is
 /// created in the temp directory, the list of all the containers is fetched from Docker and then
 /// `cat` is executed inside each of them to check whether they have the same random string.
-pub(crate) fn probe_container_id(workspace: &Workspace) -> Result<Option<String>, Error> {
+pub(crate) fn probe_container_id(workspace: &Workspace) -> Result<Option<String>> {
     info!("detecting the ID of the container where rustwide is running");
 
     // Create the probe on the current file system

src/native/unix.rs

@@ -1,6 +1,6 @@
 use super::CurrentUser;
 use crate::cmd::KillFailedError;
-use failure::Error;
+use anyhow::Result;
 use nix::{
     sys::signal::{kill, Signal},
     unistd::{Gid, Pid, Uid},
@@ -29,7 +29,7 @@ pub(crate) fn current_user() -> Option<CurrentUser> {
     })
 }
 
-fn executable_mode_for(path: &Path) -> Result<u32, Error> {
+fn executable_mode_for(path: &Path) -> Result<u32> {
     let metadata = path.metadata()?;
 
     let user = current_user().unwrap();
@@ -43,14 +43,14 @@ fn executable_mode_for(path: &Path) -> Result<u32, Error> {
     }
 }
 
-pub(crate) fn is_executable<P: AsRef<Path>>(path: P) -> Result<bool, Error> {
+pub(crate) fn is_executable<P: AsRef<Path>>(path: P) -> Result<bool> {
     let path = path.as_ref();
 
     let expected_mode = executable_mode_for(path)?;
     Ok(path.metadata()?.mode() & expected_mode == expected_mode)
 }
 
-pub(crate) fn make_executable<P: AsRef<Path>>(path: P) -> Result<(), Error> {
+pub(crate) fn make_executable<P: AsRef<Path>>(path: P) -> Result<()> {
     let path = path.as_ref();
 
     // Set the executable and readable bits on the file