Feature/refactor module hanlders (#211)

* Module Handlers WIP

* Module Handlers

* ReleaseNotes.md

* Fix

* Formatting Markdown

* Fix

* Fix

* Fix

* Fix

* Fix nullability warnings

* Fix warnings

* Fix

---------

Co-authored-by: Tom Longhurst <thomhurst@users.noreply.github.com>

Author: thomhurst

README.md

@@ -52,7 +52,6 @@ Define your pipeline in .NET! Strong types, intellisense, parallelisation, and t
 | ModularPipelines.TeamCity | Helpers for interacting with TeamCity build agents. | [![nuget](https://img.shields.io/nuget/v/ModularPipelines.TeamCity.svg)](https://www.nuget.org/packages/ModularPipelines.TeamCity/) |
 | ModularPipelines.Terraform | Helpers for interacting with Terraform CLI. | [![nuget](https://img.shields.io/nuget/v/ModularPipelines.Terraform.svg)](https://www.nuget.org/packages/ModularPipelines.Terraform/) |
 
-
 ## Getting Started
 
 If you want to see how to get started, or want to know more about ModularPipelines, [read the Wiki page here](https://github.com/thomhurst/ModularPipelines/wiki)

src/ModularPipelines.Build/Modules/NugetVersionGeneratorModule.cs

@@ -23,7 +23,7 @@ public NugetVersionGeneratorModule(IOptions<PublishSettings> publishSettings)
 
         if (_publishSettings.Value.IsAlpha)
         {
-            return $"{gitVersionInformation.FullSemVer}alpha{gitVersionInformation.CommitsSinceVersionSourcePadded!}";
+            return $"{gitVersionInformation.FullSemVer}-alpha{gitVersionInformation.CommitsSinceVersionSourcePadded!}";
         }
 
         return gitVersionInformation.FullSemVer;

src/ModularPipelines.Build/ReleaseNotes.md

@@ -0,0 +1 @@
+*   Refactored Module Handlers for cleaner code

src/ModularPipelines.DotNet/DotNet.cs

@@ -75,7 +75,7 @@ public async Task<DotNetTestResult> Test(DotNetTestOptions options, Cancellation
             throw new DotNetTestFailedException(result, null);
         }
 
-        var trxContents = await _fileSystemContext.GetFile(trxFilePath).ReadAsync();
+        var trxContents = await _fileSystemContext.GetFile(trxFilePath).ReadAsync(cancellationToken);
 
         logger.LogDebug("Trx file contents: {Contents}", trxContents);
 

src/ModularPipelines.Examples/Modules/GitVersionModule.cs

@@ -1,5 +1,4 @@
 using Microsoft.Extensions.Logging;
-using ModularPipelines.Attributes;
 using ModularPipelines.Context;
 using ModularPipelines.Git.Extensions;
 using ModularPipelines.Git.Options;

src/ModularPipelines.Examples/SubmodulesModule.cs

@@ -1,11 +1,17 @@
 using Microsoft.Extensions.Logging;
 using ModularPipelines.Context;
+using ModularPipelines.Models;
 using ModularPipelines.Modules;
 
 namespace ModularPipelines.Examples;
 
 public class SubmodulesModule : Module
 {
+    protected override Task<SkipDecision> ShouldSkip(IPipelineContext context)
+    {
+        return base.ShouldSkip(context);
+    }
+
     /// <inheritdoc/>
     protected override async Task<IDictionary<string, object>?> ExecuteAsync(IPipelineContext context, CancellationToken cancellationToken)
     {

src/ModularPipelines/Context/NoModulePipelineContext.cs

@@ -115,7 +115,7 @@ public static void Initialize(IServiceCollection services)
             .AddSingleton<IBuildSystemSecretMasker, BuildSystemSecretMasker>()
             .AddSingleton<IBuildSystemDetector, BuildSystemDetector>()
             .AddSingleton<ISmartCollapsableLoggingStringBlockProvider, SmartCollapsableLoggingStringBlockProvider>()
-            .AddSingleton<IModuleIgnoreHandler, ModuleIgnoreHandler>()
+            .AddSingleton<IModuleConditionHandler, ModuleConditionHandler>()
             .AddSingleton<IAssemblyLoadedTypesProvider, AssemblyLoadedTypesProvider>()
             .AddSingleton<IConsoleWriter, ConsoleWriter>()
             .AddSingleton<IEnvironmentVariables, EnvironmentVariables>();

src/ModularPipelines/DependencyInjection/DependencyInjectionSetup.cs

@@ -0,0 +1,28 @@
+using Microsoft.Extensions.Logging;
+using ModularPipelines.Context;
+using ModularPipelines.Models;
+using ModularPipelines.Modules;
+
+namespace ModularPipelines.Engine.Executors.ModuleHandlers;
+
+internal class BaseHandler<T>
+{
+    public Module<T> Module { get; }
+
+    public TaskCompletionSource<ModuleResult<T>> ModuleResultTaskCompletionSource => Module.ModuleResultTaskCompletionSource;
+
+    public IPipelineContext Context => Module.Context;
+    
+    public ILogger Logger => Context.Logger;
+
+    public EngineCancellationToken EngineCancellationToken => Context.EngineCancellationToken;
+
+    public CancellationTokenSource ModuleCancellationTokenSource => Module.ModuleCancellationTokenSource;
+
+    public ModuleRunType RunType => Module.ModuleRunType;
+    
+    protected BaseHandler(Module<T> module)
+    {
+        Module = module;
+    }
+}

src/ModularPipelines/Engine/Executors/ModuleHandlers/BaseHandler.cs

@@ -0,0 +1,33 @@
+using ModularPipelines.Models;
+using ModularPipelines.Modules;
+
+namespace ModularPipelines.Engine.Executors.ModuleHandlers;
+
+internal class CancellationHandler<T> : BaseHandler<T>, ICancellationHandler
+{
+    public CancellationHandler(Module<T> module) : base(module)
+    {
+    }
+
+    public void SetupCancellation()
+    {
+        if (Module.ModuleRunType != ModuleRunType.AlwaysRun)
+        {
+            EngineCancellationToken.Token.Register(Module.ModuleCancellationTokenSource.Cancel);
+        }
+        
+        ModuleCancellationTokenSource.Token.ThrowIfCancellationRequested();
+    }
+
+    public Task ConfigureModuleTimeout()
+    {
+        if (Module.Timeout == TimeSpan.Zero)
+        {
+            return Task.CompletedTask;
+        }
+
+        ModuleCancellationTokenSource.CancelAfter(Module.Timeout);
+        
+        return Task.Delay(Module.Timeout + TimeSpan.FromSeconds(30), ModuleCancellationTokenSource.Token);
+    }
+}