registry: make GetProvider method async

mjcheetham · mjcheetham · commit 6ec2db23b3d8 · 2021-01-12T13:57:34.000Z
Make the GetProvider method on the IHostProviderRegistry interface async
in preparation for introducing some network I/O to the auto-detection of
providers.
diff --git a/src/shared/Microsoft.Git.CredentialManager.Tests/Commands/HostProviderCommandBaseTests.cs b/src/shared/Microsoft.Git.CredentialManager.Tests/Commands/HostProviderCommandBaseTests.cs
@@ -19,8 +19,8 @@ public async Task HostProviderCommandBase_ExecuteAsync_CallsExecuteInternalAsync
             var mockProvider = new Mock<IHostProvider>();
             var mockHostRegistry = new Mock<IHostProviderRegistry>();
 
-            mockHostRegistry.Setup(x => x.GetProvider(It.IsAny<InputArguments>()))
-                .Returns(mockProvider.Object)
+            mockHostRegistry.Setup(x => x.GetProviderAsync(It.IsAny<InputArguments>()))
+                .ReturnsAsync(mockProvider.Object)
                 .Verifiable();
 
             mockProvider.Setup(x => x.IsSupported(It.IsAny<InputArguments>()))
@@ -58,8 +58,8 @@ public async Task HostProviderCommandBase_ExecuteAsync_ConfiguresSettingsRemoteU
             var mockSettings = new Mock<ISettings>();
             var mockHostRegistry = new Mock<IHostProviderRegistry>();
 
-            mockHostRegistry.Setup(x => x.GetProvider(It.IsAny<InputArguments>()))
-                .Returns(mockProvider.Object);
+            mockHostRegistry.Setup(x => x.GetProviderAsync(It.IsAny<InputArguments>()))
+                .ReturnsAsync(mockProvider.Object);
 
             string standardIn = "protocol=test\nhost=example.com\npath=a/b/c\n\n";
             TextReader standardInReader = new StringReader(standardIn);
diff --git a/src/shared/Microsoft.Git.CredentialManager.Tests/HostProviderRegistryTests.cs b/src/shared/Microsoft.Git.CredentialManager.Tests/HostProviderRegistryTests.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 using System;
 using System.Collections.Generic;
+using System.Threading.Tasks;
 using Microsoft.Git.CredentialManager.Tests.Objects;
 using Moq;
 using Xunit;
@@ -39,11 +40,11 @@ public void HostProviderRegistry_GetProvider_NoProviders_ThrowException()
             var registry = new HostProviderRegistry(context);
             var input = new InputArguments(new Dictionary<string, string>());
 
-            Assert.Throws<Exception>(() => registry.GetProvider(input));
+            Assert.ThrowsAsync<Exception>(() => registry.GetProviderAsync(input));
         }
 
         [Fact]
-        public void HostProviderRegistry_GetProvider_Auto_HasProviders_ReturnsSupportedProvider()
+        public async Task HostProviderRegistry_GetProvider_Auto_HasProviders_ReturnsSupportedProvider()
         {
             var context = new TestCommandContext();
             var registry = new HostProviderRegistry(context);
@@ -58,13 +59,13 @@ public void HostProviderRegistry_GetProvider_Auto_HasProviders_ReturnsSupportedP
 
             registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);
 
-            IHostProvider result = registry.GetProvider(input);
+            IHostProvider result = await registry.GetProviderAsync(input);
 
             Assert.Same(provider2Mock.Object, result);
         }
 
         [Fact]
-        public void HostProviderRegistry_GetProvider_Auto_MultipleValidProviders_ReturnsFirstRegistered()
+        public async Task HostProviderRegistry_GetProvider_Auto_MultipleValidProviders_ReturnsFirstRegistered()
         {
             var context = new TestCommandContext();
             var registry = new HostProviderRegistry(context);
@@ -79,13 +80,13 @@ public void HostProviderRegistry_GetProvider_Auto_MultipleValidProviders_Returns
 
             registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);
 
-            IHostProvider result = registry.GetProvider(input);
+            IHostProvider result = await registry.GetProviderAsync(input);
 
             Assert.Same(provider1Mock.Object, result);
         }
 
         [Fact]
