Implement source generators for domain signature / hash code

.build/definitions.cake

@@ -1,21 +1,35 @@
 // ADDINS
-#addin nuget:?package=Cake.Coveralls&version=4.0.0
-#addin nuget:?package=Cake.FileHelpers&version=7.0.0
-#addin nuget:?package=Cake.AppVeyor&version=6.0.0
+#addin nuget:?package=Cake.Coverlet&version=6.0.1
+#addin nuget:?package=Cake.FileHelpers&version=9.0.0
+#addin nuget:?package=Cake.AppVeyor&version=10.0.0
 
 // TOOLS
-#tool nuget:?package=GitReleaseManager&version=0.20.0
-#tool nuget:?package=GitVersion.CommandLine&version=5.12.0
-#tool nuget:?package=OpenCover&version=4.7.1221
+#tool nuget:?package=GitReleaseManager.Tool&version=0.20.0
+#tool "dotnet:?package=GitVersion.Tool&version=6.8.2"
 #tool nuget:?package=ReportGenerator&version=5.4.8
 
 
 public class CodeCoverageSettings
 {
-    public string ExcludeByFile { get; set; } = "*/*Designer.cs";
-    public string ExcludeByAttribute { get; set; } = "*.ExcludeFromCodeCoverage*";
-    public string ExcludeFilter { get; set; } = "-[Tests*]*;-[*]Microsoft.CodeAnalysis*;-[*]System.Runtime.CompilerServices.*";
-    public string IncludeFilter { get; set; }
+    /// <summary>
+    /// Glob pattern to exclude source files from coverage (Coverlet format, e.g. "**/*Designer.cs").
+    /// </summary>
+    public string ExcludeByFile { get; set; } = "**/*Designer.cs";
+
+    /// <summary>
+    /// Attribute short name used to exclude members from coverage (e.g. "ExcludeFromCodeCoverage").
+    /// </summary>
+    public string ExcludeByAttribute { get; set; } = "ExcludeFromCodeCoverage";
+
+    /// <summary>
+    /// Coverlet exclude filters in [Assembly]Type format, e.g. "[Tests*]*".
+    /// </summary>
+    public List<string> ExcludeFilter { get; set; } = new List<string> { "[Tests*]*", "[*]Microsoft.CodeAnalysis*", "[*]System.Runtime.CompilerServices.*" };
+
+    /// <summary>
+    /// Coverlet include filters in [Assembly]Type format, e.g. "[SharpArch.*]*".
+    /// </summary>
+    public List<string> IncludeFilter { get; set; } = new List<string>();
 }
 
 // params
@@ -40,7 +54,7 @@ public class ProjectSettings {
         SolutionName = solutionName;
 
         CodeCoverage = new CodeCoverageSettings {
-            IncludeFilter = $"+[solutionName*]*"
+            IncludeFilter = new List<string> { $"[{solutionName}*]*" }
         };
     }
 }
@@ -101,25 +115,26 @@ public class Paths {
     public DirectoryPath RootDir { get; }
     public string SrcDir { get; set; }
     public string ArtifactsDir { get; set; }
-    public string TestCoverageOutputFile { get; set; }
+    /// <summary>Glob matching the per-test-project, per-TargetFramework Cobertura XML files Coverlet writes
+    /// (e.g. coverage.SharpArch.XunitTests.net10.0.cobertura.xml). Each test project is run separately with a
+    /// unique CoverletOutputName so projects/TFMs don't overwrite each other. Consumed both by ReportGenerator
+    /// (local HTML report) and by the Coveralls upload loop.</summary>
+    public string TestCoverageGlobPattern { get; set; }
     public string TestCoverageReportDir { get; set; }
     public string PackagesDir { get; set; }
     public string BuildPropsFile { get; set; }
-    public string TestsRootDir { get; set; }
-    public string SamplesRootDir { get; set; }
     public string CommonAssemblyVersionFile { get; set; }
 
     public Paths(ICakeContext context)
     {
         RootDir = context.MakeAbsolute(context.Directory("./"));
-        SrcDir = RootDir.Combine("src").ToString();
+        SrcDir = RootDir.Combine("Src").ToString();
         ArtifactsDir = RootDir.Combine("artifacts").ToString();
-        TestCoverageOutputFile = ArtifactsDir + "/OpenCover.xml";
+        TestCoverageGlobPattern = ArtifactsDir + "/coverage.*.cobertura.*.xml";
         TestCoverageReportDir = ArtifactsDir + "/CodeCoverageReport";
         PackagesDir = ArtifactsDir + "/packages";
         BuildPropsFile = SrcDir + "/Directory.Build.props";
-        TestsRootDir = SrcDir + "/tests";
-        CommonAssemblyVersionFile = SrcDir + "/common/AssemblyVersion.cs";
+        CommonAssemblyVersionFile = SrcDir + "/Common/AssemblyVersion.cs";
     }
 
 }
