Cloning from push remote instead of origin.

If HTML files are pushed to another repo other than origin it doesn't
make sense to clone from origin (previous files won't be available).

Author: Robpol86

README.rst

@@ -44,6 +44,13 @@ Changelog
 
 This project adheres to `Semantic Versioning <http://semver.org/>`_.
 
+Unreleased
+----------
+
+Fixed
+    * Cloning from push remote instead of origin. If HTML files are pushed to another repo other than origin it doesn't
+      make sense to clone from origin (previous files won't be available).
+
 2.1.1 - 2016-08-23
 ------------------
 

sphinxcontrib/versioning/__main__.py

@@ -365,7 +365,7 @@ def push(ctx, config, rel_source, dest_branch, rel_dest, **options):
         with TempDir() as temp_dir:
             log.info('Cloning %s into temporary directory...', dest_branch)
             try:
-                clone(config.git_root, temp_dir, dest_branch, rel_dest, config.grm_exclude)
+                clone(config.git_root, temp_dir, config.push_remote, dest_branch, rel_dest, config.grm_exclude)
             except GitError as exc:
                 log.error(exc.message)
                 log.error(exc.output)

sphinxcontrib/versioning/git.py

@@ -299,32 +299,36 @@ def export(local_root, commit, target):
                     log.debug('Skipping broken symlink: %s', args[0])
 
 
-def clone(local_root, new_root, branch, rel_dest, exclude):
+def clone(local_root, new_root, remote, branch, rel_dest, exclude):
     """Clone "local_root" origin into a new directory and check out a specific branch. Optionally run "git rm".
 
     :raise CalledProcessError: Unhandled git command failure.
     :raise GitError: Handled git failures.
 
     :param str local_root: Local path to git root directory.
     :param str new_root: Local path empty directory in which branch will be cloned into.
+    :param str remote: The git remote to clone from to.
     :param str branch: Checkout this branch.
     :param str rel_dest: Run "git rm" on this directory if exclude is truthy.
     :param iter exclude: List of strings representing relative file paths to exclude from "git rm".
     """
     log = logging.getLogger(__name__)
     output = run_command(local_root, ['git', 'remote', '-v'])
-    matches = RE_ALL_REMOTES.findall(output)
-    if not matches:
+    remotes = dict()
+    for match in RE_ALL_REMOTES.findall(output):
+        remotes.setdefault(match[0], [None, None])
+        if match[2] == 'fetch':
+            remotes[match[0]][0] = match[1]
+        else:
+            remotes[match[0]][1] = match[1]
+    if not remotes:
         raise GitError('Git repo has no remotes.', output)
-    remotes = {m[0]: [m[1], ''] for m in matches if m[2] == 'fetch'}
-    for match in (m for m in matches if m[2] == 'push'):
-        remotes[match[0]][1] = match[1]
-    if 'origin' not in remotes:
-        raise GitError('Git repo missing remote "origin".', output)
+    if remote not in remotes:
+        raise GitError('Git repo missing remote "{}".'.format(remote), output)
 
     # Clone.
     try:
-        run_command(new_root, ['git', 'clone', remotes['origin'][0], '--depth=1', '--branch', branch, '.'])
+        run_command(new_root, ['git', 'clone', remotes[remote][0], '--depth=1', '--branch', branch, '.'])
     except CalledProcessError as exc:
         raise GitError('Failed to clone from remote repo URL.', exc.output)
 
@@ -336,8 +340,7 @@ def clone(local_root, new_root, branch, rel_dest, exclude):
 
     # Copy all remotes from original repo.
     for name, (fetch, push) in remotes.items():
-        if name != 'origin':
-            run_command(new_root, ['git', 'remote', 'add', name, fetch])
+        run_command(new_root, ['git', 'remote', 'set-url' if name == 'origin' else 'add', name, fetch])
         run_command(new_root, ['git', 'remote', 'set-url', '--push', name, push])
 
     # Done if no exclude.

tests/test__main__/test_main_push_scenarios.py

@@ -164,41 +164,115 @@ def test_race(tmpdir, local_docs_ghp, remote, run, urls, give_up):
     assert actual == 'Orphaned branch for HTML docs.changed'
 
 
-def test_second_remote(tmpdir, local_docs_ghp, run, urls):
-    """Test pushing to a non-origin remote.
+def test_different_push(tmpdir, local_docs_ghp, run, urls):
+    """Test pushing to a different remote URL.
 
     :param tmpdir: pytest fixture.
     :param local_docs_ghp: conftest fixture.
     :param run: conftest fixture.
     :param urls: conftest fixture.
     """
+    remote2 = tmpdir.ensure_dir('remote2')
+    run(local_docs_ghp, ['git', 'remote', 'set-url', 'origin', '--push', remote2])
+
     # Error out because remote2 doesn't exist yet.
     with pytest.raises(CalledProcessError) as exc:
-        run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'remote2'])
+        run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.'])
     assert 'Traceback' not in exc.value.output
     assert 'Failed to push to remote.' in exc.value.output
-    assert "fatal: 'remote2' does not appear to be a git repository" in exc.value.output
+    assert "remote2' does not appear to be a git repository" in exc.value.output
+
+    # Create remote2.
+    run(remote2, ['git', 'init', '--bare'])
+
+    # Run again.
+    output = run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.'])
+    assert 'Traceback' not in output
+    assert 'Successfully pushed to remote repository.' in output
+
+    # Check files.
+    run(local_docs_ghp, ['git', 'fetch', 'origin'])
+    run(local_docs_ghp, ['git', 'checkout', 'origin/gh-pages'])
+    assert not local_docs_ghp.join('contents.html').check()
+    assert not local_docs_ghp.join('master').check()
+    run(local_docs_ghp, ['git', 'remote', 'add', 'remote2', remote2])
+    run(local_docs_ghp, ['git', 'fetch', 'remote2'])
+    run(local_docs_ghp, ['git', 'checkout', 'remote2/gh-pages'])
+    urls(local_docs_ghp.join('contents.html'), ['<li><a href="master/contents.html">master</a></li>'])
+    urls(local_docs_ghp.join('master', 'contents.html'), ['<li><a href="contents.html">master</a></li>'])
+
+
+@pytest.mark.parametrize('remove', [True, False])
+def test_second_remote(tmpdir, local_docs_ghp, run, urls, remove):
+    """Test pushing to a non-origin remote without the original remote having the destination branch.
+
+    :param tmpdir: pytest fixture.
+    :param local_docs_ghp: conftest fixture.
+    :param run: conftest fixture.
+    :param urls: conftest fixture.
+    :param bool remove: Remove gh-pages from origin.
+    """
+    if remove:
+        run(local_docs_ghp, ['git', 'push', 'origin', '--delete', 'gh-pages'])
 
     # Create remote2.
     remote2 = tmpdir.ensure_dir('remote2')
     run(remote2, ['git', 'init', '--bare'])
+    local2 = tmpdir.ensure_dir('local2')
+    run(local2, ['git', 'clone', remote2, '.'])
+    run(local2, ['git', 'checkout', '-b', 'gh-pages'])
+    local2.ensure('README')
+    run(local2, ['git', 'add', 'README'])
+    run(local2, ['git', 'commit', '-m', 'Initial commit.'])
+    run(local2, ['git', 'push', 'origin', 'gh-pages'])
     run(local_docs_ghp, ['git', 'remote', 'add', 'remote2', remote2])
-    run(local_docs_ghp, ['git', 'push', 'remote2', 'gh-pages'])
+    run(local_docs_ghp, ['git', 'fetch', 'remote2'])
+
+    # Run.
+    output = run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'remote2'])
+    assert 'Traceback' not in output
+    assert 'Successfully pushed to remote repository.' in output
+
+    # Check files.
+    run(local_docs_ghp, ['git', 'fetch', 'remote2'])
+    run(local_docs_ghp, ['git', 'checkout', 'remote2/gh-pages'])
+    urls(local_docs_ghp.join('contents.html'), ['<li><a href="master/contents.html">master</a></li>'])
+    urls(local_docs_ghp.join('master', 'contents.html'), ['<li><a href="contents.html">master</a></li>'])
+    if remove:
+        with pytest.raises(CalledProcessError) as exc:
+            run(local_docs_ghp, ['git', 'checkout', 'origin/gh-pages'])
+        assert "origin/gh-pages' did not match any file(s) known to git." in exc.value.output
+    else:
+        run(local_docs_ghp, ['git', 'checkout', 'origin/gh-pages'])
+        run(local_docs_ghp, ['git', 'pull', 'origin', 'gh-pages'])
+        assert not local_docs_ghp.join('contents.html').check()
+        assert not local_docs_ghp.join('master').check()
 
     # Run again.
+    run(local_docs_ghp, ['git', 'checkout', 'master'])
+    local_docs_ghp.join('contents.rst').write('\nNew Line Added\n', mode='a')
+    run(local_docs_ghp, ['git', 'commit', '-am', 'Adding new line.'])
+    run(local_docs_ghp, ['git', 'push', 'origin', 'master'])
     output = run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'remote2'])
     assert 'Traceback' not in output
     assert 'Successfully pushed to remote repository.' in output
 
     # Check files.
+    run(local_docs_ghp, ['git', 'fetch', 'remote2'])
     run(local_docs_ghp, ['git', 'checkout', 'remote2/gh-pages'])
-    run(local_docs_ghp, ['git', 'pull', 'remote2', 'gh-pages'])
     urls(local_docs_ghp.join('contents.html'), ['<li><a href="master/contents.html">master</a></li>'])
     urls(local_docs_ghp.join('master', 'contents.html'), ['<li><a href="contents.html">master</a></li>'])
-    run(local_docs_ghp, ['git', 'checkout', 'origin/gh-pages'])
-    run(local_docs_ghp, ['git', 'pull', 'origin', 'gh-pages'])
-    assert not local_docs_ghp.join('contents.html').check()
-    assert not local_docs_ghp.join('master').check()
+    contents = local_docs_ghp.join('contents.html').read()
+    assert 'New Line Added' in contents
+    if remove:
+        with pytest.raises(CalledProcessError) as exc:
+            run(local_docs_ghp, ['git', 'checkout', 'origin/gh-pages'])
+        assert "origin/gh-pages' did not match any file(s) known to git." in exc.value.output
+    else:
+        run(local_docs_ghp, ['git', 'checkout', 'origin/gh-pages'])
+        run(local_docs_ghp, ['git', 'pull', 'origin', 'gh-pages'])
+        assert not local_docs_ghp.join('contents.html').check()
+        assert not local_docs_ghp.join('master').check()
 
 
 def test_error_clone_failure(local_docs, run):

tests/test_git/test_clone.py

@@ -15,7 +15,7 @@ def test_no_exclude(tmpdir, local_docs, run):
     :param run: conftest fixture.
     """
     new_root = tmpdir.ensure_dir('new_root')
-    clone(str(local_docs), str(new_root), 'master', '', None)
+    clone(str(local_docs), str(new_root), 'origin', 'master', '', None)
     assert new_root.join('conf.py').check(file=True)
     assert new_root.join('contents.rst').check(file=True)
     assert new_root.join('README').check(file=True)
@@ -48,7 +48,7 @@ def test_exclude(tmpdir, local, run):
         'README', 'two.txt', 'sub/four.txt',  # Only leave these.
     ]
     new_root = tmpdir.ensure_dir('new_root')
-    clone(str(local), str(new_root), 'feature', '.', exclude)
+    clone(str(local), str(new_root), 'origin', 'feature', '.', exclude)
 
     # Verify files.
     assert new_root.join('.git').check(dir=True)
@@ -86,7 +86,7 @@ def test_exclude_subdir(tmpdir, local, run):
     run(local, ['git', 'push', 'origin', 'master'])
 
     new_root = tmpdir.ensure_dir('new_root')
-    clone(str(local), str(new_root), 'master', 'sub', ['three.txt'])
+    clone(str(local), str(new_root), 'origin', 'master', 'sub', ['three.txt'])
     paths = sorted(f.relto(new_root) for f in new_root.visit() if new_root.join('.git') not in f.parts())
     assert paths == ['README', 'sub', 'sub/three.txt']
 
@@ -112,7 +112,7 @@ def test_exclude_patterns(tmpdir, local, run):
     run(local, ['git', 'push', 'origin', 'master'])
 
     new_root = tmpdir.ensure_dir('new_root')
-    clone(str(local), str(new_root), 'master', '.', ['*.md', '*/*.md'])
+    clone(str(local), str(new_root), 'origin', 'master', '.', ['*.md', '*/*.md'])
     paths = sorted(f.relto(new_root) for f in new_root.visit() if new_root.join('.git') not in f.parts())
     assert paths == ['one.md', 'six.md', 'sub', 'sub/five.md', 'sub/four.md']
 
@@ -129,43 +129,43 @@ def test_bad_branch_rel_dest_exclude(tmpdir, local, run):
     """
     # Unknown branch.
     with pytest.raises(GitError) as exc:
-        clone(str(local), str(tmpdir.ensure_dir('new_root')), 'unknown_branch', '.', None)
+        clone(str(local), str(tmpdir.ensure_dir('new_root')), 'origin', 'unknown_branch', '.', None)
     assert 'Remote branch unknown_branch not found in upstream origin' in exc.value.output
 
     # Not a branch.
     with pytest.raises(GitError) as exc:
-        clone(str(local), str(tmpdir.ensure_dir('new_root')), 'light_tag', '.', None)
+        clone(str(local), str(tmpdir.ensure_dir('new_root')), 'origin', 'light_tag', '.', None)
     assert 'fatal: ref HEAD is not a symbolic ref' in exc.value.output
 
     # rel_dest outside of repo.
     with pytest.raises(GitError) as exc:
-        clone(str(local), str(tmpdir.ensure_dir('new_root2')), 'master', '..', ['README'])
+        clone(str(local), str(tmpdir.ensure_dir('new_root2')), 'origin', 'master', '..', ['README'])
     assert "'..' is outside repository" in exc.value.output
 
     # rel_dest invalid.
     with pytest.raises(GitError) as exc:
-        clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'master', 'unknown', ['README'])
+        clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'origin', 'master', 'unknown', ['README'])
     assert "pathspec 'unknown' did not match any files" in exc.value.output
 
     # No origin.
     run(local, ['git', 'remote', 'rename', 'origin', 'origin2'])
     with pytest.raises(GitError) as exc:
-        clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'master', '.', None)
+        clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'origin', 'master', '.', None)
     assert 'Git repo missing remote "origin".' in exc.value.message
     assert 'origin2\t' in exc.value.output
     assert 'origin\t' not in exc.value.output
 
     # No remote.
     run(local, ['git', 'remote', 'rm', 'origin2'])
     with pytest.raises(GitError) as exc:
-        clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'master', '.', None)
+        clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'origin', 'master', '.', None)
     assert 'Git repo has no remotes.' 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)
+        clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'origin', 'master', '.', None)
     assert "repository '{}' does not exist".format(local.join('does_not_exist')) in exc.value.output
 
 
@@ -188,7 +188,7 @@ def test_multiple_remotes(tmpdir, local, remote, run):
     run(local, ['git', 'remote', 'set-url', '--push', 'origin2', str(origin2_push)])
 
     new_root = tmpdir.ensure_dir('new_root')
-    clone(str(local), str(new_root), 'master', '', None)
+    clone(str(local), str(new_root), 'origin', 'master', '', None)
 
     output = run(new_root, ['git', 'remote', '-v'])
     actual = output.strip().splitlines()