refacror: RequireIdentityExistsError

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

@@ -1,7 +1,7 @@
 use crate::error::identity::get_identity_config_or_default::GetIdentityConfigOrDefaultError;
 use crate::error::identity::load_pem::LoadPemError;
+use crate::error::identity::require_identity_exists::RequireIdentityExistsError;
 use crate::error::identity::validate_pem_file::ValidatePemFileError;
-use crate::error::identity::IdentityError;
 use std::string::FromUtf8Error;
 use thiserror::Error;
 
@@ -11,7 +11,7 @@ pub enum ExportIdentityError {
     GetIdentityConfigFailed(GetIdentityConfigOrDefaultError),
 
     #[error("The specified identity does not exist: {0}")]
-    IdentityDoesNotExist(IdentityError),
+    IdentityDoesNotExist(RequireIdentityExistsError),
 
     #[error("Failed to load pem file: {0}")]
     LoadPemFailed(LoadPemError),

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

@@ -1,5 +1,5 @@
 use crate::error::identity::load_identity::LoadIdentityError;
-use crate::error::identity::IdentityError;
+use crate::error::identity::require_identity_exists::RequireIdentityExistsError;
 use thiserror::Error;
 
 #[derive(Error, Debug)]
@@ -11,5 +11,5 @@ pub enum InstantiateIdentityFromNameError {
     LoadIdentityFailed(LoadIdentityError),
 
     #[error("Identity must exist: {0}")]
-    RequireIdentityExistsFailed(IdentityError),
+    RequireIdentityExistsFailed(RequireIdentityExistsError),
 }

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

@@ -19,21 +19,10 @@ pub mod new_identity_manager;
 pub mod remove_identity;
 pub mod rename_identity;
 pub mod rename_wallet_global_config_key;
+pub mod require_identity_exists;
 pub mod save_identity_configuration;
 pub mod save_pem;
 pub mod use_identity_by_name;
 pub mod validate_pem_file;
 pub mod write_default_identity;
 pub mod write_pem_to_file;
-
-use std::path::PathBuf;
-use thiserror::Error;
-
-#[derive(Error, Debug)]
-pub enum IdentityError {
-    #[error("Identity {0} does not exist at '{1}'.")]
-    IdentityDoesNotExist(String, PathBuf),
-
-    #[error("An Identity named {0} cannot be created as it is reserved for internal use.")]
-    ReservedIdentityName(String),
-}

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

@@ -1,6 +1,6 @@
 use crate::error::config::ConfigError;
 use crate::error::identity::initialize_identity_manager::InitializeIdentityManagerError;
-use crate::error::identity::IdentityError;
+use crate::error::identity::require_identity_exists::RequireIdentityExistsError;
 use crate::error::structured_file::StructuredFileError;
 use thiserror::Error;
 
@@ -16,5 +16,5 @@ pub enum NewIdentityManagerError {
     InitializeFailed(InitializeIdentityManagerError),
 
     #[error("The specified identity must exist: {0}")]
-    OverrideIdentityMustExist(IdentityError),
+    OverrideIdentityMustExist(RequireIdentityExistsError),
 }

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

@@ -1,5 +1,5 @@
 use crate::error::fs::FsError;
-use crate::error::identity::IdentityError;
+use crate::error::identity::require_identity_exists::RequireIdentityExistsError;
 use crate::error::keyring::KeyringError;
 use crate::error::wallet_config::WalletConfigError;
 use thiserror::Error;
@@ -28,5 +28,5 @@ pub enum RemoveIdentityError {
     RemoveIdentityFromKeyringFailed(KeyringError),
 
     #[error("Identity must exist: {0}")]
-    RequireIdentityExistsFailed(IdentityError),
+    RequireIdentityExistsFailed(RequireIdentityExistsError),
 }

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

@@ -2,10 +2,10 @@ use crate::error::fs::FsError;
 use crate::error::identity::get_identity_config_or_default::GetIdentityConfigOrDefaultError;
 use crate::error::identity::load_pem::LoadPemError;
 use crate::error::identity::map_wallets_to_renamed_identity::MapWalletsToRenamedIdentityError;
+use crate::error::identity::require_identity_exists::RequireIdentityExistsError;
 use crate::error::identity::save_identity_configuration::SaveIdentityConfigurationError;
 use crate::error::identity::save_pem::SavePemError;
 use crate::error::identity::write_default_identity::WriteDefaultIdentityError;
-use crate::error::identity::IdentityError;
 use crate::error::keyring::KeyringError;
 use thiserror::Error;
 
@@ -21,7 +21,7 @@ pub enum RenameIdentityError {
     IdentityAlreadyExists(),
 
     #[error("Identity does not exist: {0}")]
-    IdentityDoesNotExist(IdentityError),
+    IdentityDoesNotExist(RequireIdentityExistsError),
 
     #[error("Failed to load pem: {0}")]
     LoadPemFailed(LoadPemError),

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

@@ -0,0 +1,11 @@
+use std::path::PathBuf;
+use thiserror::Error;
+
+#[derive(Error, Debug)]
+pub enum RequireIdentityExistsError {
+    #[error("Identity {0} does not exist at '{1}'.")]
+    IdentityDoesNotExist(String, PathBuf),
+
+    #[error("An Identity named {0} cannot be created as it is reserved for internal use.")]
+    ReservedIdentityName(String),
+}

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

@@ -1,11 +1,11 @@
+use crate::error::identity::require_identity_exists::RequireIdentityExistsError;
 use crate::error::identity::write_default_identity::WriteDefaultIdentityError;
-use crate::error::identity::IdentityError;
 use thiserror::Error;
 
 #[derive(Error, Debug)]
 pub enum UseIdentityByNameError {
     #[error("Identity must exist: {0}")]
-    RequireIdentityExistsFailed(IdentityError),
+    RequireIdentityExistsFailed(RequireIdentityExistsError),
 
     #[error("Failed to write default identity: {0}")]
     WriteDefaultIdentityFailed(WriteDefaultIdentityError),

src/dfx-core/src/identity/identity_manager.rs

@@ -45,13 +45,13 @@ use crate::error::identity::rename_identity::RenameIdentityError::{
     GetIdentityConfigFailed, LoadPemFailed, MapWalletsToRenamedIdentityFailed,
     RenameIdentityDirectoryFailed, SavePemFailed, SwitchDefaultIdentitySettingsFailed,
 };
+use crate::error::identity::require_identity_exists::RequireIdentityExistsError;
 use crate::error::identity::save_identity_configuration::SaveIdentityConfigurationError;
 use crate::error::identity::save_identity_configuration::SaveIdentityConfigurationError::EnsureIdentityConfigurationDirExistsFailed;
 use crate::error::identity::use_identity_by_name::UseIdentityByNameError;
 use crate::error::identity::use_identity_by_name::UseIdentityByNameError::WriteDefaultIdentityFailed;
 use crate::error::identity::write_default_identity::WriteDefaultIdentityError;
 use crate::error::identity::write_default_identity::WriteDefaultIdentityError::SaveIdentityManagerConfigurationFailed;
-use crate::error::identity::IdentityError;
 use crate::error::structured_file::StructuredFileError;
 use crate::foundation::get_user_home;
 use crate::fs::composite::ensure_parent_dir_exists;
@@ -623,22 +623,28 @@ impl IdentityManager {
 
     /// Determines if there are enough files present to consider the identity as existing.
     /// Does NOT guarantee that the identity will load correctly.
-    pub fn require_identity_exists(&self, log: &Logger, name: &str) -> Result<(), IdentityError> {
+    pub fn require_identity_exists(
+        &self,
+        log: &Logger,
+        name: &str,
+    ) -> Result<(), RequireIdentityExistsError> {
         trace!(log, "Checking if identity '{name}' exists.");
         if name == ANONYMOUS_IDENTITY_NAME {
             return Ok(());
         }
 
         if name.starts_with(TEMP_IDENTITY_PREFIX) {
-            return Err(IdentityError::ReservedIdentityName(String::from(name)));
+            return Err(RequireIdentityExistsError::ReservedIdentityName(
+                String::from(name),
+            ));
         }
 
         let json_path = self.get_identity_json_path(name);
         let plaintext_pem_path = self.file_locations.get_plaintext_identity_pem_path(name);
         let encrypted_pem_path = self.file_locations.get_encrypted_identity_pem_path(name);
 
         if !plaintext_pem_path.exists() && !encrypted_pem_path.exists() && !json_path.exists() {
-            Err(IdentityError::IdentityDoesNotExist(
+            Err(RequireIdentityExistsError::IdentityDoesNotExist(
                 String::from(name),
                 json_path,
             ))

src/dfx/src/lib/error/mod.rs

@@ -5,7 +5,6 @@ pub mod project;
 
 pub use build::BuildError;
 pub use dfx_core::error::extension::ExtensionError;
-pub use dfx_core::error::identity::IdentityError;
 pub use notify_create_canister::NotifyCreateCanisterError;
 pub use notify_top_up::NotifyTopUpError;
 pub use project::ProjectError;