Merge pull request #2327 from thomhurst/fix/ignored-failure-status

Fix ignored module failures incorrectly failing the pipeline

Author: thomhurst

src/ModularPipelines/Engine/Execution/ModuleRunner.cs

@@ -113,7 +113,7 @@ private async Task ExecuteCore(
 
                 await ExecuteModuleWithPipeline(moduleState, scope.ServiceProvider, cancellationToken).ConfigureAwait(false);
 
-                scheduler.MarkModuleCompleted(moduleType, true);
+                scheduler.MarkModuleCompleted(moduleType, true, statusOverride: moduleState.Result?.ModuleStatus);
             }
             catch (Exception ex)
             {
@@ -157,11 +157,16 @@ private async Task ExecuteModuleWithPipeline(ModuleState moduleState, IServicePr
         {
             await ExecuteModuleLifecycle(moduleState, scopedServiceProvider, pipelineContext, executionContext, moduleContext, cancellationToken).ConfigureAwait(false);
 
-            // Record success or skip status on the Activity
+            // Record success, skip, or ignored failure status on the Activity
             if (executionContext.Status == Enums.Status.Skipped)
             {
                 ModuleActivityTracing.RecordSkipped(activity);
             }
+            else if (executionContext.Status == Enums.Status.IgnoredFailure)
+            {
+                activity?.SetTag("module.status", "IgnoredFailure");
+                activity?.SetStatus(System.Diagnostics.ActivityStatusCode.Ok, "Module failed but failure was ignored");
+            }
             else
             {
                 ModuleActivityTracing.RecordSuccess(activity);

src/ModularPipelines/Engine/IModuleScheduler.cs

@@ -1,4 +1,5 @@
 using System.Threading.Channels;
+using ModularPipelines.Enums;
 using ModularPipelines.Modules;
 
 namespace ModularPipelines.Engine;
@@ -33,7 +34,7 @@ internal interface IModuleScheduler : IDisposable
     /// <summary>
     /// Marks a module as completed and notifies dependents.
     /// </summary>
-    void MarkModuleCompleted(Type moduleType, bool success, Exception? exception = null);
+    void MarkModuleCompleted(Type moduleType, bool success, Exception? exception = null, Status? statusOverride = null);
 
     /// <summary>
     /// Gets the completion task for a specific module.

src/ModularPipelines/Engine/IModuleStateTracker.cs

@@ -1,3 +1,4 @@
+using ModularPipelines.Enums;
 using ModularPipelines.Modules;
 
 namespace ModularPipelines.Engine;
@@ -26,9 +27,10 @@ internal interface IModuleStateTracker
     /// Marks a module as completed and notifies dependents.
     /// </summary>
     /// <param name="moduleType">The type of the module to mark as completed.</param>
-    /// <param name="success">True if execution succeeded, false otherwise.</param>
+    /// <param name="success">True if execution succeeded (or failure was ignored), false otherwise.</param>
     /// <param name="exception">Optional exception if execution failed.</param>
-    void MarkModuleCompleted(Type moduleType, bool success, Exception? exception = null);
+    /// <param name="statusOverride">Optional status override. When provided, this status is used instead of computing from the success parameter.</param>
+    void MarkModuleCompleted(Type moduleType, bool success, Exception? exception = null, Status? statusOverride = null);
 
     /// <summary>
     /// Cancels all modules that are queued or pending (not yet executing).

src/ModularPipelines/Engine/MetricsCollector.cs

@@ -44,7 +44,7 @@ public void RecordModuleCompleted(Type moduleType, DateTimeOffset time, bool suc
     {
         var data = _moduleMetrics.GetOrAdd(moduleType, _ => new ModuleMetricsData { ModuleType = moduleType });
         data.EndTime = time;
-        data.WasSuccessful = success;
+        data.WasSuccessful = status is Status.Successful or Status.UsedHistory;
         data.WasSkipped = skipped;
         data.Status = status;
     }
@@ -76,6 +76,10 @@ public PipelineMetrics ComputeMetrics(DateTimeOffset pipelineStart, DateTimeOffs
             {
                 skippedCount++;
             }
+            else if (data.Status == Status.IgnoredFailure)
+            {
+                // Ignored failures don't count as passed or failed
+            }
             else if (data.WasSuccessful)
             {
                 successfulCount++;

src/ModularPipelines/Engine/ModuleScheduler.cs

@@ -427,9 +427,9 @@ public bool MarkModuleStarted(Type moduleType)
     /// <summary>
     /// Marks a module as completed and notifies dependents.
     /// </summary>
-    public void MarkModuleCompleted(Type moduleType, bool success, Exception? exception = null)
+    public void MarkModuleCompleted(Type moduleType, bool success, Exception? exception = null, Status? statusOverride = null)
     {
-        _stateTracker.MarkModuleCompleted(moduleType, success, exception);
+        _stateTracker.MarkModuleCompleted(moduleType, success, exception, statusOverride);
     }
 
     /// <summary>

src/ModularPipelines/Engine/ModuleStateTracker.cs

@@ -143,7 +143,7 @@ public bool MarkModuleStarted(Type moduleType)
     }
 
     /// <inheritdoc />
-    public void MarkModuleCompleted(Type moduleType, bool success, Exception? exception = null)
+    public void MarkModuleCompleted(Type moduleType, bool success, Exception? exception = null, Enums.Status? statusOverride = null)
     {
         if (!_moduleStates.TryGetValue(moduleType, out var state))
         {
@@ -171,7 +171,7 @@ public void MarkModuleCompleted(Type moduleType, bool success, Exception? except
             // Capture data for metrics recording outside lock
             completionTime = state.CompletionTime.Value;
             wasSkipped = state.SkipResult != null && state.SkipResult != Models.SkipDecision.DoNotSkip;
-            status = wasSkipped ? Enums.Status.Skipped : (success ? Enums.Status.Successful : Enums.Status.Failed);
+            status = statusOverride ?? (wasSkipped ? Enums.Status.Skipped : (success ? Enums.Status.Successful : Enums.Status.Failed));
 
             // Capture counts for logging outside lock
             queuedCount = _queuedModules.Count;

src/ModularPipelines/Helpers/SpectreResultsPrinter.cs

@@ -73,6 +73,12 @@ private static void PrintHeader(PipelineSummary pipelineSummary)
             return timeline?.WasSkipped == true;
         });
 
+        var ignoredCount = pipelineSummary.Modules.Count(m =>
+        {
+            var timeline = pipelineSummary.ModuleTimelines?.FirstOrDefault(t => t.ModuleName == m.GetType().Name);
+            return timeline?.Status == ModuleStatus.IgnoredFailure;
+        });
+
         var totalCount = metrics?.TotalModules ?? pipelineSummary.Modules.Count;
 
         // Build the summary line
@@ -88,6 +94,11 @@ private static void PrintHeader(PipelineSummary pipelineSummary)
             parts.Add($"[red]{failedCount} failed[/]");
         }
 
+        if (ignoredCount > 0)
+        {
+            parts.Add($"[yellow]{ignoredCount} ignored[/]");
+        }
+
         if (skippedCount > 0)
         {
             parts.Add($"[yellow]{skippedCount} skipped[/]");

src/ModularPipelines/Models/PipelineSummary.cs

@@ -169,7 +169,8 @@ private Status GetStatus()
                 var result = _resultRegistry.GetResult(module.GetType());
                 if (result != null)
                 {
-                    if (result.ModuleResultType == ModuleResultType.Failure)
+                    if (result.ModuleResultType == ModuleResultType.Failure
+                        && result.ModuleStatus != Status.IgnoredFailure)
                     {
                         return Status.Failed;
                     }