During traverse, correctly detect a failed rebase in a worktree

Author: PawelLipski

RELEASE_NOTES.md

@@ -2,6 +2,9 @@
 
 ## New in git-machete 3.39.3
 
+- fixed: when `git machete traverse` failed on a rebase within a worktree,
+  in certain cases the warning message about changed directory didn't show up (reported by @lsierant)
+
 ## New in git-machete 3.39.2
 
 - improved: interactive `git machete go` displays a branch layout as in `status`

git_machete/git_operations.py

@@ -262,8 +262,9 @@ def chdir(self, path: str) -> None:
         self.__flush_current_worktree_caches()
 
     def __flush_current_worktree_caches(self) -> None:
+        # No point in clearing main worktree paths as they are not affected by chdir between worktrees
         self.__current_worktree_root_dir = None
-        self.__main_worktree_root_dir = None
+        self.__current_worktree_git_dir = None
 
     def _run_git(self, git_cmd: str, *args: str, flush_caches: bool, allow_non_zero: bool = False) -> int:
         exit_code = utils.run_cmd(*GIT_EXEC, git_cmd, *args)

tests/mockers.py

@@ -9,8 +9,6 @@
                         redirect_stderr, redirect_stdout)
 from typing import Any, Callable, Iterable, Iterator, Optional, Tuple, Type
 
-import pytest
-
 from git_machete import cli, utils
 from git_machete.utils import MacheteException, PopenResult
 
@@ -61,27 +59,41 @@ def launch_command(*cmd_and_args: str) -> str:
         return output
 
 
+def strip_trailing_spaces(text: str) -> str:
+    return re.sub(" +$", "", text, flags=re.MULTILINE)
+
+
 def assert_success(cmd_and_args: Iterable[str], expected_result: str) -> None:
     if expected_result.startswith("\n"):
         # removeprefix is only available since Python 3.9
         expected_result = expected_result[1:]
     expected_result = textwrap.dedent(expected_result)
-    actual_result = re.sub(" +$", "", textwrap.dedent(launch_command(*cmd_and_args)), flags=re.MULTILINE)
+    actual_result = strip_trailing_spaces(textwrap.dedent(launch_command(*cmd_and_args)))
     assert actual_result == expected_result
 
 
-def assert_failure(cmd_and_args: Iterable[str], expected_message: str, expected_type: Type[BaseException] = MacheteException) -> None:
+def assert_failure(cmd_and_args: Iterable[str], expected_message: str, expected_type: Type[BaseException] = MacheteException,
+                   expected_output: Optional[str] = None) -> None:
     if expected_message.startswith("\n"):
         # removeprefix is only available since Python 3.9
         expected_message = expected_message[1:]
     expected_message = textwrap.dedent(expected_message)
 
-    with pytest.raises(expected_type) as ei:
-        launch_command(*cmd_and_args)
-    error_message = ei.value.msg  # type: ignore[attr-defined]
-    error_message = re.sub(" +$", "", error_message, flags=re.MULTILINE)
+    if expected_output is not None:
+        if expected_output.startswith("\n"):
+            expected_output = expected_output[1:]
+        expected_output = textwrap.dedent(expected_output)
+
+    output, e = launch_command_capturing_output_and_exception(*cmd_and_args)
+    assert e is not None, f"Expected {expected_type.__name__} but no exception was raised"
+    assert isinstance(e, expected_type), f"Expected {expected_type.__name__} but got {type(e).__name__}: {e}"
+    error_message = strip_trailing_spaces(e.msg)  # type: ignore[attr-defined]
     assert error_message == expected_message
 
+    if expected_output is not None:
+        actual_output = strip_trailing_spaces(textwrap.dedent(output or ""))
+        assert actual_output == expected_output
+
 
 def read_branch_layout_file() -> str:
     with open(".git/machete") as def_file:

tests/test_traverse.py

@@ -1,5 +1,6 @@
 import os
 
+import pytest
 from pytest_mock import MockerFixture
 
 from git_machete.utils import UnderlyingGitException
