Migrate from vstest to Microsoft.Testing.Platform (#43)

Co-authored-by: Martin Costello <[email protected]>
Co-authored-by: Oleksii Holub <[email protected]>

GitHubActionsTestLogger.Tests/AnnotationSpecs.cs

@@ -16,9 +16,9 @@ public void I_can_use_the_logger_to_produce_annotations_for_failed_tests()
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            TestLoggerOptions.Default
+            TestReporterOptions.Default
         );
 
         // Act
@@ -54,9 +54,9 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_source_info
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            TestLoggerOptions.Default
+            TestReporterOptions.Default
         );
 
         // Act
@@ -104,9 +104,9 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_source_info
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            TestLoggerOptions.Default
+            TestReporterOptions.Default
         );
 
         // Act
@@ -155,9 +155,9 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_the_test_na
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            new TestLoggerOptions
+            new TestReporterOptions
             {
                 AnnotationTitleFormat = "<@test>",
                 AnnotationMessageFormat = "[@test]",
@@ -184,9 +184,9 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_test_traits
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            new TestLoggerOptions
+            new TestReporterOptions
             {
                 AnnotationTitleFormat = "<@traits.Category -> @test>",
                 AnnotationMessageFormat = "[@traits.Category -> @test]",
@@ -218,9 +218,9 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_the_error_m
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            new TestLoggerOptions
+            new TestReporterOptions
             {
                 AnnotationTitleFormat = "<@test: @error>",
                 AnnotationMessageFormat = "[@test: @error]",
@@ -251,9 +251,9 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_the_error_s
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            new TestLoggerOptions
+            new TestReporterOptions
             {
                 AnnotationTitleFormat = "<@test: @trace>",
                 AnnotationMessageFormat = "[@test: @trace]",
@@ -284,9 +284,9 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_the_target_
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            new TestLoggerOptions
+            new TestReporterOptions
             {
                 AnnotationTitleFormat = "<@test (@framework)>",
                 AnnotationMessageFormat = "[@test (@framework)]",
@@ -319,9 +319,9 @@ public void I_can_use_the_logger_to_produce_annotations_that_include_line_breaks
         // Arrange
         using var commandWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(commandWriter, TextWriter.Null),
-            new TestLoggerOptions { AnnotationMessageFormat = "foo\\nbar" }
+            new TestReporterOptions { AnnotationMessageFormat = "foo\\nbar" }
         );
 
         // Act

GitHubActionsTestLogger.Tests/InitializationSpecs.cs

@@ -20,7 +20,7 @@ public void I_can_use_the_logger_with_the_default_configuration()
 
         // Assert
         logger.Context.Should().NotBeNull();
-        logger.Context?.Options.Should().BeEquivalentTo(TestLoggerOptions.Default);
+        logger.Context?.Options.Should().BeEquivalentTo(TestReporterOptions.Default);
     }
 
     [Fact]
@@ -35,7 +35,7 @@ public void I_can_use_the_logger_with_an_empty_configuration()
 
         // Assert
         logger.Context.Should().NotBeNull();
-        logger.Context?.Options.Should().BeEquivalentTo(TestLoggerOptions.Default);
+        logger.Context?.Options.Should().BeEquivalentTo(TestReporterOptions.Default);
     }
 
     [Fact]

GitHubActionsTestLogger.Tests/SummarySpecs.cs

@@ -16,9 +16,9 @@ public void I_can_use_the_logger_to_produce_a_summary_that_includes_the_test_sui
         // Arrange
         using var summaryWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(TextWriter.Null, summaryWriter),
-            TestLoggerOptions.Default
+            TestReporterOptions.Default
         );
 
         // Act
@@ -38,9 +38,9 @@ public void I_can_use_the_logger_to_produce_a_summary_that_includes_the_list_of_
         // Arrange
         using var summaryWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(TextWriter.Null, summaryWriter),
-            new TestLoggerOptions { SummaryIncludePassedTests = true }
+            new TestReporterOptions { SummaryIncludePassedTests = true }
         );
 
         // Act
@@ -85,9 +85,9 @@ public void I_can_use_the_logger_to_produce_a_summary_that_includes_the_list_of_
         // Arrange
         using var summaryWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(TextWriter.Null, summaryWriter),
-            TestLoggerOptions.Default
+            TestReporterOptions.Default
         );
 
         // Act
