Merge pull request #238 from christianbumann/feature/gh-176

(GH-176) Return artifacts of a build

Author: pascalberger

src/Cake.AzureDevOps/Pipelines/ArtifactResourceExtensions.cs

@@ -0,0 +1,30 @@
+namespace Cake.AzureDevOps.Pipelines
+{
+    using Microsoft.TeamFoundation.Build.WebApi;
+
+    /// <summary>
+    /// Extensions for the <see cref="ArtifactResource"/> class.
+    /// </summary>
+    internal static class ArtifactResourceExtensions
+    {
+        /// <summary>
+        /// Converts a <see cref="ArtifactResource"/> to an <see cref="AzureDevOpsBuildArtifact"/>.
+        /// </summary>
+        /// <param name="artifactResource">Artifact resource record to convert.</param>
+        /// <returns>Converted artifact resorce record.</returns>
+        public static AzureDevOpsArtifactResource ToAzureDevOpsArtifactResource(this ArtifactResource artifactResource)
+        {
+            artifactResource.NotNull(nameof(artifactResource));
+
+            return
+                new AzureDevOpsArtifactResource
+                {
+                    Data = artifactResource.Data,
+                    DownloadUrl = artifactResource.DownloadUrl,
+                    Type = artifactResource.Type,
+                    Url = artifactResource.Url,
+                    Properties = artifactResource.Properties,
+                };
+        }
+    }
+}

src/Cake.AzureDevOps/Pipelines/AzureDevOpsArtifactResource.cs

@@ -0,0 +1,35 @@
+using System.Collections.Generic;
+
+namespace Cake.AzureDevOps.Pipelines
+{
+    /// <summary>
+    /// Represents a resource associated with a <see cref="AzureDevOpsBuildArtifact" />.
+    /// </summary>
+    public class AzureDevOpsArtifactResource
+    {
+        /// <summary>
+        /// Gets the data of the resource.
+        /// </summary>
+        public string Data { get; internal set; }
+
+        /// <summary>
+        /// Gets the download url of the resource.
+        /// </summary>
+        public string DownloadUrl { get; internal set; }
+
+        /// <summary>
+        /// Gets the type of the resource.
+        /// </summary>
+        public string Type { get; internal set; }
+
+        /// <summary>
+        /// Gets the full http link to the resource.
+        /// </summary>
+        public string Url { get; internal set; }
+
+        /// <summary>
+        /// Gets the properties for the resource.
+        /// </summary>
+        public Dictionary<string, string> Properties { get; internal set; }
+    }
+}

src/Cake.AzureDevOps/Pipelines/AzureDevOpsBuild.cs

@@ -356,6 +356,32 @@ public IEnumerable<AzureDevOpsTimelineRecord> GetTimelineRecords()
             }
         }
 
+        /// <summary>
+        /// Gets the artifacts associated with a build.
+        /// </summary>
+        /// <returns>The artifacts associated with 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>
+        public IEnumerable<AzureDevOpsBuildArtifact> GetArtifacts()
+        {
+            if (!this.ValidateBuild())
+            {
+                return new List<AzureDevOpsBuildArtifact>();
+            }
+
+            using (var buildClient = this.buildClientFactory.CreateBuildClient(this.CollectionUrl, this.credentials))
+            {
+                return
+                    buildClient
+                        .GetArtifactsAsync(this.ProjectId, this.BuildId)
+                        .ConfigureAwait(false)
+                        .GetAwaiter()
+                        .GetResult()
+                        .Select(x => x.ToAzureDevOpsBuildArtifact());
+            }
+        }
+
         /// <summary>
         /// Validates if a build could be found.
         /// Depending on <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/>

src/Cake.AzureDevOps/Pipelines/AzureDevOpsBuildArtifact.cs

@@ -0,0 +1,23 @@
+namespace Cake.AzureDevOps.Pipelines
+{
+    /// <summary>
+    /// Represents an artifact associated with a build.
+    /// </summary>
+    public class AzureDevOpsBuildArtifact
+    {
+        /// <summary>
+        /// Gets the id of the artifact.
+        /// </summary>
+        public int Id { get; internal set; }
+
+        /// <summary>
+        /// Gets the name of the artifact.
+        /// </summary>
+        public string Name { get; internal set; }
+
+        /// <summary>
+        /// Gets the artifact resource.
+        /// </summary>
+        public AzureDevOpsArtifactResource Resource { get; internal set; }
+    }
+}

src/Cake.AzureDevOps/Pipelines/BuildArtifactExtensions.cs

@@ -0,0 +1,28 @@
+namespace Cake.AzureDevOps.Pipelines
+{
+    using Microsoft.TeamFoundation.Build.WebApi;
+
+    /// <summary>
+    /// Extensions for the <see cref="BuildArtifact"/> class.
+    /// </summary>
+    internal static class BuildArtifactExtensions
+    {
+        /// <summary>
+        /// Converts a <see cref="BuildArtifact"/> to an <see cref="AzureDevOpsBuildArtifact"/>.
+        /// </summary>
+        /// <param name="buildArtifact">Build artifact record to convert.</param>
+        /// <returns>Converted build artifact record.</returns>
+        public static AzureDevOpsBuildArtifact ToAzureDevOpsBuildArtifact(this BuildArtifact buildArtifact)
+        {
+            buildArtifact.NotNull(nameof(buildArtifact));
+
+            return
+                new AzureDevOpsBuildArtifact
+                {
+                    Id = buildArtifact.Id,
+                    Name = buildArtifact.Name,
+                    Resource = buildArtifact.Resource.ToAzureDevOpsArtifactResource(),
+                };
+        }
+    }
+}