Merge pull request #244 from phlorian/feature/gh-243

(GH-243) Add test runs and test results to build

Author: pascalberger

src/Cake.AzureDevOps/Cake.AzureDevOps.csproj

@@ -75,6 +75,9 @@
       <TfmSpecificPackageFile Include="$(OutputPath)\**\Microsoft.TeamFoundation.SourceControl.WebApi.dll">
         <PackagePath>lib\$(TargetFramework)\</PackagePath>
       </TfmSpecificPackageFile>
+      <TfmSpecificPackageFile Include="$(OutputPath)\**\Microsoft.TeamFoundation.TestManagement.WebApi.dll">
+        <PackagePath>lib\$(TargetFramework)\</PackagePath>
+      </TfmSpecificPackageFile>
       <TfmSpecificPackageFile Include="$(OutputPath)\**\Microsoft.VisualStudio.Services.Client.Interactive.dll">
         <PackagePath>lib\$(TargetFramework)\</PackagePath>
       </TfmSpecificPackageFile>

src/Cake.AzureDevOps/Pipelines/AzureDevOpsBuild.cs

@@ -3,9 +3,11 @@
     using System;
     using System.Collections.Generic;
     using System.Linq;
+    using System.Threading.Tasks;
     using Cake.AzureDevOps.Authentication;
     using Cake.Core.Diagnostics;
     using Microsoft.TeamFoundation.Build.WebApi;
+    using Microsoft.TeamFoundation.TestManagement.WebApi;
 
     /// <summary>
     /// Class for writing issues to Azure DevOps pull requests.
@@ -16,6 +18,7 @@ public sealed class AzureDevOpsBuild
         private readonly IAzureDevOpsCredentials credentials;
         private readonly bool throwExceptionIfBuildCouldNotBeFound;
         private readonly IBuildClientFactory buildClientFactory;
+        private readonly ITestManagementClientFactory testClientFactory;
         private readonly Build build;
 
         /// <summary>
@@ -45,6 +48,7 @@ internal AzureDevOpsBuild(ICakeLog log, AzureDevOpsBuildsSettings settings, Buil
             this.log = log;
             this.build = build;
             this.buildClientFactory = new BuildClientFactory();
+            this.testClientFactory = new TestManagementClientFactory();
             this.credentials = settings.Credentials;
             this.CollectionUrl = settings.CollectionUrl;
         }
@@ -65,6 +69,7 @@ internal AzureDevOpsBuild(ICakeLog log, AzureDevOpsBuildSettings settings, IBuil
 
             this.log = log;
             this.buildClientFactory = buildClientFactory;
+            this.testClientFactory = new TestManagementClientFactory();
             this.credentials = settings.Credentials;
             this.CollectionUrl = settings.CollectionUrl;
             this.throwExceptionIfBuildCouldNotBeFound = settings.ThrowExceptionIfBuildCouldNotBeFound;
@@ -401,6 +406,62 @@ public IEnumerable<AzureDevOpsBuildArtifact> GetArtifacts()
             }
         }
 
+        /// <summary>
+        /// Gets the test run ID's of a build.
+        /// </summary>
+        /// <returns>A list of RunIDs as int.</returns>
+        public IEnumerable<AzureDevOpsTestRun> GetTestRuns()
+        {
+            if (!this.ValidateBuild())
+            {
+                return new List<AzureDevOpsTestRun>();
+            }
+
+            using (var testClient = this.testClientFactory.CreateTestManagementClient(this.CollectionUrl, this.credentials.ToVssCredentials()))
+            {
+                return
+                    testClient
+                    .GetTestResultDetailsForBuildAsync(this.ProjectId, this.build.Id)
+                    .GetAwaiter()
+                    .GetResult()
+                    .ResultsForGroup
+                        .SelectMany(testResultGroup => testResultGroup.Results).ToList()
+                        .GroupBy(testResult => testResult.TestRun.Id)
+                        .Select(runGroup => int.Parse(runGroup.Key))
+                        .Select(runId =>
+                            new AzureDevOpsTestRun
+                            {
+                                RunId = runId,
+                                TestResults =
+                                    this.GetTestResults(testClient, runId)
+                                    .GetAwaiter()
+                                    .GetResult(),
+                            });
+            }
+        }
+
+        /// <summary>
+        /// Gets the test runs of this build.
+        /// </summary>
+        /// <param name="testClient">Instance of a <see cref="TestManagementHttpClient"/> class.</param>
+        /// <param name="runId">Id of the test run.</param>
+        /// <returns>The test results for a build or an empty list if no build could be found and
+        /// <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/> is set to <c>false</c>.</returns>
+        /// <exception cref="AzureDevOpsBuildNotFoundException">If build could not be found and
+        /// <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/> is set to <c>true</c>.</exception>
+        private async Task<IEnumerable<AzureDevOpsTestResult>> GetTestResults(TestManagementHttpClient testClient, int runId)
+        {
+            return
+                (await testClient.GetTestResultsAsync(this.ProjectId, runId).ConfigureAwait(false))
+                .Select(test =>
+                    new AzureDevOpsTestResult
+                    {
+                        AutomatedTestName = test.AutomatedTestName,
+                        Outcome = test.Outcome,
+                        ErrorMessage = test.ErrorMessage,
+                    });
+        }
+
         /// <summary>
         /// Validates if a build could be found.
         /// Depending on <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/>

