build: Add GitHubActionsTestLogger

Author: alexmg

.nuke/build.schema.json

@@ -26,7 +26,6 @@
       "enum": [
         "Clean",
         "Compile",
-        "Cover",
         "Pack",
         "Prepare",
         "Publish",

Directory.Packages.props

@@ -15,6 +15,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageVersion>
     <PackageVersion Include="FluentAssertions" Version="6.12.2" />
+    <PackageVersion Include="GitHubActionsTestLogger" Version="2.4.1" />
     <PackageVersion Include="Microsoft.AspNetCore.Http" Version="2.2.2" />
     <PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="9.0.0" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />

build/Build.cs

@@ -1,6 +1,7 @@
 using GlobExpressions;
 using Nuke.Common;
 using Nuke.Common.CI;
+using Nuke.Common.CI.GitHubActions;
 using Nuke.Common.Git;
 using Nuke.Common.IO;
 using Nuke.Common.ProjectModel;
@@ -46,8 +47,6 @@ class Build : NukeBuild
     AbsolutePath ArtifactsDirectory => RootDirectory / "artifacts";
     AbsolutePath NugetDirectory => ArtifactsDirectory / "nuget";
     AbsolutePath TestResultDirectory => ArtifactsDirectory / "test-results";
-    AbsolutePath CoverageResultDirectory => ArtifactsDirectory / "coverage";
-    AbsolutePath CoverageReportDirectory => ArtifactsDirectory / "coverage-report";
 
     IEnumerable<Project> TestProjects => Solution.GetAllProjects("*.Tests");
 
@@ -95,28 +94,15 @@ class Build : NukeBuild
             .EnableNoBuild()
             .ResetVerbosity()
             .SetResultsDirectory(TestResultDirectory)
-            .EnableCollectCoverage()
-            .SetCoverletOutputFormat(CoverletOutputFormat.cobertura)
-            .SetExcludeByFile("*.Generated.cs")
-            .CombineWith(TestProjects, (_, v) => _
-                .SetProjectFile(v)
-                .SetLoggers($"trx;LogFileName={v.Name}.trx;FailureBodyFormat=Verbose")
-                .SetCoverletOutput($"{CoverageResultDirectory}/{v.Name}.xml"))));
-
-    Target Cover => _ => _
-        .DependsOn(Test)
-        .Consumes(Test)
-        .Produces(CoverageResultDirectory / "lcov.info")
-        .Executes(() =>
-        {
-            ReportGenerator(_ => _
-                .SetFramework("net5.0")
-                .SetReports(CoverageResultDirectory / "*.xml")
-                .SetTargetDirectory(CoverageReportDirectory)
-                .SetReportTypes("lcov")
-                .When(IsLocalBuild, _ => _
-                    .AddReportTypes(ReportTypes.HtmlInline)));
-        });
+            .CombineWith(TestProjects, (_, project) => _
+                .SetProjectFile(project)
+                .When(GitHubActions.Instance is not null && project.HasPackageReference("GitHubActionsTestLogger"),
+                    settings => settings.AddLoggers("GitHubActions;summary.includePassedTests=true;summary.includeSkippedTests=true")
+                        .AddRunSetting("RunConfiguration.CollectSourceInformation", "true"))
+                .AddLoggers($"trx;LogFileName={project.Name}.trx;FailureBodyFormat=Verbose")
+                .When(project.HasPackageReference("coverlet.collector"),
+                    settings => settings.SetDataCollector("XPlat Code Coverage")
+                        .SetSettingsFile("coverlet.runsettings")))));
 
     Target Pack => _ => _
         .DependsOn(Clean, Restore)

coverlet.runsettings

@@ -4,10 +4,10 @@
     <DataCollectors>
       <DataCollector friendlyName="XPlat Code Coverage">
         <Configuration>
-          <Format>lcov</Format>
+          <Format>opencover</Format>
           <ExcludeByFile>**/GitVersionInformation.g.cs</ExcludeByFile>
           <IncludeTestAssembly>false</IncludeTestAssembly>
-          <UseSourceLink>false</UseSourceLink>
+          <UseSourceLink>true</UseSourceLink>
         </Configuration>
       </DataCollector>
     </DataCollectors>

test/Timingz.Tests/Timingz.Tests.csproj

@@ -17,6 +17,10 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="FluentAssertions" />
+    <PackageReference Include="GitHubActionsTestLogger">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
     <PackageReference Include="Microsoft.AspNetCore.TestHost" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="xunit" />