-        public void HostProviderRegistry_GetProvider_ProviderSpecified_ReturnsProvider()
+        public async Task HostProviderRegistry_GetProvider_ProviderSpecified_ReturnsProvider()
         {
             var context = new TestCommandContext
             {
@@ -106,13 +107,13 @@ public void HostProviderRegistry_GetProvider_ProviderSpecified_ReturnsProvider()
 
             registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);
 
-            IHostProvider result = registry.GetProvider(input);
+            IHostProvider result = await registry.GetProviderAsync(input);
 
             Assert.Same(provider3Mock.Object, result);
         }
 
         [Fact]
-        public void HostProviderRegistry_GetProvider_AutoProviderSpecified_ReturnsFirstSupportedProvider()
+        public async Task HostProviderRegistry_GetProvider_AutoProviderSpecified_ReturnsFirstSupportedProvider()
         {
             var context = new TestCommandContext
             {
@@ -133,13 +134,13 @@ public void HostProviderRegistry_GetProvider_AutoProviderSpecified_ReturnsFirstS
 
             registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);
 
-            IHostProvider result = registry.GetProvider(input);
+            IHostProvider result = await registry.GetProviderAsync(input);
 
             Assert.Same(provider2Mock.Object, result);
         }
 
         [Fact]
-        public void HostProviderRegistry_GetProvider_UnknownProviderSpecified_ReturnsFirstSupportedProvider()
+        public async Task HostProviderRegistry_GetProvider_UnknownProviderSpecified_ReturnsFirstSupportedProvider()
         {
             var context = new TestCommandContext
             {
@@ -160,13 +161,13 @@ public void HostProviderRegistry_GetProvider_UnknownProviderSpecified_ReturnsFir
 
             registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);
 
-            IHostProvider result = registry.GetProvider(input);
+            IHostProvider result = await registry.GetProviderAsync(input);
 
             Assert.Same(provider2Mock.Object, result);
         }
 
         [Fact]
-        public void HostProviderRegistry_GetProvider_LegacyAuthoritySpecified_ReturnsProvider()
+        public async Task HostProviderRegistry_GetProvider_LegacyAuthoritySpecified_ReturnsProvider()
         {
             var context = new TestCommandContext
             {
@@ -187,13 +188,13 @@ public void HostProviderRegistry_GetProvider_LegacyAuthoritySpecified_ReturnsPro
 
             registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);
 
-            IHostProvider result = registry.GetProvider(input);
+            IHostProvider result = await registry.GetProviderAsync(input);
 
             Assert.Same(provider2Mock.Object, result);
         }
 
         [Fact]
-        public void HostProviderRegistry_GetProvider_AutoLegacyAuthoritySpecified_ReturnsFirstSupportedProvider()
+        public async Task HostProviderRegistry_GetProvider_AutoLegacyAuthoritySpecified_ReturnsFirstSupportedProvider()
         {
             var context = new TestCommandContext
             {
@@ -214,7 +215,7 @@ public void HostProviderRegistry_GetProvider_AutoLegacyAuthoritySpecified_Return
 
             registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);
 
-            IHostProvider result = registry.GetProvider(input);
+            IHostProvider result = await registry.GetProviderAsync(input);
 
             Assert.Same(provider2Mock.Object, result);
         }
diff --git a/src/shared/Microsoft.Git.CredentialManager/Commands/Command.cs b/src/shared/Microsoft.Git.CredentialManager/Commands/Command.cs
@@ -73,7 +73,7 @@ public override async Task ExecuteAsync(ICommandContext context, string[] args)
             // Determine the host provider
             context.Trace.WriteLine("Detecting host provider for input:");
             context.Trace.WriteDictionarySecrets(inputDict, new []{ "password" }, StringComparer.OrdinalIgnoreCase);
-            IHostProvider provider = _hostProviderRegistry.GetProvider(input);
+            IHostProvider provider = await _hostProviderRegistry.GetProviderAsync(input);
             context.Trace.WriteLine($"Host provider '{provider.Name}' was selected.");
 
             await ExecuteInternalAsync(context, input, provider);
diff --git a/src/shared/Microsoft.Git.CredentialManager/HostProviderRegistry.cs b/src/shared/Microsoft.Git.CredentialManager/HostProviderRegistry.cs
@@ -3,6 +3,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Threading.Tasks;
 
 namespace Microsoft.Git.CredentialManager
 {
@@ -28,7 +29,7 @@ public interface IHostProviderRegistry : IDisposable
         /// </summary>
         /// <param name="input">Input arguments of a Git credential query.</param>
         /// <returns>A host provider that can service the given query.</returns>
-        IHostProvider GetProvider(InputArguments input);
+        Task<IHostProvider> GetProviderAsync(InputArguments input);
     }
 
     /// <summary>
