Implement environment variable as a possible path source for diff too…

…ls (#314)
VerifyTests · May 28, 2023 · afa3381 · afa3381
1 parent 563f3a3
commit afa3381
Show file tree

Hide file tree

Showing 31 changed files with 403 additions and 148 deletions.
diff --git a/docs/diff-tool.md b/docs/diff-tool.md
diff --git a/src/DiffEngine.Tests/DefinitionsTest.cs b/src/DiffEngine.Tests/DefinitionsTest.cs
@@ -1,4 +1,4 @@
-public class DefinitionsTest :
+public class DefinitionsTest :
     XunitContextBase
 {
     [Fact]
@@ -14,6 +14,26 @@ public void WriteList()
         }
     }
 
+    [Fact]
+    public void EnvironmentVariablesShouldBeUnique()
+    {
+        static void FindDuplicates(Func<OsSupport, OsSettings?> SelectOs)
+        {
+            var findDuplicates = Definitions.Tools
+                .Select(d => d.OsSupport)
+                .Select(SelectOs)
+                .Where(s => s is not null)
+                .GroupBy(x => x);
+            foreach (var group in findDuplicates)
+            {
+                Assert.Equal(1, group.Count());
+            }
+        }
+        FindDuplicates(os => os.Windows);
+        FindDuplicates(os => os.Osx);
+        FindDuplicates(os => os.Linux);
+    }
+
     static void AddToolLink(TextWriter writer, Definition tool)
     {
         var osSupport = GetOsSupport(tool.OsSupport);

diff --git a/src/DiffEngine.Tests/OsSettingsResolverTest.cs b/src/DiffEngine.Tests/OsSettingsResolverTest.cs
@@ -1,17 +1,17 @@
-public class OsSettingsResolverTest :
+public class OsSettingsResolverTest :
     XunitContextBase
 {
     [Fact]
     public void Simple()
     {
-        var paths = OsSettingsResolver.ExpandProgramFiles(new[] {"Path"}).ToList();
+        var paths = OsSettingsResolver.ExpandProgramFiles(new[] { "Path" }).ToList();
         Assert.Equal("Path", paths.Single());
     }
 
     [Fact]
     public void Expand()
     {
-        var paths = OsSettingsResolver.ExpandProgramFiles(new[] {@"%ProgramFiles%\Path"}).ToList();
+        var paths = OsSettingsResolver.ExpandProgramFiles(new[] { @"%ProgramFiles%\Path" }).ToList();
         Assert.Equal(@"%ProgramFiles%\Path", paths[0]);
         Assert.Equal(@"%ProgramW6432%\Path", paths[1]);
         Assert.Equal(@"%ProgramFiles(x86)%\Path", paths[2]);
@@ -36,6 +36,21 @@ public void EnvPath()
         }
     }
 
+    [Fact]
+    public void EnvVar()
+    {
+        var launchArguments = new LaunchArguments(
+            Left: (temp, target) => string.Empty,
+            Right: (temp, target) => string.Empty);
+
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+        {
+            var found = OsSettingsResolver.Resolve(new OsSupport(Windows: new OsSettings("ComSpec", "cmd.exe", launchArguments, "")), out var filePath, out var launchArgs);
+            Assert.Equal(true, found);
+            Assert.Equal(@"C:\Windows\System32\cmd.exe", filePath, ignoreCase: true);
+        }
+    }
+
     public OsSettingsResolverTest(ITestOutputHelper output) :
         base(output)
     {

diff --git a/src/DiffEngine.Tests/diffTools.include.md b/src/DiffEngine.Tests/diffTools.include.md
diff --git a/src/DiffEngine/Implementation/AraxisMerge.cs b/src/DiffEngine/Implementation/AraxisMerge.cs
@@ -1,7 +1,9 @@
-static partial class Implementation
+static partial class Implementation
 {
-    public static Definition AraxisMerge() =>
-        new(
+    public static Definition AraxisMerge()
+    {
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.AraxisMerge)}";
+        return new(
             Tool: DiffTool.AraxisMerge,
             Url: "https://www.araxis.com/merge",
             AutoRefresh: true,
@@ -36,12 +38,14 @@ public static Definition AraxisMerge() =>
             },
             OsSupport: new(
                 Windows: new(
+                    environmentVariable,
                     "Compare.exe",
                     new(
                         Left: (temp, target) => $"/nowait \"{target}\" \"{temp}\"",
                         Right: (temp, target) => $"/nowait \"{temp}\" \"{target}\""),
                     @"%ProgramFiles%\Araxis\Araxis Merge\"),
                 Osx: new(
+                    environmentVariable,
                     "compare",
                     new(
                         Left: (temp, target) => $"-nowait \"{target}\" \"{temp}\"",
@@ -53,5 +57,6 @@ public static Definition AraxisMerge() =>
                  * [MacOS command line usage](https://www.araxis.com/merge/documentation-os-x/command-line.en)
                  * [Installing MacOS command line](https://www.araxis.com/merge/documentation-os-x/installing.en)
                 """);
+    }
     //TODO: add doco about auto refresh
 }
diff --git a/src/DiffEngine/Implementation/BeyondCompare.cs b/src/DiffEngine/Implementation/BeyondCompare.cs
@@ -1,4 +1,4 @@
-static partial class Implementation
+static partial class Implementation
 {
     public static Definition BeyondCompare()
     {
@@ -22,6 +22,7 @@ static string RightOsxLinuxArguments(string temp, string target)
             return $"-solo -leftreadonly \"{temp}\" \"{target}\"";
         }
 
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.BeyondCompare)}";
         return new(
             Tool: DiffTool.BeyondCompare,
             Url: "https://www.scootersoftware.com",
@@ -47,18 +48,21 @@ static string RightOsxLinuxArguments(string temp, string target)
             },
             OsSupport: new(
                 Windows: new(
+                    environmentVariable,
                     "BCompare.exe",
                     new(
                         LeftWindowsArguments,
                         RightWindowsArguments),
                     @"%ProgramFiles%\Beyond Compare *\"),
                 Linux: new(
+                    environmentVariable,
                     "bcomp",
                     new(
                         LeftOsxLinuxArguments,
                         RightOsxLinuxArguments),
                     "/usr/lib/beyondcompare/"),
                 Osx: new(
+                    environmentVariable,
                     "bcomp",
                     new(
                         LeftOsxLinuxArguments,

diff --git a/src/DiffEngine/Implementation/CodeCompare.cs b/src/DiffEngine/Implementation/CodeCompare.cs
@@ -1,7 +1,9 @@
-static partial class Implementation
+static partial class Implementation
 {
-    public static Definition CodeCompare() =>
-        new(
+    public static Definition CodeCompare()
+    {
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.CodeCompare)}";
+        return new(
             Tool: DiffTool.CodeCompare,
             Url: "https://www.devart.com/codecompare/",
             AutoRefresh: false,
@@ -12,10 +14,12 @@ public static Definition CodeCompare() =>
             BinaryExtensions: Array.Empty<string>(),
             OsSupport: new(
                 Windows: new(
+                    environmentVariable,
                     "CodeCompare.exe",
                     new(
                         Left: (temp, target) => $"\"{target}\" \"{temp}\"",
                         Right: (temp, target) => $"\"{temp}\" \"{target}\""),
                     @"%ProgramFiles%\Devart\Code Compare\")),
             Notes: @" * [Command line reference](https://docs.devart.com/code-compare/using-command-line/comparing-via-command-line.html)");
+    }
 }
diff --git a/src/DiffEngine/Implementation/DeltaWalker.cs b/src/DiffEngine/Implementation/DeltaWalker.cs
@@ -1,11 +1,13 @@
-static partial class Implementation
+static partial class Implementation
 {
     public static Definition DeltaWalker()
     {
         var launchArguments = new LaunchArguments(
             Left: (temp, target) => $"-mi \"{target}\" \"{temp}\"",
             Right: (temp, target) => $"-mi \"{temp}\" \"{target}\"");
 
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.DeltaWalker)}";
+
         return new(
             Tool: DiffTool.DeltaWalker,
             Url: "https://www.deltawalker.com/",
@@ -52,10 +54,12 @@ public static Definition DeltaWalker()
             },
             OsSupport: new(
                 Osx: new(
+                    environmentVariable,
                     "DeltaWalker",
                     launchArguments,
                     "/Applications/DeltaWalker.app/Contents/MacOS/"),
                 Windows: new(
+                    environmentVariable,
                     "DeltaWalker.exe",
                     launchArguments,
                     @"C:\Program Files\Deltopia\DeltaWalker\")),

diff --git a/src/DiffEngine/Implementation/DiffMerge.cs b/src/DiffEngine/Implementation/DiffMerge.cs
@@ -1,11 +1,12 @@
-static partial class Implementation
+static partial class Implementation
 {
     public static Definition DiffMerge()
     {
         var launchArguments = new LaunchArguments(
             Left: (temp, target) => $"--nosplash \"{target}\" \"{temp}\"",
             Right: (temp, target) => $"--nosplash \"{temp}\" \"{target}\"");
 
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.DiffMerge)}";
         return new(
             Tool: DiffTool.DiffMerge,
             Url: "https://www.sourcegear.com/diffmerge/",

diff --git a/src/DiffEngine/Implementation/Diffinity.cs b/src/DiffEngine/Implementation/Diffinity.cs
@@ -1,7 +1,9 @@
-static partial class Implementation
+static partial class Implementation
 {
-    public static Definition Diffinity() =>
-        new(
+    public static Definition Diffinity()
+    {
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.Diffinity)}";
+        return new(
             Tool: DiffTool.Diffinity,
             Url: "https://truehumandesign.se/s_diffinity.php",
             AutoRefresh: true,
@@ -12,6 +14,7 @@ public static Definition Diffinity() =>
             BinaryExtensions: Array.Empty<string>(),
             OsSupport: new(
                 Windows: new(
+                    environmentVariable,
                     "Diffinity.exe",
                     new(
                         Left: (temp, target) => $"\"{target}\" \"{temp}\"",
@@ -21,4 +24,5 @@ public static Definition Diffinity() =>
                  * Disable single instance:
                    \ Preferences \ Tabs \ uncheck `Use single instance and open new diffs in tabs`.
                 """);
+    }
 }
diff --git a/src/DiffEngine/Implementation/ExamDiff.cs b/src/DiffEngine/Implementation/ExamDiff.cs
@@ -1,4 +1,4 @@
-static partial class Implementation
+static partial class Implementation
 {
     public static Definition ExamDiff()
     {
@@ -16,6 +16,7 @@ static string RightArguments(string temp, string target)
             return $"\"{temp}\" \"{target}\" /nh /diffonly /dn1:{tempTitle} /dn2:{targetTitle}";
         }
 
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.ExamDiff)}";
         return new(
             Tool: DiffTool.ExamDiff,
             Url: "https://www.prestosoft.com/edp_examdiffpro.asp",
@@ -27,6 +28,7 @@ static string RightArguments(string temp, string target)
             BinaryExtensions: Array.Empty<string>(),
             OsSupport: new(
                 Windows: new(
+                    environmentVariable,
                     "ExamDiff.exe",
                     new(LeftArguments, RightArguments),
                     @"%ProgramFiles%\ExamDiff Pro\")),

diff --git a/src/DiffEngine/Implementation/Guiffy.cs b/src/DiffEngine/Implementation/Guiffy.cs
@@ -1,11 +1,12 @@
-static partial class Implementation
+static partial class Implementation
 {
     public static Definition Guiffy()
     {
         var launchArguments = new LaunchArguments(
             Left: (temp, target) => $"\"{target}\" \"{temp}\" -ge2",
             Right: (temp, target) => $"\"{temp}\" \"{target}\" -ge1");
 
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.Guiffy)}";
         return new(
             Tool: DiffTool.Guiffy,
             Url: "https://www.guiffy.com/",

diff --git a/src/DiffEngine/Implementation/ImplementationDefaults.cs b/src/DiffEngine/Implementation/ImplementationDefaults.cs
@@ -0,0 +1,4 @@
+static partial class Implementation
+{
+    const string DefaultEnvironmentVariablePrefix = "DiffEngine";
+}
diff --git a/src/DiffEngine/Implementation/KDiff3.cs b/src/DiffEngine/Implementation/KDiff3.cs
@@ -1,11 +1,12 @@
-static partial class Implementation
+static partial class Implementation
 {
     public static Definition KDiff3()
     {
         var launchArguments = new LaunchArguments(
             Left: (temp, target) => $"\"{target}\" \"{temp}\" --cs CreateBakFiles=0",
             Right: (temp, target) => $"\"{temp}\" \"{target}\" --cs CreateBakFiles=0");
 
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.KDiff3)}";
         return new(
             Tool: DiffTool.KDiff3,
             Url: "https://github.com/KDE/kdiff3",
@@ -17,10 +18,12 @@ public static Definition KDiff3()
             BinaryExtensions: Array.Empty<string>(),
             OsSupport: new(
                 Windows: new(
+                    environmentVariable,
                     "kdiff3.exe",
                     launchArguments,
                     @"%ProgramFiles%\KDiff3\"),
                 Osx: new(
+                    environmentVariable,
                     "kdiff3",
                     launchArguments,
                     "/Applications/kdiff3.app/Contents/MacOS/")),

diff --git a/src/DiffEngine/Implementation/Kaleidoscope.cs b/src/DiffEngine/Implementation/Kaleidoscope.cs
@@ -1,7 +1,9 @@
-static partial class Implementation
+static partial class Implementation
 {
-    public static Definition Kaleidoscope() =>
-        new(
+    public static Definition Kaleidoscope()
+    {
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.Kaleidoscope)}";
+        return new(
             Tool: DiffTool.Kaleidoscope,
             Url: "https://www.kaleidoscopeapp.com/",
             AutoRefresh: true,
@@ -22,8 +24,10 @@ public static Definition Kaleidoscope() =>
             },
             OsSupport: new(
                 Osx: new(
+                    environmentVariable,
                     "ksdiff",
                     new(
                         Left: (temp, target) => $"\"{target}\" \"{temp}\"",
                         Right: (temp, target) => $"\"{temp}\" \"{target}\""))));
+    }
 }
diff --git a/src/DiffEngine/Implementation/Meld.cs b/src/DiffEngine/Implementation/Meld.cs
@@ -1,11 +1,12 @@
-static partial class Implementation
+static partial class Implementation
 {
     public static Definition Meld()
     {
         var launchArguments = new LaunchArguments(
             Left: (temp, target) => $"\"{target}\" \"{temp}\"",
             Right: (temp, target) => $"\"{temp}\" \"{target}\"");
 
+        var environmentVariable = $"${DefaultEnvironmentVariablePrefix}_{nameof(DiffTool.Meld)}";
         return new(
             Tool: DiffTool.Meld,
             Url: "https://meldmerge.org/",
@@ -17,14 +18,17 @@ public static Definition Meld()
             BinaryExtensions: Array.Empty<string>(),
             OsSupport: new(
                 Windows: new(
+                    environmentVariable,
                     "meld.exe",
                     launchArguments,
                     @"%LOCALAPPDATA%\Programs\Meld\",
                     @"%ProgramFiles%\Meld\"),
                 Linux: new(
+                    environmentVariable,
                     "meld",
                     launchArguments),
                 Osx: new(
+                    environmentVariable,
                     "meld",
                     launchArguments,
                     "/Applications/meld.app/Contents/MacOS/")),