(build) Added ArgumentNullException checks for context.Version in various files.

arturcic · arturcic · commit 35e272c009a1 · 2024-10-09T23:54:25.000+02:00
Improved error messaging and updated some syntax for consistency and clarity
diff --git a/build/artifacts/Tasks/ArtifactsExecutableTest.cs b/build/artifacts/Tasks/ArtifactsExecutableTest.cs
@@ -36,10 +36,10 @@ private static void PackageTest(BuildContextBase context, string packageToTest)
 
         context.NuGetInstall(packageToTest, new NuGetInstallSettings
         {
-            Source = new[]
-            {
+            Source =
+            [
                 context.MakeAbsolute(Paths.Nuget).FullPath
-            },
+            ],
             ExcludeVersion = true,
             Prerelease = true,
             OutputDirectory = outputDirectory
diff --git a/build/artifacts/Tasks/ArtifactsMsBuildFullTest.cs b/build/artifacts/Tasks/ArtifactsMsBuildFullTest.cs
@@ -36,7 +36,7 @@ public override void Run(BuildContext context)
                 Verbosity = DotNetVerbosity.Minimal,
                 Configuration = context.MsBuildConfiguration,
                 MSBuildSettings = dotnetMsBuildSettings,
-                Sources = new[] { nugetSource }
+                Sources = [nugetSource]
             });
 
             var exe = Paths.Integration.Combine("build").Combine(framework).CombineWithFilePath("app.dll");
diff --git a/build/build/BuildLifetime.cs b/build/build/BuildLifetime.cs
@@ -29,7 +29,8 @@ public override void Setup(BuildContext context, ISetupContext info)
     private static void SetMsBuildSettingsVersion(BuildContext context)
     {
         var msBuildSettings = context.MsBuildSettings;
-        var version = context.Version!;
+        ArgumentNullException.ThrowIfNull(context.Version);
+        var version = context.Version;
 
         msBuildSettings.SetVersion(version.SemVersion);
         msBuildSettings.SetAssemblyVersion(version.Version);
diff --git a/build/build/Tasks/Build.cs b/build/build/Tasks/Build.cs
@@ -16,7 +16,7 @@ public override void Run(BuildContext context)
         context.DotNetRestore(sln, new DotNetRestoreSettings
         {
             Verbosity = DotNetVerbosity.Minimal,
-            Sources = new[] { Constants.NugetOrgUrl },
+            Sources = [Constants.NugetOrgUrl],
             MSBuildSettings = context.MsBuildSettings
         });
 
diff --git a/build/build/Tasks/BuildPrepare.cs b/build/build/Tasks/BuildPrepare.cs
@@ -16,7 +16,7 @@ public override void Run(BuildContext context)
             new()
             {
                 Verbosity = DotNetVerbosity.Minimal,
-                Sources = new[] { Constants.NugetOrgUrl },
+                Sources = [Constants.NugetOrgUrl],
             });
 
         context.DotNetBuild("./src/GitVersion.App/GitVersion.App.csproj",
diff --git a/build/build/Tasks/Package/PackageChocolatey.cs b/build/build/Tasks/Package/PackageChocolatey.cs
@@ -35,10 +35,10 @@ public override void Run(BuildContext context)
             .Select(file => new ChocolateyNuSpecContent { Source = file.FullPath, Target = file.FullPath.Replace(artifactPath, "") })
             .ToArray();
 
-        metaPackageSettings.Dependencies = new[]
-        {
+        metaPackageSettings.Dependencies =
+        [
             new ChocolateyNuSpecDependency { Id = "GitVersion.Portable", Version = context.Version?.ChocolateyVersion }
-        };
+        ];
 
         context.ChocolateyPack(metaPackageSettings);
     }
