PipelineFailedException and PipelineCancelledException should fail fast

Author: albertwoo

Fun.Build.Tests/ExceptionHandlingTests.fs

@@ -58,3 +58,53 @@ let ``exception handling should work for parallel steps`` () =
 
     Assert.True exn.IsSome
     Assert.Equal("/step-0> test", exn.Value.InnerException.Message)
+
+[<Fact>]
+let ``PipelineFailedException should fail fast`` () =
+    let mutable exn = ValueNone
+
+    try
+        shouldNotBeCalled (fun call ->
+            pipeline "" {
+                stage "" {
+                    continueOnStepFailure
+                    run (fun _ ->
+                        raise (PipelineFailedException("demo"))
+                        ()
+                    )
+                }
+                post [ stage "" { run call } ]
+                runImmediate
+            }
+        )
+
+    with :? PipelineFailedException as ex ->
+        exn <- ValueSome ex
+
+    Assert.True exn.IsSome
+    Assert.Equal("demo", exn.Value.Message)
+
+[<Fact>]
+let ``PipelineCancelledException should fail fast`` () =
+    let mutable exn = ValueNone
+
+    try
+        shouldNotBeCalled (fun call ->
+            pipeline "" {
+                stage "" {
+                    continueOnStepFailure
+                    run (fun _ ->
+                        raise (PipelineCancelledException("demo"))
+                        ()
+                    )
+                }
+                post [ stage "" { run call } ]
+                runImmediate
+            }
+        )
+
+    with :? PipelineCancelledException as ex ->
+        exn <- ValueSome ex
+
+    Assert.True exn.IsSome
+    Assert.Equal("demo", exn.Value.Message)

Fun.Build/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [1.1.14] - 2024-10-21
+
+- PipelineFailedException and PipelineCancelledException should fail fast
+
 ## [1.1.13] - 2024-10-21
 
 - Improve error reporting in github actions

Fun.Build/PipelineContextExtensions.fs

@@ -125,28 +125,36 @@ module PipelineContextExtensionsInternal =
             let pipelineExns = ResizeArray<exn>()
             use cts = new Threading.CancellationTokenSource(timeoutForPipeline)
 
-            AnsiConsole.MarkupLine $"[turquoise4]Run stages[/]"
-            let hasFailedStage, stageExns = this.RunStages(this.Stages, cts.Token, failfast = true)
-            pipelineExns.AddRange stageExns
-            AnsiConsole.MarkupLine $"[turquoise4]Run stages finished[/]"
-            AnsiConsole.WriteLine()
-            AnsiConsole.WriteLine()
 
-            let mutable hasFailedPostStage = false
-            if cts.IsCancellationRequested |> not then
-                AnsiConsole.MarkupLine $"[turquoise4]Run post stages[/]"
-                let result, postStageExns = this.RunStages(this.PostStages, cts.Token, failfast = false)
-                hasFailedPostStage <- result
-                pipelineExns.AddRange postStageExns
-                AnsiConsole.MarkupLine $"[turquoise4]Run post stages finished[/]"
+            let mutable hasErrors = false
+
+            try
+                AnsiConsole.MarkupLine $"[turquoise4]Run stages[/]"
+                let hasFailedStage, stageExns = this.RunStages(this.Stages, cts.Token, failfast = true)
+                pipelineExns.AddRange stageExns
+                AnsiConsole.MarkupLine $"[turquoise4]Run stages finished[/]"
                 AnsiConsole.WriteLine()
                 AnsiConsole.WriteLine()
 
+                let mutable hasFailedPostStage = false
+                if cts.IsCancellationRequested |> not then
+                    AnsiConsole.MarkupLine $"[turquoise4]Run post stages[/]"
+                    let result, postStageExns = this.RunStages(this.PostStages, cts.Token, failfast = false)
+                    hasFailedPostStage <- result
+                    pipelineExns.AddRange postStageExns
+                    AnsiConsole.MarkupLine $"[turquoise4]Run post stages finished[/]"
+                    AnsiConsole.WriteLine()
+                    AnsiConsole.WriteLine()
+
+                hasErrors <- hasFailedStage || hasFailedPostStage
+
+            with ex ->
+                this.PrintError ex.Message
+                raise ex
 
-            let hasError = hasFailedStage || hasFailedPostStage
 
             let color =
-                if hasError then "red"
+                if hasErrors then "red"
                 else if cts.IsCancellationRequested then "yellow"
                 else "lime"
 
@@ -166,8 +174,8 @@ module PipelineContextExtensionsInternal =
                     this.PrintError(exn.Message + " " + innerMessage)
                 AnsiConsole.WriteLine()
                 raise (PipelineFailedException("Pipeline is failed because of exception", pipelineExns[0]))
-            else if hasError then
-                AnsiConsole.MarkupLine "[red]Pipeline is failed because result is not indicating as successful[/]"
+            else if hasErrors then
+                this.PrintError "Pipeline is failed because result is not indicating as successful"
                 raise (PipelineFailedException "Pipeline is failed because result is not indicating as successful")
 
 

Fun.Build/StageContextExtensions.fs

@@ -62,7 +62,7 @@ module StageContextExtensionsInternal =
             |> fun x -> x + ctx.Name
 
 
-        member ctx.PrinterError(msg: string) =
+        member ctx.PrintError(msg: string) =
             match ctx.TryGetEnvVar("GITHUB_ENV") with
             | ValueSome _ ->
                 let title = "[STAGE] " + ctx.GetNamePath().Replace(",", "_")
@@ -256,9 +256,9 @@ module StageContextExtensionsInternal =
                                         | Error e ->
                                             if String.IsNullOrEmpty e |> not then
                                                 if not isParallel && stage.GetNoPrefixForStep() then
-                                                    stage.PrinterError(e)
+                                                    stage.PrintError(e)
                                                 else
-                                                    stage.PrinterError(prefix + " " + e)
+                                                    stage.PrintError(prefix + " " + e)
 
                                             return false
 
@@ -289,6 +289,14 @@ module StageContextExtensionsInternal =
                                 return isSuccess, exns
 
                             with
+                            | :? PipelineCancelledException as ex ->
+                                raise ex
+                                return false, exns
+
+                            | :? PipelineFailedException as ex ->
+                                raise ex
+                                return false, exns
+
                             | :? StepSoftCancelledException as ex ->
                                 AnsiConsole.MarkupLineInterpolated $"[yellow]{prefix} {ex.Message}.[/]"
                                 return true, exns
@@ -343,6 +351,9 @@ module StageContextExtensionsInternal =
                         Async.RunSynchronously(ts, cancellationToken = linkedCTS.Token)
 
                     with
+                    | :? PipelineCancelledException as ex -> raise ex
+                    | :? PipelineFailedException as ex -> raise ex
+
                     | _ when isStageSoftCancelled -> isSuccess <- true
                     | ex ->
                         isSuccess <- false

README.md

@@ -29,7 +29,7 @@ If you find my projects helpful and would like to support my work, consider maki
 ## Minimal example and conventions
 
 ```fsharp
-#r "nuget: Fun.Build, 1.1.7"
+#r "nuget: Fun.Build, 1.1.14"
 open Fun.Build
 
 pipeline "demo" {
@@ -76,7 +76,7 @@ dotnet fsi build.fsx -- -p your_pipeline -h
 Below example covered most of the apis and usage example, take it as the documents😊:
 
 ```fsharp
-#r "nuget: Fun.Build, 1.1.7"
+#r "nuget: Fun.Build, 1.1.14"
 
 open Fun.Result
 open Fun.Build