Centralize Coverlet command-line option definitions

Refactor to introduce CoverletCommandLineOptionDefinitions as the single source of truth for all command-line options, eliminating duplication and inconsistencies. Remove CoverletCommandLineOptionsProvider and update CoverletExtensionCommandLineProvider to use the centralized definitions and validation. Rename and clean up option constants in CoverletOptionNames. Update CoverageConfiguration and related logging for new source mapping file handling. Adjust tests and namespaces for consistency with new option names and structure.

Author: Bertk

eng/build.yml

@@ -42,7 +42,7 @@ steps:
     artifacts\bin\coverlet.MTP.unit.tests\debug\coverlet.MTP.unit.tests.exe --diagnostic --diagnostic-verbosity trace --report-xunit-trx --report-xunit-trx-filename "coverlet.MTP.unit.tests.trx" --diagnostic --diagnostic-output-directory "$(Build.SourcesDirectory)/artifacts/log/$(BuildConfiguration)" --diagnostic-file-prefix "coverlet.MTP.unit.tests_"
     artifacts\bin\coverlet.MTP.validation.tests\debug\coverlet.MTP.validation.tests.exe --diagnostic --diagnostic-verbosity trace --report-xunit-trx --report-xunit-trx-filename "coverlet.MTP.validation.tests.trx" --diagnostic --diagnostic-output-directory "$(Build.SourcesDirectory)/artifacts/log/$(BuildConfiguration)" --diagnostic-file-prefix "coverlet.MTP.validation.tests_"
     dotnet test test/coverlet.core.tests/coverlet.core.tests.csproj -c $(BuildConfiguration) --no-build -bl:test.core.binlog /p:CollectCoverage=true /p:CoverletOutputFormat=opencover /p:Exclude="[coverlet.core.tests.samples.netstandard]*%2c[coverlet.tests.projectsample]*" /p:ExcludeByAttribute="GeneratedCodeAttribute" --diag:"$(Build.SourcesDirectory)/artifacts/log/$(BuildConfiguration)/coverlet.core.tests.diag;tracelevel=verbose"
-    dotnet test test/coverlet.core.coverage.tests/coverlet.core.coverage.tests.csproj -c $(BuildConfiguration) --no-build -bl:test.core.coverage.binlog /p:CollectCoverage=true /p:CoverletOutputFormat=opencover /p:Exclude="[coverlet.core.tests.samples.netstandard]*%2c[coverlet.tests.projectsample]*" /p:ExcludeByAttribute="GeneratedCodeAttribute" -- --results-directory "$(Build.SourcesDirectory))/artifacts/reports" --report-xunit-trx --report-xunit-trx-filename "coverlet.core.coverage.tests.trx" --diagnostic-verbosity trace  --diagnostic --diagnostic-output-directory "$(Build.SourcesDirectory)/artifacts/log/$(BuildConfiguration)" --diagnostic-file-prefix "coverlet.core.coverage.tests_"
+    dotnet test test/coverlet.core.coverage.tests/coverlet.core.coverage.tests.csproj -c $(BuildConfiguration) --no-build -bl:test.core.coverage.binlog /p:CollectCoverage=true /p:CoverletOutputFormat=opencover /p:Exclude="[coverlet.core.tests.samples.netstandard]*%2c[coverlet.tests.projectsample]*" /p:ExcludeByAttribute="GeneratedCodeAttribute" -- --results-directory "$(Build.SourcesDirectory))/artifacts/reports" --report-xunit-trx --report-xunit-trx-filename "coverlet.core.coverage.tests.trx" --diagnostic-verbosity trace  --diagnostic --diagnostic-output-directory "$(Build.SourcesDirectory)/artifacts/log/$(BuildConfiguration)" --diagnostic-output-fileprefix "coverlet.core.coverage.tests_"
     dotnet test test/coverlet.msbuild.tasks.tests\coverlet.msbuild.tasks.tests.csproj -c $(BuildConfiguration) --no-build -bl:test.msbuild.tasks.binlog /p:CollectCoverage=true /p:CoverletOutputFormat=opencover /p:Exclude="[coverlet.core.tests.samples.netstandard]*%2c[coverlet.tests.projectsample]*" /p:ExcludeByAttribute="GeneratedCodeAttribute" --diag:"$(Build.SourcesDirectory)/artifacts/log/$(BuildConfiguration)/coverlet.msbuild.tasks.tests.diag;tracelevel=verbose"
     dotnet test test/coverlet.collector.tests/coverlet.collector.tests.csproj -c $(BuildConfiguration) --no-build -bl:test.collector.binlog /p:CollectCoverage=true /p:CoverletOutputFormat=opencover /p:Exclude="[coverlet.core.tests.samples.netstandard]*%2c[coverlet.tests.projectsample]*" /p:ExcludeByAttribute="GeneratedCodeAttribute" --diag:"$(Build.SourcesDirectory)/artifacts/log/coverlet.collector.tests.diag.$(BuildConfiguration).log;tracelevel=verbose"
     dotnet test test/coverlet.integration.tests/coverlet.integration.tests.csproj -c $(BuildConfiguration) -f net8.0 --no-build -bl:test.integration.binlog --diag:"$(Build.SourcesDirectory)/artifacts/log/coverlet.integration.tests.diag.net8.0.$(BuildConfiguration).log;tracelevel=verbose"

