Refactor ProcessHelper and PathHelper classes

The ProcessHelper and PathHelper classes have been refactored to align with proper visibility levels and aliased "System.Environment.Newline" to "PathHelper.Newline". Their corresponding usages throughout the project have also been updated. Additionally, redundant code has been removed with this change.

Author: arturcic

src/Directory.Build.props

@@ -98,6 +98,7 @@
         <Using Include="System.Text.Json"/>
         <Using Include="System.Text.Json.Serialization"/>
         <Using Include="System.Xml"/>
+        <Using Include="System.Environment" Alias="SysEnv"/>
     </ItemGroup>
 
     <ItemGroup>

src/GitVersion.App.Tests/ArgumentParserTests.cs

@@ -30,7 +30,7 @@ public void SetUp()
     public void EmptyMeansUseCurrentDirectory()
     {
         var arguments = this.argumentParser.ParseArguments("");
-        arguments.TargetPath.ShouldBe(System.Environment.CurrentDirectory);
+        arguments.TargetPath.ShouldBe(SysEnv.CurrentDirectory);
         arguments.LogFilePath.ShouldBe(null);
         arguments.IsHelp.ShouldBe(false);
     }
@@ -48,7 +48,7 @@ public void SingleMeansUseAsTargetDirectory()
     public void NoPathAndLogfileShouldUseCurrentDirectoryTargetDirectory()
     {
         var arguments = this.argumentParser.ParseArguments("-l logFilePath");
-        arguments.TargetPath.ShouldBe(System.Environment.CurrentDirectory);
+        arguments.TargetPath.ShouldBe(SysEnv.CurrentDirectory);
         arguments.LogFilePath.ShouldBe("logFilePath");
         arguments.IsHelp.ShouldBe(false);
     }

src/GitVersion.App.Tests/ExecCmdLineArgumentTest.cs

