V1.1.0/worker flexibility

.github/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to `Classlibrary1`
+# Contributing to `BenchmarkDotNet Extensions by Codebelt`
 When contributing to this repository, please first discuss the change you wish to make via issue,
 email, or any other method with the owners of this repository before making a change.
 
@@ -48,5 +48,5 @@ That is, in pursuit of the items on the left we have found the items on the righ
 [Manifesto for Software Craftsmanship](https://manifesto.softwarecraftsmanship.org/) is the originator of this text.
 
 ## License
-By contributing to `ClassLibrary1`, you agree that your contributions will be licensed
+By contributing to `BenchmarkDotNet Extensions by Codebelt`, you agree that your contributions will be licensed
 under the MIT license.

.nuget/Codebelt.Extensions.BenchmarkDotNet.Console/PackageReleaseNotes.txt

@@ -1,6 +1,17 @@
+Version: 1.1.0
+Availability: .NET 10 and .NET 9
+
+# ALM
+- CHANGED Dependencies have been upgraded to the latest compatible versions for all supported target frameworks (TFMs)
+
+# Improvements
+- EXTENDED BenchmarkProgram class in the Codebelt.Extensions.BenchmarkDotNet.Console namespace to support an optional service configurator delegate for customizing the IServiceCollection during host building
+- EXTENDED BenchmarkWorker class in the Codebelt.Extensions.BenchmarkDotNet.Console namespace to support skipping benchmarks that already have generated reports based on the BenchmarkWorkspaceOptions.SkipBenchmarksWithReports property
+- CHANGED BenchmarkWorker class in the Codebelt.Extensions.BenchmarkDotNet.Console namespace to conditionally suppress console status messages in services based on wether you are in a debugging session or not
+
 Version: 1.0.0
 Availability: .NET 10 and .NET 9
-
+ 
 # New Features
 - ADDED BenchmarkContext class in the Codebelt.Extensions.BenchmarkDotNet.Console namespace that represents the command-line context for a benchmark run
 - ADDED BenchmarkProgram class in the Codebelt.Extensions.BenchmarkDotNet.Console namespace that provides the main entry point for hosting and running benchmarks using BenchmarkDotNet

.nuget/Codebelt.Extensions.BenchmarkDotNet/PackageReleaseNotes.txt

@@ -1,6 +1,19 @@
+Version: 1.1.0
+Availability: .NET 10 and .NET 9
+
+# ALM
+- CHANGED Dependencies have been upgraded to the latest compatible versions for all supported target frameworks (TFMs)
+
+# Bug Fixes
+- FIXED BenchmarkWorkspaceOptions class in the Codebelt.Extensions.BenchmarkDotNet namespace so it no longer relies on Danish culture
+
+# Improvements
+- EXTENDED BenchmarkWorkspace class in the Codebelt.Extensions.BenchmarkDotNet namespace with two new static methods; GetReportsResultsPath and GetReportsTuningPath for retrieving the paths to the reports results and tuning directories respectively
+- EXTENDED BenchmarkWorkspaceOptions class in the Codebelt.Extensions.BenchmarkDotNet namespace to include one new property; SkipBenchmarksWithReports that indicates whether benchmarks that already have generated reports should be skipped during execution
+
 Version: 1.0.0
 Availability: .NET 10 and .NET 9
-
+ 
 # New Features
 - ADDED BenchmarkWorkspace class in the Codebelt.Extensions.BenchmarkDotNet namespace that provides a default implementation of IBenchmarkWorkspace for discovering and handling assemblies and their generated artifacts in BenchmarkDotNet
 - ADDED BenchmarkWorkspaceOptions class in the Codebelt.Extensions.BenchmarkDotNet namespace that specifies configuration options that is related to the BenchmarkWorkspace class

CHANGELOG.md

@@ -4,6 +4,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 For more details, please refer to `PackageReleaseNotes.txt` on a per assembly basis in the `.nuget` folder.
 
+## [1.1.0] - 2025-12-14
+
+### Changed
+
+- `BenchmarkWorkspace` class in the Codebelt.Extensions.BenchmarkDotNet namespace was extended with two new static methods; `GetReportsResultsPath` and `GetReportsTuningPath` for retrieving the paths to the reports results and tuning directories respectively,
+- `BenchmarkWorkspaceOptions` class in the Codebelt.Extensions.BenchmarkDotNet namespace was extended with an additional new property; `SkipBenchmarksWithReports` that indicates whether benchmarks that already have generated reports should be skipped during execution,
+- `BenchmarkProgram` class in the Codebelt.Extensions.BenchmarkDotNet.Console namespace was extended to support an optional service configurator delegate for customizing the `IServiceCollection` during host building,
+- `BenchmarkWorker` class in the Codebelt.Extensions.BenchmarkDotNet.Console namespace was extended to support skipping benchmarks that already have generated reports based on the `BenchmarkWorkspaceOptions.SkipBenchmarksWithReports` property,
+- `BenchmarkWorker` class in the Codebelt.Extensions.BenchmarkDotNet.Console namespace was changed to conditionally suppress console status messages in services based on wether you are in a debugging session or not.
+
+### Fixed
+
+- `BenchmarkWorkspaceOptions` class in the Codebelt.Extensions.BenchmarkDotNet namespace was fixed so it no longer relies on Danish culture.
+
 ## [1.0.0] - 2025-12-12
 
 This is the initial stable release of the `Codebelt.Extensions.BenchmarkDotNet` and `Codebelt.Extensions.BenchmarkDotNet.Console` packages.

Directory.Build.props

@@ -6,7 +6,7 @@
     <IsToolingProject>$(MSBuildProjectDirectory.ToLower().StartsWith('$(MSBuildThisFileDirectory.ToLower())tooling'))</IsToolingProject>
     <IsLinux>$([MSBuild]::IsOSPlatform('Linux'))</IsLinux>
     <IsWindows>$([MSBuild]::IsOSPlatform('Windows'))</IsWindows>
-    <IsMainAuthor Condition="'$(EMAIL)' == 'classlibrary1@dot.net'">true</IsMainAuthor>
+    <IsMainAuthor Condition="'$(EMAIL)' == 'michael@geekle.io'">true</IsMainAuthor>
     <SkipSignAssembly>false</SkipSignAssembly>
     <PackageReleaseNotesFile>..\..\.nuget\$(MSBuildProjectName)\PackageReleaseNotes.txt</PackageReleaseNotesFile>
     <LangVersion>latest</LangVersion>

Directory.Packages.props

@@ -7,7 +7,7 @@
     <PackageVersion Include="BenchmarkDotNet.Diagnostics.Windows" Version="0.15.8" />
     <PackageVersion Include="Codebelt.Bootstrapper.Console" Version="5.0.1" />
     <PackageVersion Include="Codebelt.Extensions.Xunit.App" Version="11.0.2" />
-    <PackageVersion Include="Cuemon.Core" Version="10.1.0" />
+    <PackageVersion Include="Cuemon.Core" Version="10.1.1" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
     <PackageVersion Include="MinVer" Version="6.0.0" />
     <PackageVersion Include="coverlet.collector" Version="6.0.4" />

src/Codebelt.Extensions.BenchmarkDotNet.Console/BenchmarkProgram.cs

@@ -43,7 +43,21 @@ static BenchmarkProgram()
         /// </remarks>
         public static void Run(string[] args, Action<BenchmarkWorkspaceOptions> setup = null)
         {
-            Run<BenchmarkWorkspace>(args, setup);
+            Run(args, null, setup);
+        }
+
+        /// <summary>
+        /// Runs benchmarks using the default <see cref="BenchmarkWorkspace"/> implementation.
+        /// </summary>
+        /// <param name="args">The command-line arguments passed to the application.</param>
+        /// <param name="serviceConfigurator">The delegate that will be invoked to configure additional services in the <see cref="IServiceCollection"/>.</param>
+        /// <param name="setup">The <see cref="BenchmarkWorkspaceOptions"/> which may be configured.</param>
+        /// <remarks>
+        /// This method configures the host builder with the necessary services, builds the host, and runs it to execute benchmarks.
+        /// </remarks>
+        public static void Run(string[] args, Action<IServiceCollection> serviceConfigurator = null, Action<BenchmarkWorkspaceOptions> setup = null)
+        {
+            Run<BenchmarkWorkspace>(args, serviceConfigurator, setup);
         }
 
         /// <summary>
@@ -56,12 +70,28 @@ public static void Run(string[] args, Action<BenchmarkWorkspaceOptions> setup =
         /// This method configures the host builder with the necessary services, builds the host, and runs it to execute benchmarks.
         /// </remarks>
         public static void Run<TWorkspace>(string[] args, Action<BenchmarkWorkspaceOptions> setup = null) where TWorkspace : class, IBenchmarkWorkspace
+        {
+            Run<TWorkspace>(args, null, setup);
+        }
+
+        /// <summary>
+        /// Runs benchmarks using a custom implementation of <see cref="IBenchmarkWorkspace"/>.
+        /// </summary>
+        /// <typeparam name="TWorkspace">The type of the workspace that implements <see cref="IBenchmarkWorkspace"/>.</typeparam>
+        /// <param name="args">The command-line arguments passed to the application.</param>
+        /// <param name="serviceConfigurator">The delegate that will be invoked to configure additional services in the <see cref="IServiceCollection"/>.</param>
+        /// <param name="setup">The <see cref="BenchmarkWorkspaceOptions"/> which may be configured.</param>
+        /// <remarks>
+        /// This method configures the host builder with the necessary services, builds the host, and runs it to execute benchmarks.
+        /// </remarks>
+        public static void Run<TWorkspace>(string[] args, Action<IServiceCollection> serviceConfigurator = null, Action<BenchmarkWorkspaceOptions> setup = null) where TWorkspace : class, IBenchmarkWorkspace
         {
             var hostBuilder = CreateHostBuilder(args);
             hostBuilder.ConfigureServices(services =>
             {
                 services.AddSingleton(new BenchmarkContext(args));
                 services.AddBenchmarkWorkspace<TWorkspace>(setup);
+                serviceConfigurator?.Invoke(services);
             });
             var host = hostBuilder.Build();
             host.Run();

src/Codebelt.Extensions.BenchmarkDotNet.Console/BenchmarkWorker.cs

@@ -4,8 +4,12 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using System;
+using System.IO;
+using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
+using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Filters;
 
 namespace Codebelt.Extensions.BenchmarkDotNet.Console
 {
@@ -33,7 +37,7 @@
         /// </remarks>
         public override void ConfigureServices(IServiceCollection services)
         {
-            services.Configure<ConsoleLifetimeOptions>(o => o.SuppressStatusMessages = true);
+            services.Configure<ConsoleLifetimeOptions>(o => o.SuppressStatusMessages = !BenchmarkProgram.IsDebugBuild);
         }
 
         /// <summary>
@@ -46,13 +50,39 @@
         /// When arguments are provided, they are forwarded to <see cref="BenchmarkSwitcher"/> for selective execution.
         /// After execution completes, the worker performs artifact post-processing.
         /// </remarks>
         public override Task RunAsync(IServiceProvider serviceProvider, CancellationToken cancellationToken)
         {
             var options = serviceProvider.GetRequiredService<BenchmarkWorkspaceOptions>();
             var workspace = serviceProvider.GetRequiredService<IBenchmarkWorkspace>();
             var assemblies = workspace.LoadBenchmarkAssemblies();
             var context = serviceProvider.GetRequiredService<BenchmarkContext>();
 
+            if (options.SkipBenchmarksWithReports)
+            {
+                var benchmarkTypes = assemblies.SelectMany(a => a.GetTypes().Where(t => t.Name.EndsWith("Benchmark"))).ToList();
+                options.ConfigureBenchmarkDotNet(c =>
+                {
+                    var reports = Directory.EnumerateFiles(BenchmarkWorkspace.GetReportsTuningPath(options));
+                    foreach (var report in reports)
+                    {
+                        var filename = Path.GetFileNameWithoutExtension(report);
+                        var potentialTypeFullName = filename.Split('-').FirstOrDefault();
+                        if (string.IsNullOrWhiteSpace(potentialTypeFullName)) { continue; }
+
+                        var potentialTypeName = potentialTypeFullName.Split('.').LastOrDefault();
+                        if (string.IsNullOrWhiteSpace(potentialTypeName)) { continue; }
+
+                        var matchingType = benchmarkTypes.SingleOrDefault(t => t.Name.Equals(potentialTypeName, StringComparison.OrdinalIgnoreCase));
+
+                        if (matchingType != null)
+                        {
+                            c = c.AddFilter(new SimpleFilter(bc => bc.Descriptor.Type != matchingType));
+                        }
+                    }
+                    return c;
+                });
+            }
+
             try
             {
                 if (context.Args.Length == 0)

src/Codebelt.Extensions.BenchmarkDotNet/BenchmarkWorkspace.cs

@@ -21,6 +21,34 @@
     private static readonly Lock AssemblyResolverLock = new();
     private static Dictionary<string, string> _assemblyLookup = new(StringComparer.OrdinalIgnoreCase);
 
+    /// <summary>
+    /// Gets the path to the BenchmarkDotNet results directory
+    /// </summary>
+    /// <param name="options">The <see cref="BenchmarkWorkspaceOptions"/> which configures repository paths, build modes and BenchmarkDotNet configuration.</param>
+    /// <returns>A string containing the full path to the 'results' directory within the artifacts path.</returns>
+    /// <remarks>
+    /// This path is constructed from the configured <see cref="IConfig.ArtifactsPath"/> and the "results" subdirectory.
+    /// </remarks>
+    public static string GetReportsResultsPath(BenchmarkWorkspaceOptions options)
+    {
+        Validator.ThrowIfInvalidOptions(options);
+        return Path.Combine(options.Configuration.ArtifactsPath, "results");
+    }
+
+    /// <summary>
+    /// Gets the path to the tuning folder where final benchmark reports are stored.
+    /// </summary>
+    /// <param name="options">The <see cref="BenchmarkWorkspaceOptions"/> which configures repository paths, build modes and BenchmarkDotNet configuration.</param>
+    /// <returns>A string representing the full path to the tuning reports directory.</returns>
+    /// <remarks>
+    /// This path is constructed from the configured <see cref="IConfig.ArtifactsPath"/> and the <see cref="BenchmarkWorkspaceOptions.RepositoryTuningFolder"/>.
+    /// </remarks>
+    public static string GetReportsTuningPath(BenchmarkWorkspaceOptions options)
+    {
+        Validator.ThrowIfInvalidOptions(options);
+        return Path.Combine(options.Configuration.ArtifactsPath, options.RepositoryTuningFolder);
+    }
+
     /// <summary>
     /// Initializes a new instance of the <see cref="BenchmarkWorkspace"/> class with the specified options.
     /// </summary>
@@ -74,12 +102,10 @@
     /// </remarks>
     public void PostProcessArtifacts()
     {
-        var reportsResultsPath = Path.Combine(_options.Configuration.ArtifactsPath, "results");
-        var reportsTuningPath = Path.Combine(_options.Configuration.ArtifactsPath, _options.RepositoryTuningFolder);
-        CleanupResults(reportsResultsPath, reportsTuningPath);
+        CleanupResults(GetReportsResultsPath(_options), GetReportsTuningPath(_options));
     }
 
     private static IEnumerable<Assembly> LoadAssemblies(string repositoryPath, string targetFrameworkMoniker, string benchmarkProjectSuffix, string repositoryTuningFolder, bool useDebugBuild)
     {
         var tuningDir = Path.Combine(repositoryPath, repositoryTuningFolder);
         Directory.CreateDirectory(tuningDir);
@@ -95,7 +121,7 @@
 
         var candidatePaths = Directory
             .EnumerateFiles(tuningDir, $"*.{benchmarkProjectSuffix}.dll", SearchOption.AllDirectories)
             .Where(path => path.IndexOf(buildSegment, StringComparison.OrdinalIgnoreCase) >= 0);
 
         foreach (var path in candidatePaths)
         {
@@ -116,7 +142,7 @@
                     continue;
                 }
 
                 assemblies.Add(Assembly.LoadFrom(path));
             }
             catch
             {
@@ -188,11 +214,10 @@
 
         Directory.CreateDirectory(reportsTuningPath);
 
-        foreach (var file in Directory.GetFiles(reportsResultsPath).Where(s => !s.EndsWith(".lock")))
+        foreach (var file in Directory.GetFiles(reportsResultsPath))
         {
             var targetFile = Path.Combine(reportsTuningPath, Path.GetFileName(file));
-            File.Delete(targetFile);
-            File.Move(file, targetFile);
+            File.Move(file, targetFile, true);
         }
 
         Directory.Delete(reportsResultsPath, recursive: true);

src/Codebelt.Extensions.BenchmarkDotNet/BenchmarkWorkspaceOptions.cs

@@ -55,6 +55,10 @@
 ///         <term><see cref="AllowDebugBuild"/></term>
 ///         <description><c>false</c></description>
 ///     </item>
+///     <item>
+///         <term><see cref="SkipBenchmarksWithReports"/></term>
+///         <description><c>false</c></description>
+///     </item>
 /// </list>
 /// </remarks>
 public class BenchmarkWorkspaceOptions : IValidatableParameterObject, IPostConfigurableParameterObject
@@ -87,7 +91,6 @@
 
     private static readonly string DefaultRepositoryPath = GetDefaultRepositoryPath();
     private static readonly string DefaultTargetFrameworkMoniker = ResolveCurrentTfm();
-    private static readonly CultureInfo DanishCulture = CultureInfo.GetCultureInfo("da-DK");
 
     /// <summary>
     /// Initializes a new instance of the <see cref="BenchmarkWorkspaceOptions"/> class with sensible defaults.
@@ -147,6 +150,14 @@
     /// <c>true</c> to allow Debug builds for benchmarks; otherwise, <c>false</c>. Default is <c>false</c>.
     /// </value>
     public bool AllowDebugBuild { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether benchmarks that already have generated reports should be skipped during execution.
+    /// </summary>
+    /// <value>
+    /// <c>true</c> to skip benchmarks with existing reports; otherwise, <c>false</c>. Default is <c>false</c>.
+    /// </value>
+    public bool SkipBenchmarksWithReports { get; set; }
 
     /// <summary>
     /// Finalizes the configured options before use.
@@ -221,7 +232,7 @@
             .AddJob(Slim.AsDefault()) // tell BDN that this are our default settings
             .AddDiagnoser(MemoryDiagnoser.Default) // MemoryDiagnoser is enabled by default
             .AddColumn(StatisticColumn.Median, StatisticColumn.Min, StatisticColumn.Max)
-            .WithSummaryStyle(SummaryStyle.Default.WithMaxParameterColumnWidth(36).WithCultureInfo(DanishCulture)); // the default is 20 and trims too aggressively some benchmark results
+            .WithSummaryStyle(SummaryStyle.Default.WithMaxParameterColumnWidth(36)); // the default is 20 and trims too aggressively some benchmark results
         config.Options = ConfigOptions.DisableLogFile;
         return config;
     }
@@ -236,7 +247,7 @@
             .DontEnforcePowerPlan(); // make sure BDN does not try to enforce High Performance power plan on Windows
     }
 
     private static string ResolveCurrentTfm()
     {
         try
         {

test/Codebelt.Extensions.BenchmarkDotNet.Console.Tests/BenchmarkProgramTest.cs

@@ -57,6 +57,13 @@ public void BuildConfiguration_ShouldBeDebug_WhenCompiledInDebugMode()
             return;
         }
 
+        if (entryAssembly.FullName.Contains("ReSharper", StringComparison.OrdinalIgnoreCase))
+        {
+            // Skip test if running under ReSharper
+            TestOutput.WriteLine("Running under ReSharper, skipping test");
+            return;
+        }
+
         // Act
         var buildConfiguration = BenchmarkProgram.BuildConfiguration;
 
@@ -82,6 +89,13 @@ public void IsDebugBuild_ShouldBeTrue_WhenCompiledInDebugMode()
             return;
         }
 
+        if (entryAssembly.FullName.Contains("ReSharper", StringComparison.OrdinalIgnoreCase))
+        {
+            // Skip test if running under ReSharper
+            TestOutput.WriteLine("Running under ReSharper, skipping test");
+            return;
+        }
+
         // Act
         var isDebugBuild = BenchmarkProgram.IsDebugBuild;
 

test/Codebelt.Extensions.BenchmarkDotNet.Console.Tests/BenchmarkWorkerTest.cs

@@ -161,7 +161,16 @@ public void ConfigureServices_ShouldSuppressStatusMessages()
 
         // Assert
         Assert.NotNull(options);
-        Assert.True(options.SuppressStatusMessages);
+
+        if (BenchmarkProgram.IsDebugBuild)
+        {
+            Assert.False(options.SuppressStatusMessages);
+        }
+        else
+        {
+            Assert.True(options.SuppressStatusMessages);
+        }
+
 
         TestOutput.WriteLine($"ConsoleLifetimeOptions.SuppressStatusMessages = {options.SuppressStatusMessages}");
     }