@@ -1922,3 +1923,28 @@ def test_traverse_yellow_edges(self, mocker: MockerFixture) -> None:
             Returned to the initial branch feature-2
             """
         )
+
+    # The expected error message includes `--empty=drop` which is only passed on git >= 2.26.0.
+    @pytest.mark.skipif(get_git_version() < (2, 26, 0), reason="--empty=drop is only passed to git rebase since git 2.26.0")
+    def test_traverse_rebase_conflict(self) -> None:
+        create_repo()
+        with fixed_author_and_committer_date_in_past():
+            new_branch("master")
+            add_file_and_commit("file.txt", "base content\n", "Base commit")
+            new_branch("feature")
+            add_file_and_commit("file.txt", "feature content\n", "Feature commit")
+            check_out("master")
+            add_file_and_commit("file.txt", "master content\n", "Master commit")
+        check_out("feature")
+
+        rewrite_branch_layout_file("master\n\tfeature")
+
+        assert_failure(
+            ["traverse", "-y"],
+            "git -c log.showSignature=false rebase --empty=drop"
+            " --onto refs/heads/master 77b81e64de792099dad58d67756b66cda9e80aa7 feature returned 1",
+            expected_type=UnderlyingGitException,
+            expected_output="""
+            Rebasing feature onto master...
+            """
+        )

tests/test_traverse_worktrees.py

@@ -4,12 +4,14 @@
 import pytest
 from pytest_mock import MockerFixture
 
-from git_machete.utils import abspath_posix
+from git_machete.utils import UnderlyingGitException, abspath_posix
 
 from .base_test import BaseTest
-from .mockers import (assert_success, launch_command, mock_input_returning,
-                      rewrite_branch_layout_file)
-from .mockers_git_repository import (add_worktree, check_out, commit,
+from .mockers import (assert_failure, assert_success,
+                      fixed_author_and_committer_date_in_past, launch_command,
+                      mock_input_returning, rewrite_branch_layout_file)
+from .mockers_git_repository import (add_file_and_commit, add_worktree,
+                                     check_out, commit,
                                      create_repo_with_remote, get_git_version,
                                      new_branch, push, set_git_config_key)
 
@@ -517,3 +519,52 @@ def test_traverse_stay_in_same_worktree_when_branch_not_checked_out(self, mocker
               cd {normalized_branch_2_worktree}
             """
         )
+
+    # The expected error message includes `--empty=drop` which is only passed on git >= 2.26.0.
+    @pytest.mark.skipif(get_git_version() < (2, 26, 0), reason="--empty=drop is only passed to git rebase since git 2.26.0")
+    def test_traverse_rebase_conflict_in_worktree(self) -> None:
+        create_repo_with_remote()
+        with fixed_author_and_committer_date_in_past():
+            new_branch("base")
+            add_file_and_commit("file.txt", "base content\n", "Base commit")
+            push()
+            new_branch("feature")
+            add_file_and_commit("file.txt", "feature content\n", "Feature commit")
+            push()
+
+        body: str = \
+            """
+            base
+                feature
+            """
+        rewrite_branch_layout_file(body)
+
+        # Create a worktree for feature
+        check_out("base")
+        feature_worktree = add_worktree("feature")
+        normalized_feature_worktree = abspath_posix(feature_worktree)
+
+        # Make a conflicting change on base
+        check_out("base")
+        with fixed_author_and_committer_date_in_past():
+            add_file_and_commit("file.txt", "conflicting base content\n", "Conflicting base commit")
+            push()
+
+        assert_failure(
+            ["traverse", "-y"],
+            "git -c log.showSignature=false rebase --empty=drop"
+            " --onto refs/heads/base 77b81e64de792099dad58d67756b66cda9e80aa7 feature returned 1",
+            expected_type=UnderlyingGitException,
+            expected_output=f"""
+            Changing directory to {normalized_feature_worktree} worktree where feature is checked out
+
+              base
+              |
+              x-feature *
+
+            Rebasing feature onto base...
+            Warn: branch feature is checked out in worktree at {normalized_feature_worktree}
+            You may want to change directory with:
+              cd {normalized_feature_worktree}
+            """
+        )