fix(init): install post-applypatch hook

Author: arxanas

git-branchless-opts/src/lib.rs

@@ -231,6 +231,10 @@ pub enum Command {
     #[clap(hide = true)]
     HookPreAutoGc,
 
+    /// Internal use.
+    #[clap(hide = true)]
+    HookPostApplypatch,
+
     /// Internal use.
     #[clap(hide = true)]
     HookPostCheckout {

git-branchless/src/commands/hooks.rs

@@ -134,6 +134,14 @@ pub fn hook_post_merge(effects: &Effects, _is_squash_merge: isize) -> eyre::Resu
     hook_post_commit_common(effects, "post-merge")
 }
 
+/// Handle Git's `post-applypatch` hook.
+///
+/// See the man-page for `githooks(5)`.
+#[instrument]
+pub fn hook_post_applypatch(effects: &Effects) -> eyre::Result<()> {
+    hook_post_commit_common(effects, "post-applypatch")
+}
+
 mod reference_transaction {
     use std::collections::HashMap;
     use std::fs::File;

git-branchless/src/commands/init.rs

@@ -19,6 +19,18 @@ use lib::core::repo_ext::RepoExt;
 use lib::git::{BranchType, Config, ConfigRead, ConfigWrite, GitRunInfo, GitVersion, Repo};
 
 pub const ALL_HOOKS: &[(&str, &str)] = &[
+    (
+        "post-applypatch",
+        r#"
+git branchless hook-post-applypatch "$@"
+"#,
+    ),
+    (
+        "post-checkout",
+        r#"
+git branchless hook-post-checkout "$@"
+"#,
+    ),
     (
         "post-commit",
         r#"
@@ -35,12 +47,6 @@ git branchless hook-post-merge "$@"
         "post-rewrite",
         r#"
 git branchless hook-post-rewrite "$@"
-"#,
-    ),
-    (
-        "post-checkout",
-        r#"
-git branchless hook-post-checkout "$@"
 "#,
     ),
     (

git-branchless/src/commands/mod.rs

@@ -126,6 +126,11 @@ fn do_main_and_drop_locals() -> eyre::Result<i32> {
             ExitCode(0)
         }
 
+        Command::HookPostApplypatch => {
+            hooks::hook_post_applypatch(&effects)?;
+            ExitCode(0)
+        }
+
         Command::HookPostCheckout {
             previous_commit,
             current_commit,

git-branchless/tests/test_bug_report.rs

@@ -37,45 +37,55 @@ fn test_bug_report() -> eyre::Result<()> {
 
         insta::assert_snapshot!(stdout, @r###"
         <details>
-        <summary>Show 6 hooks</summary>
+        <summary>Show 7 hooks</summary>
 
-        ##### Hook `post-commit`
+        ##### Hook `post-applypatch`
 
         ```
         #!/bin/sh
         ## START BRANCHLESS CONFIG
 
-        git branchless hook-post-commit "$@"
+        git branchless hook-post-applypatch "$@"
 
         ## END BRANCHLESS CONFIG
         ```
-        ##### Hook `post-merge`
+        ##### Hook `post-checkout`
 
         ```
         #!/bin/sh
         ## START BRANCHLESS CONFIG
 
-        git branchless hook-post-merge "$@"
+        git branchless hook-post-checkout "$@"
 
         ## END BRANCHLESS CONFIG
         ```
-        ##### Hook `post-rewrite`
+        ##### Hook `post-commit`
 
         ```
         #!/bin/sh
         ## START BRANCHLESS CONFIG
 
-        git branchless hook-post-rewrite "$@"
+        git branchless hook-post-commit "$@"
 
         ## END BRANCHLESS CONFIG
         ```
-        ##### Hook `post-checkout`
+        ##### Hook `post-merge`
 
         ```
         #!/bin/sh
         ## START BRANCHLESS CONFIG
 
-        git branchless hook-post-checkout "$@"
+        git branchless hook-post-merge "$@"
+
+        ## END BRANCHLESS CONFIG
+        ```
+        ##### Hook `post-rewrite`
+
+        ```
+        #!/bin/sh
+        ## START BRANCHLESS CONFIG
+
+        git branchless hook-post-rewrite "$@"
 
         ## END BRANCHLESS CONFIG
         ```

git-branchless/tests/test_hooks.rs

@@ -345,3 +345,46 @@ fn test_merge_commit_recorded() -> eyre::Result<()> {
 
     Ok(())
 }
+
+#[test]
+fn test_git_am_recorded() -> eyre::Result<()> {
+    let git = make_git()?;
+    git.init_repo()?;
+
+    git.detach_head()?;
+    git.commit_file("test1", 1)?;
+    git.run(&["format-patch", "HEAD^"])?;
+    git.run(&["reset", "--hard", "HEAD^"])?;
+
+    {
+        let (stdout, _stderr) = git.run(&["am", "0001-create-test1.txt.patch"])?;
+        insta::assert_snapshot!(stdout, @r###"
+        Applying: create test1.txt
+        "###);
+    }
+
+    {
+        let (stdout, _stderr) = git.run(&["smartlog"])?;
+        insta::assert_snapshot!(stdout, @r###"
+        O f777ecc (master) create initial.txt
+        |\
+        | @ 047b7ad create test1.txt
+        |
+        o 62fc20d create test1.txt
+        "###);
+    }
+
+    git.run(&["reset", "--hard", "HEAD^"])?;
+    {
+        let (stdout, _stderr) = git.run(&["smartlog"])?;
+        insta::assert_snapshot!(stdout, @r###"
+        @ f777ecc (master) create initial.txt
+        |\
+        | o 047b7ad create test1.txt
+        |
+        o 62fc20d create test1.txt
+        "###);
+    }
+
+    Ok(())
+}

git-branchless/tests/test_init.rs

@@ -185,7 +185,7 @@ fn test_old_git_version_warning() -> eyre::Result<()> {
         Created config file at <repo-path>/.git/branchless/config
         Auto-detected your main branch as: master
         If this is incorrect, run: git branchless init --main-branch <branch>
-        Installing hooks: post-commit, post-merge, post-rewrite, post-checkout, pre-auto-gc, reference-transaction
+        Installing hooks: post-applypatch, post-checkout, post-commit, post-merge, post-rewrite, pre-auto-gc, reference-transaction
         Warning: the branchless workflow's `git undo` command requires Git
         v2.29 or later, but your Git version is: <git version output>
 
@@ -225,7 +225,7 @@ fn test_init_basic() -> eyre::Result<()> {
         Created config file at <repo-path>/.git/branchless/config
         Auto-detected your main branch as: master
         If this is incorrect, run: git branchless init --main-branch <branch>
-        Installing hooks: post-commit, post-merge, post-rewrite, post-checkout, pre-auto-gc, reference-transaction
+        Installing hooks: post-applypatch, post-checkout, post-commit, post-merge, post-rewrite, pre-auto-gc, reference-transaction
         Successfully installed git-branchless.
         To uninstall, run: git branchless init --uninstall
         "###);
@@ -264,7 +264,7 @@ fn test_init_prompt_for_main_branch() -> eyre::Result<()> {
         Your main branch name could not be auto-detected!
         Examples of a main branch: master, main, trunk, etc.
         See https://github.com/arxanas/git-branchless/wiki/Concepts#main-branch
-        Enter the name of your main branch: Installing hooks: post-commit, post-merge, post-rewrite, post-checkout, pre-auto-gc, reference-transaction
+        Enter the name of your main branch: Installing hooks: post-applypatch, post-checkout, post-commit, post-merge, post-rewrite, pre-auto-gc, reference-transaction
         Successfully installed git-branchless.
         To uninstall, run: git branchless init --uninstall
         "###);
@@ -352,7 +352,7 @@ fn test_init_uninstall() -> eyre::Result<()> {
         insta::assert_snapshot!(stderr, @"");
         insta::assert_snapshot!(stdout, @r###"
         Removing config file: <repo-path>/.git/branchless/config
-        Uninstalling hooks: post-commit, post-merge, post-rewrite, post-checkout, pre-auto-gc, reference-transaction
+        Uninstalling hooks: post-applypatch, post-checkout, post-commit, post-merge, post-rewrite, pre-auto-gc, reference-transaction
         "###);
     }
 
@@ -538,7 +538,7 @@ fn test_init_core_hooks_path_warning() -> eyre::Result<()> {
         Created config file at <repo-path>/.git/branchless/config
         Auto-detected your main branch as: master
         If this is incorrect, run: git branchless init --main-branch <branch>
-        Installing hooks: post-commit, post-merge, post-rewrite, post-checkout, pre-auto-gc, reference-transaction
+        Installing hooks: post-applypatch, post-checkout, post-commit, post-merge, post-rewrite, pre-auto-gc, reference-transaction
         Warning: the configuration value core.hooksPath was set to: my-hooks
         The Git hooks above may have been installed to an unexpected location.
         Successfully installed git-branchless.