Merge 6a9295e into f5b93c6

Author: Daniel B

.pylint.ini

@@ -125,6 +125,7 @@ disable=
     too-many-branches,
     keyword-arg-before-vararg,
     logging-not-lazy,
+    redefined-builtin,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -268,7 +269,7 @@ indent-after-paren=4
 indent-string='    '
 
 # Maximum number of characters on a single line.
-max-line-length=79
+max-line-length=100
 
 # Maximum number of lines in a module
 max-module-lines=1000

Pipfile

@@ -25,6 +25,7 @@ pytest-describe = "*"
 pytest-expecter = "*"
 pytest-random = "*"
 pytest-cov = "*"
+pathlib2 = "*"
 freezegun = "*"
 
 # Reports

Pipfile.lock

@@ -0,0 +1,64 @@
+# Git SVN Setup
+
+## Install missing SVN packages
+
+```shell
+sudo apt-get install git-svn
+sudo apt-get install subversion libapache2-svn 
+```
+
+## Credentials
+
+In order for `gitman` to interact with `git svn`, it must be configured to store your SVN credentials (cached) for private repository access.
+
+
+To test, trying cloning one of your private repositories:
+
+```shell
+$ git svn clone -r <rev> <repo>
+```
+
+### Option 1: Enter manually credentials
+
+If authentication realm is not already properly configured then Username and Password needs to be entered. 
+
+For example:
+
+```shell
+$ git svn clone -r HEAD http://my-svn-repo/trunk/MyDirectory
+Initialized empty Git repository in /home/Dev/MyDirectory/.git/
+Authentication realm: <http://my-svn-repo:80> my-svn-repo repository access
+Username: JohnDoe
+Password for 'John Doe'
+```
+
+This credentials should be cached afterwards.
+For further information about caching credentials see [here](http://svnbook.red-bean.com/vi/1.8/svn.serverconfig.netmodel.html).
+
+### Option 2: Manually store Credentials
+
+1. Generate the MD5 hash of the realmstring of the repository provider. 
+2. Create a file under /home/<username>/.subversion/auth/svn.simple, where the filename is the md5 hash. This is how `git svn` will find the credentials when challenged.
+3. The content of the file will have key value pairs as shown below:
+
+```
+K 8
+passtype
+V 6
+simple
+K 8
+password
+V <password character count>
+<password>
+K 15
+svn:realmstring
+V 50
+<repo> <repo name>
+K 8
+username
+V <username character count>
+<username>
+END
+```
+
+4. Now both `git svn` and `svn` should be able to check out from the repo without asking for credentials.

docs/setup/git-svn.md

@@ -0,0 +1,52 @@
+# Using Git SVN
+
+Many development projects use Subversion (SVN) to manage their source code. It’s the most popular open source VCS and has been around for nearly a decade. It’s also very similar in many ways to CVS, which was the big boy of the source-control world before that.
+
+One of Git’s great features is a bidirectional bridge to Subversion called `git svn`. This tool allows you to use Git as a valid client to a Subversion server, so you can use all the local features of Git and then push to a Subversion server as if you were using Subversion locally.
+
+The gitman git svn support allows you to resolve SVN source dependencies. The gitman does resolve a specified SVN revision (e.g. HEAD) of an SVN repository source dependency (from whole branches to particular subdirectories). 
+
+> **Important**
+>
+> The gitman `git svn` support does currently not track any changes in the imported svn repository.
+> The focus of this feature is to just import svn dependencies
+> in a readonly fashion.
+> In this matter any changes in the imported svn repository
+> will be overridden by an update/install process (like an implicit `--force` for each gitman command).
+
+To import svn repositories it is required to specify the repo source parameter `type` to `git-svn` for the corresponding entries.
+
+Example Configuration:
+
+```yaml
+location: imports
+
+sources:
+- name: MyDirectory
+  type: git-svn
+  repo: http:http://my-svn-repo/trunk/MyDirectory
+  rev: HEAD
+
+- name: MySecondDirectory
+  type: git-svn
+  repo: http:http://my-svn-repo/trunk/MySecondDirectory
+  rev: 72846
+
+- name: lz4
+  type: git
+  repo: https://github.com/lz4/lz4
+  rev: v1.8.1.2
+
+```
+
+By default the repo source parameter `type` is `git`.
+
+> **Note** 
+>
+> The gitman `git svn` support uses internally 
+> ```shell
+> $ git svn clone -r <rev> <repo>
+> ```
+> to resolve the individual SVN source dependency. In this matter only the specified svn revsion will be fetched (shallow history).
+
+

docs/use-cases/git-svn.md

@@ -34,7 +34,8 @@ def init():
 
     else:
         config = Config()
-        source = Source(name="sample_dependency",
+        source = Source('git',
+                        name="sample_dependency",
                         repo="https://github.com/githubtraining/hellogitworld")
         config.sources.append(source)
         source = source.lock(rev="ebbbf773431ba07510251bb03f9525c7bab2b13a")

gitman/commands.py

@@ -5,6 +5,8 @@
 import re
 from contextlib import suppress
 
+import shutil
+
 from . import common, settings
 from .exceptions import ShellError
 from .shell import call
@@ -16,11 +18,20 @@
 def git(*args, **kwargs):
     return call('git', *args, **kwargs)
 
+def gitsvn(*args, **kwargs):
+    return call('git', 'svn', *args, **kwargs) 
 
-def clone(repo, path, *, cache=settings.CACHE, sparse_paths=None, rev=None):
+def clone(type, repo, path, *, cache=settings.CACHE, sparse_paths=None, rev=None):
     """Clone a new Git repository."""
     log.debug("Creating a new repository...")
 
+    if type == 'git-svn':
+        # just the preperation for the svn deep clone / checkout here (clone will be made in update function to simplify source.py).
+        os.makedirs(path)
+        return
+
+    assert type == 'git'
+
     name = repo.split('/')[-1]
     if name.endswith(".git"):
         name = name[:-4]
@@ -50,6 +61,7 @@ def clone(repo, path, *, cache=settings.CACHE, sparse_paths=None, rev=None):
         git('clone', '--reference', reference, repo, os.path.normpath(path))
 
 
+
 def is_sha(rev):
     """Heuristically determine whether a revision corresponds to a commit SHA.
 
@@ -60,8 +72,15 @@ def is_sha(rev):
     return re.match('^[0-9a-f]{7,40}$', rev) is not None
 
 
-def fetch(repo, rev=None):
+def fetch(type, repo, path, rev=None):
     """Fetch the latest changes from the remote repository."""
+    
+    if type == 'git-svn':
+        # deep clone happens in update function
+        return
+    
+    assert type == 'git'
+
     git('remote', 'set-url', 'origin', repo)
     args = ['fetch', '--tags', '--force', '--prune', 'origin']
     if rev:
@@ -86,10 +105,16 @@ def valid():
         return True
 
 
-def changes(include_untracked=False, display_status=True, _show=False):
+def changes(type, include_untracked=False, display_status=True, _show=False):
     """Determine if there are changes in the working tree."""
     status = False
 
+    if type == 'git-svn':
+        # ignore changes in case of git-svn
+        return status
+
+    assert type == 'git'
+    
     try:
         # Refresh changes
         git('update-index', '-q', '--refresh', _show=False)
@@ -114,7 +139,25 @@ def changes(include_untracked=False, display_status=True, _show=False):
     return status
 
 
-def update(rev, *, clean=True, fetch=False):  # pylint: disable=redefined-outer-name
+def update(type, repo, path, *, clean=True, fetch=False, rev=None):  # pylint: disable=redefined-outer-name
+ 
+    if type == 'git-svn':
+        # make deep clone here for simplification of sources.py
+        # and to realize consistent readonly clone (always forced)
+        
+        # completly empty current directory (remove also hidden content)
+        for root, dirs, files in os.walk('.'):
+            for f in files:
+                os.unlink(os.path.join(root, f))
+            for d in dirs:
+                shutil.rmtree(os.path.join(root, d))
+        
+        # clone specified svn revision 
+        gitsvn('clone', '-r', rev, repo, '.')
+        return
+
+    assert type == 'git'
+
     """Update the working tree to the specified revision."""
     hide = {'_show': False, '_ignore': True}
 
@@ -131,21 +174,40 @@ def update(rev, *, clean=True, fetch=False):  # pylint: disable=redefined-outer-
         git('pull', '--ff-only', '--no-rebase', **hide)
 
 
-def get_url():
+def get_url(type):
     """Get the current repository's URL."""
+    if type == 'git-svn':
+        return git('config', '--get', 'svn-remote.svn.url', _show=False)[0]
+    
+    assert type == 'git'
+
     return git('config', '--get', 'remote.origin.url', _show=False)[0]
 
 
-def get_hash(_show=False):
+def get_hash(type, _show=False):
     """Get the current working tree's hash."""
+    if type == 'git-svn':
+        return ''.join(filter(str.isdigit, gitsvn('info', _show=_show)[4]))
+    
+    assert type == 'git'
+    
     return git('rev-parse', 'HEAD', _show=_show)[0]
 
-
 def get_tag():
     """Get the current working tree's tag (if on a tag)."""
     return git('describe', '--tags', '--exact-match',
                _show=False, _ignore=True)[0]
 
+def is_fetch_required(type, rev):
+    if type == 'git-svn':
+        return False
+   
+    assert type == 'git'
+
+    return rev not in (get_branch(),
+                        get_hash(type),
+                        get_tag())
+
 
 def get_branch():
     """Get the current working tree's branch."""