Merge pull request #256 from pascalberger/feature/client-factory-unification

Unify client factory interfaces

Author: pascalberger

src/Cake.AzureDevOps/BuildClientFactory.cs

@@ -9,13 +9,13 @@
     /// <inheritdoc />
     internal class BuildClientFactory : IBuildClientFactory
     {
-        /// <summary>
-        /// Creates a client object for communicating with Azure DevOps.
-        /// </summary>
-        /// <param name="collectionUrl">The URL of the Azure DevOps team project collection.</param>
-        /// <param name="credentials">The credentials to connect to Azure DevOps.</param>
-        /// <param name="authorizedIdentity">Returns identity which is authorized.</param>
-        /// <returns>Client object for communicating with Azure DevOps.</returns>
+        /// <inheritdoc/>
+        public BuildHttpClient CreateBuildClient(Uri collectionUrl, IAzureDevOpsCredentials credentials)
+        {
+            return this.CreateBuildClient(collectionUrl, credentials, out _);
+        }
+
+        /// <inheritdoc/>
         public BuildHttpClient CreateBuildClient(Uri collectionUrl, IAzureDevOpsCredentials credentials, out Identity authorizedIdentity)
         {
             var connection =
@@ -31,16 +31,5 @@ public BuildHttpClient CreateBuildClient(Uri collectionUrl, IAzureDevOpsCredenti
 
             return buildClient;
         }
-
-        /// <summary>
-        /// Creates a client object for communicating with Azure DevOps.
-        /// </summary>
-        /// <param name="collectionUrl">The URL of the Azure DevOps team project collection.</param>
-        /// <param name="credentials">The credentials to connect to Azure DevOps.</param>
-        /// <returns>Client object for communicating with Azure DevOps.</returns>
-        public BuildHttpClient CreateBuildClient(Uri collectionUrl, IAzureDevOpsCredentials credentials)
-        {
-            return this.CreateBuildClient(collectionUrl, credentials, out _);
-        }
     }
 }

src/Cake.AzureDevOps/GitClientFactory.cs

@@ -9,13 +9,13 @@
     /// <inheritdoc />
     internal class GitClientFactory : IGitClientFactory
     {
-        /// <summary>
-        /// Creates a client object for communicating with Azure DevOps.
-        /// </summary>
-        /// <param name="collectionUrl">The URL of the Azure DevOps team project collection.</param>
-        /// <param name="credentials">The credentials to connect to Azure DevOps.</param>
-        /// <param name="authorizedIdentity">Returns identity which is authorized.</param>
-        /// <returns>Client object for communicating with Azure DevOps.</returns>
+        /// <inheritdoc/>
+        public GitHttpClient CreateGitClient(Uri collectionUrl, IAzureDevOpsCredentials credentials)
+        {
+            return this.CreateGitClient(collectionUrl, credentials, out _);
+        }
+
+        /// <inheritdoc/>
         public GitHttpClient CreateGitClient(Uri collectionUrl, IAzureDevOpsCredentials credentials, out Identity authorizedIdentity)
         {
             var connection =
@@ -31,16 +31,5 @@ public GitHttpClient CreateGitClient(Uri collectionUrl, IAzureDevOpsCredentials
 
             return gitClient;
         }
-
-        /// <summary>
-        /// Creates a client object for communicating with Azure DevOps.
-        /// </summary>
-        /// <param name="collectionUrl">The URL of the Azure DevOps team project collection.</param>
-        /// <param name="credentials">The credentials to connect to Azure DevOps.</param>
-        /// <returns>Client object for communicating with Azure DevOps.</returns>
-        public GitHttpClient CreateGitClient(Uri collectionUrl, IAzureDevOpsCredentials credentials)
-        {
-            return this.CreateGitClient(collectionUrl, credentials, out _);
-        }
     }
 }

src/Cake.AzureDevOps/IBuildClientFactory.cs

@@ -23,8 +23,8 @@ internal interface IBuildClientFactory
         /// </summary>
         /// <param name="collectionUrl">The URL of the Azure DevOps team project collection.</param>
         /// <param name="credentials">The credentials to connect to Azure DevOps.</param>
-        /// <param name="identity">Returns identity which is authorized.</param>
+        /// <param name="authorizedIdentity">Returns identity which is authorized.</param>
         /// <returns>The instance of <see cref="BuildHttpClient"/> class.</returns>
-        BuildHttpClient CreateBuildClient(Uri collectionUrl, IAzureDevOpsCredentials credentials, out Identity identity);
+        BuildHttpClient CreateBuildClient(Uri collectionUrl, IAzureDevOpsCredentials credentials, out Identity authorizedIdentity);
     }
 }

src/Cake.AzureDevOps/IGitClientFactory.cs