@@ -51,17 +51,18 @@ private static ChocolateyPackSettings GetChocolateyPackSettings(BuildContextBase
             Version = context.Version?.ChocolateyVersion,
             Title = "GitVersion",
             Description = "Derives SemVer information from a repository following GitFlow or GitHubFlow.",
-            Authors = new[] { "GitTools and Contributors" },
-            Owners = new[] { "GitTools and Contributors" },
+            Authors = ["GitTools and Contributors"],
+            Owners = ["GitTools and Contributors"],
             Copyright = $"Copyright GitTools {DateTime.Now.Year}",
             DocsUrl = new Uri("https://gitversion.net/docs/"),
             LicenseUrl = new Uri("https://opensource.org/license/mit/"),
             ProjectUrl = new Uri("https://github.com/GitTools/GitVersion"),
             ProjectSourceUrl = new Uri("https://github.com/GitTools/GitVersion"),
             IconUrl = new Uri("https://raw.githubusercontent.com/GitTools/graphics/master/GitVersion/Color/icon_100x100.png"),
             RequireLicenseAcceptance = false,
-            Tags = new[] { "Git", "Versioning", "GitVersion", "GitFlowVersion", "GitFlow", "GitHubFlow", "SemVer" },
-            ReleaseNotes = new[] { $"https://github.com/GitTools/GitVersion/releases/tag/{context.Version?.ChocolateyVersion}" },
+            Tags = ["Git", "Versioning", "GitVersion", "GitFlowVersion", "GitFlow", "GitHubFlow", "SemVer"],
+            ReleaseNotes = [$"https://github.com/GitTools/GitVersion/releases/tag/{context.Version?.ChocolateyVersion}"
+            ],
             OutputDirectory = Paths.Nuget,
             LimitOutput = true,
         };
diff --git a/build/build/Tasks/Test/UnitTest.cs b/build/build/Tasks/Test/UnitTest.cs
@@ -73,7 +73,7 @@ private static void TestProjectForTarget(BuildContext context, FilePath project,
         };
 
         var resultsPath = context.MakeAbsolute(testResultsPath.CombineWithFilePath($"{projectName}.results.xml"));
-        settings.Loggers = new[] { $"junit;LogFilePath={resultsPath}" };
+        settings.Loggers = [$"junit;LogFilePath={resultsPath}"];
 
         var coverletSettings = new CoverletSettings
         {
diff --git a/build/build/Tasks/ValidateVersion.cs b/build/build/Tasks/ValidateVersion.cs
@@ -9,7 +9,8 @@ public class ValidateVersion : FrostingTask<BuildContext>
 {
     public override void Run(BuildContext context)
     {
+        ArgumentNullException.ThrowIfNull(context.Version);
         var gitVersionTool = context.GetGitVersionToolLocation();
-        context.ValidateOutput("dotnet", $"\"{gitVersionTool}\" -version", context.Version!.GitVersion!.InformationalVersion!);
+        context.ValidateOutput("dotnet", $"\"{gitVersionTool}\" -version", context.Version.GitVersion.InformationalVersion);
     }
 }
diff --git a/build/common/Addins/GitVersion/GitVersionRunner.cs b/build/common/Addins/GitVersion/GitVersionRunner.cs
@@ -6,7 +6,7 @@ namespace Common.Addins.GitVersion;
 /// <summary>
 /// The GitVersion runner.
 /// </summary>
-public sealed class GitVersionRunner : Tool<GitVersionSettings>
+public sealed partial class GitVersionRunner : Tool<GitVersionSettings>
 {
     private readonly ICakeLog _log;
 
@@ -38,14 +38,13 @@ public GitVersion Run(GitVersionSettings settings)
         Run(settings, GetArguments(settings), new ProcessSettings { RedirectStandardOutput = true }, process =>
         {
             output = string.Join("\n", process.GetStandardOutput());
-            if (this._log.Verbosity < Verbosity.Diagnostic)
+            if (this._log.Verbosity >= Verbosity.Diagnostic) return;
+            var regex = ParseErrorRegex();
+            var errors = regex.Matches(output)
+                .SelectMany(match => new[] { match.Groups[1].Value, match.Groups[2].Value });
+            foreach (var error in errors)
             {
-                var errors = Regex.Matches(output, @"( *ERROR:? [^\n]*)\n([^\n]*)")
-                    .SelectMany(match => new[] { match.Groups[1].Value, match.Groups[2].Value });
-                foreach (var error in errors)
-                {
-                    this._log.Error(error);
-                }
+                this._log.Error(error);
             }
         });
 
@@ -68,6 +67,7 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
             builder.Append("-output");
             builder.Append("json");
         }
+
         if (settings.OutputTypes.Contains(GitVersionOutput.BuildServer))
         {
             builder.Append("-output");
@@ -116,7 +116,8 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
             }
             else
             {
-                this._log.Warning("If you leave the branch name for GitVersion unset, it will fallback to the default branch for the repository.");
+                this._log.Warning(
+                    "If you leave the branch name for GitVersion unset, it will fallback to the default branch for the repository.");
             }
 
             if (!string.IsNullOrWhiteSpace(settings.Commit))
@@ -150,6 +151,7 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
             builder.Append("-verbosity");
             builder.Append(verbosity.ToString());
         }
