Merge pull request #1913 from Hosch250/Issue1910

Hosch250 · web-flow · commit f67c6c78965f · 2016-06-24T14:12:50.000-05:00
Allow passing credentials into Clone to clone a private repository
diff --git a/RetailCoder.VBE/UI/SourceControl/SourceControlViewViewModel.cs b/RetailCoder.VBE/UI/SourceControl/SourceControlViewViewModel.cs
@@ -569,7 +569,15 @@ private void DismissErrorMessage()
 
         public void CreateProviderWithCredentials(SecureCredentials credentials)
         {
-            Provider = _providerFactory.CreateProvider(_vbe.ActiveVBProject, Provider.CurrentRepository, credentials, _wrapperFactory);
+            if (!_isCloning)
+            {
+                Provider = _providerFactory.CreateProvider(_vbe.ActiveVBProject, Provider.CurrentRepository, credentials,
+                    _wrapperFactory);
+            }
+            else
+            {
+                CloneRepo(credentials);
+            }
         }
 
         private void InitRepo()
@@ -667,15 +675,17 @@ private void OpenRepo()
             }
         }
 
-        private void CloneRepo()
+        private bool _isCloning = false;
+        private void CloneRepo(SecureCredentials credentials = null)
         {
+            _isCloning = true;
             OnOpenRepoStarted();
 
             Logger.Trace("Cloning repo");
             try
             {
                 _provider = _providerFactory.CreateProvider(_vbe.ActiveVBProject);
-                var repo = _provider.Clone(CloneRemotePath, LocalDirectory);
+                var repo = _provider.Clone(CloneRemotePath, LocalDirectory, credentials);
                 AddOrUpdateLocalPathConfig(new Repository
                 {
                     Id = _vbe.ActiveVBProject.HelpFile,
@@ -687,10 +697,17 @@ private void CloneRepo()
             }
             catch (SourceControlException ex)
             {
+                const string unauthorizedMessage = "Request failed with status code: 401";
+                if (ex.InnerException.Message != unauthorizedMessage)
+                {
+                    _isCloning = false;
+                }
+
                 ViewModel_ErrorThrown(null, new ErrorEventArgs(ex.Message, ex.InnerException.Message, NotificationType.Error));
                 return;
             }
 
+            _isCloning = false;
             OnOpenRepoCompleted();
             CloseCloneRepoGrid();
             
diff --git a/Rubberduck.SourceControl/GitProvider.cs b/Rubberduck.SourceControl/GitProvider.cs
@@ -53,10 +53,6 @@ public GitProvider(VBProject project, IRepository repository, string userName, s
             _credentialsHandler = (url, user, cred) => _credentials;
         }
 
-        public GitProvider(VBProject project, IRepository repository, ICredentials<string> credentials, ICodePaneWrapperFactory wrapperFactory)
-            :this(project, repository, credentials.Username, credentials.Password, wrapperFactory)
-        { }
-
         public GitProvider(VBProject project, IRepository repository, ICredentials<SecureString> credentials, ICodePaneWrapperFactory wrapperFactory)
             : this(project, repository, wrapperFactory)
         {
@@ -104,12 +100,28 @@ public override IList<ICommit> UnsyncedRemoteCommits
             get { return _unsyncedRemoteCommits; }
         }
 
-        public override IRepository Clone(string remotePathOrUrl, string workingDirectory)
+        public override IRepository Clone(string remotePathOrUrl, string workingDirectory, SecureCredentials credentials = null)
         {
             try
             {
                 var name = GetProjectNameFromDirectory(remotePathOrUrl);
-                LibGit2Sharp.Repository.Clone(remotePathOrUrl, workingDirectory);
+
+                if (credentials == null)
+                {
+                    LibGit2Sharp.Repository.Clone(remotePathOrUrl, workingDirectory);
+                }
+                else
+                {
+                    var credentialsHandler = new CredentialsHandler((url, usernameFromUrl, types) => new SecureUsernamePasswordCredentials
+                    {
+                        Username = credentials.Username,
+                        Password = credentials.Password
+                    });
+
+                    var options = new CloneOptions {CredentialsProvider = credentialsHandler};
+                    LibGit2Sharp.Repository.Clone(remotePathOrUrl, workingDirectory, options);
+                }
+
                 return new Repository(name, workingDirectory, remotePathOrUrl);
             }
             catch (LibGit2SharpException ex)
diff --git a/Rubberduck.SourceControl/ISourceControlProvider.cs b/Rubberduck.SourceControl/ISourceControlProvider.cs
@@ -19,8 +19,9 @@ public interface ISourceControlProvider
         /// <summary>Clone a remote repository.</summary>
         /// <param name="remotePathOrUrl">Either a Url "https://github.com/retailcoder/Rubberduck.git" or a UNC path. "//server/share/path/to/repo.git"</param>
         /// <param name="workingDirectory">Directory the repository will be cloned to.</param>
+        /// <param name="credentials">Credentials required if repository is private.</param>
         /// <returns>Newly cloned repository.</returns>
-        IRepository Clone(string remotePathOrUrl, string workingDirectory);
+        IRepository Clone(string remotePathOrUrl, string workingDirectory, SecureCredentials credentials = null);
 
         /// <summary>
         /// Creates a new repository in/from the given directory.
diff --git a/Rubberduck.SourceControl/Interop/GitProvider.cs b/Rubberduck.SourceControl/Interop/GitProvider.cs
@@ -3,6 +3,7 @@
 using System.ComponentModel;
 using System.Linq;
 using System.Runtime.InteropServices;
+using System.Security;
 using Microsoft.Vbe.Interop;
 using Rubberduck.VBEditor.VBEInterfaces.RubberduckCodePane;
 
@@ -67,5 +68,24 @@ public override void Commit(string message)
             Stage(filePaths);
             base.Commit(message);
         }
+        /// <summary>
+        /// For use by COM API only.
+        /// </summary>
+        /// <param name="remotePathOrUrl"></param>
+        /// <param name="workingDirectory"></param>
+        /// <param name="credentials"></param>
+        /// <returns></returns>
+        public IRepository Clone(string remotePathOrUrl, string workingDirectory, Credentials credentials)
+        {
+            var password = new SecureString();
+            foreach (var chr in credentials.Password)
+            {
+                password.AppendChar(chr);
+            }
+
+            credentials.Password = string.Empty;
+
+            return base.Clone(remotePathOrUrl, workingDirectory, new SecureCredentials(credentials.Username, password));
+        }
     }
 }
diff --git a/Rubberduck.SourceControl/Interop/ISourceControlProvider.cs b/Rubberduck.SourceControl/Interop/ISourceControlProvider.cs
@@ -19,7 +19,7 @@ public interface ISourceControlProvider
 
         [DispId(3)]
         [Description("Clones a remote repository to the local file system.")]
-        IRepository Clone(string remotePathOrUrl, string workingDirectory);
+        IRepository Clone(string remotePathOrUrl, string workingDirectory, Credentials credentials = null);
 
         [DispId(4)]
         [Description("Creates a new repository in/from the specified directory.")]
diff --git a/Rubberduck.SourceControl/SourceControlProviderBase.cs b/Rubberduck.SourceControl/SourceControlProviderBase.cs
@@ -33,7 +33,7 @@ protected SourceControlProviderBase(VBProject project, IRepository repository, I
         public abstract IList<ICommit> UnsyncedRemoteCommits { get; }
         public bool NotifyExternalFileChanges { get; protected set; }
         public bool HandleVbeSinkEvents { get; protected set; }
-        public abstract IRepository Clone(string remotePathOrUrl, string workingDirectory);
+        public abstract IRepository Clone(string remotePathOrUrl, string workingDirectory, SecureCredentials credentials = null);
         public abstract void Push();
         public abstract void Fetch(string remoteName);
         public abstract void AddFile(string filePath);
diff --git a/RubberduckTests/SourceControl/SourceControlViewModelTests.cs b/RubberduckTests/SourceControl/SourceControlViewModelTests.cs
@@ -70,7 +70,7 @@ public void InitializeMocks()
             _provider.SetupGet(git => git.UnsyncedLocalCommits).Returns(new List<ICommit>());
             _provider.SetupGet(git => git.UnsyncedRemoteCommits).Returns(new List<ICommit>());
             _provider.Setup(git => git.InitVBAProject(It.IsAny<string>())).Returns(GetDummyRepo());
-            _provider.Setup(git => git.Clone(It.IsAny<string>(), It.IsAny<string>())).Returns(GetDummyRepo());
+            _provider.Setup(git => git.Clone(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<SecureCredentials>())).Returns(GetDummyRepo());
             _provider.Setup(git => git.CurrentRepository).Returns(GetDummyRepo());
 
             _providerFactory = new Mock<ISourceControlProviderFactory>();
@@ -647,7 +647,7 @@ public void CloneRepo_ClonesRepo()
             _vm.CloneRepoOkButtonCommand.Execute(null);
 
             //Assert
-            _provider.Verify(git => git.Clone(remotePath, localDirectory));
+            _provider.Verify(git => git.Clone(remotePath, localDirectory, null));
         }
 
         [TestMethod]
@@ -741,7 +741,7 @@ public void CloneRepo_ActionFailedEventIsRaised()
             SetupValidVbProject();
             SetupVM();
 
-            _provider.Setup(p => p.Clone(It.IsAny<string>(), It.IsAny<string>()))
+            _provider.Setup(p => p.Clone(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<SecureCredentials>()))
                 .Throws(
                     new SourceControlException("A source control exception was thrown.",
                         new LibGit2Sharp.LibGit2SharpException("With an inner libgit2sharp exception"))

Original file line number	Diff line number	Diff line change
`@@ -569,7 +569,15 @@ private void DismissErrorMessage()`
`569`	`569`
`570`	`570`	`public void CreateProviderWithCredentials(SecureCredentials credentials)`
`571`	`571`	`{`
`572`		`- Provider = _providerFactory.CreateProvider(_vbe.ActiveVBProject, Provider.CurrentRepository, credentials, _wrapperFactory);`
	`572`	`+ if (!_isCloning)`
	`573`	`+ {`
	`574`	`+ Provider = _providerFactory.CreateProvider(_vbe.ActiveVBProject, Provider.CurrentRepository, credentials,`
	`575`	`+ _wrapperFactory);`
	`576`	`+ }`
	`577`	`+ else`
	`578`	`+ {`
	`579`	`+ CloneRepo(credentials);`
	`580`	`+ }`
`573`	`581`	`}`
`574`	`582`
`575`	`583`	`private void InitRepo()`
`@@ -667,15 +675,17 @@ private void OpenRepo()`
`667`	`675`	`}`
`668`	`676`	`}`
`669`	`677`
`670`		`- private void CloneRepo()`
	`678`	`+ private bool _isCloning = false;`
	`679`	`+ private void CloneRepo(SecureCredentials credentials = null)`
`671`	`680`	`{`
	`681`	`+ _isCloning = true;`
`672`	`682`	`OnOpenRepoStarted();`
`673`	`683`
`674`	`684`	`Logger.Trace("Cloning repo");`
`675`	`685`	`try`
`676`	`686`	`{`
`677`	`687`	`_provider = _providerFactory.CreateProvider(_vbe.ActiveVBProject);`
`678`		`- var repo = _provider.Clone(CloneRemotePath, LocalDirectory);`
	`688`	`+ var repo = _provider.Clone(CloneRemotePath, LocalDirectory, credentials);`
`679`	`689`	`AddOrUpdateLocalPathConfig(new Repository`
`680`	`690`	`{`
`681`	`691`	`Id = _vbe.ActiveVBProject.HelpFile,`
`@@ -687,10 +697,17 @@ private void CloneRepo()`
`687`	`697`	`}`
`688`	`698`	`catch (SourceControlException ex)`
`689`	`699`	`{`
	`700`	`+ const string unauthorizedMessage = "Request failed with status code: 401";`
	`701`	`+ if (ex.InnerException.Message != unauthorizedMessage)`
	`702`	`+ {`
	`703`	`+ _isCloning = false;`
	`704`	`+ }`
	`705`	`+`
`690`	`706`	`ViewModel_ErrorThrown(null, new ErrorEventArgs(ex.Message, ex.InnerException.Message, NotificationType.Error));`
`691`	`707`	`return;`
`692`	`708`	`}`
`693`	`709`
	`710`	`+ _isCloning = false;`
`694`	`711`	`OnOpenRepoCompleted();`
`695`	`712`	`CloseCloneRepoGrid();`
`696`	`713`