feat: improve behavior when config file is missing

.vscode/cSpell.json

@@ -28,6 +28,7 @@
     "rustup",
     "sendemail",
     "setvariable",
+    "shellcheck",
     "shiba",
     "swellaby",
     "testresults",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rusty-hook"
-version = "0.8.4"
+version = "0.9.0"
 authors = ["Swellaby <[email protected]>"]
 description = "git hook utility"
 license = "MIT"

README.md

@@ -25,7 +25,7 @@ Just add `rusty-hook` as a dev dependency in your Cargo.toml file:
 
 ```toml
 [dev-dependencies]
-rusty-hook = "0.8.4"
+rusty-hook = "0.9.0"
 ```
 
 ## Initialize

src/config.rs

@@ -9,7 +9,7 @@ verbose = true
 
 const DEFAULT_CONFIG_FILE_NAME: &str = ".rusty-hook.toml";
 const CONFIG_FILE_NAMES: [&str; 2] = [DEFAULT_CONFIG_FILE_NAME, "rusty-hook.toml"];
-const NO_CONFIG_FILE_FOUND: &str = "No config file found";
+pub const NO_CONFIG_FILE_FOUND: &str = "No config file found";
 pub const MISSING_CONFIG_KEY: &str = "Missing config key";
 
 fn find_config_file<F>(root_directory_path: &str, file_exists: F) -> Result<String, String>
