+semver:minor - GetModuleResultsAsync() method exposed on PipelineSummary object.… (#471)

thomhurst · web-flow · commit 9a5d1faa8887 · 2024-04-15T19:28:24.000+01:00
* `GetModuleResultsAsync()` method exposed on `PipelineSummary` object. This will give `IModuleResult` objects which exposes module name, status, start, finish, and any skip reasons or exceptions.

* Formatting Markdown

* Tweak logic

* Tweak assertion

* Revert

* Tidy using

* Tidy usings

* Throw exception on empty stream

* Update Octokit

* Update DownloadCodeCoverageFromOtherOperatingSystemBuildsModule.cs

* Update ModularPipelines.GitHub.csproj

---------

Co-authored-by: Tom Longhurst &lt;thomhurst@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -63,7 +63,6 @@ Define your pipeline in .NET! Strong types, intellisense, parallelisation, and t
 | ModularPipelines.WinGet | Helpers for interacting with the Windows Package Manager. | [![nuget](https://img.shields.io/nuget/v/ModularPipelines.WinGet.svg)](https://www.nuget.org/packages/ModularPipelines.WinGet/) |
 | ModularPipelines.Yarn | Helpers for interacting with Yarn CLI. | [![nuget](https://img.shields.io/nuget/v/ModularPipelines.Yarn.svg)](https://www.nuget.org/packages/ModularPipelines.Yarn/) |
 
-
 ## Getting Started
 
 If you want to see how to get started, or want to know more about ModularPipelines, [read the Documentation here](https://thomhurst.github.io/ModularPipelines)
diff --git a/src/ModularPipelines.Build/ModularPipelines.Build.csproj b/src/ModularPipelines.Build/ModularPipelines.Build.csproj
@@ -21,7 +21,6 @@
       <PackageReference Include="FluentAssertions" Version="6.12.0" />
       <PackageReference Include="Microsoft.Build" Version="17.3.2" />
       <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-      <PackageReference Include="Octokit" Version="10.0.0" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/src/ModularPipelines.Build/Modules/CheckReleaseNotesAddedModule.cs b/src/ModularPipelines.Build/Modules/CheckReleaseNotesAddedModule.cs
@@ -5,7 +5,6 @@
 using ModularPipelines.GitHub.Attributes;
 using ModularPipelines.Models;
 using ModularPipelines.Modules;
-using Octokit;
 using File = ModularPipelines.FileSystem.File;
 
 namespace ModularPipelines.Build.Modules;
diff --git a/src/ModularPipelines.Build/Modules/DependabotCommitsModule.cs b/src/ModularPipelines.Build/Modules/DependabotCommitsModule.cs
@@ -1,8 +1,6 @@
 ﻿using Microsoft.Extensions.Logging;
 using ModularPipelines.Attributes;
 using ModularPipelines.Context;
-using ModularPipelines.Git.Extensions;
-using ModularPipelines.Git.Options;
 using ModularPipelines.GitHub.Attributes;
 using ModularPipelines.GitHub.Extensions;
 using ModularPipelines.Modules;
diff --git a/src/ModularPipelines.Build/Modules/DownloadCodeCoverageFromOtherOperatingSystemBuildsModule.cs b/src/ModularPipelines.Build/Modules/DownloadCodeCoverageFromOtherOperatingSystemBuildsModule.cs
@@ -60,10 +60,15 @@ private async Task<File> DownloadZip(Artifact artifact)
             BuildConstants.RepositoryName,
             artifact.Id, "zip");
 
+        if (zipStream is null)
+        {
+            throw new Exception($"Stream from artifact {artifact.Id} is null");
+        }
+
         var file = File.GetNewTemporaryFilePath();
 
         await file.WriteAsync(zipStream);
 
         return file;
     }
-}
+}
diff --git a/src/ModularPipelines.Build/ReleaseNotes.md b/src/ModularPipelines.Build/ReleaseNotes.md
@@ -0,0 +1 @@
+*   `GetModuleResultsAsync()` method exposed on `PipelineSummary` object. This will return `IModuleResult` objects which exposes module name, status, start, finish, and any skip reasons or exceptions.
diff --git a/src/ModularPipelines.GitHub/Attributes/SkipIfNoGitHubToken.cs b/src/ModularPipelines.GitHub/Attributes/SkipIfNoGitHubToken.cs
@@ -1,4 +1,3 @@
-using Microsoft.Extensions.Options;
 using ModularPipelines.Attributes;
 using ModularPipelines.Context;
 
diff --git a/src/ModularPipelines.GitHub/ModularPipelines.GitHub.csproj b/src/ModularPipelines.GitHub/ModularPipelines.GitHub.csproj
@@ -10,7 +10,7 @@
     </ItemGroup>
     
     <ItemGroup>
-        <PackageReference Include="Octokit" Version="10.0.0" />
+        <PackageReference Include="Octokit" Version="11.0.1" />
     </ItemGroup>
 
 </Project>
diff --git a/src/ModularPipelines/Engine/Executors/ModuleDisposeExecutor.cs b/src/ModularPipelines/Engine/Executors/ModuleDisposeExecutor.cs
@@ -2,7 +2,6 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using ModularPipelines.Options;
-using Spectre.Console;
 
 namespace ModularPipelines.Engine.Executors;
 
diff --git a/src/ModularPipelines/Engine/ModuleContextProvider.cs b/src/ModularPipelines/Engine/ModuleContextProvider.cs
@@ -1,4 +1,3 @@
-using Initialization.Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.DependencyInjection;
 using ModularPipelines.Context;
 using ModularPipelines.Interfaces;
diff --git a/src/ModularPipelines/Engine/ModuleExecutor.cs b/src/ModularPipelines/Engine/ModuleExecutor.cs
@@ -6,7 +6,6 @@
 using ModularPipelines.Extensions;
 using ModularPipelines.Modules;
 using ModularPipelines.Options;
-using Spectre.Console;
 
 namespace ModularPipelines.Engine;
 
diff --git a/src/ModularPipelines/Engine/PipelineFileWriter.cs b/src/ModularPipelines/Engine/PipelineFileWriter.cs
@@ -1,6 +1,5 @@
 ﻿using EnumerableAsyncProcessor.Extensions;
 using Microsoft.Extensions.DependencyInjection;
-using ModularPipelines.Context;
 using ModularPipelines.Interfaces;
 
 namespace ModularPipelines.Engine;
diff --git a/src/ModularPipelines/Exceptions/PipelineException.cs b/src/ModularPipelines/Exceptions/PipelineException.cs
@@ -1,5 +1,3 @@
-using System.Runtime.Serialization;
-
 namespace ModularPipelines.Exceptions;
 
 public class PipelineException : Exception
diff --git a/src/ModularPipelines/Models/IModuleResult.cs b/src/ModularPipelines/Models/IModuleResult.cs
@@ -0,0 +1,39 @@
+﻿namespace ModularPipelines.Models;
+
+public interface IModuleResult
+{
+    /// <summary>
+    /// Gets the name of the module.
+    /// </summary>
+    public string ModuleName { get; }
+
+    /// <summary>
+    /// Gets how long the module ran for.
+    /// </summary>
+    public TimeSpan ModuleDuration { get; }
+
+    /// <summary>
+    /// Gets when the module started.
+    /// </summary>
+    public DateTimeOffset ModuleStart { get; }
+
+    /// <summary>
+    /// Gets when the module ended.
+    /// </summary>
+    public DateTimeOffset ModuleEnd { get; }
+    
+    /// <summary>
+    /// Gets the exception that occurred in the module, if one was thrown.
+    /// </summary>
+    public Exception? Exception { get; }
+
+    /// <summary>
+    /// Gets the Skip Decision of the module.
+    /// </summary>
+    public SkipDecision SkipDecision { get; }
+
+    /// <summary>
+    /// Gets the type of result that is held.
+    /// </summary>
+    public ModuleResultType ModuleResultType { get; }
+}
diff --git a/src/ModularPipelines/Models/ModuleResult.cs b/src/ModularPipelines/Models/ModuleResult.cs
@@ -61,29 +61,21 @@ private set
 }
 
 [JsonConverter(typeof(TypeDiscriminatorConverter<ModuleResult>))]
-public class ModuleResult : ITypeDiscriminator
+public class ModuleResult : IModuleResult, ITypeDiscriminator
 {
-    /// <summary>
-    /// Gets the name of the module.
-    /// </summary>
+    /// <inheritdoc />
     [JsonInclude]
     public string ModuleName { get; private set; }
 
-    /// <summary>
-    /// Gets how long the module ran for.
-    /// </summary>
+    /// <inheritdoc />
     [JsonInclude]
     public TimeSpan ModuleDuration { get; private set; }
 
-    /// <summary>
-    /// Gets when the module started.
-    /// </summary>
+    /// <inheritdoc />
     [JsonInclude]
     public DateTimeOffset ModuleStart { get; private set; }
 
-    /// <summary>
-    /// Gets when the module ended.
-    /// </summary>
+    /// <inheritdoc />
     [JsonInclude]
     public DateTimeOffset ModuleEnd { get; private set; }
 
@@ -123,21 +115,15 @@ protected ModuleResult(ModuleBase module)
         TypeDiscriminator = GetType().FullName!;
     }
 
-    /// <summary>
-    /// Gets the exception that occurred in the module, if one was thrown.
-    /// </summary>
+    /// <inheritdoc />
     [JsonInclude]
     public Exception? Exception { get; private set; }
 
-    /// <summary>
-    /// Gets the Skip Decision of the module.
-    /// </summary>
+    /// <inheritdoc />
     [JsonInclude]
     public SkipDecision SkipDecision { get; private protected set; }
 
-    /// <summary>
-    /// Gets the type of result that is held.
-    /// </summary>
+    /// <inheritdoc />
     public ModuleResultType ModuleResultType
     {
         get
diff --git a/src/ModularPipelines/Models/PipelineSummary.cs b/src/ModularPipelines/Models/PipelineSummary.cs
@@ -57,6 +57,9 @@ public T GetModule<T>()
         where T : ModuleBase
         => Modules.GetModule<T>();
 
+    public async Task<IReadOnlyList<IModuleResult>> GetModuleResultsAsync() =>
+        await Task.WhenAll(Modules.Select(x => x.GetModuleResult()));
+
     private Status GetStatus()
     {
         if (Modules.Any(x => x.Status == Status.Failed))
diff --git a/src/ModularPipelines/Modules/Module.cs b/src/ModularPipelines/Modules/Module.cs
@@ -108,6 +108,8 @@ internal override Task ExecutionTask
         }
     }
 
+    internal override async Task<IModuleResult> GetModuleResult() => await this;
+    
     /// <summary>
     /// Gets the Module of type <see cref="TModule">{TModule}</see>.
     /// </summary>
@@ -314,12 +316,13 @@ private void SetResult(ModuleResult<T> result)
 
         if (Timeout == TimeSpan.Zero)
         {
+            await await Task.WhenAny(executeAsyncTask, ThrowQuicklyOnFailure(executeAsyncTask, null));
             return await executeAsyncTask;
         }
 
         ModuleCancellationTokenSource.CancelAfter(Timeout);
 
-        var timeoutCancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(ModuleCancellationTokenSource.Token);
+        using var timeoutCancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(ModuleCancellationTokenSource.Token);
 
         var timeoutExceptionTask = Task.Delay(Timeout, timeoutCancellationTokenSource.Token)
             .ContinueWith(t =>
@@ -337,21 +340,35 @@ private void SetResult(ModuleResult<T> result)
                 throw new ModuleTimeoutException(this);
             }, CancellationToken.None);
 
