code cleanup

Author: arturcic

src/GitTools.Testing/Fixtures/RepositoryFixtureBase.cs

@@ -8,7 +8,6 @@ namespace GitTools.Testing;
 /// </summary>
 public abstract class RepositoryFixtureBase : IDisposable
 {
-    private readonly SequenceDiagram sequenceDiagram;
 
     protected RepositoryFixtureBase(Func<string, IRepository> repoBuilder)
         : this(repoBuilder(PathHelper.GetTempPath()))
@@ -17,7 +16,7 @@ protected RepositoryFixtureBase(Func<string, IRepository> repoBuilder)
 
     protected RepositoryFixtureBase(IRepository repository)
     {
-        this.sequenceDiagram = new SequenceDiagram();
+        this.SequenceDiagram = new SequenceDiagram();
         Repository = repository;
         Repository.Config.Set("user.name", "Test");
         Repository.Config.Set("user.email", "[email protected]");
@@ -27,7 +26,8 @@ protected RepositoryFixtureBase(IRepository repository)
 
     public string RepositoryPath => Repository.Info.WorkingDirectory.TrimEnd('\\');
 
-    public SequenceDiagram SequenceDiagram => this.sequenceDiagram;
+    public SequenceDiagram SequenceDiagram { get; }
+
 
     /// <summary>
     ///     Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
@@ -57,10 +57,10 @@ protected virtual void Dispose(bool disposing)
                 e.Message);
         }
 
-        this.sequenceDiagram.End();
+        this.SequenceDiagram.End();
         Console.WriteLine("**Visualisation of test:**");
         Console.WriteLine(string.Empty);
-        Console.WriteLine(this.sequenceDiagram.GetDiagram());
+        Console.WriteLine(this.SequenceDiagram.GetDiagram());
     }
 
     public void Checkout(string branch) => Commands.Checkout(Repository, branch);
@@ -75,28 +75,28 @@ public void MakeATaggedCommit(string tag)
 
     public void ApplyTag(string tag)
     {
-        this.sequenceDiagram.ApplyTag(tag, Repository.Head.FriendlyName);
+        this.SequenceDiagram.ApplyTag(tag, Repository.Head.FriendlyName);
         Repository.ApplyTag(tag);
     }
 
     public void BranchTo(string branchName, string @as = null)
     {
-        this.sequenceDiagram.BranchTo(branchName, Repository.Head.FriendlyName, @as);
+        this.SequenceDiagram.BranchTo(branchName, Repository.Head.FriendlyName, @as);
         var branch = Repository.CreateBranch(branchName);
         Commands.Checkout(Repository, branch);
     }
 
     public void BranchToFromTag(string branchName, string fromTag, string onBranch, string @as = null)
     {
-        this.sequenceDiagram.BranchToFromTag(branchName, fromTag, onBranch, @as);
+        this.SequenceDiagram.BranchToFromTag(branchName, fromTag, onBranch, @as);
         var branch = Repository.CreateBranch(branchName);
         Commands.Checkout(Repository, branch);
     }
 
     public void MakeACommit()
     {
         var to = Repository.Head.FriendlyName;
-        this.sequenceDiagram.MakeACommit(to);
+        this.SequenceDiagram.MakeACommit(to);
         Repository.MakeACommit();
     }
 
@@ -105,7 +105,7 @@ public void MakeACommit()
     /// </summary>
     public void MergeNoFF(string mergeSource)
     {
-        this.sequenceDiagram.Merge(mergeSource, Repository.Head.FriendlyName);
+        this.SequenceDiagram.Merge(mergeSource, Repository.Head.FriendlyName);
         Repository.MergeNoFF(mergeSource, Generate.SignatureNow());
     }
 

src/GitTools.Testing/Generate.cs

@@ -19,5 +19,5 @@ public static Signature SignatureNow()
     /// <summary>
     /// Creates a libgit2sharp signature at the specified time
     /// </summary>
-    public static Signature Signature(DateTimeOffset dateTimeOffset) => new("A. U. Thor", "[email protected]", dateTimeOffset);
+    private static Signature Signature(DateTimeOffset dateTimeOffset) => new("A. U. Thor", "[email protected]", dateTimeOffset);
 }