src/coverlet.MTP/CommandLine/CoverletCommandLineOptionDefinitions.cs

@@ -0,0 +1,36 @@
+// Copyright (c) Toni Solarin-Sodara
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Microsoft.Testing.Platform.Extensions.CommandLine;
+
+namespace Coverlet.MTP.CommandLine;
+
+/// <summary>
+/// Centralized definitions for all Coverlet command line options.
+/// This ensures consistency and avoids duplication across providers.
+/// </summary>
+internal static class CoverletCommandLineOptionDefinitions
+{
+  public static readonly string[] SupportedFormats = ["json", "lcov", "opencover", "cobertura", "teamcity"];
+
+  public static IReadOnlyCollection<CommandLineOption> GetAllOptions()
+  {
+    return
+    [
+      new CommandLineOption(CoverletOptionNames.Coverage, "Enable code coverage data collection.", ArgumentArity.Zero, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.Formats, "Output format(s) for coverage report (json, lcov, opencover, cobertura).", ArgumentArity.OneOrMore, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.Output, "Output path for coverage files.", ArgumentArity.ExactlyOne, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.Include, "Include assemblies matching filters (e.g., [Assembly]Type).", ArgumentArity.OneOrMore, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.IncludeDirectory, "Include additional directories for instrumentation.", ArgumentArity.OneOrMore, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.Exclude, "Exclude assemblies matching filters (e.g., [Assembly]Type).", ArgumentArity.OneOrMore, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.ExcludeByFile, "Exclude source files matching glob patterns.", ArgumentArity.OneOrMore, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.ExcludeByAttribute, "Exclude methods/classes decorated with attributes.", ArgumentArity.OneOrMore, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.IncludeTestAssembly, "Include test assembly in coverage.", ArgumentArity.Zero, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.SingleHit, "Limit the number of hits to one for each location.", ArgumentArity.Zero, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.SkipAutoProps, "Skip auto-implemented properties.", ArgumentArity.Zero, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.DoesNotReturnAttribute, "Attributes that mark methods as not returning.", ArgumentArity.ZeroOrMore, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.ExcludeAssembliesWithoutSources, "Exclude assemblies without source code.", ArgumentArity.ZeroOrOne, isHidden: false),
+      new CommandLineOption(CoverletOptionNames.SourceMappingFile, "Output path for SourceRootsMappings file.", ArgumentArity.ZeroOrOne, isHidden: false)
+    ];
+  }
+}

src/coverlet.MTP/CommandLine/CoverletCommandLineOptionsProvider.cs

@@ -18,7 +18,5 @@ internal static class CoverletOptionNames
   public const string SkipAutoProps = "coverage-skip-auto-props";
   public const string DoesNotReturnAttribute = "coverage-does-not-return-attribute";
   public const string ExcludeAssembliesWithoutSources = "coverage-exclude-assemblies-without-sources";
-  public const string SourceLink = "coverage-source-link";
-  public const string SourceMappingFile = "source-mapping-file";
-  public const string MergeWith = "coverage-merge-with";
+  public const string SourceMappingFile = "coverage-source-mapping-file";
 }

src/coverlet.MTP/CommandLine/CoverletOptionNames.cs

@@ -55,6 +55,22 @@ public string[] GetOutputFormats()
     return defaultFormats;
   }
 
