Merge branch 'release/0.5.1'

pascalberger · pascalberger · commit 0863c635525e · 2020-11-03T14:07:12.000+01:00
diff --git a/src/Cake.AzureDevOps.Tests/Cake.AzureDevOps.Tests.csproj b/src/Cake.AzureDevOps.Tests/Cake.AzureDevOps.Tests.csproj
@@ -14,11 +14,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
     <PackageReference Include="Cake.Core" Version="0.33.0" />
     <PackageReference Include="Cake.Testing" Version="0.33.0" />
     <PackageReference Include="Microsoft.TeamFoundationServer.Client" Version="16.143.2" />
-    <PackageReference Include="Moq" Version="4.14.5" />
+    <PackageReference Include="Moq" Version="4.14.7" />
     <PackageReference Include="Shouldly" Version="3.0.2" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" />
     <PackageReference Include="xunit" Version="2.4.1" />
diff --git a/src/Cake.AzureDevOps.Tests/Fakes/FakeAllSetGitClientFactory.cs b/src/Cake.AzureDevOps.Tests/Fakes/FakeAllSetGitClientFactory.cs
@@ -1,4 +1,4 @@
-﻿namespace Cake.AzureDevOps.Tests.Repos.PullRequest.Fakes
+﻿namespace Cake.AzureDevOps.Tests.Fakes
 {
     using System;
     using System.Collections.Generic;
diff --git a/src/Cake.AzureDevOps.Tests/Fakes/FakeGitClientFactory.cs b/src/Cake.AzureDevOps.Tests/Fakes/FakeGitClientFactory.cs
@@ -1,8 +1,7 @@
-﻿namespace Cake.AzureDevOps.Tests.Repos.PullRequest.Fakes
+﻿namespace Cake.AzureDevOps.Tests.Fakes
 {
     using System;
     using Cake.AzureDevOps.Authentication;
-    using Cake.AzureDevOps.Repos;
     using Microsoft.TeamFoundation.SourceControl.WebApi;
     using Microsoft.VisualStudio.Services.Identity;
     using Moq;
diff --git a/src/Cake.AzureDevOps.Tests/Fakes/FakeNullForMethodsGitClientFactory.cs b/src/Cake.AzureDevOps.Tests/Fakes/FakeNullForMethodsGitClientFactory.cs
@@ -1,4 +1,4 @@
-﻿namespace Cake.AzureDevOps.Tests.Repos.PullRequest.Fakes
+﻿namespace Cake.AzureDevOps.Tests.Fakes
 {
     using System;
     using System.Collections.Generic;
diff --git a/src/Cake.AzureDevOps.Tests/Fakes/FakeNullGitClientFactory.cs b/src/Cake.AzureDevOps.Tests/Fakes/FakeNullGitClientFactory.cs
@@ -1,4 +1,4 @@
-﻿namespace Cake.AzureDevOps.Tests.Repos.PullRequest.Fakes
+﻿namespace Cake.AzureDevOps.Tests.Fakes
 {
     using System;
     using System.Collections.Generic;
diff --git a/src/Cake.AzureDevOps.Tests/Repos/PullRequest/AzureDevOpsPullRequestTests.cs b/src/Cake.AzureDevOps.Tests/Repos/PullRequest/AzureDevOpsPullRequestTests.cs
@@ -2,10 +2,9 @@
 {
     using System.Collections.Generic;
     using System.Linq;
-    using Cake.AzureDevOps.Repos;
     using Cake.AzureDevOps.Repos.PullRequest;
     using Cake.AzureDevOps.Repos.PullRequest.CommentThread;
-    using Cake.AzureDevOps.Tests.Repos.PullRequest.Fakes;
+    using Cake.AzureDevOps.Tests.Fakes;
     using Cake.Core.Diagnostics;
     using Cake.Core.IO;
     using Microsoft.VisualStudio.Services.Common;
diff --git a/src/Cake.AzureDevOps.Tests/Repos/PullRequest/BasePullRequestFixture.cs b/src/Cake.AzureDevOps.Tests/Repos/PullRequest/BasePullRequestFixture.cs
@@ -1,7 +1,6 @@
 ﻿namespace Cake.AzureDevOps.Tests.Repos.PullRequest
 {
-    using Cake.AzureDevOps.Repos;
-    using Cake.AzureDevOps.Tests.Repos.PullRequest.Fakes;
+    using Cake.AzureDevOps.Tests.Fakes;
     using Cake.Testing;
 
     internal abstract class BasePullRequestFixture
diff --git a/src/Cake.AzureDevOps/Cake.AzureDevOps.csproj b/src/Cake.AzureDevOps/Cake.AzureDevOps.csproj
@@ -21,7 +21,7 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <RepositoryType>git</RepositoryType>
     <RepositoryUrl>https://github.com/cake-contrib/Cake.AzureDevOps.git</RepositoryUrl>
-    <PackageReleaseNotes>https://github.com/cake-contrib/Cake.AzureDevOps/releases/tag/0.5.0</PackageReleaseNotes>
+    <PackageReleaseNotes>https://github.com/cake-contrib/Cake.AzureDevOps/releases/tag/0.5.1</PackageReleaseNotes>
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
     <IncludeBuildOutput>false</IncludeBuildOutput>
     <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);PackBuildOutputs</TargetsForTfmSpecificContentInPackage>
@@ -37,7 +37,7 @@
 
   <ItemGroup>
     <PackageReference Include="Cake.Core" Version="0.33.0" PrivateAssets="All" />
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.3.0" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.3.1" PrivateAssets="All" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
     <PackageReference Include="Microsoft.TeamFoundationServer.Client" Version="16.143.2" PrivateAssets="All" />
     <PackageReference Include="Microsoft.VisualStudio.Services.InteractiveClient" Version="16.143.2" PrivateAssets="All" />
diff --git a/src/Cake.AzureDevOps/GitClientFactory.cs b/src/Cake.AzureDevOps/GitClientFactory.cs
@@ -1,4 +1,4 @@
-﻿namespace Cake.AzureDevOps.Repos
+﻿namespace Cake.AzureDevOps
 {
     using System;
     using Cake.AzureDevOps.Authentication;
diff --git a/src/Cake.AzureDevOps/IGitClientFactory.cs b/src/Cake.AzureDevOps/IGitClientFactory.cs
@@ -1,4 +1,4 @@
-﻿namespace Cake.AzureDevOps.Repos
+﻿namespace Cake.AzureDevOps
 {
     using System;
     using Cake.AzureDevOps.Authentication;
diff --git a/src/Cake.AzureDevOps/Pipelines/AzureDevOpsBuild.cs b/src/Cake.AzureDevOps/Pipelines/AzureDevOpsBuild.cs
@@ -292,6 +292,26 @@ public AzureDevOpsBuildResult? Result
             }
         }
 
+        /// <summary>
+        /// Gets the finish time of the build.
+        /// Returns <c>null</c> if no build could be found and
+        /// <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/> is set to <c>false</c>.
+        /// </summary>
+        /// <exception cref="AzureDevOpsBuildNotFoundException">If build could not be found and
+        /// <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/> is set to <c>true</c>.</exception>
+        public DateTime? FinishTime
+        {
+            get
+            {
+                if (!this.ValidateBuild())
+                {
+                    return null;
+                }
+
+                return this.build.FinishTime;
+            }
+        }
+
         /// <summary>
         /// Gets the parameters passed to the build.
         /// Returns an empty dictionary if no build could be found and
@@ -413,10 +433,91 @@ public IEnumerable<AzureDevOpsBuildArtifact> GetArtifacts()
         }
 
         /// <summary>
-        /// Gets the test run ID's of a build.
+        /// Create an artifact link, such as a file or folder path or a version control path.
+        /// </summary>
+        /// <param name="name">The artifact name.</param>
+        /// <param name="type">The artifact type.
+        /// The following artifact types are supported:
+        /// <list type="table">
+        ///     <listheader>
+        ///         <term>Type</term>
+        ///         <description>Description</description>
+        ///     </listheader>
+        ///     <item>
+        ///         <term>FilePath</term>
+        ///         <description>File path type</description>
+        ///     </item>
+        ///     <item>
+        ///         <term>GitRef</term>
+        ///         <description>Git reference type</description>
+        ///     </item>
+        ///     <item>
+        ///         <term>TFVCLabel</term>
+        ///         <description>TFVC label type</description>
+        ///     </item>
+        ///     <item>
+        ///         <term>VersionControl</term>
+        ///         <description>Version control path type</description>
+        ///     </item>
+        /// </list>
+        /// </param>
+        /// <param name="location">The link path or value.</param>
+        /// <returns>Description of the new artifact or <c>null</c> 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>
+        public AzureDevOpsBuildArtifact LinkArtifact(string name, string type, string location)
+        {
+            if (!this.ValidateBuild())
+            {
+                return null;
+            }
+
+            using (var buildClient = this.buildClientFactory.CreateBuildClient(this.CollectionUrl, this.credentials))
+            {
+                var artifact =
+                    new BuildArtifact
+                    {
+                        Name = name,
+                        Resource =
+                            new ArtifactResource
+                            {
+                                Type = type,
+                                Data = location,
+                            },
+                    };
+                return
+                    buildClient
+                        .CreateArtifactAsync(artifact, this.ProjectId, this.BuildId)
+                        .ConfigureAwait(false)
+                        .GetAwaiter()
+                        .GetResult()
+                        .ToAzureDevOpsBuildArtifact();
+            }
+        }
+
+        /// <summary>
+        /// Gets the test runs of the build including test results.
         /// </summary>
-        /// <returns>A list of RunIDs as int.</returns>
+        /// <returns>A list of test runs 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>
         public IEnumerable<AzureDevOpsTestRun> GetTestRuns()
+        {
+            return this.GetTestRuns(null);
+        }
+
+        /// <summary>
+        /// Gets the test runs of the build including test results.
+        /// </summary>
+        /// <param name="maxResultsPerTestRun">Number of maximum test results to read for every test run.
+        /// <c>0</c> for skipping reading of test results. <c>null</c> for reading all test results in batches.</param>
+        /// <returns>A list of test runs 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>
+        public IEnumerable<AzureDevOpsTestRun> GetTestRuns(int? maxResultsPerTestRun)
         {
             if (!this.ValidateBuild())
             {
@@ -425,24 +526,35 @@ public IEnumerable<AzureDevOpsTestRun> GetTestRuns()
 
             using (var testClient = this.testClientFactory.CreateTestManagementClient(this.CollectionUrl, this.credentials))
             {
-                return
+                // Read test result details for current build.
+                var testResultDetails =
                     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 =>
+                        .GetTestResultDetailsForBuildAsync(this.ProjectId, this.build.Id)
+                        .ConfigureAwait(false)
+                        .GetAwaiter()
+                        .GetResult();
+
+                // Group result by test runs.
+                var testRuns =
+                    testResultDetails
+                        .ResultsForGroup
+                        .SelectMany(testResultGroup => testResultGroup.Results)
+                        .GroupBy(testResult => int.Parse(testResult.TestRun.Id));
+
+                // Read result details for every test run.
+                return
+                    testRuns
+                        .Select(testRun =>
                             new AzureDevOpsTestRun
                             {
-                                RunId = runId,
+                                RunId = testRun.Key,
                                 TestResults =
-                                    this.GetTestResults(testClient, runId)
+                                    this.GetTestResults(testClient, testRun.Key, testRun.Count(), maxResultsPerTestRun)
+                                    .ConfigureAwait(false)
                                     .GetAwaiter()
                                     .GetResult(),
-                            }).ToList();
+                            })
+                        .ToList();
             }
         }
 
@@ -451,21 +563,50 @@ public IEnumerable<AzureDevOpsTestRun> GetTestRuns()
         /// </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)
+        /// <param name="testCount">Number of tests in the test run.</param>
+        /// <param name="maxResults">Number of maximum test results to read.
+        /// <c>0</c> for skipping reading of test results. <c>null</c> for reading all test results in batches.</param>
+        /// <returns>The test results for a build.</returns>
+        private async Task<IEnumerable<AzureDevOpsTestResult>> GetTestResults(
+            TestManagementHttpClient testClient,
+            int runId,
+            int testCount,
+            int? maxResults)
         {
-            return
-                (await testClient.GetTestResultsAsync(this.ProjectId, runId).ConfigureAwait(false))
-                .Select(test =>
-                    new AzureDevOpsTestResult
-                    {
-                        AutomatedTestName = test.AutomatedTestName,
-                        Outcome = test.Outcome,
-                        ErrorMessage = test.ErrorMessage,
-                    });
+            var testResults = new List<AzureDevOpsTestResult>();
+
+            if (maxResults <= 0)
+            {
+                return testResults;
+            }
+
+            const int maxPagingSize = 10000;
+            var resultCount = 0;
+            var remainingResultsToRead = maxResults.HasValue ? Math.Min(testCount, maxResults.Value) : testCount;
+            do
+            {
+                var resultsToRead = Math.Min(remainingResultsToRead, maxPagingSize);
+                testResults.AddRange(
+                    (await testClient
+                        .GetTestResultsAsync(
+                            this.ProjectId,
+                            runId,
+                            skip: resultCount,
+                            top: resultsToRead)
+                        .ConfigureAwait(false))
+                    .Select(test =>
+                        new AzureDevOpsTestResult
+                        {
+                            AutomatedTestName = test.AutomatedTestName,
+                            Outcome = test.Outcome,
+                            ErrorMessage = test.ErrorMessage,
+                        }));
+
+                resultCount += resultsToRead;
+                remainingResultsToRead = Math.Max(remainingResultsToRead - resultsToRead, 0);
+            } while (remainingResultsToRead > 0);
+
+            return testResults;
         }
 
         /// <summary>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace Cake.AzureDevOps.Tests.Repos.PullRequest.Fakes`
	`1`	`+namespace Cake.AzureDevOps.Tests.Fakes`
`2`	`2`	`{`
`3`	`3`	`using System;`
`4`	`4`	`using System.Collections.Generic;`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`namespace Cake.AzureDevOps.Tests.Repos.PullRequest`
`2`	`2`	`{`
`3`		`- using Cake.AzureDevOps.Repos;`
`4`		`- using Cake.AzureDevOps.Tests.Repos.PullRequest.Fakes;`
	`3`	`+ using Cake.AzureDevOps.Tests.Fakes;`
`5`	`4`	`using Cake.Testing;`
`6`	`5`
`7`	`6`	`internal abstract class BasePullRequestFixture`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace Cake.AzureDevOps.Repos`
	`1`	`+namespace Cake.AzureDevOps`
`2`	`2`	`{`
`3`	`3`	`using System;`
`4`	`4`	`using Cake.AzureDevOps.Authentication;`