src/Cake.AzureDevOps/Pipelines/AzureDevOpsTestResult.cs

@@ -0,0 +1,25 @@
+namespace Cake.AzureDevOps.Pipelines
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Represents a test result associated with a <see cref="AzureDevOpsTestRun" />.
+    /// </summary>
+    public class AzureDevOpsTestResult
+    {
+        /// <summary>
+        /// Gets the automated test name.
+        /// </summary>
+        public string AutomatedTestName { get; internal set; }
+
+        /// <summary>
+        /// Gets the outcome of the test.
+        /// </summary>
+        public string Outcome { get; internal set; }
+
+        /// <summary>
+        /// Gets the message of the test.
+        /// </summary>
+        public string ErrorMessage { get; internal set; }
+    }
+}

src/Cake.AzureDevOps/Pipelines/AzureDevOpsTestRun.cs

@@ -0,0 +1,20 @@
+namespace Cake.AzureDevOps.Pipelines
+{
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Represents a test run associated with a <see cref="AzureDevOpsBuild" />.
+    /// </summary>
+    public class AzureDevOpsTestRun
+    {
+        /// <summary>
+        /// Gets the name of the test run.
+        /// </summary>
+        public int RunId { get; internal set; }
+
+        /// <summary>
+        /// Gets the test results of a test run.
+        /// </summary>
+        public IEnumerable<AzureDevOpsTestResult> TestResults { get; internal set; }
+    }
+}

src/Cake.AzureDevOps/Pipelines/TestManagementClient/ITestManagementClientFactory.cs

@@ -0,0 +1,23 @@
+namespace Cake.AzureDevOps
+{
+    using System;
+    using Cake.AzureDevOps.Authentication;
+    using Microsoft.TeamFoundation.Build.WebApi;
+    using Microsoft.TeamFoundation.TestManagement.WebApi;
+    using Microsoft.VisualStudio.Services.Common;
+    using Microsoft.VisualStudio.Services.Identity;
+
+    /// <summary>
+    /// The interface for a Git client factory.
+    /// </summary>
+    internal interface ITestManagementClientFactory
+    {
+        /// <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>
+        /// <returns>The instance of <see cref="TestManagementHttpClient"/> class.</returns>
+        TestManagementHttpClient CreateTestManagementClient(Uri collectionUrl, VssCredentials credentials);
+    }
+}

src/Cake.AzureDevOps/Pipelines/TestManagementClient/TestManagementClientFactory.cs

@@ -0,0 +1,17 @@
+namespace Cake.AzureDevOps
+{
+    using System;
+    using Microsoft.TeamFoundation.TestManagement.WebApi;
+    using Microsoft.VisualStudio.Services.Common;
+
+    /// <inheritdoc />
+    internal class TestManagementClientFactory : ITestManagementClientFactory
+    {
+        /// <inheritdoc />
+        public TestManagementHttpClient CreateTestManagementClient(Uri collectionUrl, VssCredentials credentials)
+        {
+            TestManagementHttpClient testClient = new TestManagementHttpClient(collectionUrl, credentials);
+            return testClient;
+        }
+    }
+}