Add convenience method for checking if a branch exists

Author: jpichon

git_wrapper/branch.py

@@ -48,6 +48,28 @@ def _run_cherry(self, upstream, head, regex):
                 ret_data[match.group(1)] = match.group(2)
         return ret_data
 
+    def exists(self, name, remote=None):
+        """Checks if a branch exists locally or on the specified remote.
+
+           :param str name: Name of the branch to find
+           :param str remote: Remote name to check for the branch, or None
+                              if local
+        """
+        if not remote:
+            if name in self.git_repo.repo.branches:
+                return True
+            else:
+                return False
+        else:
+            if remote not in self.git_repo.remote.names():
+                raise exceptions.RemoteException(
+                    "Remote {0} does not exist.".format(remote)
+                )
+            if name in self.git_repo.repo.remotes[remote].refs:
+                return True
+            else:
+                return False
+
     def cherry_on_head_only(self, upstream, head):
         """Get new patches between upstream and head.
 

tests/conftest.py

@@ -6,6 +6,7 @@
 from mock import Mock
 
 import git
+from git.util import IterableList
 import pytest
 
 
@@ -18,7 +19,9 @@ def mock_repo():
 
     remote = Mock(spec=git.Remote)
     remote.configure_mock(name="origin", url="http://example.com")
-    repo_mock.remotes = [remote]
+    remote_list = IterableList("name")
+    remote_list.extend([remote])
+    repo_mock.remotes = remote_list
 
     return repo_mock
 

tests/test_branch.py

@@ -677,3 +677,69 @@ def test_reset_reset_failure(mock_repo):
         mock_repo.head.reset.side_effect = git.GitCommandError('reset', '')
         with pytest.raises(exceptions.ResetException):
             repo.branch.hard_reset(refresh=False)
+
+
+def test_local_branch_exists(mock_repo):
+    """
+    GIVEN GitRepo is initialized with a path and repo
+    WHEN branch.exists is called with a valid branch and None remote
+    THEN True is returned
+    """
+    repo = GitRepo(repo=mock_repo)
+    mock_repo.branches = ["master", "test"]
+
+    assert repo.branch.exists("test") is True
+
+
+def test_local_branch_doesnt_exist(mock_repo):
+    """
+    GIVEN GitRepo is initialized with a path and repo
+    WHEN branch.exists is called with an invalid branch and None remote
+    THEN False is returned
+    """
+    repo = GitRepo(repo=mock_repo)
+    mock_repo.branches = ["master", "test"]
+
+    assert repo.branch.exists("another-test") is False
+
+
+def test_branch_exists_with_invalid_remote(mock_repo):
+    """
+    GIVEN GitRepo is initialized with a path and repo
+    WHEN branch.exists is called with a valid branch and invalid remote
+    THEN a RemoteException is raised
+    """
+    repo = GitRepo(repo=mock_repo)
+
+    with pytest.raises(exceptions.RemoteException):
+        assert repo.branch.exists("another", "doesntexist")
+
+
+def test_remote_branch_exists(mock_repo):
+    """
+    GIVEN GitRepo is initialized with a path and repo
+    WHEN branch.exists is called with a valid branch and valid remote
+    THEN True is returned
+    """
+    repo = GitRepo(repo=mock_repo)
+
+    remote = Mock(spec=git.Remote)
+    remote.configure_mock(name="testremote", refs=["testbranch"])
+    mock_repo.remotes.extend([remote])
+
+    assert repo.branch.exists("testbranch", "testremote") is True
+
+
+def test_remote_branch_doesnt_exists(mock_repo):
+    """
+    GIVEN GitRepo is initialized with a path and repo
+    WHEN branch.exists is called with an invalid branch and valid remote
+    THEN True is returned
+    """
+    repo = GitRepo(repo=mock_repo)
+
+    remote = Mock(spec=git.Remote)
+    remote.configure_mock(name="testremote", refs=[])
+    mock_repo.remotes.extend([remote])
+
+    assert repo.branch.exists("testbranch", "testremote") is False