Change name to PackageMaintenanceHookExt

Signed-off-by: David McNeil <mcneil.david2@gmail.com>
habitat-sh · Jul 8, 2020 · c02acae · c02acae
1 parent 65495b5
commit c02acae
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/components/common/src/command/package/install.rs b/components/common/src/command/package/install.rs
@@ -26,8 +26,8 @@ use crate::{api_client::{self,
                          Error::APIError},
             error::{Error,
                     Result},
-            templating::hooks::{HookExt,
-                                InstallHook},
+            templating::hooks::{InstallHook,
+                                PackageMaintenanceHookExt},
             ui::{Status,
                  UIWriter}};
 use habitat_core::{self,

diff --git a/components/common/src/templating/hooks.rs b/components/common/src/templating/hooks.rs
@@ -320,8 +320,16 @@ pub trait Hook: fmt::Debug + Sized + Send {
     fn stderr_log_path(&self) -> &Path;
 }
 
+/// A trait that adds a convenient method for executing one-off hooks
+///
+/// This trait unifies the logic the `install` and `uninstall` hooks use to execute. These hooks
+/// are unique in that they are run in a one-off fashion opposed to running as part of a service
+/// lifecycle.
+///
+/// In future refactoring of the `Hook` trait this should probably be integrated into that trait
+/// directly.
 #[async_trait::async_trait]
-pub trait HookExt: Hook<ExitValue = ExitStatus> + Sync {
+pub trait PackageMaintenanceHookExt: Hook<ExitValue = ExitStatus> + Sync {
     /// A high level hook operation that adds the following conveniences around `Hook::run`:
     ///
     /// * find the hook in a given `PackageInstall`
@@ -373,7 +381,7 @@ pub trait HookExt: Hook<ExitValue = ExitStatus> + Sync {
     }
 }
 
-impl<T: Hook<ExitValue = ExitStatus> + Sync> HookExt for T {}
+impl<T: Hook<ExitValue = ExitStatus> + Sync> PackageMaintenanceHookExt for T {}
 
 #[derive(Debug, Serialize)]
 pub struct InstallHook {

diff --git a/components/hab/src/command/pkg/uninstall/uninstall_impl.rs b/components/hab/src/command/pkg/uninstall/uninstall_impl.rs
@@ -6,7 +6,7 @@ use crate::{command::pkg::list,
                     Result}};
 use futures::stream::StreamExt;
 use habitat_common::{package_graph::PackageGraph,
-                     templating::hooks::{HookExt,
+                     templating::hooks::{PackageMaintenanceHookExt,
                                          UninstallHook},
                      types::ListenCtlAddr,
                      ui::{Status,