@@ -144,9 +144,9 @@ public void I_can_use_the_logger_to_produce_a_summary_that_includes_the_list_of_
         // Arrange
         using var summaryWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(TextWriter.Null, summaryWriter),
-            new TestLoggerOptions { SummaryIncludeSkippedTests = true }
+            new TestReporterOptions { SummaryIncludeSkippedTests = true }
         );
 
         // Act
@@ -191,9 +191,9 @@ public void I_can_use_the_logger_to_produce_a_summary_that_includes_empty_test_s
         // Arrange
         using var summaryWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(TextWriter.Null, summaryWriter),
-            TestLoggerOptions.Default
+            TestReporterOptions.Default
         );
 
         // Act
@@ -212,9 +212,9 @@ public void I_can_use_the_logger_to_produce_a_summary_that_does_not_include_empt
         // Arrange
         using var summaryWriter = new StringWriter();
 
-        var context = new TestLoggerContext(
+        var context = new TestReporterContext(
             new GitHubWorkflow(TextWriter.Null, summaryWriter),
-            new TestLoggerOptions { SummaryIncludeNotFoundTests = false }
+            new TestReporterOptions { SummaryIncludeNotFoundTests = false }
         );
 
         // Act

GitHubActionsTestLogger.Tests/Utils/Extensions/TestLoggerContextExtensions.cs

@@ -11,7 +11,7 @@ namespace GitHubActionsTestLogger.Tests.Utils.Extensions;
 internal static class TestLoggerContextExtensions
 {
     public static void SimulateTestRun(
-        this TestLoggerContext context,
+        this TestReporterContext context,
         string testSuiteFilePath,
         string targetFrameworkName,
         params IReadOnlyList<TestResult> testResults
@@ -65,13 +65,13 @@ params IReadOnlyList<TestResult> testResults
     }
 
     public static void SimulateTestRun(
-        this TestLoggerContext context,
+        this TestReporterContext context,
         string testSuiteName,
         params IReadOnlyList<TestResult> testResults
     ) => context.SimulateTestRun(testSuiteName, "FakeTargetFramework", testResults);
 
     public static void SimulateTestRun(
-        this TestLoggerContext context,
+        this TestReporterContext context,
         params IReadOnlyList<TestResult> testResults
     ) => context.SimulateTestRun("FakeTests.dll", testResults);
 }

GitHubActionsTestLogger/CliOptionsProvider.cs

@@ -0,0 +1,89 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+using Microsoft.Testing.Platform.CommandLine;
+using Microsoft.Testing.Platform.Extensions;
+using Microsoft.Testing.Platform.Extensions.CommandLine;
+
+namespace GitHubActionsTestLogger;
+
+internal sealed class CliOptionsProvider(GitHubTestReporterExtension extension) : ICommandLineOptionsProvider
+{
+    public const string ReportGitHubOption = "report-github";
+    public const string ReportGitHubSummaryOption = "report-github-summary";
+    public const string ReportGitHubTitleOption = "report-github-title";
+    public const string ReportGitHubMessageOption = "report-github-message";
+
+    public static class ReportGitHubSummaryArguments
+    {
+        public const string IncludePassedTests = "includePassedTests";
+        public const string IncludeSkippedTests = "includeSkippedTests";
+        public const string IncludeNotFoundTests = "includeNotFoundTests";
+    }
+
+    public string Uid => extension.Uid;
+    public string Version => extension.Version;
+    public string DisplayName => extension.DisplayName;
+    public string Description => extension.Description;
+
+    public IReadOnlyCollection<CommandLineOption> GetCommandLineOptions() =>
+        [
+            new(ReportGitHubOption, "Reports test run information to GitHub Actions", ArgumentArity.Zero, isHidden: false),
+            // TODO: Do you prefer multiple zero argument options or a single option with argument?
+            new(ReportGitHubSummaryOption, "Defines the information to include in the summary", ArgumentArity.OneOrMore, isHidden: false),
+            new(ReportGitHubTitleOption, "Defines the annotation title format used for reporting test failures", ArgumentArity.ExactlyOne, isHidden: false),
+            new(ReportGitHubMessageOption, "Defines the annotation message format used for reporting test failures", ArgumentArity.ExactlyOne, isHidden: false),
+        ];
+
+    public Task<bool> IsEnabledAsync() => extension.IsEnabledAsync();
+
+    // This method is called once after all options are parsed and is used to validate the combination of options.
+    public Task<ValidationResult> ValidateCommandLineOptionsAsync(ICommandLineOptions commandLineOptions)
+    {
+        // We just want to validate that the sub options are set only if the main option is set.
+        if (commandLineOptions.IsOptionSet(ReportGitHubOption))
+        {
+            return ValidationResult.ValidTask;
+        }
+
+        if (commandLineOptions.IsOptionSet(ReportGitHubSummaryOption)
+            || commandLineOptions.IsOptionSet(ReportGitHubTitleOption)
+            || commandLineOptions.IsOptionSet(ReportGitHubMessageOption))
+        {
+            return ValidationResult.InvalidTask("The options 'report-github-summary', 'report-github-title', and 'report-github-message' can only be used if 'report-github' is set.");
+        }
+
+        return ValidationResult.ValidTask;
+    }
+
+    // This method is called once per option declared and is used to validate the arguments of the given option.
+    // The arity of the option is checked before this method is called.
+    public Task<ValidationResult> ValidateOptionArgumentsAsync(CommandLineOption commandOption, string[] arguments)
+    {
+        if (commandOption.Name == ReportGitHubSummaryOption)
+        {
+            if (arguments.Length > 3)
+            {
+                return ValidationResult.InvalidTask($"The option '{ReportGitHubSummaryOption}' can have at most 3 arguments.");
+            }
+
+            if (arguments.Distinct().Count() != arguments.Length)
+            {
+                return ValidationResult.InvalidTask($"The option '{ReportGitHubSummaryOption}' cannot have duplicate arguments.");
+            }
+
+            for (int i = 0; i < arguments.Length; i++)
+            {
+                if (arguments[i] != ReportGitHubSummaryArguments.IncludePassedTests
+                    && arguments[i] != ReportGitHubSummaryArguments.IncludeSkippedTests
+                    && arguments[i] != ReportGitHubSummaryArguments.IncludeNotFoundTests)
+                {
+                    return ValidationResult.InvalidTask($"The option '{ReportGitHubSummaryOption}' can only have the arguments '{ReportGitHubSummaryArguments.IncludePassedTests}', '{ReportGitHubSummaryArguments.IncludeSkippedTests}', and '{ReportGitHubSummaryArguments.IncludeNotFoundTests}'.");
+                }
+            }
+        }
+
+        return ValidationResult.ValidTask;
+    }
+}

GitHubActionsTestLogger/GitHubActionsTestLogger.csproj

@@ -1,4 +1,5 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
+
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net9.0</TargetFrameworks>
     <IsPackable>true</IsPackable>
@@ -25,8 +26,8 @@
     <None Include="../favicon.png" Pack="true" PackagePath="" Visible="false" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="CSharpier.MsBuild" Version="1.1.2" PrivateAssets="all" />
-    <PackageReference Include="Microsoft.TestPlatform.ObjectModel" Version="17.14.1" />
+    <PackageReference Include="CSharpier.MsBuild" Version="0.30.6" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.Testing.Platform" Version="1.6.2" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
     <PackageReference Include="PolyShim" Version="1.15.0" PrivateAssets="all" />
     <PackageReference

GitHubActionsTestLogger/GitHubReportExtensions.cs

@@ -0,0 +1,24 @@
+using Microsoft.Testing.Platform.Builder;
+using Microsoft.Testing.Platform.Extensions;
+using Microsoft.Testing.Platform.Services;
+
+namespace GitHubActionsTestLogger;
+
+public static class GitHubReportExtensions
+{
+    /// <summary>
+    /// Adds GitHub report support to the Testing Platform Builder.
+    /// </summary>
+    /// <param name="testApplicationBuilder">The test application builder.</param>
+    public static void AddGitHubReportProvider(this ITestApplicationBuilder testApplicationBuilder)
+    {
+        var extension = new GitHubTestReporterExtension();
+
+        var compositeExtension = new CompositeExtensionFactory<GitHubTestReporter>(serviceProvider => 
+            new GitHubTestReporter(extension, serviceProvider.GetCommandLineOptions()));
+        testApplicationBuilder.TestHost.AddDataConsumer(compositeExtension);
+        testApplicationBuilder.TestHost.AddTestSessionLifetimeHandle(compositeExtension);
+
+        testApplicationBuilder.CommandLine.AddProvider(() => new CliOptionsProvider(extension));
+    }
+}