@@ -49,7 +49,7 @@ public void CheckBuildServerVerbosityConsole(string verbosityArg, string expecte
     [Test]
     public void WorkingDirectoryWithoutGitFolderFailsWithInformativeMessage()
     {
-        var result = GitVersionHelper.ExecuteIn(System.Environment.SystemDirectory, null, false);
+        var result = GitVersionHelper.ExecuteIn(SysEnv.SystemDirectory, null, false);
 
         result.ExitCode.ShouldNotBe(0);
         result.Output.ShouldContain("Cannot find the .git directory");
@@ -69,7 +69,7 @@ public void WorkingDirectoryWithoutCommitsFailsWithInformativeMessage()
     [Test]
     public void WorkingDirectoryDoesNotExistFailsWithInformativeMessage()
     {
-        var workingDirectory = PathHelper.Combine(ExecutableHelper.GetCurrentDirectory(), Guid.NewGuid().ToString("N"));
+        var workingDirectory = PathHelper.Combine(PathHelper.GetCurrentDirectory(), Guid.NewGuid().ToString("N"));
         var executable = ExecutableHelper.GetDotNetExecutable();
 
         var output = new StringBuilder();
@@ -81,7 +81,7 @@ public void WorkingDirectoryDoesNotExistFailsWithInformativeMessage()
             null,
             executable,
             args,
-            ExecutableHelper.GetCurrentDirectory());
+            PathHelper.GetCurrentDirectory());
 
         exitCode.ShouldNotBe(0);
         var outputString = output.ToString();

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

@@ -67,7 +67,7 @@ public async Task<ProgramFixtureResult> Run(params string[] args)
 
         return new ProgramFixtureResult
         {
-            ExitCode = System.Environment.ExitCode,
+            ExitCode = SysEnv.ExitCode,
             Output = this.output.Value,
             Log = this.logger.Value
         };

src/GitVersion.App.Tests/PullRequestInBuildAgentTest.cs

@@ -1,6 +1,7 @@
 using GitVersion.Agents;
 using GitVersion.Core.Tests.Helpers;
 using GitVersion.Extensions;
+using GitVersion.Helpers;
 using GitVersion.Output;
 using LibGit2Sharp;
 
@@ -142,7 +143,7 @@ public async Task VerifyBitBucketPipelinesPullRequest(string pullRequestRef)
     private static async Task VerifyPullRequestVersionIsCalculatedProperly(string pullRequestRef, Dictionary<string, string> env)
     {
         using var fixture = new EmptyRepositoryFixture("main");
-        var remoteRepositoryPath = ExecutableHelper.GetTempPath();
+        var remoteRepositoryPath = PathHelper.GetTempPath();
         RepositoryFixtureBase.Init(remoteRepositoryPath, "main");
         using (var remoteRepository = new Repository(remoteRepositoryPath))
         {

src/GitVersion.App.Tests/TagCheckoutInBuildAgentTests.cs

@@ -1,5 +1,6 @@
 using GitVersion.Agents;
 using GitVersion.Core.Tests.Helpers;
+using GitVersion.Helpers;
 using LibGit2Sharp;
 
 namespace GitVersion.App.Tests;
@@ -34,7 +35,7 @@ public async Task VerifyTagCheckoutOnGitHubActions()
     private static async Task VerifyTagCheckoutVersionIsCalculatedProperly(Dictionary<string, string> env)
     {
         using var fixture = new EmptyRepositoryFixture("main");
-        var remoteRepositoryPath = ExecutableHelper.GetTempPath();
+        var remoteRepositoryPath = PathHelper.GetTempPath();
         RepositoryFixtureBase.Init(remoteRepositoryPath, "main");
         using (var remoteRepository = new Repository(remoteRepositoryPath))
         {

src/GitVersion.App/ArgumentParser.cs

@@ -36,7 +36,7 @@ public Arguments ParseArguments(string[] commandLineArguments)
         {
             var args = new Arguments
             {
-                TargetPath = System.Environment.CurrentDirectory
+                TargetPath = SysEnv.CurrentDirectory
             };
 
             args.Output.Add(OutputType.Json);
@@ -54,7 +54,7 @@ public Arguments ParseArguments(string[] commandLineArguments)
         {
             return new Arguments
             {
-                TargetPath = System.Environment.CurrentDirectory,
+                TargetPath = SysEnv.CurrentDirectory,
                 Init = true
             };
         }
@@ -99,7 +99,7 @@ public Arguments ParseArguments(string[] commandLineArguments)
         // If the first argument is a switch, it should already have been consumed in the above loop,
         // or else a WarningException should have been thrown and we wouldn't end up here.
         arguments.TargetPath ??= firstArgumentIsSwitch
-            ? System.Environment.CurrentDirectory
+            ? SysEnv.CurrentDirectory
             : firstArgument;
 
         arguments.TargetPath = arguments.TargetPath.TrimEnd('/', '\\');
@@ -388,7 +388,7 @@ private static void ParseShowVariable(Arguments arguments, string? value, string
 
         if (versionVariable == null)
         {
-            var message = $"{name} requires a valid version variable. Available variables are:{System.Environment.NewLine}" +
+            var message = $"{name} requires a valid version variable. Available variables are:{PathHelper.NewLine}" +
                           string.Join(", ", availableVariables.Select(x => string.Concat("'", x, "'")));
             throw new WarningException(message);
         }

src/GitVersion.App/GitVersionApp.cs

@@ -25,12 +25,12 @@ public Task StartAsync(CancellationToken cancellationToken)
         {
             var gitVersionOptions = this.options.Value;
             this.log.Verbosity = gitVersionOptions.Verbosity;
-            System.Environment.ExitCode = this.gitVersionExecutor.Execute(gitVersionOptions);
+            SysEnv.ExitCode = this.gitVersionExecutor.Execute(gitVersionOptions);
         }
         catch (Exception exception)
         {
             Console.Error.WriteLine(exception.Message);
-            System.Environment.ExitCode = 1;
+            SysEnv.ExitCode = 1;
         }
 
         this.applicationLifetime.StopApplication();

src/GitVersion.App/GitVersionExecutor.cs

@@ -1,5 +1,6 @@
 using GitVersion.Configuration;
 using GitVersion.Extensions;
+using GitVersion.Helpers;
 using GitVersion.Logging;
 
 namespace GitVersion;
@@ -72,13 +73,13 @@ private int RunGitVersionTool(GitVersionOptions gitVersionOptions)
         }
         catch (WarningException exception)
         {
-            var error = $"An error occurred:{System.Environment.NewLine}{exception.Message}";
+            var error = $"An error occurred:{PathHelper.NewLine}{exception.Message}";
             this.log.Warning(error);
             return 1;
         }
         catch (Exception exception)
         {
-            var error = $"An unexpected error occurred:{System.Environment.NewLine}{exception}";
+            var error = $"An unexpected error occurred:{PathHelper.NewLine}{exception}";
             this.log.Error(error);
 
             this.log.Info("Attempting to show the current git graph (please include in issue): ");

src/GitVersion.App/HelpWriter.cs

@@ -1,4 +1,5 @@
 using GitVersion.Extensions;
+using GitVersion.Helpers;
 using GitVersion.Logging;
 
 namespace GitVersion;
@@ -23,8 +24,7 @@ public void WriteTo(Action<string> writeAction)
         this.versionWriter.WriteTo(assembly, v => version = v);
 
         var args = ArgumentList();
-        var nl = System.Environment.NewLine;
-        var message = "GitVersion " + version + nl + nl + args;
+        var message = $"GitVersion {version}{PathHelper.NewLine}{PathHelper.NewLine}{args}";
 
         writeAction(message);
     }