Modules - Composition (#1343)

* Refactor module result repository to use IModule interface

* refactor: change TaskCompletionSource to instance variable in EngineCancellationTokenTests

* Refactor module interfaces and implementations to use IModule instead of ModuleBase

- Updated IModuleScheduler and IPipelineSetupExecutor interfaces to accept IModule instead of ModuleBase.
- Introduced ModuleDependencyResolver to handle module dependencies using DependsOn attributes.
- Refactored ModuleDisposer and ModuleExecutor to work with IModule and ModuleState.
- Enhanced ModuleState to track module results and skip decisions.
- Updated event notifications to use ModuleState instead of ModuleBase.
- Adjusted ProgressPrinter to manage progress for IModule and ModuleState.
- Modified IPipelineModuleHooks to work with IModule.
- Ensured all modules and related classes now consistently use IModule for better abstraction and flexibility.

* Refactor unit tests to use IModule interface and improve consistency

* refactor: update JSON serialization handling for IModule properties in PipelineSummary

* refactor: add global.json for SDK and test configuration; update TrxParsingTests to use temporary results directory

* refactor: update AzureCommandTests to implement IModule interface and improve test consistency

* refactor: update ModuleExecutor to create a scope for resolving IPipelineContext

* refactor: update .NET version in workflow to 10.0.x

* refactor: create a scope for resolving scoped services in ModuleExecutor

* fix: use scoped service provider in tests for IPipelineContext

IPipelineContext is a scoped service, so tests need to create a scope
before resolving it from the host's service provider.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* refactor: update test options to use WorkingDirectory instead of ProjectSolutionDirectoryDllExe

* refactor: update IModule references to use Module base class in various modules and tests

* refactor: replace RunModuleWithResult with RunModule in test cases

* fix: set completion result for skipped modules in ModuleExecutionPipeline

* refactor: update AzureCommandModules to inherit from Module base class and adjust test cases

* refactor: update modules to inherit from Module base class and override ExecuteAsync method

* refactor: enhance module dependency resolution to support self-referencing checks and available module types

* refactor: enhance logging for NotInParallel constraint checks in ModuleScheduler and related tests

* refactor: enhance logging in ModuleScheduler and simplify test setup in NotInParallelTestsWithConstraintKeys

* refactor: replace ConcurrentBag with ConcurrentDictionary for accurate module tracking in NotInParallelTestsWithConstraintKeys

* refactor: replace Dictionary with ConcurrentDictionary for thread-safe module start time tracking in MyModuleHooks

---------

Co-authored-by: Claude <noreply@anthropic.com>

Author: thomhurst

.github/copilot-instructions.md

@@ -43,7 +43,7 @@ dotnet build ModularPipelines.Examples.sln -c Release
 4. **Run Build Pipeline** (150+ seconds - NEVER CANCEL):
 ```bash
 cd src/ModularPipelines.Build
-dotnet run -c Release --framework net8.0
+dotnet run -c Release --framework net10.0
 ```
 Note: The build pipeline may fail in development environment due to missing CI environment variables (like origin/main branch). This is expected. The pipeline includes test execution with code coverage.
 
@@ -138,7 +138,7 @@ yarn start
 1. Build the affected solutions
 2. Run formatting: `dotnet format ModularPipelines.sln`
 3. Run tests for affected areas
-4. If modifying the build pipeline, test with: `cd src/ModularPipelines.Build && dotnet run -c Release --framework net8.0`
+4. If modifying the build pipeline, test with: `cd src/ModularPipelines.Build && dotnet run -c Release --framework net10.0`
 
 **For module development:**
 1. Create a module inheriting from `Module<T>`

.github/workflows/dotnet.yml

@@ -51,7 +51,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v5
         with:
-          dotnet-version: 9.0.x
+          dotnet-version: 10.0.x
       - name: Cache NuGet
         uses: actions/cache@v4
         with:
@@ -70,7 +70,7 @@ jobs:
           done
       
       - name: Run Pipeline
-        run: dotnet run -c Release --framework net8.0
+        run: dotnet run -c Release --framework net10.0
         working-directory: "src/ModularPipelines.Build"
         env:
           GITHUB_TOKEN: ${{ github.token }}

CLAUDE.md

@@ -15,18 +15,18 @@ dotnet build ModularPipelines.Analyzers.sln -c Release
 
 # Run the build pipeline (from src/ModularPipelines.Build)
 cd src/ModularPipelines.Build
-dotnet run -c Release --framework net8.0
+dotnet run -c Release --framework net10.0
 ```
 
 ### Running Tests
 ```bash
 # Run all unit tests (pattern: *UnitTests.csproj)
 # Tests are executed via the build pipeline with coverage
 cd src/ModularPipelines.Build
-dotnet run -c Release --framework net8.0
+dotnet run -c Release --framework net10.0
 
 # Run a single test project manually
-dotnet run --project <path-to-test-project> --framework net9.0 -- --coverage --coverage-output-format cobertura
+dotnet run --project <path-to-test-project> --framework net10.0 -- --coverage --coverage-output-format cobertura
 ```
 
 ### Code Formatting
@@ -111,4 +111,5 @@ The build pipeline (`src/ModularPipelines.Build/`) demonstrates best practices:
 - Unit tests use the project's own pipeline system
 - Tests run with code coverage collection enabled
 - Coverage reports uploaded to Codacy and Codecov
-- Test projects identified by "*UnitTests.csproj" pattern
+- Test projects identified by "*UnitTests.csproj" pattern
+- remember the correct filter syntax

Directory.Build.props

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
   <PropertyGroup>
-    <TargetFrameworks Condition="'$(TargetFrameworks)' == ''">net8.0;net9.0</TargetFrameworks>
+    <TargetFrameworks Condition="'$(TargetFrameworks)' == ''">net10.0</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <LangVersion>preview</LangVersion>

global.json

@@ -1,7 +1,10 @@
 {
   "sdk": {
-    "version": "9.0.304",
+    "version": "10.0.100",
     "rollForward": "latestMinor", 
     "allowPrerelease": false
+  },
+  "test": {
+    "runner": "Microsoft.Testing.Platform"
   }
 }

src/ModularPipelines.Analyzers/ModularPipelines.Analyzers.Test/Net.cs

@@ -19,11 +19,11 @@ internal static class Net
 
     private static readonly Lazy<ReferenceAssemblies> LazyNet80 = new(() =>
         new ReferenceAssemblies(
-                "net8.0",
+                "net10.0",
                 new PackageIdentity(
                     "Microsoft.NETCore.App.Ref",
                     "8.0.6"),
-                Path.Combine("ref", "net8.0"))
+                Path.Combine("ref", "net10.0"))
             .AddPackages(ImmutableArray.Create(new PackageIdentity("Microsoft.Extensions.Logging", "8.0.0")))
     );
 

src/ModularPipelines.Build/Modules/ChangedFilesInPullRequestModule.cs

@@ -12,7 +12,7 @@ namespace ModularPipelines.Build.Modules;
 [SkipOnMainBranch]
 public class ChangedFilesInPullRequestModule : Module<IReadOnlyList<File>>
 {
-    protected override async Task<IReadOnlyList<File>?> ExecuteAsync(IPipelineContext context, CancellationToken cancellationToken)
+    public override async Task<IReadOnlyList<File>?> ExecuteAsync(IModuleContext context, CancellationToken cancellationToken)
     {
         var result = await context.Git().Commands.Diff(new GitDiffOptions
         {

src/ModularPipelines.Build/Modules/CodeFormattedNicelyModule.cs

@@ -11,17 +11,16 @@
 using ModularPipelines.GitHub.Extensions;
 using ModularPipelines.Models;
 using ModularPipelines.Modules;
+using ModularPipelines.Modules.Behaviors;
 
 namespace ModularPipelines.Build.Modules;
 
 [SkipIfNoGitHubToken]
 [SkipIfNoStandardGitHubToken]
 [SkipOnMainBranch]
 [RunOnLinuxOnly]
-public class CodeFormattedNicelyModule : Module<CommandResult>
+public class CodeFormattedNicelyModule : Module<CommandResult>, ISkippable, IAlwaysRun
 {
-    public override ModuleRunType ModuleRunType => ModuleRunType.AlwaysRun;
-
     private const string DotnetFormatGitMessage = "DotNet Format";
 
     private readonly IOptions<GitHubSettings> _githubSettings;
@@ -31,7 +30,7 @@ public CodeFormattedNicelyModule(IOptions<GitHubSettings> githubSettings)
         _githubSettings = githubSettings;
     }
 
-    protected override Task<SkipDecision> ShouldSkip(IPipelineContext context)
+    public Task<SkipDecision> ShouldSkip(IPipelineContext context)
     {
         if (context.GitHub().EnvironmentVariables.EventName != "pull_request")
         {
@@ -46,12 +45,11 @@ protected override Task<SkipDecision> ShouldSkip(IPipelineContext context)
         return SkipDecision.DoNotSkip.AsTask();
     }
 
-    /// <inheritdoc/>
-    protected override async Task<CommandResult?> ExecuteAsync(IPipelineContext context, CancellationToken cancellationToken)
+    public override async Task<CommandResult?> ExecuteAsync(IModuleContext context, CancellationToken cancellationToken)
     {
         if (!context.Git().Information.BranchName!.Contains("pull"))
         {
-            return await NothingAsync();
+            return null;
         }
 
         try

src/ModularPipelines.Build/Modules/CreateReleaseModule.cs

@@ -8,6 +8,7 @@
 using ModularPipelines.GitHub.Extensions;
 using ModularPipelines.Models;
 using ModularPipelines.Modules;
+using ModularPipelines.Modules.Behaviors;
 using Octokit;
 
 namespace ModularPipelines.Build.Modules;
@@ -18,7 +19,7 @@ namespace ModularPipelines.Build.Modules;
 [DependsOn<NugetVersionGeneratorModule>]
 [DependsOn<UploadPackagesToNugetModule>]
 [DependsOn<DependabotCommitsModule>]
-public class CreateReleaseModule : Module<Release>
+public class CreateReleaseModule : Module<Release>, ISkippable, IIgnoreFailures
 {
     private readonly IOptions<GitHubSettings> _githubSettings;
     private readonly IOptions<PublishSettings> _publishSettings;
@@ -30,14 +31,13 @@ public CreateReleaseModule(IOptions<GitHubSettings> githubSettings,
         _publishSettings = publishSettings;
     }
 
-    protected override async Task<bool> ShouldIgnoreFailures(IPipelineContext context, Exception exception)
+    public async Task<bool> ShouldIgnoreFailures(IPipelineContext context, Exception exception)
     {
         await Task.Yield();
         return exception is ApiValidationException;
     }
 
-    /// <inheritdoc/>
-    protected override async Task<SkipDecision> ShouldSkip(IPipelineContext context)
+    public async Task<SkipDecision> ShouldSkip(IPipelineContext context)
     {
         await Task.CompletedTask;
 
@@ -49,10 +49,9 @@ protected override async Task<SkipDecision> ShouldSkip(IPipelineContext context)
         return string.IsNullOrEmpty(_githubSettings.Value.AdminToken);
     }
 
-    /// <inheritdoc/>
-    protected override async Task<Release?> ExecuteAsync(IPipelineContext context, CancellationToken cancellationToken)
+    public override async Task<Release?> ExecuteAsync(IModuleContext context, CancellationToken cancellationToken)
     {
-        var versionInfoResult = await GetModule<NugetVersionGeneratorModule>();
+        var versionInfoResult = context.GetModule<NugetVersionGeneratorModule, string>();
 
         return await context.GitHub().Client.Repository.Release.Create(long.Parse(context.GitHub().EnvironmentVariables.RepositoryId!),
             new NewRelease($"v{versionInfoResult.Value}")

src/ModularPipelines.Build/Modules/DependabotCommitsModule.cs

@@ -12,7 +12,7 @@ namespace ModularPipelines.Build.Modules;
 [RunOnLinuxOnly]
 public class DependabotCommitsModule : Module<List<string>>
 {
-    protected override async Task<List<string>?> ExecuteAsync(IPipelineContext context, CancellationToken cancellationToken)
+    public override async Task<List<string>?> ExecuteAsync(IModuleContext context, CancellationToken cancellationToken)
     {
         var repositoryInfo = context.GitHub().RepositoryInfo;