@@ -23,8 +23,8 @@ internal interface IGitClientFactory
         /// </summary>
         /// <param name="collectionUrl">The URL of the Azure DevOps team project collection.</param>
         /// <param name="credentials">The credentials to connect to Azure DevOps.</param>
-        /// <param name="identity">Returns identity which is authorized.</param>
+        /// <param name="authorizedIdentity">Returns identity which is authorized.</param>
         /// <returns>The instance of <see cref="GitHttpClient"/> class.</returns>
-        GitHttpClient CreateGitClient(Uri collectionUrl, IAzureDevOpsCredentials credentials, out Identity identity);
+        GitHttpClient CreateGitClient(Uri collectionUrl, IAzureDevOpsCredentials credentials, out Identity authorizedIdentity);
     }
 }

src/Cake.AzureDevOps/ITestManagementClientFactory.cs

@@ -1,8 +1,9 @@
 namespace Cake.AzureDevOps
 {
     using System;
+    using Cake.AzureDevOps.Authentication;
     using Microsoft.TeamFoundation.TestManagement.WebApi;
-    using Microsoft.VisualStudio.Services.Common;
+    using Microsoft.VisualStudio.Services.Identity;
 
     /// <summary>
     /// The interface for a Git client factory.
@@ -15,6 +16,15 @@ internal interface ITestManagementClientFactory
         /// <param name="collectionUrl">The URL of the Azure DevOps team project collection.</param>
         /// <param name="credentials">The credentials to connect to Azure DevOps.</param>
         /// <returns>The instance of <see cref="TestManagementHttpClient"/> class.</returns>
-        TestManagementHttpClient CreateTestManagementClient(Uri collectionUrl, VssCredentials credentials);
+        TestManagementHttpClient CreateTestManagementClient(Uri collectionUrl, IAzureDevOpsCredentials credentials);
+
+        /// <summary>
+        /// Creates the instance of the <see cref="TestManagementHttpClient"/> class.
+        /// </summary>
+        /// <param name="collectionUrl">The URL of the Azure DevOps team project collection.</param>
+        /// <param name="credentials">The credentials to connect to Azure DevOps.</param>
+        /// <param name="authorizedIdentity">Returns identity which is authorized.</param>
+        /// <returns>The instance of <see cref="TestManagementHttpClient"/> class.</returns>
+        TestManagementHttpClient CreateTestManagementClient(Uri collectionUrl, IAzureDevOpsCredentials credentials, out Identity authorizedIdentity);
     }
 }

src/Cake.AzureDevOps/Pipelines/AzureDevOpsBuild.cs

@@ -417,7 +417,7 @@ public IEnumerable<AzureDevOpsTestRun> GetTestRuns()
                 return new List<AzureDevOpsTestRun>();
             }
 
-            using (var testClient = this.testClientFactory.CreateTestManagementClient(this.CollectionUrl, this.credentials.ToVssCredentials()))
+            using (var testClient = this.testClientFactory.CreateTestManagementClient(this.CollectionUrl, this.credentials))
             {
                 return
                     testClient

src/Cake.AzureDevOps/TestManagementClientFactory.cs

@@ -1,16 +1,34 @@
 namespace Cake.AzureDevOps
 {
     using System;
+    using Cake.AzureDevOps.Authentication;
     using Microsoft.TeamFoundation.TestManagement.WebApi;
-    using Microsoft.VisualStudio.Services.Common;
+    using Microsoft.VisualStudio.Services.Identity;
+    using Microsoft.VisualStudio.Services.WebApi;
 
     /// <inheritdoc />
     internal class TestManagementClientFactory : ITestManagementClientFactory
     {
+        /// <inheritdoc/>
+        public TestManagementHttpClient CreateTestManagementClient(Uri collectionUrl, IAzureDevOpsCredentials credentials)
+        {
+            return this.CreateTestManagementClient(collectionUrl, credentials, out _);
+        }
+
         /// <inheritdoc />
-        public TestManagementHttpClient CreateTestManagementClient(Uri collectionUrl, VssCredentials credentials)
+        public TestManagementHttpClient CreateTestManagementClient(Uri collectionUrl, IAzureDevOpsCredentials credentials, out Identity authorizedIdentity)
         {
-            TestManagementHttpClient testClient = new TestManagementHttpClient(collectionUrl, credentials);
+            var connection =
+                new VssConnection(collectionUrl, credentials.ToVssCredentials());
+
+            authorizedIdentity = connection.AuthorizedIdentity;
+
+            var testClient = connection.GetClient<TestManagementHttpClient>();
+            if (testClient == null)
+            {
+                throw new AzureDevOpsException("Could not retrieve the TestManagementHttpClient object");
+            }
+
             return testClient;
         }
     }