+  public string GetOutputSourceMappingDirectory()
+  {
+    if (_commandLineOptions.TryGetOptionArgumentList(
+      CoverletOptionNames.SourceMappingFile,
+      out string[]? outputPath))
+    {
+      LogOptionValue(CoverletOptionNames.SourceMappingFile, outputPath, isExplicit: true);
+      return outputPath[0];
+    }
+    // Default: TestResults folder next to test assembly
+    string testDir = Path.GetDirectoryName(GetTestAssemblyPath()) ?? AppContext.BaseDirectory;
+    string defaultPath = Path.Combine(testDir, "TestResults");
+    LogOptionValue(CoverletOptionNames.Output, new[] { defaultPath }, isExplicit: false);
+    return defaultPath;
+  }
+
   public string GetOutputDirectory()
   {
     if (_commandLineOptions.TryGetOptionArgumentList(
@@ -168,22 +184,6 @@ public string[] GetDoesNotReturnAttributes()
   public bool ExcludeAssembliesWithoutSources =>
     GetBoolOptionWithDefault(CoverletOptionNames.ExcludeAssembliesWithoutSources, defaultValue: true);
 
-  public bool UseSourceLink =>
-    _commandLineOptions.IsOptionSet(CoverletOptionNames.SourceLink);
-
-  public string? GetMergeWith()
-  {
-    if (_commandLineOptions.TryGetOptionArgumentList(
-      CoverletOptionNames.MergeWith,
-      out string[]? mergeWith))
-    {
-      LogOptionValue(CoverletOptionNames.MergeWith, mergeWith, isExplicit: true);
-      return mergeWith[0];
-    }
-
-    return null;
-  }
-
   /// <summary>
   /// Gets the test assembly path using multiple fallback strategies.
   /// </summary>
@@ -242,8 +242,7 @@ public void LogConfigurationSummary()
     _logger.LogInformation($"Include Test Assembly: {IncludeTestAssembly}");
     _logger.LogInformation($"Skip Auto Properties: {SkipAutoProps}");
     _logger.LogInformation($"Exclude Assemblies Without Sources: {ExcludeAssembliesWithoutSources}");
-    _logger.LogInformation($"Use Source Link: {UseSourceLink}");
-    _logger.LogInformation($"Merge With: {GetMergeWith() ?? "(none)"}");
+    _logger.LogInformation($"Output directory for source mapping file: {GetOutputSourceMappingDirectory()}");
     _logger.LogInformation("========================================");
   }
 

src/coverlet.MTP/Configuration/CoverageConfiguration.cs

@@ -8,8 +8,6 @@ namespace Coverlet.MTP.CommandLine;
 
 internal sealed class CoverletExtensionCommandLineProvider : ICommandLineOptionsProvider
 {
-  private static readonly string[] s_supportedFormats = ["json", "lcov", "opencover", "cobertura", "teamcity"];
-
   private readonly IExtension _extension;
 
   public CoverletExtensionCommandLineProvider(IExtension extension)
@@ -25,24 +23,7 @@ public CoverletExtensionCommandLineProvider(IExtension extension)
   public Task<bool> IsEnabledAsync() => Task.FromResult(true);
 
   public IReadOnlyCollection<CommandLineOption> GetCommandLineOptions()
-  {
-    return
-    [
-      new CommandLineOption(CoverletOptionNames.Coverage, "Enable code coverage collection.", ArgumentArity.Zero, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.Formats, "Specifies the output formats for the coverage report (e.g., 'json', 'lcov').", ArgumentArity.OneOrMore, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.Exclude, "Filter expressions to exclude specific modules and types.", ArgumentArity.OneOrMore, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.Include, "Filter expressions to include only specific modules and type", ArgumentArity.OneOrMore, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.ExcludeByFile, "Glob patterns specifying source files to exclude.", ArgumentArity.OneOrMore, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.IncludeDirectory, "Include directories containing additional assemblies to be instrumented.", ArgumentArity.OneOrMore, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.ExcludeByAttribute, "Attributes to exclude from code coverage.", ArgumentArity.OneOrMore, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.IncludeTestAssembly, "Specifies whether to report code coverage of the test assembly.", ArgumentArity.Zero, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.SingleHit, "Specifies whether to limit code coverage hit reporting to a single hit for each location", ArgumentArity.Zero, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.SkipAutoProps, "Neither track nor record auto-implemented properties.", ArgumentArity.Zero, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.DoesNotReturnAttribute, "Attributes that mark methods that do not return", ArgumentArity.ZeroOrMore, isHidden: false),
-      new CommandLineOption(CoverletOptionNames.ExcludeAssembliesWithoutSources, "Specifies behavior of heuristic to ignore assemblies with missing source documents.", ArgumentArity.ZeroOrOne, isHidden: false),
-      //new CommandLineOption(CoverletOptionNames.SourceMappingFile, "Specifies the path to a SourceRootsMappings file.", ArgumentArity.ZeroOrOne, isHidden: false)
-    ];
-  }
+    => CoverletCommandLineOptionDefinitions.GetAllOptions();
 
   public Task<ValidationResult> ValidateOptionArgumentsAsync(CommandLineOption commandOption, string[] arguments)
   {
@@ -55,8 +36,7 @@ public Task<ValidationResult> ValidateOptionArgumentsAsync(CommandLineOption com
 
       foreach (string format in arguments)
       {
-        // does not support string with multiple formats e.g. "json,lcov"
-        if (!s_supportedFormats.Contains(format))
+        if (!CoverletCommandLineOptionDefinitions.SupportedFormats.Contains(format))
         {
           return Task.FromResult(ValidationResult.Invalid($"The value '{format}' is not a valid option for '{commandOption.Name}'."));
         }

src/coverlet.MTP/CoverletExtensionCommandLineProvider.cs

@@ -6,7 +6,7 @@
 using System.Xml.Linq;
 using Xunit;
 
-namespace coverlet.MTP.validation.tests;
+namespace Coverlet.MTP.validation.tests;
 
 /// <summary>
 /// Integration tests for Coverlet Microsoft Testing Platform extension.