@@ -133,6 +148,9 @@ public class BuildInfo {
     public bool IsRelease {get; protected set;}
 
     public bool IsLocal { get; protected set; }
+
+    public bool IsPullRequest { get; protected set; }
+
     public string AppVeyorJobId { get; protected set; }
 
     public BuildVersion Version { get; protected set; }
@@ -151,18 +169,48 @@ public class BuildInfo {
             throw new ArgumentNullException(nameof(context));
         var target = context.Argument("target", "Default");
         var config = context.Argument("buildConfig", "Release");
-        var buildSystem = context.BuildSystem();
 
-        // Calculate version and commit hash
-        GitVersion semVersion = context.GitVersion();
-        var version = new BuildVersion(
-            semVersion.NuGetVersion,
-            semVersion.FullBuildMetaData,
-            semVersion.InformationalVersion,
-            $"{semVersion.Major+1}.0.0",
-            semVersion.Sha,
-            semVersion.MajorMinorPatch
-        );
+        var buildSystem = context.BuildSystem();
+        var repositoryInfo = RepositoryInfo.Get(buildSystem, settings);
+        BuildVersion version;
+
+        if (repositoryInfo.IsPullRequest) {
+            // GitVersion fails on PR builds, use 0.PullRequestId.BuildNumber as a version number
+            var buildVersion = $"0.{buildSystem.AppVeyor.Environment.PullRequest.Number}.{buildSystem.AppVeyor.Environment.Build.Number}";
+            var commitHash = buildSystem.AppVeyor.Environment.Repository.Commit.Id;
+
+            version = new BuildVersion(
+                buildVersion,
+                $"{buildVersion}/{commitHash}-PR-{buildSystem.AppVeyor.Environment.PullRequest.Title}",
+                buildVersion,
+                $"{buildVersion}.0",
+                commitHash,
+                buildVersion
+            );
+        }
+        else {
+            // Calculate version and commit hash
+            // GitVersion 6.0 removed the NuGetVersion variable; SemVer is its SemVer2-compatible
+            // replacement and is accepted by modern NuGet (v3+).
+            // Force the pinned GitVersion.Tool (the dotnet global tool, `dotnet-gitversion`) so the
+            // GitVersion() alias never falls back to a stale legacy `GitVersion.exe`
+            // (GitVersion.CommandLine 5.x) lingering in the local tools cache; 5.x cannot
+            // deserialize the 6.0 `label` branch-config property used in GitVersion.yml.
+            var dotnetGitVersion = context.Tools.Resolve("dotnet-gitversion.exe");
+            GitVersion semVersion = context.GitVersion(new GitVersionSettings
+            {
+                OutputType = GitVersionOutput.Json,
+                ToolPath = dotnetGitVersion.FullPath is null ? null : dotnetGitVersion,
+            });
+            version = new BuildVersion(
+                semVersion.SemVer,
+                semVersion.FullBuildMetaData,
+                semVersion.InformationalVersion,
+                $"{semVersion.Major+1}.0.0",
+                semVersion.Sha,
+                semVersion.MajorMinorPatch
+            );
+        }
 
         var gitHubToken = context.EnvironmentVariable("GITHUB_TOKEN");
 
@@ -172,6 +220,7 @@ public class BuildInfo {
             IsDebug = string.Equals(config, "Debug", StringComparison.OrdinalIgnoreCase),
             IsRelease = string.Equals(config, "Release", StringComparison.OrdinalIgnoreCase),
             IsLocal = buildSystem.IsLocalBuild,
+            IsPullRequest = repositoryInfo.IsPullRequest,
             AppVeyorJobId = buildSystem.AppVeyor.Environment.JobId,
             Version = version,
             Repository = RepositoryInfo.Get(buildSystem, settings),
@@ -181,5 +230,3 @@ public class BuildInfo {
         };
     }
 }
-
-