Starting with small Windows fixes.

Starting working on Windows support. Git seems to behave a bit
differently on Windows.

Git always shows Unix paths in its output even on Windows. Handling.

Fixed badge in README. Forgot to update it when switching to Codecov.

Author: Robpol86

README.rst

@@ -12,8 +12,8 @@ Sphinx extension that allows building versioned docs for self-hosting.
     :target: https://travis-ci.org/Robpol86/sphinxcontrib-versioning
     :alt: Build Status
 
-.. image:: https://img.shields.io/coveralls/Robpol86/sphinxcontrib-versioning/master.svg?style=flat-square&label=Coveralls
-    :target: https://coveralls.io/github/Robpol86/sphinxcontrib-versioning
+.. image:: https://img.shields.io/codecov/c/github/Robpol86/sphinxcontrib-versioning/master.svg?style=flat-square&label=Codecov
+    :target: https://codecov.io/gh/Robpol86/sphinxcontrib-versioning
     :alt: Coverage Status
 
 .. image:: https://img.shields.io/pypi/v/sphinxcontrib-versioning.svg?style=flat-square&label=Latest

sphinxcontrib/versioning/git.py

@@ -6,12 +6,14 @@
 import os
 import re
 import shutil
+import sys
 from datetime import datetime
 from subprocess import CalledProcessError, PIPE, Popen, STDOUT
 
 from sphinxcontrib.versioning.lib import TempDir
 
-RE_ALL_REMOTES = re.compile(r'([\w./-]+)\t([A-Za-z0-9@:/._-]+) \((fetch|push)\)\n')
+IS_WINDOWS = sys.platform == 'win32'
+RE_ALL_REMOTES = re.compile(r'([\w./-]+)\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)
@@ -118,7 +120,7 @@ def run_command(local_root, command, env_var=True, piped=None):
 
     :param str local_root: Local path to git root directory.
     :param iter command: Command to run.
-    :param bool env_var: Define GIT_DIR environment variable.
+    :param bool env_var: Define GIT_DIR environment variable (on non-Windows).
     :param iter piped: Second command to pipe its stdout to `command`'s stdin.
 
     :return: Command output.
@@ -128,7 +130,7 @@ def run_command(local_root, command, env_var=True, piped=None):
 
     # Setup env.
     env = os.environ.copy()
-    if env_var:
+    if env_var and not IS_WINDOWS:
         env['GIT_DIR'] = os.path.join(local_root, '.git')
     else:
         env.pop('GIT_DIR', None)
@@ -174,6 +176,8 @@ def get_root(directory):
         output = run_command(directory, command, env_var=False)
     except CalledProcessError as exc:
         raise GitError('Failed to find local git repository root in {}.'.format(repr(directory)), exc.output)
+    if IS_WINDOWS:
+        output = output.replace('/', '\\')
     return output.strip()
 
 
@@ -395,7 +399,7 @@ def commit_and_push(local_root, remote, versions):
     for status, name in (l.split('\t', 1) for l in output.splitlines()):
         if status != 'M':
             break  # Only looking for modified files.
-        components = name.split(os.sep)
+        components = name.split('/')
         if '.doctrees' not in components and components[-1] != 'searchindex.js':
             break  # Something other than those two dirs/files has changed.
     else:

tests/test_git/test_clone.py

@@ -1,10 +1,11 @@
 """Test function in module."""
 
+from os.path import join
 from subprocess import CalledProcessError
 
 import pytest
 
-from sphinxcontrib.versioning.git import clone, GitError
+from sphinxcontrib.versioning.git import clone, GitError, IS_WINDOWS
 
 
 def test_no_exclude(tmpdir, local_docs, run):
@@ -45,7 +46,7 @@ def test_exclude(tmpdir, local, run):
     # Run.
     exclude = [
         '.travis.yml', 'appveyor.yml',  # Ignored (nonexistent), show warnings.
-        'README', 'two.txt', 'sub/four.txt',  # Only leave these.
+        'README', 'two.txt', join('sub', 'four.txt'),  # Only leave these.
     ]
     new_root = tmpdir.ensure_dir('new_root')
     clone(str(local), str(new_root), 'origin', 'feature', '.', exclude)
@@ -56,7 +57,7 @@ def test_exclude(tmpdir, local, run):
     assert new_root.join('sub', 'four.txt').read() == 'four'
     assert new_root.join('two.txt').read() == 'two'
     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/four.txt', 'two.txt']
+    assert paths == ['README', 'sub', join('sub', 'four.txt'), 'two.txt']
 
     # Verify original repo state.
     run(local, ['git', 'diff-index', '--quiet', 'HEAD', '--'])  # Verify unchanged.
@@ -88,7 +89,7 @@ def test_exclude_subdir(tmpdir, local, run):
     new_root = tmpdir.ensure_dir('new_root')
     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']
+    assert paths == ['README', 'sub', join('sub', 'three.txt')]
 
     status = run(new_root, ['git', 'status', '--porcelain'])
     assert status == 'D  sub/four.txt\n'
@@ -112,9 +113,9 @@ 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), 'origin', 'master', '.', ['*.md', '*/*.md'])
+    clone(str(local), str(new_root), 'origin', 'master', '.', ['*.md', join('*', '*.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']
+    assert paths == ['one.md', 'six.md', 'sub', join('sub', 'five.md'), join('sub', 'four.md')]
 
     status = run(new_root, ['git', 'status', '--porcelain'])
     assert status == 'D  README\nD  sub/three.txt\nD  two.txt\n'
@@ -165,8 +166,11 @@ def test_bad_branch_rel_dest_exclude(tmpdir, local, run):
     # 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')), 'origin', 'master', '.', None)
-    assert "repository '{}' does not exist".format(local.join('does_not_exist')) in exc.value.output
+        clone(str(local), str(tmpdir.ensure_dir('new_root4')), 'origin', 'master', '.', None)
+    if IS_WINDOWS:
+        assert "'{}' does not appear to be a git repository".format(local.join('does_not_exist')) in exc.value.output
+    else:
+        assert "repository '{}' does not exist".format(local.join('does_not_exist')) in exc.value.output
 
 
 def test_multiple_remotes(tmpdir, local, remote, run):

tests/test_git/test_commit_and_push.py

@@ -98,6 +98,7 @@ def test_changes(monkeypatch, local, run):
     :param local: conftest fixture.
     :param run: conftest fixture.
     """
+    monkeypatch.setenv('LANG', 'en_US.UTF-8')
     monkeypatch.setenv('TRAVIS_BUILD_ID', '12345')
     monkeypatch.setenv('TRAVIS_BRANCH', 'master')
     old_sha = run(local, ['git', 'rev-parse', 'HEAD']).strip()