Handling git remotes with different push URLs.

Git remotes (e.g. origin) can have different fetch and push URLs. Before
clone() just set the fetch URL for both in the new temporary repo.

If the user set a push URL, SCVersioning would effectively not use it at
all. Fixing this.

Author: Robpol86

README.rst

@@ -44,6 +44,12 @@ Changelog
 
 This project adheres to `Semantic Versioning <http://semver.org/>`_.
 
+Unreleased
+----------
+
+Fixed
+    * Carrying over to cloned repo the git remote push URL if it's different from fetch URL.
+
 2.1.0 - 2016-08-22
 ------------------
 

sphinxcontrib/versioning/git.py

@@ -11,6 +11,7 @@
 
 from sphinxcontrib.versioning.lib import TempDir
 
+RE_FETCH_PUSH = re.compile(r'origin\t([A-Za-z0-9@:/._-]+) \((fetch|push)\)\n')
 RE_REMOTE = re.compile(r'^(?P<sha>[0-9a-f]{5,40})\trefs/(?P<kind>heads|tags)/(?P<name>[\w./-]+(?:\^\{})?)$',
                        re.MULTILINE)
 RE_UNIX_TIME = re.compile(r'^\d{10}$', re.MULTILINE)
@@ -311,13 +312,15 @@ def clone(local_root, new_root, branch, rel_dest, exclude):
     :param iter exclude: List of strings representing relative file paths to exclude from "git rm".
     """
     log = logging.getLogger(__name__)
-    remote_url = run_command(local_root, ['git', 'ls-remote', '--get-url', 'origin']).strip()
-    if remote_url == 'origin':
-        raise GitError('Git repo missing remote "origin".', remote_url)
+    output = run_command(local_root, ['git', 'remote', '-v'])
+    remote_urls = dict((m[1], m[0]) for m in RE_FETCH_PUSH.findall(output))
+    if not remote_urls:
+        raise GitError('Git repo missing remote "origin".', output)
+    remote_push_url, remote_fetch_url = remote_urls['push'], remote_urls['fetch']
 
     # Clone.
     try:
-        run_command(new_root, ['git', 'clone', remote_url, '--depth=1', '--branch', branch, '.'])
+        run_command(new_root, ['git', 'clone', remote_fetch_url, '--depth=1', '--branch', branch, '.'])
     except CalledProcessError as exc:
         raise GitError('Failed to clone from remote repo URL.', exc.output)
 
@@ -327,6 +330,10 @@ def clone(local_root, new_root, branch, rel_dest, exclude):
     except CalledProcessError as exc:
         raise GitError('Specified branch is not a real branch.', exc.output)
 
+    # Set push URL if different.
+    if remote_fetch_url != remote_push_url:
+        run_command(new_root, ['git', 'remote', 'set-url', '--push', 'origin', remote_push_url])
+
     # Done if no exclude.
     if not exclude:
         return

tests/test_git/test_clone.py

@@ -151,10 +151,31 @@ def test_bad_branch_rel_dest_exclude(tmpdir, local, run):
     run(local, ['git', 'remote', 'rm', 'origin'])
     with pytest.raises(GitError) as exc:
         clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'master', '.', None)
-    assert 'origin' in exc.value.output
+    assert 'Git repo missing remote "origin".' in exc.value.message
+    assert not exc.value.output
 
     # Bad remote.
     run(local, ['git', 'remote', 'add', 'origin', local.join('does_not_exist')])
     with pytest.raises(GitError) as exc:
         clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'master', '.', None)
     assert "repository '{}' does not exist".format(local.join('does_not_exist')) in exc.value.output
+
+
+def test_fetch_push_remotes(tmpdir, local, remote, run):
+    """Test different fetch/push URLs being carried over.
+
+    :param tmpdir: pytest fixture.
+    :param local: conftest fixture.
+    :param remote: conftest fixture.
+    :param run: conftest fixture.
+    """
+    remote_push = tmpdir.ensure_dir('remote_push')
+    run(remote_push, ['git', 'init', '--bare'])
+    run(local, ['git', 'remote', 'set-url', '--push', 'origin', str(remote_push)])
+
+    new_root = tmpdir.ensure_dir('new_root')
+    clone(str(local), str(new_root), 'master', '', None)
+
+    output = run(new_root, ['git', 'remote', '-v'])
+    expected = 'origin\t{} (fetch)\norigin\t{} (push)\n'.format(remote, remote_push)
+    assert output == expected