@@ -106,14 +106,14 @@ where
     G: Fn(&str) -> Result<bool, ()>,
 {
     let path = match find_config_file(root_directory_path, &file_exists) {
-        Ok(path) => path,
-        Err(_) => {
-            return Err(String::from(NO_CONFIG_FILE_FOUND));
+        Ok(path) => {
+            if path == NO_CONFIG_FILE_FOUND {
+                return Err(String::from(NO_CONFIG_FILE_FOUND));
+            } else {
+                path
+            }
         }
-    };
-
-    if path == NO_CONFIG_FILE_FOUND {
-        return Err(String::from(NO_CONFIG_FILE_FOUND));
+        Err(_) => return Err(String::from(NO_CONFIG_FILE_FOUND)),
     };
 
     match read_file(&path) {

src/git.rs

@@ -1,3 +1,5 @@
+pub const NO_CONFIG_FILE_FOUND_ERROR_CODE: i32 = 3;
+
 pub fn get_root_directory_path<F>(run_command: F, target_directory: &str) -> Result<String, String>
 where
     F: Fn(&str, &str) -> Result<String, String>,
@@ -12,30 +14,7 @@ where
     run_command("git rev-parse --git-path hooks", &root_directory)
 }
 
-const HOOK_FILE_TEMPLATE: &str = "#!/bin/sh
-# rusty-hook
-# version {{VERSION}}
-
-hookName=$(basename \"$0\")
-gitParams=\"$*\"
-
-if ! command -v rusty-hook >/dev/null 2>&1; then
-  if [ -z \"${RUSTY_HOOK_SKIP_AUTO_INSTALL}\" ]; then
-    echo \"Finalizing rusty-hook configuration...\"
-    echo \"This may take a few seconds...\"
-    cargo install rusty-hook >/dev/null 2>&1
-  else
-    echo \"rusty-hook is not installed, and auto install is disabled\"
-    echo \"skipping $hookName hook\"
-    echo \"You can reinstall it using 'cargo install rusty-hook' or delete this hook\"
-    exit 0
-  fi
-fi
-
-# echo \"rusty-hook version: $(rusty-hook --version)\"
-# echo \"hook file version: {{VERSION}}\"
-rusty-hook run --hook \"$hookName\" \"$gitParams\"";
-
+const HOOK_FILE_TEMPLATE: &str = include_str!("hook_script.sh");
 const HOOK_NAMES: [&str; 19] = [
     "applypatch-msg",
     "pre-applypatch",
@@ -72,7 +51,12 @@ where
         Err(_) => return Err(String::from("Failure determining git hooks directory")),
     };
     let version = env!("CARGO_PKG_VERSION");
-    let hook_file_contents = String::from(HOOK_FILE_TEMPLATE).replace("{{VERSION}}", version);
+    let exit_code = &NO_CONFIG_FILE_FOUND_ERROR_CODE.to_string();
+    let hook_file_contents = String::from(HOOK_FILE_TEMPLATE)
+        .replace("{{VERSION}}", version)
+        .replace("\n# shellcheck disable=SC2170,SC1083", "")
+        .replace("{{NO_CONFIG_FILE_EXIT_CODE}}", exit_code);
+
     for hook in HOOK_NAMES.iter() {
         if write_file(
             &format!("{}/{}/{}", root_directory_path, hooks_directory, hook),

src/git_test.rs

@@ -112,7 +112,11 @@ mod create_hook_files_tests {
         let version = env!("CARGO_PKG_VERSION");
         let root_dir = "/usr/repos/foo";
         let git_hooks = ".git/hooks";
-        let exp_contents = &String::from(HOOK_FILE_TEMPLATE).replace("{{VERSION}}", version);
+        let exit_code = &NO_CONFIG_FILE_FOUND_ERROR_CODE.to_string();
+        let exp_contents = String::from(HOOK_FILE_TEMPLATE)
+            .replace("{{VERSION}}", version)
+            .replace("\n# shellcheck disable=SC2170,SC1083", "")
+            .replace("{{NO_CONFIG_FILE_EXIT_CODE}}", exit_code);
         let run_command = |_cmd: &str, _dir: &str| Ok(String::from(git_hooks));
         let write_file = |path: &str, contents: &str, make_executable: bool| {
             let act_hook = &&path[(path.rfind('/').unwrap() + 1)..];

src/hook_script.sh

@@ -0,0 +1,41 @@
+#!/bin/sh
+# rusty-hook
+# version {{VERSION}}
+
+hookName=$(basename "$0")
+gitParams="$*"
+
+if ! command -v rusty-hook >/dev/null 2>&1; then
+  if [ -z "${RUSTY_HOOK_SKIP_AUTO_INSTALL}" ]; then
+    echo "Finalizing rusty-hook configuration..."
+    echo "This may take a few seconds..."
+    cargo install rusty-hook >/dev/null 2>&1
+  else
+    echo "rusty-hook is not installed, and auto install is disabled"
+    echo "skipping $hookName hook"
+    echo "You can reinstall it using 'cargo install rusty-hook' or delete this hook"
+    exit 0
+  fi
+fi
+
+rusty-hook run --hook "$hookName" "$gitParams"
+rhExitCode=$?
+
+if [ $rhExitCode -ne 0 ]; then
+# shellcheck disable=SC2170,SC1083
+  if [ $rhExitCode -eq {{NO_CONFIG_FILE_EXIT_CODE}} ]; then
+    if [ "$hookName" = "pre-commit" ]; then
+      echo "rusty-hook git hooks are configured, but no config file was found"
+      echo "In order to use rusty-hook, your project must have a config file"
+      echo "See https://github.com/swellaby/rusty-hook#configure for more information"
+      echo
+      echo "If you were trying to remove rusty-hook, then you should also delete the git hook files to remove this warning"
+      echo
+    fi
+    exit 0
+  else
+    echo "Configured hook command failed"
+    echo "$hookName hook rejected"
+    exit $rhExitCode
+  fi
+fi

src/main.rs

@@ -56,8 +56,12 @@ fn run(args: Vec<String>) {
         &closures::get_logger(),
         &hook_name,
     ) {
-        eprintln!("{}", err);
-        exit(1);
+        if err == rusty_hook::NO_CONFIG_FILE_FOUND {
+            exit(rusty_hook::NO_CONFIG_FILE_FOUND_ERROR_CODE);
+        } else {
+            eprintln!("{}", err);
+            exit(1);
+        }
     }
 }
 

src/rusty_hook.rs

@@ -4,6 +4,9 @@ mod config;
 #[path = "git.rs"]
 mod git;
 
+pub use config::NO_CONFIG_FILE_FOUND;
+pub use git::NO_CONFIG_FILE_FOUND_ERROR_CODE;
+
 pub fn init_directory<F, G, H>(
     run_command: F,
     write_file: G,
@@ -62,7 +65,13 @@ where
     let config_file_contents =
         match config::get_config_file_contents(read_file, file_exists, &root_directory_path) {
             Ok(contents) => contents,
-            Err(_) => return Err(String::from("Failed to locate or parse config file")),
+            Err(err) => {
+                if err == config::NO_CONFIG_FILE_FOUND {
+                    return Err(String::from(config::NO_CONFIG_FILE_FOUND));
+                } else {
+                    return Err(String::from("Failed to parse config file"));
+                }
+            }
         };
 
     let log_details = config::get_log_setting(&config_file_contents);
@@ -72,7 +81,7 @@ where
             if err == config::MISSING_CONFIG_KEY {
                 return Ok(());
             }
-            return Err(String::from("Invalid config file"));
+            return Err(String::from("Invalid rusty-hook config file"));
         }
     };
 
@@ -81,14 +90,13 @@ where
         log(&format!("Running command: {}", script));
     };
 
-    match run_command(&script, &root_directory_path) {
-        Ok(stdout) => {
-            if log_details {
-                log(&stdout);
-            }
+    match (run_command(&script, &root_directory_path), log_details) {
+        (Ok(stdout), true) => {
+            log(&stdout);
             Ok(())
         }
-        Err(stderr) => Err(stderr),
+        (Ok(_), false) => Ok(()),
+        (Err(stderr), _) => Err(stderr),
     }
 }
 

src/rusty_hook_test.rs

@@ -79,8 +79,8 @@ mod run_tests {
     }
 
     #[test]
-    fn returns_error_when_config_contents_unloadable() {
-        let exp_err = "Failed to locate or parse config file";
+    fn returns_error_when_config_file_missing() {
+        let exp_err = config::NO_CONFIG_FILE_FOUND;
         let run_command = |_cmd: &str, _dir: &str| Ok(String::from(""));
         let read_file = |_file_path: &str| Err(());
         let file_exists = |_path: &str| Ok(false);
@@ -89,6 +89,17 @@ mod run_tests {
         assert_eq!(result, Err(String::from(exp_err)));
     }
 
+    #[test]
+    fn returns_error_when_config_contents_unloadable() {
+        let exp_err = "Failed to parse config file";
+        let run_command = |_cmd: &str, _dir: &str| Ok(String::from(""));
+        let read_file = |_file_path: &str| Err(());
+        let file_exists = |_path: &str| Ok(true);
+        let log = |_path: &str| panic!("");
+        let result = run(run_command, file_exists, read_file, log, "");
+        assert_eq!(result, Err(String::from(exp_err)));
+    }
+
     #[test]
     fn returns_ok_when_hook_missing() {
         let contents = "[hooks]
@@ -104,7 +115,7 @@ mod run_tests {
 
     #[test]
     fn returns_error_on_invalid_config() {
-        let exp_err = "Invalid config file";
+        let exp_err = "Invalid rusty-hook config file";
         let contents = "abc";
         let run_command = |_cmd: &str, _dir: &str| Ok(String::from(""));
         let read_file = |_file_path: &str| Ok(String::from(contents));