src/GitTools.Testing/Internal/ObjectExtensions.cs

@@ -0,0 +1,13 @@
+namespace GitTools.Testing.Internal;
+
+public static class ObjectExtensions
+{
+    public static void Deconstruct<TKey, TValue>(
+        this KeyValuePair<TKey, TValue> kvp,
+        out TKey key,
+        out TValue value)
+    {
+        key = kvp.Key;
+        value = kvp.Value;
+    }
+}

src/GitTools.Testing/Internal/ProcessHelper.cs

@@ -81,8 +81,6 @@ public static int Run(Action<string> output, Action<string> errorOutput, TextRea
         if (output == null)
             throw new ArgumentNullException(nameof(output));
 
-        workingDirectory ??= Environment.CurrentDirectory;
-
         var psi = new ProcessStartInfo
         {
             UseShellExecute = false,
@@ -96,23 +94,31 @@ public static int Run(Action<string> output, Action<string> errorOutput, TextRea
             FileName = exe,
             Arguments = args
         };
-        foreach (var environmentalVariable in environmentalVariables)
+        foreach (var (key, value) in environmentalVariables)
         {
-            if (psi.EnvironmentVariables.ContainsKey(environmentalVariable.Key))
+            var psiEnvironmentVariables = psi.EnvironmentVariables;
+            if (psiEnvironmentVariables.ContainsKey(key) && string.IsNullOrEmpty(value))
             {
-                psi.EnvironmentVariables[environmentalVariable.Key] = environmentalVariable.Value;
+                psiEnvironmentVariables.Remove(key);
             }
-            else
+            else if (psiEnvironmentVariables.ContainsKey(key))
             {
-                psi.EnvironmentVariables.Add(environmentalVariable.Key, environmentalVariable.Value);
+                psiEnvironmentVariables[key] = value;
             }
-            if (psi.EnvironmentVariables.ContainsKey(environmentalVariable.Key) && environmentalVariable.Value == null)
+            else
             {
-                psi.EnvironmentVariables.Remove(environmentalVariable.Key);
+                psiEnvironmentVariables.Add(key, value);
             }
         }
 
         using var process = Start(psi);
+
+        if (process is null)
+        {
+            // FIX ME: What error code do you want to return?
+            return -1;
+        }
+
         using var mreOut = new ManualResetEvent(false);
         using var mreErr = new ManualResetEvent(false);
         process.EnableRaisingEvents = true;
@@ -160,7 +166,7 @@ private enum NativeErrorCode
     }
 
     [Flags]
-    public enum ErrorModes
+    private enum ErrorModes
     {
         Default = 0x0,
         FailCriticalErrors = 0x1,
@@ -169,7 +175,7 @@ public enum ErrorModes
         NoOpenFileErrorBox = 0x8000
     }
 
-    private struct ChangeErrorMode : IDisposable
+    private readonly struct ChangeErrorMode : IDisposable
     {
         private readonly int oldMode;
 

src/GitVersion.App.Tests/ArgumentParserTests.cs

@@ -201,10 +201,10 @@ public void OutputFileArgumentCanBeParsed(string args, string outputFile)
     [Test]
     public void UrlAndBranchNameCanBeParsed()
     {
-        var arguments = this.argumentParser.ParseArguments("targetDirectoryPath -url http://github.com/Particular/GitVersion.git -b somebranch");
+        var arguments = this.argumentParser.ParseArguments("targetDirectoryPath -url https://github.com/Particular/GitVersion.git -b someBranch");
         arguments.TargetPath.ShouldBe("targetDirectoryPath");
-        arguments.TargetUrl.ShouldBe("http://github.com/Particular/GitVersion.git");
-        arguments.TargetBranch.ShouldBe("somebranch");
+        arguments.TargetUrl.ShouldBe("https://github.com/Particular/GitVersion.git");
+        arguments.TargetBranch.ShouldBe("someBranch");
         arguments.IsHelp.ShouldBe(false);
     }
 
@@ -255,7 +255,7 @@ public void UpdateAssemblyInfoFalse(string command)
     }
 
     [TestCase("-updateAssemblyInfo Assembly.cs Assembly1.cs -ensureassemblyinfo")]
-    public void CreateMulitpleAssemblyInfoProtected(string command)
+    public void CreateMultipleAssemblyInfoProtected(string command)
     {
         var exception = Assert.Throws<WarningException>(() => this.argumentParser.ParseArguments(command));
         exception.Message.ShouldBe("Can't specify multiple assembly info files when using /ensureassemblyinfo switch, either use a single assembly info file or do not specify /ensureassemblyinfo and create assembly info files manually");
@@ -642,7 +642,7 @@ public void NofetchTrueWhenDefined()
     }
 
     [Test]
-    public void NonormilizeTrueWhenDefined()
+    public void NoNormalizeTrueWhenDefined()
     {
         var arguments = this.argumentParser.ParseArguments("-nonormalize");
         arguments.NoNormalize.ShouldBe(true);

src/GitVersion.App.Tests/ExecCmdLineArgumentTest.cs

@@ -27,7 +27,7 @@ public void LogPathContainsForwardSlash()
         fixture.MakeATaggedCommit("1.2.3");
         fixture.MakeACommit();
 
-        var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, arguments: @" /l ""/tmp/path""", logToFile: false);
+        var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, @" /l ""/tmp/path""", false);
 
         result.ExitCode.ShouldBe(0);
         result.Output.ShouldContain(@"""MajorMinorPatch"": ""1.2.4""");