-        var finishedTask = await Task.WhenAny(timeoutExceptionTask, executeAsyncTask);
+        var finishedTask = await Task.WhenAny(timeoutExceptionTask, executeAsyncTask, ThrowQuicklyOnFailure(executeAsyncTask, timeoutExceptionTask));
 
 #if NET8_0_OR_GREATER
         await timeoutCancellationTokenSource.CancelAsync();
 #else
         timeoutCancellationTokenSource.Cancel();
 #endif
-        timeoutCancellationTokenSource.Dispose();
         
         // Will throw a timeout exception if configured and timeout is reached
         await finishedTask;
 
         return await executeAsyncTask;
     }
 
+    private async Task ThrowQuicklyOnFailure(IAsyncResult mainExecutionTask, IAsyncResult? timeoutTask)
+    {
+        while (!mainExecutionTask.IsCompleted)
+        {
+            if (timeoutTask?.IsCompleted == true)
+            {
+                throw new ModuleTimeoutException(this);
+            }
+            
+            ModuleCancellationTokenSource.Token.ThrowIfCancellationRequested();
+            
+            await Task.Delay(TimeSpan.FromSeconds(5));
+        }
+    }
+
     private void SetEndTime()
     {
         _stopwatch.Stop();
diff --git a/src/ModularPipelines/Modules/ModuleBase.cs b/src/ModularPipelines/Modules/ModuleBase.cs
@@ -114,6 +114,8 @@ protected set
     internal readonly List<SubModuleBase> SubModuleBases = new();
 
     internal EventHandler<SubModuleBase>? OnSubModuleCreated;
+    
+    internal abstract Task<IModuleResult> GetModuleResult(); 
 
     /// <summary>
     /// Starts a Sub Module which will display in the pipeline progress in the console.
diff --git a/test/ModularPipelines.UnitTests/ModuleTimeoutTests.cs b/test/ModularPipelines.UnitTests/ModuleTimeoutTests.cs
@@ -51,7 +51,7 @@ public async Task Throws_TaskException_When_Using_CancellationToken()
     public async Task Throws_Timeout_Exception_When_Not_Using_CancellationToken()
     {
         var exception = await Assert.ThrowsAsync<ModuleFailedException>(RunModule<Module_NotUsingCancellationToken>);
-        await Assert.That(exception.InnerException).Is.TypeOf<ModuleTimeoutException>();
+        await Assert.That(exception.InnerException).Is.TypeOf<ModuleTimeoutException>().Or.Is.TypeOf<OperationCanceledException>().Or.Is.TypeOf<TaskCanceledException>();
     }
 
     [Test]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+* `GetModuleResultsAsync()` method exposed on `PipelineSummary` object. This will return `IModuleResult` objects which exposes module name, status, start, finish, and any skip reasons or exceptions.
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-using Microsoft.Extensions.Options;`
`2`	`1`	`using ModularPipelines.Attributes;`
`3`	`2`	`using ModularPipelines.Context;`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-using Initialization.Microsoft.Extensions.DependencyInjection.Extensions;`
`2`	`1`	`using Microsoft.Extensions.DependencyInjection;`
`3`	`2`	`using ModularPipelines.Context;`
`4`	`3`	`using ModularPipelines.Interfaces;`