+
         return builder;
     }
 
@@ -163,5 +165,14 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
     /// Gets the possible names of the tool executable.
     /// </summary>
     /// <returns>The tool executable name.</returns>
-    protected override IEnumerable<string> GetToolExecutableNames() => new[] { "GitVersion.exe", "dotnet-gitversion", "dotnet-gitversion.exe", "gitversion" };
+    protected override IEnumerable<string> GetToolExecutableNames() =>
+    [
+        "GitVersion.exe",
+        "dotnet-gitversion",
+        "dotnet-gitversion.exe",
+        "gitversion"
+    ];
+
+    [GeneratedRegex(@"( *ERROR:? [^\n]*)\n([^\n]*)")]
+    private static partial Regex ParseErrorRegex();
 }
diff --git a/build/common/Lifetime/BuildLifetimeBase.cs b/build/common/Lifetime/BuildLifetimeBase.cs
@@ -30,11 +30,18 @@ public override void Setup(T context, ISetupContext info)
             context.Information("Running BuildPrepare...");
             return;
         }
+
+        var gitVersionPath = context.GetGitVersionDotnetToolLocation();
+        if (gitVersionPath is null || context.FileExists(gitVersionPath) is false)
+        {
+            throw new FileNotFoundException("Failed to locate the Release build of gitversion.dll in ./tools/gitversion. Try running \"./build.ps1 -Stage build -Target BuildPrepare\"");
+        }
+
         var gitVersionSettings = new GitVersionSettings
         {
             OutputTypes = [GitVersionOutput.Json, GitVersionOutput.BuildServer],
             ToolPath = context.Tools.Resolve(["dotnet.exe", "dotnet"]),
-            ArgumentCustomization = args => args.Prepend(context.GetGitVersionDotnetToolLocation()?.FullPath ?? throw new FileNotFoundException("Failed to locate the Release build of gitversion.dll in ./tools/gitversion. Try running \"./build.ps1 -Stage build -Target BuildPrepare\""))
+            ArgumentCustomization = args => args.Prepend(gitVersionPath.FullPath)
         };
 
         var gitVersion = context.GitVersion(gitVersionSettings);
