Skip to content

Show how to restore the backport branch after deleting it #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
muhammad-a-dev wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −2
Open

Show how to restore the backport branch after deleting it #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions cherry_picker/cherry_picker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,13 +516,22 @@ def cleanup_branch(self, branch):
print(f"branch {branch} NOT deleted.")
set_state(WORKFLOW_STATES.REMOVING_BACKPORT_BRANCH_FAILED)
return
# Remember where the branch points so that the user can restore it,
# for example if pushing it failed and manual work would be lost.
try:
branch_sha = get_sha1_from(branch)
except ValueError:
branch_sha = None
try:
self.delete_branch(branch)
except subprocess.CalledProcessError:
print(f"branch {branch} NOT deleted.")
set_state(WORKFLOW_STATES.REMOVING_BACKPORT_BRANCH_FAILED)
else:
print(f"branch {branch} has been deleted.")
if branch_sha:
print("To restore it, run:")
print(f"git branch {branch} {branch_sha}")
set_state(WORKFLOW_STATES.REMOVED_BACKPORT_BRANCH)

def unset_upstream(self, branch):
Expand Down
11 changes: 9 additions & 2 deletions cherry_picker/test_cherry_picker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -838,17 +838,21 @@ def _fetch(cmd, *args, **kwargs):
assert get_state() == end_state


def test_cleanup_branch(tmp_git_repo_dir, git_checkout):
def test_cleanup_branch(tmp_git_repo_dir, git_checkout, capsys):
assert get_state() == WORKFLOW_STATES.UNSET

with mock.patch("cherry_picker.cherry_picker.validate_sha", return_value=True):
cherry_picker = CherryPicker("origin", "xxx", [])
assert get_state() == WORKFLOW_STATES.UNSET

git_checkout("-b", "some_branch")
branch_sha = get_sha1_from("some_branch")
cherry_picker.cleanup_branch("some_branch")
assert get_state() == WORKFLOW_STATES.REMOVED_BACKPORT_BRANCH
assert get_current_branch() == "main"
out = capsys.readouterr().out
assert "branch some_branch has been deleted." in out
assert f"To restore it, run:\ngit branch some_branch {branch_sha}\n" in out


def test_cleanup_branch_checkout_previous_branch(
Expand All @@ -868,7 +872,7 @@ def test_cleanup_branch_checkout_previous_branch(
assert get_current_branch() == "previous_branch"


def test_cleanup_branch_fail(tmp_git_repo_dir):
def test_cleanup_branch_fail(tmp_git_repo_dir, capsys):
assert get_state() == WORKFLOW_STATES.UNSET

with mock.patch("cherry_picker.cherry_picker.validate_sha", return_value=True):
Expand All @@ -877,6 +881,9 @@ def test_cleanup_branch_fail(tmp_git_repo_dir):

cherry_picker.cleanup_branch("some_branch")
assert get_state() == WORKFLOW_STATES.REMOVING_BACKPORT_BRANCH_FAILED
out = capsys.readouterr().out
assert "branch some_branch NOT deleted." in out
assert "To restore it" not in out


def test_cleanup_branch_checkout_fail(
Expand Down
Loading