feat(git): Improve git status check (#263)

Author: tony

CHANGES

@@ -10,6 +10,14 @@ Generally speaking, refactor / magic is in the process of being stripped
 out in the next few releases. The API is subject to change significantly
 in pre-1.0 builds.
 
+0.4-current
+-----------
+- [bug] :meth:`libvcs.git.GitRepo.get_current_remote_name()` Handle case where
+  upstream is unpushed
+- [feature] :meth:`libvcs.git.GitRepo.status()` - Retrieve status of repo
+- [feature] :func:`libvcs.git.extract_status()` - Return structured info from
+  ``git status``
+
 0.4.1 <2020-08-01>
 ------------------
 - Remove log statement

doc/api.rst

@@ -34,6 +34,8 @@ Git
    :members:
    :show-inheritance:
 
+.. autofunction:: libvcs.git.extract_status
+
 Mercurial
 ---------
 

libvcs/git.py

@@ -40,6 +40,61 @@
 """
 
 
+def extract_status(value):
+    """Returns ``git status -sb --porcelain=2`` extracted to a dict
+
+    Returns
+    -------
+    dict : 
+        Dictionary of git repo's status
+    """
+    pattern = re.compile(
+        r"""[\n\r]?
+        (
+            #
+            \W+
+            branch.oid\W+
+            (?P<branch_oid>
+                [a-f0-9]{40}
+            )
+        )?
+        (
+            #
+            \W+
+            branch.head
+            [\W]+
+            (?P<branch_head>
+                [\w-]*
+            )
+            
+        )?
+        (
+            #
+            \W+
+            branch.upstream
+            [\W]+
+            (?P<branch_upstream>
+                [/\w-]*
+            )
+        )?
+        (
+            #
+            \W+
+            branch.ab
+            [\W]+
+            (?P<branch_ab>
+                \+(?P<branch_ahead>\d+)
+                \W{1}
+                \-(?P<branch_behind>\d+)
+            )
+        )?
+        """,
+        re.VERBOSE | re.MULTILINE,
+    )
+    matches = pattern.search(value)
+    return matches.groupdict()
+
+
 class GitRepo(BaseRepo):
     bin_name = 'git'
     schemes = ('git', 'git+http', 'git+https', 'git+ssh', 'git+git', 'git+file')
@@ -307,7 +362,9 @@ def remotes(self, flat=False):
            This used to return a dict of tuples, it now returns a dict of dictionaries
            with ``name``, ``fetch_url``, and ``push_url``.
 
-        :rtype: dict
+        Returns
+        -------
+        dict
         """
         remotes = {}
 
@@ -340,10 +397,15 @@ def remotes_get(self):
     def remote(self, name, **kwargs):
         """Get the fetch and push URL for a specified remote name.
 
-        :param name: the remote name used to define the fetch and push URL
-        :type name: str
-        :returns: remote name and url in tuple form
-        :rtype: :class:`libvcs.git.GitRemote`
+        Parameters
+        ----------
+        name : str
+            The remote name used to define the fetch and push URL
+
+        Returns
+        -------
+        :class:`libvcs.git.GitRemote` : 
+            Remote name and url in tuple form
 
         .. versionchanged:: 0.4.0
 
@@ -429,11 +491,15 @@ def remote_set(self, url, name='origin', overwrite=False, **kwargs):
     def chomp_protocol(url):
         """Return clean VCS url from RFC-style url
 
-        :param url: url
-        :type url: str
-        :rtype: str
-        :returns: url as VCS software would accept it
-        :seealso: #14
+        Parameters
+        ----------
+        url : str 
+            PIP-style url
+
+        Returns
+        -------
+        str :
+            URL as VCS software would accept it
         """
         if '+' in url:
             url = url.split('+', 1)[1]
@@ -453,7 +519,9 @@ def chomp_protocol(url):
     def get_git_version(self):
         """Return current version of git binary
 
-        :rtype: str
+        Returns
+        -------
+        str
         """
         VERSION_PFX = 'git version '
         version = self.run(['version'])
@@ -463,19 +531,44 @@ def get_git_version(self):
             version = ''
         return '.'.join(version.split('.')[:3])
 
+    def status(self):
+        """Retrieve status of project in dict format.
+
+        Wraps ``git status --sb --porcelain=2``. Does not include changed files, yet.
+
+        Examples
+        --------
+
+        ::
+
+            print(git_repo.status())
+            {
+                "branch_oid": 'de6185fde0806e5c7754ca05676325a1ea4d6348',
+                "branch_head": 'fix-current-remote-name',
+                "branch_upstream": 'origin/fix-current-remote-name',
+                "branch_ab": '+0 -0',
+                "branch_ahead": '0',
+                "branch_behind": '0',
+            }
+
+        Returns
+        -------
+        dict :
+            Status of current checked out repository
+        """
+        return extract_status(self.run(['status', '-sb', '--porcelain=2']))
+
     def get_current_remote_name(self):
         """Retrieve name of the remote / upstream of currently checked out branch.
 
-        :rtype: str, None if no remote set
+        Returns
+        -------
+        str :
+            If upstream the same, returns ``branch_name``.
+            If upstream mismatches, returns ``remote_name/branch_name``.
         """
-        current_status = self.run(['status', '-sb'])
-        # git status -sb
-        # ## v1.0-ourbranch...remotename/v1.0-ourbranch
-        match = re.match(
-            r'^## (?P<branch>.*)\.{3}(?P<remote_slash_branch>.*)', current_status,
-        )
-        if match is None:  # No upstream set
-            return None
-        return match.group('remote_slash_branch').replace(
-            '/' + match.group('branch'), ''
-        )
+        match = self.status()
+
+        if match['branch_upstream'] is None:  # no upstream set
+            return match['branch_head']
+        return match['branch_upstream'].replace('/' + match['branch_head'], '')

tests/test_git.py

@@ -4,12 +4,13 @@
 
 import datetime
 import os
+import textwrap
 
 import pytest
 
 from libvcs import exc
-from libvcs._compat import string_types
-from libvcs.git import GitRemote, GitRepo
+from libvcs._compat import PY2, string_types
+from libvcs.git import GitRemote, GitRepo, extract_status
 from libvcs.shortcuts import create_repo_from_pip_url
 from libvcs.util import run, which
 
@@ -201,3 +202,134 @@ def test_set_remote(git_repo, repo_name, new_repo_url):
     assert new_repo_url in git_repo.remote(
         name='myrepo'
     ), 'Running remove_set should overwrite previous remote'
+
+
+def test_get_git_version(git_repo):
+    expected_version = git_repo.run(['--version']).replace('git version ', '')
+    assert git_repo.get_git_version()
+    assert expected_version == git_repo.get_git_version()
+
+
+def test_get_current_remote_name(git_repo):
+    assert git_repo.get_current_remote_name() == 'origin'
+
+    new_branch = 'another-branch-with-no-upstream'
+    git_repo.run(['checkout', '-B', new_branch])
+    assert (
+        git_repo.get_current_remote_name() == new_branch
+    ), 'branch w/o upstream should return branch only'
+
+    new_remote_name = 'new_remote_name'
+    git_repo.set_remote(
+        name=new_remote_name, url='file://' + git_repo.path, overwrite=True
+    )
+    git_repo.run(['fetch', new_remote_name])
+    git_repo.run(
+        ['branch', '--set-upstream-to', '{}/{}'.format(new_remote_name, new_branch)]
+    )
+    assert (
+        git_repo.get_current_remote_name() == new_remote_name
+    ), 'Should reflect new upstream branch (different remote)'
+
+    upstream = '{}/{}'.format(new_remote_name, 'master')
+
+    git_repo.run(['branch', '--set-upstream-to', upstream])
+    assert (
+        git_repo.get_current_remote_name() == upstream
+    ), 'Should reflect upstream branch (differente remote+branch)'
+
+    git_repo.run(['checkout', 'master'])
+
+    # Different remote, different branch
+    remote = '{}/{}'.format(new_remote_name, new_branch)
+    git_repo.run(['branch', '--set-upstream-to', remote])
+    assert (
+        git_repo.get_current_remote_name() == remote
+    ), 'Should reflect new upstream branch (different branch)'
+
+
+def test_extract_status():
+    FIXTURE_A = textwrap.dedent(
+        """
+        # branch.oid d4ccd4d6af04b53949f89fbf0cdae13719dc5a08
+        # branch.head fix-current-remote-name
+        1 .M N... 100644 100644 100644 91082f119279b6f105ee9a5ce7795b3bdbe2b0de 91082f119279b6f105ee9a5ce7795b3bdbe2b0de CHANGES
+    """  # NOQA: E501
+    )
+    assert {
+        "branch_oid": 'd4ccd4d6af04b53949f89fbf0cdae13719dc5a08',
+        "branch_head": 'fix-current-remote-name',
+    }.items() <= extract_status(FIXTURE_A).items()
+
+
+@pytest.mark.parametrize(
+    'fixture,expected_result',
+    [
+        [
+            """
+        # branch.oid de6185fde0806e5c7754ca05676325a1ea4d6348
+        # branch.head fix-current-remote-name
+        # branch.upstream origin/fix-current-remote-name
+        # branch.ab +0 -0
+        1 .M N... 100644 100644 100644 91082f119279b6f105ee9a5ce7795b3bdbe2b0de 91082f119279b6f105ee9a5ce7795b3bdbe2b0de CHANGES
+        1 .M N... 100644 100644 100644 302ca2c18d4c295ce217bff5f93e1ba342dc6665 302ca2c18d4c295ce217bff5f93e1ba342dc6665 tests/test_git.py
+    """,  # NOQA: E501
+            {
+                "branch_oid": 'de6185fde0806e5c7754ca05676325a1ea4d6348',
+                "branch_head": 'fix-current-remote-name',
+                "branch_upstream": 'origin/fix-current-remote-name',
+                "branch_ab": '+0 -0',
+                "branch_ahead": '0',
+                "branch_behind": '0',
+            },
+        ],
+        [
+            '# branch.upstream moo/origin/myslash/remote',
+            {"branch_upstream": 'moo/origin/myslash/remote'},
+        ],
+    ],
+)
+def test_extract_status_b(fixture, expected_result):
+    if PY2:
+        assert (
+            extract_status(textwrap.dedent(fixture)).items() <= expected_result.items()
+        )
+    else:
+        assert (
+            extract_status(textwrap.dedent(fixture)).items() >= expected_result.items()
+        )
+
+
+@pytest.mark.parametrize(
+    'fixture,expected_result',
+    [
+        [
+            '# branch.ab +1 -83',
+            {"branch_ab": '+1 -83', "branch_ahead": '1', "branch_behind": '83',},
+        ],
+        [
+            """
+            # branch.ab +0 -0
+            """,
+            {"branch_ab": '+0 -0', "branch_ahead": '0', "branch_behind": '0',},
+        ],
+        [
+            """
+            # branch.ab +1 -83
+            """,
+            {"branch_ab": '+1 -83', "branch_ahead": '1', "branch_behind": '83',},
+        ],
+        [
+            """
+            # branch.ab +9999999 -9999999
+            """,
+            {
+                "branch_ab": '+9999999 -9999999',
+                "branch_ahead": '9999999',
+                "branch_behind": '9999999',
+            },
+        ],
+    ],
+)
+def test_extract_status_c(fixture, expected_result):
+    assert expected_result.items() <= extract_status(textwrap.dedent(fixture)).items()