Add nullability checks and update properties' mutability in tests

Nullability checks are added in several test cases for output-based assertions to prevent potential NullReferenceExceptions. Concurrently, the 'ExecutionResults' class is modified to handle null outputs, and the mutability of its 'ExitCode', 'Output', and 'Log' properties is updated using 'init'.

Author: arturcic

src/GitVersion.App.Tests/ExecCmdLineArgumentTest.cs

@@ -14,6 +14,7 @@ public void InvalidArgumentsExitCodeShouldNotBeZero()
         var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, arguments: " /invalid-argument");
 
         result.ExitCode.ShouldNotBe(0);
+        result.Output.ShouldNotBeNull();
         result.Output.ShouldContain("Could not parse command line parameter '/invalid-argument'");
     }
 
@@ -27,6 +28,7 @@ public void LogPathContainsForwardSlash()
         var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, @" /l ""/tmp/path""", false);
 
         result.ExitCode.ShouldBe(0);
+        result.Output.ShouldNotBeNull();
         result.Output.ShouldContain(@"""MajorMinorPatch"": ""1.2.4""");
     }
 
@@ -43,6 +45,7 @@ public void CheckBuildServerVerbosityConsole(string verbosityArg, string expecte
         var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, $@" {verbosityArg} -output buildserver /l ""/tmp/path""", false);
 
         result.ExitCode.ShouldBe(0);
+        result.Output.ShouldNotBeNull();
         result.Output.ShouldContain(expectedOutput);
     }
 
@@ -52,6 +55,7 @@ public void WorkingDirectoryWithoutGitFolderFailsWithInformativeMessage()
         var result = GitVersionHelper.ExecuteIn(SysEnv.SystemDirectory, null, false);
 
         result.ExitCode.ShouldNotBe(0);
+        result.Output.ShouldNotBeNull();
         result.Output.ShouldContain("Cannot find the .git directory");
     }
 
@@ -63,6 +67,7 @@ public void WorkingDirectoryWithoutCommitsFailsWithInformativeMessage()
         var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, null, false);
 
         result.ExitCode.ShouldNotBe(0);
+        result.Output.ShouldNotBeNull();
         result.Output.ShouldContain("No commits found on the current branch.");
     }
 

src/GitVersion.App.Tests/Helpers/ExecutionResults.cs

@@ -1,25 +1,28 @@
 using GitVersion.Core.Tests;
