refactor: split up FoundationError into method-specific error types

src/dfx-core/src/config/directories.rs

@@ -3,15 +3,15 @@ use crate::error::config::ConfigError::{
     DetermineConfigDirectoryFailed, DetermineSharedNetworkDirectoryFailed,
     EnsureConfigDirectoryExistsFailed,
 };
-use crate::error::foundation::FoundationError;
-use crate::error::foundation::FoundationError::NoHomeInEnvironment;
+use crate::error::get_user_home::GetUserHomeError;
+use crate::error::get_user_home::GetUserHomeError::NoHomeInEnvironment;
 #[cfg(not(windows))]
 use crate::foundation::get_user_home;
 use crate::fs::composite::ensure_dir_exists;
 use directories_next::ProjectDirs;
 use std::path::PathBuf;
 
-pub fn project_dirs() -> Result<&'static ProjectDirs, FoundationError> {
+pub fn project_dirs() -> Result<&'static ProjectDirs, GetUserHomeError> {
     lazy_static::lazy_static! {
         static ref DIRS: Option<ProjectDirs> = ProjectDirs::from("org", "dfinity", "dfx");
     }

src/dfx-core/src/error/cache.rs

@@ -2,12 +2,17 @@ use super::{
     archive::ArchiveError, fs::FsError, structured_file::StructuredFileError,
     unified_io::UnifiedIoError,
 };
+use crate::error::get_current_exe::GetCurrentExeError;
+use crate::error::get_user_home::GetUserHomeError;
 use thiserror::Error;
 
 #[derive(Error, Debug)]
 pub enum CacheError {
     #[error(transparent)]
-    FoundationError(#[from] crate::error::foundation::FoundationError),
+    GetCurrentExeError(#[from] GetCurrentExeError),
+
+    #[error(transparent)]
+    GetUserHomeError(#[from] GetUserHomeError),
 
     #[error(transparent)]
     UnifiedIo(#[from] crate::error::unified_io::UnifiedIoError),

src/dfx-core/src/error/config.rs

@@ -1,5 +1,5 @@
-use crate::error::foundation::FoundationError;
 use crate::error::fs::FsError;
+use crate::error::get_user_home::GetUserHomeError;
 use thiserror::Error;
 
 #[derive(Error, Debug)]
@@ -8,8 +8,8 @@ pub enum ConfigError {
     EnsureConfigDirectoryExistsFailed(FsError),
 
     #[error("Failed to determine config directory path: {0}")]
-    DetermineConfigDirectoryFailed(FoundationError),
+    DetermineConfigDirectoryFailed(GetUserHomeError),
 
     #[error("Failed to determine shared network data directory: {0}")]
-    DetermineSharedNetworkDirectoryFailed(FoundationError),
+    DetermineSharedNetworkDirectoryFailed(GetUserHomeError),
 }

src/dfx-core/src/error/foundation.rs → src/dfx-core/src/error/get_current_exe.rs

@@ -1,10 +1,7 @@
 use thiserror::Error;
 
 #[derive(Error, Debug)]
-pub enum FoundationError {
-    #[error("Cannot find home directory (no HOME environment variable).")]
-    NoHomeInEnvironment(),
-
+pub enum GetCurrentExeError {
     #[error("Failed to identify currently running executable: {0}")]
     NoCurrentExe(std::io::Error),
 }

src/dfx-core/src/error/get_user_home.rs

@@ -0,0 +1,7 @@
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum GetUserHomeError {
+    #[error("Cannot find home directory (no HOME environment variable).")]
+    NoHomeInEnvironment(),
+}

src/dfx-core/src/error/identity/get_legacy_credentials_pem_path.rs

@@ -1,8 +1,8 @@
-use crate::error::foundation::FoundationError;
+use crate::error::get_user_home::GetUserHomeError;
 use thiserror::Error;
 
 #[derive(Error, Debug)]
 pub enum GetLegacyCredentialsPemPathError {
     #[error("Failed to get legacy pem path: {0}")]
-    GetLegacyPemPathFailed(FoundationError),
+    GetLegacyPemPathFailed(GetUserHomeError),
 }

src/dfx-core/src/error/mod.rs

@@ -7,8 +7,9 @@ pub mod config;
 pub mod dfx_config;
 pub mod encryption;
 pub mod extension;
-pub mod foundation;
 pub mod fs;
+pub mod get_current_exe;
+pub mod get_user_home;
 pub mod identity;
 pub mod keyring;
 pub mod load_dfx_config;

src/dfx-core/src/foundation/mod.rs

@@ -1,12 +1,14 @@
-use crate::error::foundation::FoundationError;
-use crate::error::foundation::FoundationError::NoHomeInEnvironment;
+use crate::error::get_current_exe::GetCurrentExeError;
+use crate::error::get_current_exe::GetCurrentExeError::NoCurrentExe;
+use crate::error::get_user_home::GetUserHomeError;
+use crate::error::get_user_home::GetUserHomeError::NoHomeInEnvironment;
 use std::ffi::OsString;
 use std::path::PathBuf;
 
-pub fn get_user_home() -> Result<OsString, FoundationError> {
+pub fn get_user_home() -> Result<OsString, GetUserHomeError> {
     std::env::var_os("HOME").ok_or(NoHomeInEnvironment())
 }
 
-pub fn get_current_exe() -> Result<PathBuf, FoundationError> {
-    std::env::current_exe().map_err(FoundationError::NoCurrentExe)
+pub fn get_current_exe() -> Result<PathBuf, GetCurrentExeError> {
+    std::env::current_exe().map_err(NoCurrentExe)
 }