@@ -72,7 +73,7 @@ public void Register(params IHostProvider[] hostProviders)
             _hostProviders.AddRange(hostProviders);
         }
 
-        public IHostProvider GetProvider(InputArguments input)
+        public Task<IHostProvider> GetProviderAsync(InputArguments input)
         {
             IHostProvider provider;
 
@@ -94,7 +95,7 @@ public IHostProvider GetProvider(InputArguments input)
                     }
                     else
                     {
-                        return provider;
+                        return Task.FromResult(provider);
                     }
                 }
             }
@@ -118,7 +119,7 @@ public IHostProvider GetProvider(InputArguments input)
                     }
                     else
                     {
-                        return provider;
+                        return Task.FromResult(provider);
                     }
                 }
             }
@@ -134,7 +135,7 @@ public IHostProvider GetProvider(InputArguments input)
                 throw new Exception("No host provider available to service this request.");
             }
 
-            return provider;
+            return Task.FromResult(provider);
         }
 
         public void Dispose()
diff --git a/src/shared/TestInfrastructure/Objects/TestHostProviderRegistry.cs b/src/shared/TestInfrastructure/Objects/TestHostProviderRegistry.cs
@@ -1,5 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
+using System.Threading.Tasks;
+
 namespace Microsoft.Git.CredentialManager.Tests.Objects
 {
     public class TestHostProviderRegistry : IHostProviderRegistry
@@ -12,9 +14,9 @@ void IHostProviderRegistry.Register(params IHostProvider[] hostProviders)
         {
         }
 
-        IHostProvider IHostProviderRegistry.GetProvider(InputArguments input)
+        Task<IHostProvider> IHostProviderRegistry.GetProviderAsync(InputArguments input)
         {
-            return Provider;
+            return Task.FromResult(Provider);
         }
 
         #endregion

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`// Licensed under the MIT license.`
`3`	`3`	`using System;`
`4`	`4`	`using System.Collections.Generic;`
	`5`	`+using System.Threading.Tasks;`
`5`	`6`	`using Microsoft.Git.CredentialManager.Tests.Objects;`
`6`	`7`	`using Moq;`
`7`	`8`	`using Xunit;`
`@@ -39,11 +40,11 @@ public void HostProviderRegistry_GetProvider_NoProviders_ThrowException()`
`39`	`40`	`var registry = new HostProviderRegistry(context);`
`40`	`41`	`var input = new InputArguments(new Dictionary<string, string>());`
`41`	`42`
`42`		`- Assert.Throws<Exception>(() => registry.GetProvider(input));`
	`43`	`+ Assert.ThrowsAsync<Exception>(() => registry.GetProviderAsync(input));`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`[Fact]`
`46`		`- public void HostProviderRegistry_GetProvider_Auto_HasProviders_ReturnsSupportedProvider()`
	`47`	`+ public async Task HostProviderRegistry_GetProvider_Auto_HasProviders_ReturnsSupportedProvider()`
`47`	`48`	`{`
`48`	`49`	`var context = new TestCommandContext();`
`49`	`50`	`var registry = new HostProviderRegistry(context);`
`@@ -58,13 +59,13 @@ public void HostProviderRegistry_GetProvider_Auto_HasProviders_ReturnsSupportedP`
`58`	`59`
`59`	`60`	`registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);`
`60`	`61`
`61`		`- IHostProvider result = registry.GetProvider(input);`
	`62`	`+ IHostProvider result = await registry.GetProviderAsync(input);`
`62`	`63`
`63`	`64`	`Assert.Same(provider2Mock.Object, result);`
`64`	`65`	`}`
`65`	`66`
`66`	`67`	`[Fact]`
`67`		`- public void HostProviderRegistry_GetProvider_Auto_MultipleValidProviders_ReturnsFirstRegistered()`
	`68`	`+ public async Task HostProviderRegistry_GetProvider_Auto_MultipleValidProviders_ReturnsFirstRegistered()`
`68`	`69`	`{`
`69`	`70`	`var context = new TestCommandContext();`
`70`	`71`	`var registry = new HostProviderRegistry(context);`
`@@ -79,13 +80,13 @@ public void HostProviderRegistry_GetProvider_Auto_MultipleValidProviders_Returns`
`79`	`80`
`80`	`81`	`registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);`
`81`	`82`
`82`		`- IHostProvider result = registry.GetProvider(input);`
	`83`	`+ IHostProvider result = await registry.GetProviderAsync(input);`
`83`	`84`
`84`	`85`	`Assert.Same(provider1Mock.Object, result);`
`85`	`86`	`}`
`86`	`87`
`87`	`88`	`[Fact]`
`88`		`- public void HostProviderRegistry_GetProvider_ProviderSpecified_ReturnsProvider()`
	`89`	`+ public async Task HostProviderRegistry_GetProvider_ProviderSpecified_ReturnsProvider()`
`89`	`90`	`{`
`90`	`91`	`var context = new TestCommandContext`
`91`	`92`	`{`
`@@ -106,13 +107,13 @@ public void HostProviderRegistry_GetProvider_ProviderSpecified_ReturnsProvider()`
`106`	`107`
`107`	`108`	`registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);`
`108`	`109`
`109`		`- IHostProvider result = registry.GetProvider(input);`
	`110`	`+ IHostProvider result = await registry.GetProviderAsync(input);`
`110`	`111`
`111`	`112`	`Assert.Same(provider3Mock.Object, result);`
`112`	`113`	`}`
`113`	`114`
`114`	`115`	`[Fact]`
`115`		`- public void HostProviderRegistry_GetProvider_AutoProviderSpecified_ReturnsFirstSupportedProvider()`
	`116`	`+ public async Task HostProviderRegistry_GetProvider_AutoProviderSpecified_ReturnsFirstSupportedProvider()`
`116`	`117`	`{`
`117`	`118`	`var context = new TestCommandContext`
`118`	`119`	`{`
`@@ -133,13 +134,13 @@ public void HostProviderRegistry_GetProvider_AutoProviderSpecified_ReturnsFirstS`
`133`	`134`
`134`	`135`	`registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);`
`135`	`136`
`136`		`- IHostProvider result = registry.GetProvider(input);`
	`137`	`+ IHostProvider result = await registry.GetProviderAsync(input);`
`137`	`138`
`138`	`139`	`Assert.Same(provider2Mock.Object, result);`
`139`	`140`	`}`
`140`	`141`
`141`	`142`	`[Fact]`
`142`		`- public void HostProviderRegistry_GetProvider_UnknownProviderSpecified_ReturnsFirstSupportedProvider()`
	`143`	`+ public async Task HostProviderRegistry_GetProvider_UnknownProviderSpecified_ReturnsFirstSupportedProvider()`
`143`	`144`	`{`
`144`	`145`	`var context = new TestCommandContext`
`145`	`146`	`{`
`@@ -160,13 +161,13 @@ public void HostProviderRegistry_GetProvider_UnknownProviderSpecified_ReturnsFir`
`160`	`161`
`161`	`162`	`registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);`
`162`	`163`
`163`		`- IHostProvider result = registry.GetProvider(input);`
	`164`	`+ IHostProvider result = await registry.GetProviderAsync(input);`
`164`	`165`
`165`	`166`	`Assert.Same(provider2Mock.Object, result);`
`166`	`167`	`}`
`167`	`168`
`168`	`169`	`[Fact]`
`169`		`- public void HostProviderRegistry_GetProvider_LegacyAuthoritySpecified_ReturnsProvider()`
	`170`	`+ public async Task HostProviderRegistry_GetProvider_LegacyAuthoritySpecified_ReturnsProvider()`
`170`	`171`	`{`
`171`	`172`	`var context = new TestCommandContext`
`172`	`173`	`{`
`@@ -187,13 +188,13 @@ public void HostProviderRegistry_GetProvider_LegacyAuthoritySpecified_ReturnsPro`
`187`	`188`
`188`	`189`	`registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);`
`189`	`190`
`190`		`- IHostProvider result = registry.GetProvider(input);`
	`191`	`+ IHostProvider result = await registry.GetProviderAsync(input);`
`191`	`192`
`192`	`193`	`Assert.Same(provider2Mock.Object, result);`
`193`	`194`	`}`
`194`	`195`
`195`	`196`	`[Fact]`
`196`		`- public void HostProviderRegistry_GetProvider_AutoLegacyAuthoritySpecified_ReturnsFirstSupportedProvider()`
	`197`	`+ public async Task HostProviderRegistry_GetProvider_AutoLegacyAuthoritySpecified_ReturnsFirstSupportedProvider()`
`197`	`198`	`{`
`198`	`199`	`var context = new TestCommandContext`
`199`	`200`	`{`
`@@ -214,7 +215,7 @@ public void HostProviderRegistry_GetProvider_AutoLegacyAuthoritySpecified_Return`
`214`	`215`
`215`	`216`	`registry.Register(provider1Mock.Object, provider2Mock.Object, provider3Mock.Object);`
`216`	`217`
`217`		`- IHostProvider result = registry.GetProvider(input);`
	`218`	`+ IHostProvider result = await registry.GetProviderAsync(input);`
`218`	`219`
`219`	`220`	`Assert.Same(provider2Mock.Object, result);`
`220`	`221`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using System;`
`4`	`4`	`using System.Collections.Generic;`
`5`	`5`	`using System.Linq;`
	`6`	`+using System.Threading.Tasks;`
`6`	`7`
`7`	`8`	`namespace Microsoft.Git.CredentialManager`
`8`	`9`	`{`
`@@ -28,7 +29,7 @@ public interface IHostProviderRegistry : IDisposable`
`28`	`29`	`/// </summary>`
`29`	`30`	`/// <param name="input">Input arguments of a Git credential query.</param>`
`30`	`31`	`/// <returns>A host provider that can service the given query.</returns>`
`31`		`- IHostProvider GetProvider(InputArguments input);`
	`32`	`+ Task<IHostProvider> GetProviderAsync(InputArguments input);`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`/// <summary>`
`@@ -72,7 +73,7 @@ public void Register(params IHostProvider[] hostProviders)`
`72`	`73`	`_hostProviders.AddRange(hostProviders);`
`73`	`74`	`}`
`74`	`75`
`75`		`- public IHostProvider GetProvider(InputArguments input)`
	`76`	`+ public Task<IHostProvider> GetProviderAsync(InputArguments input)`
`76`	`77`	`{`
`77`	`78`	`IHostProvider provider;`
`78`	`79`
`@@ -94,7 +95,7 @@ public IHostProvider GetProvider(InputArguments input)`
`94`	`95`	`}`
`95`	`96`	`else`
`96`	`97`	`{`
`97`		`- return provider;`
	`98`	`+ return Task.FromResult(provider);`
`98`	`99`	`}`
`99`	`100`	`}`
`100`	`101`	`}`
`@@ -118,7 +119,7 @@ public IHostProvider GetProvider(InputArguments input)`
`118`	`119`	`}`
`119`	`120`	`else`
`120`	`121`	`{`
`121`		`- return provider;`
	`122`	`+ return Task.FromResult(provider);`
`122`	`123`	`}`
`123`	`124`	`}`
`124`	`125`	`}`
`@@ -134,7 +135,7 @@ public IHostProvider GetProvider(InputArguments input)`
`134`	`135`	`throw new Exception("No host provider available to service this request.");`
`135`	`136`	`}`
`136`	`137`
`137`		`- return provider;`
	`138`	`+ return Task.FromResult(provider);`
`138`	`139`	`}`
`139`	`140`
`140`	`141`	`public void Dispose()`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`// Copyright (c) Microsoft Corporation. All rights reserved.`
`2`	`2`	`// Licensed under the MIT license.`
	`3`	`+using System.Threading.Tasks;`
	`4`	`+`
`3`	`5`	`namespace Microsoft.Git.CredentialManager.Tests.Objects`
`4`	`6`	`{`
`5`	`7`	`public class TestHostProviderRegistry : IHostProviderRegistry`
`@@ -12,9 +14,9 @@ void IHostProviderRegistry.Register(params IHostProvider[] hostProviders)`
`12`	`14`	`{`
`13`	`15`	`}`
`14`	`16`
`15`		`- IHostProvider IHostProviderRegistry.GetProvider(InputArguments input)`
	`17`	`+ Task<IHostProvider> IHostProviderRegistry.GetProviderAsync(InputArguments input)`
`16`	`18`	`{`
`17`		`- return Provider;`
	`19`	`+ return Task.FromResult(Provider);`
`18`	`20`	`}`
`19`	`21`
`20`	`22`	`#endregion`