+using GitVersion.Extensions;
 using GitVersion.OutputVariables;
 
 namespace GitVersion.App.Tests;
 
 public class ExecutionResults
 {
-    public ExecutionResults(int exitCode, string output, string? logContents)
+    public ExecutionResults(int exitCode, string? output, string? logContents = null)
     {
         ExitCode = exitCode;
         Output = output;
         Log = logContents;
     }
 
-    public int ExitCode { get; }
-    public string Output { get; }
-    public string? Log { get; }
+    public int ExitCode { get; init; }
+    public string? Output { get; init; }
+    public string? Log { get; init; }
 
-    public virtual GitVersionVariables OutputVariables
+    public GitVersionVariables? OutputVariables
     {
         get
         {
+            if (Output.IsNullOrWhiteSpace()) return null;
+
             var jsonStartIndex = Output.IndexOf('{');
             var jsonEndIndex = Output.IndexOf('}');
             var json = Output.Substring(jsonStartIndex, jsonEndIndex - jsonStartIndex + 1);

src/GitVersion.App.Tests/Helpers/GitVersionHelper.cs

@@ -91,7 +91,7 @@ private static ExecutionResults ExecuteIn(ArgumentBuilder arguments,
 
         if (arguments.LogFile.IsNullOrWhiteSpace() || !File.Exists(arguments.LogFile))
         {
-            return new ExecutionResults(exitCode, output.ToString(), null);
+            return new(exitCode, output.ToString());
         }
 
         var logContents = File.ReadAllText(arguments.LogFile);
@@ -102,6 +102,6 @@ private static ExecutionResults ExecuteIn(ArgumentBuilder arguments,
         Console.WriteLine();
         Console.WriteLine("-------------------------------------------------------");
 
-        return new ExecutionResults(exitCode, output.ToString(), logContents);
+        return new(exitCode, output.ToString(), logContents);
     }
 }

src/GitVersion.App.Tests/Helpers/ProgramFixture.cs

@@ -1,8 +1,6 @@
-using GitVersion.Core.Tests;
 using GitVersion.Core.Tests.Helpers;
 using GitVersion.Extensions;
 using GitVersion.Logging;
-using GitVersion.OutputVariables;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace GitVersion.App.Tests;
@@ -49,13 +47,13 @@ public void WithEnv(params KeyValuePair<string, string>[] envs)
 
     public void WithOverrides(Action<IServiceCollection> action) => Overrides.Add(action);
 
-    public Task<ProgramFixtureResult> Run(string arg)
+    public Task<ExecutionResults> Run(string arg)
     {
         var args = arg.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries).ToArray();
         return Run(args);
     }
 
-    public async Task<ProgramFixtureResult> Run(params string[] args)
+    public async Task<ExecutionResults> Run(params string[] args)
     {
         // Create the application and override registrations.
         var program = new Program(builder => Overrides.ForEach(action => action(builder)));
@@ -66,32 +64,6 @@ public async Task<ProgramFixtureResult> Run(params string[] args)
         }
         await program.RunAsync(args);
 
-        return new ProgramFixtureResult
-        {
-            ExitCode = SysEnv.ExitCode,
-            Output = this.output.Value,
-            Log = this.logger.Value
-        };
-    }
-}
-
-public class ProgramFixtureResult
-{
-    public int ExitCode { get; set; }
-    public string? Output { get; set; }
-    public string Log { get; set; }
-
-    public GitVersionVariables? OutputVariables
-    {
-        get
-        {
-            if (Output.IsNullOrWhiteSpace()) return null;
-
-            var jsonStartIndex = Output.IndexOf('{');
-            var jsonEndIndex = Output.IndexOf('}');
-            var json = Output.Substring(jsonStartIndex, jsonEndIndex - jsonStartIndex + 1);
-
-            return json.ToGitVersionVariables();
-        }
+        return new(SysEnv.ExitCode, this.output.Value, this.logger.Value);
     }
 }

src/GitVersion.App.Tests/JsonOutputOnBuildServerTest.cs

@@ -35,6 +35,7 @@ public void BeingOnBuildServerWithOutputJsonDoesNotFail()
 
         result.ExitCode.ShouldBe(0);
         const string expectedVersion = "0.0.1-5";
+        result.Output.ShouldNotBeNull();
         result.Output.ShouldContain($"##teamcity[buildNumber '{expectedVersion}']");
         result.OutputVariables.ShouldNotBeNull();
         result.OutputVariables.FullSemVer.ShouldBeEquivalentTo(expectedVersion);
@@ -54,6 +55,7 @@ public void BeingOnBuildServerWithOutputJsonAndOutputFileDoesNotFail(string outp
 
         result.ExitCode.ShouldBe(0);
         const string expectedVersion = "0.0.1-5";
+        result.Output.ShouldNotBeNull();
         result.Output.ShouldContain($"##teamcity[buildNumber '{expectedVersion}']");
         result.OutputVariables.ShouldNotBeNull();
         result.OutputVariables.FullSemVer.ShouldBeEquivalentTo(expectedVersion);

src/GitVersion.App.Tests/PullRequestInBuildAgentTest.cs

@@ -178,6 +178,7 @@ private static async Task VerifyPullRequestVersionIsCalculatedProperly(string pu
         var result = await programFixture.Run();
 
         result.ExitCode.ShouldBe(0);
+        result.Output.ShouldNotBeNull();
         result.OutputVariables.ShouldNotBeNull();
         result.OutputVariables.FullSemVer.ShouldBe("1.0.4-PullRequest5.3");
 

src/GitVersion.App.Tests/UpdateWixVersionFileTests.cs

@@ -51,6 +51,7 @@ public void WixVersionFileContentTest()
 
         var gitVersionExecutionResults = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, arguments: null);
         var vars = gitVersionExecutionResults.OutputVariables;
+        vars.ShouldNotBeNull();
 
         GitVersionHelper.ExecuteIn(fixture.RepositoryPath, arguments: " /updatewixversionfile");