diff --git a/build/common/Utilities/BuildContextBase.cs b/build/common/Utilities/BuildContextBase.cs
@@ -2,7 +2,7 @@ namespace Common.Utilities;
 
 public class BuildContextBase : FrostingContext
 {
-    protected BuildContextBase(ICakeContext context) : base(context) => Platform = Environment.Platform.Family;
+    protected BuildContextBase(ICakeContext context) : base(context) => Platform = context.Environment.Platform.Family;
     public PlatformFamily Platform { get; set; }
     public BuildVersion? Version { get; set; }
     public bool IsOriginalRepo { get; set; }
diff --git a/build/common/Utilities/DockerContextExtensions.cs b/build/common/Utilities/DockerContextExtensions.cs
@@ -108,13 +108,14 @@ public static void DockerBuildXBuild(this ICakeContext context, DockerBuildXBuil
 
     public static void DockerManifest(this BuildContextBase context, DockerImage dockerImage)
     {
+        ArgumentNullException.ThrowIfNull(context.Version);
         var manifestTags = context.GetDockerTags(dockerImage);
         foreach (var tag in manifestTags)
         {
             var amd64Tag = $"{tag}-{Architecture.Amd64.ToSuffix()}";
             var arm64Tag = $"{tag}-{Architecture.Arm64.ToSuffix()}";
 
-            var settings = GetManifestSettings(dockerImage, context.Version!, tag);
+            var settings = GetManifestSettings(dockerImage, context.Version, tag);
             context.DockerBuildXImageToolsCreate(settings, [amd64Tag, arm64Tag]);
         }
     }
@@ -186,13 +187,13 @@ public static void DockerTestArtifact(this BuildContextBase context, DockerImage
     private static void DockerTestRun(this BuildContextBase context, string image, Architecture arch, string command,
                                       params string[] args)
     {
+        ArgumentNullException.ThrowIfNull(context.Version?.GitVersion.FullSemVer);
         var settings = GetDockerRunSettings(context, arch);
         context.Information($"Testing image: {image}");
         var output = context.DockerRun(settings, image, command, args);
         context.Information("Output : " + output);
 
-        Assert.NotNull(context.Version?.GitVersion);
-        Assert.Contains(context.Version.GitVersion.FullSemVer!, output);
+        Assert.Contains(context.Version.GitVersion.FullSemVer, output);
     }
 
     private static IEnumerable<string> GetDockerTags(this BuildContextBase context, DockerImage dockerImage,
diff --git a/build/docker/Tasks/DockerHubReadmePublish.cs b/build/docker/Tasks/DockerHubReadmePublish.cs
@@ -26,11 +26,12 @@ public override bool ShouldRun(BuildContext context)
 
     public override void Run(BuildContext context)
     {
+        ArgumentNullException.ThrowIfNull(context.Credentials?.DockerHub);
         var readme = GetReadmeContent(context);
 
         var response = context.HttpPost("https://hub.docker.com/v2/users/login", settings =>
         {
-            var credentials = context.Credentials!.DockerHub!;
+            var credentials = context.Credentials.DockerHub;
             settings
                 .SetContentType("application/json")
                 .SetJsonRequestBody(new { username = credentials.Username, password = credentials.Password });
@@ -49,7 +50,8 @@ public override void Run(BuildContext context)
 
     private static string GetReadmeContent(BuildContextBase context)
     {
-        var version = context.Version!.GitVersion.MajorMinorPatch;
+        ArgumentNullException.ThrowIfNull(context.Version);
+        var version = context.Version.GitVersion.MajorMinorPatch;
         const string distro = Constants.AlpineLatest;
         const string dotnetVersion = Constants.VersionLatest;
         var tag = $"{version}-{distro}-{dotnetVersion}";
diff --git a/build/docs/Tasks/GenerateSchemas.cs b/build/docs/Tasks/GenerateSchemas.cs
@@ -8,8 +8,9 @@ public sealed class GenerateSchemas : FrostingTask<BuildContext>
 {
     public override void Run(BuildContext context)
     {
+        ArgumentNullException.ThrowIfNull(context.Version);
         var schemaTool = context.GetSchemaDotnetToolLocation();
-        var gitVersion = context.Version!.GitVersion;
+        var gitVersion = context.Version.GitVersion;
         var version = $"{gitVersion.Major}.{gitVersion.Minor}";
         var schemaTargetDir = context.MakeAbsolute(Paths.Root.Combine("schemas"));
         context.EnsureDirectoryExists(schemaTargetDir);
diff --git a/build/publish/Tasks/PublishChocolatey.cs b/build/publish/Tasks/PublishChocolatey.cs
@@ -31,7 +31,8 @@ public override async Task RunAsync(BuildContext context)
             throw new InvalidOperationException("Could not resolve Chocolatey API key.");
         }
 
-        var nugetVersion = context.Version!.NugetVersion;
+        ArgumentNullException.ThrowIfNull(context.Version);
+        var nugetVersion = context.Version.NugetVersion;
         var packages = context.Packages
             .Where(x => x.IsChocoPackage)
             .OrderByDescending(x => x.PackageName);
diff --git a/build/publish/Tasks/PublishNuget.cs b/build/publish/Tasks/PublishNuget.cs
@@ -50,7 +50,8 @@ public override void Run(BuildContext context)
     }
     private static void PublishToNugetRepo(BuildContext context, string apiKey, string apiUrl)
     {
-        var nugetVersion = context.Version!.NugetVersion;
+        ArgumentNullException.ThrowIfNull(context.Version);
+        var nugetVersion = context.Version.NugetVersion;
         foreach (var (packageName, filePath, _) in context.Packages.Where(x => !x.IsChocoPackage))
         {
             context.Information($"Package {packageName}, version {nugetVersion} is being published.");

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,8 @@ public override void Setup(BuildContext context, ISetupContext info)`
`29`	`29`	`private static void SetMsBuildSettingsVersion(BuildContext context)`
`30`	`30`	`{`
`31`	`31`	`var msBuildSettings = context.MsBuildSettings;`
`32`		`- var version = context.Version!;`
	`32`	`+ ArgumentNullException.ThrowIfNull(context.Version);`
	`33`	`+ var version = context.Version;`
`33`	`34`
`34`	`35`	`msBuildSettings.SetVersion(version.SemVersion);`
`35`	`36`	`msBuildSettings.SetAssemblyVersion(version.Version);`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public override void Run(BuildContext context)`
`16`	`16`	`context.DotNetRestore(sln, new DotNetRestoreSettings`
`17`	`17`	`{`
`18`	`18`	`Verbosity = DotNetVerbosity.Minimal,`
`19`		`- Sources = new[] { Constants.NugetOrgUrl },`
	`19`	`+ Sources = [Constants.NugetOrgUrl],`
`20`	`20`	`MSBuildSettings = context.MsBuildSettings`
`21`	`21`	`});`
`22`	`22`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ private static void TestProjectForTarget(BuildContext context, FilePath project,`
`73`	`73`	`};`
`74`	`74`
`75`	`75`	`var resultsPath = context.MakeAbsolute(testResultsPath.CombineWithFilePath($"{projectName}.results.xml"));`
`76`		`- settings.Loggers = new[] { $"junit;LogFilePath={resultsPath}" };`
	`76`	`+ settings.Loggers = [$"junit;LogFilePath={resultsPath}"];`
`77`	`77`
`78`	`78`	`var coverletSettings = new CoverletSettings`
`79`	`79`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,8 @@ public class ValidateVersion : FrostingTask<BuildContext>`
`9`	`9`	`{`
`10`	`10`	`public override void Run(BuildContext context)`
`11`	`11`	`{`
	`12`	`+ ArgumentNullException.ThrowIfNull(context.Version);`
`12`	`13`	`var gitVersionTool = context.GetGitVersionToolLocation();`
`13`		`- context.ValidateOutput("dotnet", $"\"{gitVersionTool}\" -version", context.Version!.GitVersion!.InformationalVersion!);`
	`14`	`+ context.ValidateOutput("dotnet", $"\"{gitVersionTool}\" -version", context.Version.GitVersion.InformationalVersion);`
`14`	`15`	`}`
`15`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace Common.Addins.GitVersion;`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// The GitVersion runner.`
`8`	`8`	`/// </summary>`
`9`		`-public sealed class GitVersionRunner : Tool<GitVersionSettings>`
	`9`	`+public sealed partial class GitVersionRunner : Tool<GitVersionSettings>`
`10`	`10`	`{`
`11`	`11`	`private readonly ICakeLog _log;`
`12`	`12`
`@@ -38,14 +38,13 @@ public GitVersion Run(GitVersionSettings settings)`
`38`	`38`	`Run(settings, GetArguments(settings), new ProcessSettings { RedirectStandardOutput = true }, process =>`
`39`	`39`	`{`
`40`	`40`	`output = string.Join("\n", process.GetStandardOutput());`
`41`		`- if (this._log.Verbosity < Verbosity.Diagnostic)`
	`41`	`+ if (this._log.Verbosity >= Verbosity.Diagnostic) return;`
	`42`	`+ var regex = ParseErrorRegex();`
	`43`	`+ var errors = regex.Matches(output)`
	`44`	`+ .SelectMany(match => new[] { match.Groups[1].Value, match.Groups[2].Value });`
	`45`	`+ foreach (var error in errors)`
`42`	`46`	`{`
`43`		`- var errors = Regex.Matches(output, @"( ERROR:? [^\n])\n([^\n]*)")`
`44`		`- .SelectMany(match => new[] { match.Groups[1].Value, match.Groups[2].Value });`
`45`		`- foreach (var error in errors)`
`46`		`- {`
`47`		`- this._log.Error(error);`
`48`		`- }`
	`47`	`+ this._log.Error(error);`
`49`	`48`	`}`
`50`	`49`	`});`
`51`	`50`
`@@ -68,6 +67,7 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)`
`68`	`67`	`builder.Append("-output");`
`69`	`68`	`builder.Append("json");`
`70`	`69`	`}`
	`70`	`+`
`71`	`71`	`if (settings.OutputTypes.Contains(GitVersionOutput.BuildServer))`
`72`	`72`	`{`
`73`	`73`	`builder.Append("-output");`
`@@ -116,7 +116,8 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)`
`116`	`116`	`}`
`117`	`117`	`else`
`118`	`118`	`{`
`119`		`- this._log.Warning("If you leave the branch name for GitVersion unset, it will fallback to the default branch for the repository.");`
	`119`	`+ this._log.Warning(`
	`120`	`+ "If you leave the branch name for GitVersion unset, it will fallback to the default branch for the repository.");`
`120`	`121`	`}`
`121`	`122`
`122`	`123`	`if (!string.IsNullOrWhiteSpace(settings.Commit))`
`@@ -150,6 +151,7 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)`
`150`	`151`	`builder.Append("-verbosity");`
`151`	`152`	`builder.Append(verbosity.ToString());`
`152`	`153`	`}`
	`154`	`+`
`153`	`155`	`return builder;`
`154`	`156`	`}`
`155`	`157`
`@@ -163,5 +165,14 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)`
`163`	`165`	`/// Gets the possible names of the tool executable.`
`164`	`166`	`/// </summary>`
`165`	`167`	`/// <returns>The tool executable name.</returns>`
`166`		`- protected override IEnumerable<string> GetToolExecutableNames() => new[] { "GitVersion.exe", "dotnet-gitversion", "dotnet-gitversion.exe", "gitversion" };`
	`168`	`+ protected override IEnumerable<string> GetToolExecutableNames() =>`
	`169`	`+ [`
	`170`	`+ "GitVersion.exe",`
	`171`	`+ "dotnet-gitversion",`
	`172`	`+ "dotnet-gitversion.exe",`
	`173`	`+ "gitversion"`
	`174`	`+ ];`
	`175`	`+`
	`176`	`+ [GeneratedRegex(@"( ERROR:? [^\n])\n([^\n]*)")]`
	`177`	`+ private static partial Regex ParseErrorRegex();`
`167`	`178`	`}`