@@ -43,7 +43,7 @@ public void CheckBuildServerVerbosityConsole(string verbosityArg, string expecte
         fixture.MakeATaggedCommit("1.2.3");
         fixture.MakeACommit();
 
-        var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, arguments: $@" {verbosityArg} -output buildserver /l ""/tmp/path""", logToFile: false);
+        var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, $@" {verbosityArg} -output buildserver /l ""/tmp/path""", false);
 
         result.ExitCode.ShouldBe(0);
         result.Output.ShouldContain(expectedOutput);
@@ -52,7 +52,7 @@ public void CheckBuildServerVerbosityConsole(string verbosityArg, string expecte
     [Test]
     public void WorkingDirectoryWithoutGitFolderFailsWithInformativeMessage()
     {
-        var result = GitVersionHelper.ExecuteIn(System.Environment.SystemDirectory, arguments: null, logToFile: false);
+        var result = GitVersionHelper.ExecuteIn(System.Environment.SystemDirectory, null, false);
 
         result.ExitCode.ShouldNotBe(0);
         result.Output.ShouldContain("Cannot find the .git directory");
@@ -63,7 +63,7 @@ public void WorkingDirectoryWithoutCommitsFailsWithInformativeMessage()
     {
         using var fixture = new EmptyRepositoryFixture();
 
-        var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, arguments: null, logToFile: false);
+        var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, null, false);
 
         result.ExitCode.ShouldNotBe(0);
         result.Output.ShouldContain("No commits found on the current branch.");

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

@@ -4,58 +4,58 @@ namespace GitVersion.App.Tests;
 
 public class ArgumentBuilder
 {
-    public ArgumentBuilder(string workingDirectory) => this.workingDirectory = workingDirectory;
+    public ArgumentBuilder(string workingDirectory) => this.WorkingDirectory = workingDirectory;
 
     public ArgumentBuilder(string workingDirectory, string exec, string execArgs, string projectFile, string projectArgs, string logFile)
     {
-        this.workingDirectory = workingDirectory;
+        this.WorkingDirectory = workingDirectory;
         this.exec = exec;
         this.execArgs = execArgs;
         this.projectFile = projectFile;
         this.projectArgs = projectArgs;
-        this.logFile = logFile;
+        this.LogFile = logFile;
     }
 
     public ArgumentBuilder(string workingDirectory, string additionalArguments, string logFile)
     {
-        this.workingDirectory = workingDirectory;
+        this.WorkingDirectory = workingDirectory;
         this.additionalArguments = additionalArguments;
-        this.logFile = logFile;
+        this.LogFile = logFile;
     }
 
-    public string WorkingDirectory => this.workingDirectory;
+    public string WorkingDirectory { get; }
 
-    public string LogFile => this.logFile;
+    public string LogFile { get; }
 
     public override string ToString()
     {
         var arguments = new StringBuilder();
 
-        arguments.AppendFormat(" /targetpath \"{0}\"", this.workingDirectory);
+        arguments.Append($" /targetpath \"{this.WorkingDirectory}\"");
 
         if (!this.exec.IsNullOrWhiteSpace())
         {
-            arguments.AppendFormat(" /exec \"{0}\"", this.exec);
+            arguments.Append($" /exec \"{this.exec}\"");
         }
 
         if (!this.execArgs.IsNullOrWhiteSpace())
         {
-            arguments.AppendFormat(" /execArgs \"{0}\"", this.execArgs);
+            arguments.Append($" /execArgs \"{this.execArgs}\"");
         }
 
         if (!this.projectFile.IsNullOrWhiteSpace())
         {
-            arguments.AppendFormat(" /proj \"{0}\"", this.projectFile);
+            arguments.Append($" /proj \"{this.projectFile}\"");
         }
 
         if (!this.projectArgs.IsNullOrWhiteSpace())
         {
-            arguments.AppendFormat(" /projargs \"{0}\"", this.projectArgs);
+            arguments.Append($" /projargs \"{this.projectArgs}\"");
         }
 
-        if (!this.logFile.IsNullOrWhiteSpace())
+        if (!this.LogFile.IsNullOrWhiteSpace())
         {
-            arguments.AppendFormat(" /l \"{0}\"", this.logFile);
+            arguments.Append($" /l \"{this.LogFile}\"");
         }
 
         arguments.Append(this.additionalArguments);
@@ -66,8 +66,6 @@ public override string ToString()
     private readonly string additionalArguments;
     private readonly string exec;
     private readonly string execArgs;
-    private readonly string logFile;
     private readonly string projectArgs;
     private readonly string projectFile;
-    private readonly string workingDirectory;
 }

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

@@ -50,15 +50,15 @@ params KeyValuePair<string, string>[] environments
             { SpaceAutomation.EnvironmentVariableName, null }
         };
 
-        foreach (var environment in environments)
+        foreach (var (key, value) in environments)
         {
-            if (environmentalVariables.ContainsKey(environment.Key))
+            if (environmentalVariables.ContainsKey(key))
             {
-                environmentalVariables[environment.Key] = environment.Value;
+                environmentalVariables[key] = value;
             }
             else
             {
-                environmentalVariables.Add(environment.Key, environment.Value);
+                environmentalVariables.Add(key, value);
             }
         }
 

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

@@ -40,9 +40,9 @@ public ProgramFixture(string workingDirectory = "")
 
     public void WithEnv(params KeyValuePair<string, string>[] envs)
     {
-        foreach (var env in envs)
+        foreach (var (key, value) in envs)
         {
-            this.environment.SetEnvironmentVariable(env.Key, env.Value);
+            this.environment.SetEnvironmentVariable(key, value);
         }
     }
 

src/GitVersion.App.Tests/UpdateWixVersionFileTests.cs

@@ -71,16 +71,14 @@ public void WixVersionFileContentTest()
     private static Dictionary<string, string> GetGitVersionVarsInWixFile(string file)
     {
         var gitVersionVarsInWix = new Dictionary<string, string>();
-        using (var reader = new XmlTextReader(file))
+        using var reader = new XmlTextReader(file);
+        while (reader.Read())
         {
-            while (reader.Read())
-            {
-                if (reader.Name == "define")
-                {
-                    var component = reader.Value.Split('=');
-                    gitVersionVarsInWix[component[0]] = component[1].TrimStart('"').TrimEnd('"');
-                }
-            }
+            if (reader.Name != "define")
+                continue;
+
+            var component = reader.Value.Split('=');
+            gitVersionVarsInWix[component[0]] = component[1].TrimStart('"').TrimEnd('"');
         }
         return gitVersionVarsInWix;
     }