Add method to check if build is failing

Author: pascalberger

src/Cake.AzureDevOps/AzureDevOpsAliases.Pipelines.cs

@@ -89,6 +89,53 @@ public static AzureDevOpsBuild AzureDevOpsBuildUsingAzurePipelinesOAuthToken(
             return AzureDevOpsBuild(context, settings);
         }
 
+        /// <summary>
+        /// Returns if the Azure DevOps build is failing.
+        /// </summary>
+        /// <param name="context">The context.</param>
+        /// <param name="settings">Settings for getting the build.</param>
+        /// <example>
+        /// <para>Get changes associated with an Azure Pipelines build:</para>
+        /// <code>
+        /// <![CDATA[
+        /// var buildSettings =
+        ///     new AzureDevOpsBuildSettings(
+        ///         new Uri("http://myserver:8080/defaultcollection"),
+        ///         "MyProject",
+        ///         42,
+        ///         AzureDevOpsAuthenticationNtlm());
+        ///
+        /// var isFailing =
+        ///     AzureDevOpsBuildIsFailing(
+        ///         buildSettings);
+        ///
+        /// if (isFailing)
+        /// {
+        ///     Information("Build is failing");
+        /// }
+        /// ]]>
+        /// </code>
+        /// </example>
+        /// <returns>The changes associated with the build.
+        /// Returns an empty list if build could not 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>
+        [CakeMethodAlias]
+        [CakeAliasCategory("Azure Pipelines")]
+        [CakeNamespaceImport("Cake.AzureDevOps.Pipelines")]
+        public static bool AzureDevOpsBuildIsFailing(
+            this ICakeContext context,
+            AzureDevOpsBuildSettings settings)
+        {
+            context.NotNull(nameof(context));
+            settings.NotNull(nameof(settings));
+
+            return
+                new AzureDevOpsBuild(context.Log, settings, new BuildClientFactory())
+                    .IsBuildFailing();
+        }
+
         /// <summary>
         /// Gets the changes associated with an Azure Pipelines build.
         /// </summary>

src/Cake.AzureDevOps/Pipelines/AzureDevOpsBuild.cs

@@ -243,6 +243,10 @@ public AzureDevOpsBuildStatus? Status
         /// Returns 0 if no build could be found and
         /// <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/> is set to <c>false</c>.
         /// </summary>
+        /// <remarks>
+        /// Result is only available after a build has been finished.
+        /// The check if a running build is failing you can call <see cref="IsBuildFailing"/>.
+        /// </remarks>
         /// <exception cref="AzureDevOpsBuildNotFoundException">If build could not be found and
         /// <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/> is set to <c>true</c>.</exception>
         public AzureDevOpsBuildResult? Result
@@ -312,6 +316,19 @@ public IEnumerable<AzureDevOpsChange> GetChanges()
             }
         }
 
+        /// <summary>
+        /// Checks if the build is failing.
+        /// </summary>
+        /// <returns><c>true</c> if build is failing.</returns>
+        /// <exception cref="AzureDevOpsBuildNotFoundException">If build could not be found and
+        /// <see cref="AzureDevOpsBuildSettings.ThrowExceptionIfBuildCouldNotBeFound"/> is set to <c>true</c>.</exception>
+        public bool IsBuildFailing()
+        {
+            return
+                this.ValidateBuild() &&
+                this.GetTimelineRecords().Any(x => x.Result.HasValue && x.Result.Value == AzureDevOpsTaskResult.Failed);
+        }
+
         /// <summary>
         /// Gets the timeline entries for a build.
         /// </summary>