Merge pull request #612 from mjcheetham/wsl-localhost

Update `IsWslPath` to detect `\\wsl.localhost`-style paths

Author: mjcheetham

src/shared/Core.Tests/WslUtilsTests.cs

@@ -6,7 +6,7 @@ namespace GitCredentialManager.Tests
 {
     public class WslUtilsTests
     {
-        [PlatformTheory(Platforms.Windows)]
+        [Theory]
         [InlineData(null, false)]
         [InlineData(@"", false)]
         [InlineData(@" ", false)]
@@ -26,6 +26,18 @@ public class WslUtilsTests
         [InlineData(@"\\WSL$\UBUNTU\home", true)]
         [InlineData(@"\\wsl$\ubuntu\home\", true)]
         [InlineData(@"\\wsl$\openSUSE-42\home", true)]
+        [InlineData(@"wsl.localhost", false)]
+        [InlineData(@"\wsl.localhost\ubuntu\home", false)]
+        [InlineData(@"wsl.localhost\ubuntu\home", false)]
+        [InlineData(@"//wsl.localhost/ubuntu/home", false)]
+        [InlineData(@"\\wsl.localhost", false)]
+        [InlineData(@"\\wsl.localhost\", false)]
+        [InlineData(@"\\wsl.localhost\ubuntu", true)]
+        [InlineData(@"\\wsl.localhost\ubuntu\", true)]
+        [InlineData(@"\\wsl.localhost\ubuntu\home", true)]
+        [InlineData(@"\\WSL.LOCALHOST\UBUNTU\home", true)]
+        [InlineData(@"\\wsl.localhost\ubuntu\home\", true)]
+        [InlineData(@"\\wsl.localhost\openSUSE-42\home", true)]
         public void WslUtils_IsWslPath(string path, bool expected)
         {
             bool actual = WslUtils.IsWslPath(path);
@@ -40,14 +52,21 @@ public void WslUtils_IsWslPath(string path, bool expected)
         [InlineData(@"\\wsl$\UBUNTU\home", "UBUNTU", "/home")]
         [InlineData(@"\\wsl$\ubuntu\home\", "ubuntu", "/home/")]
         [InlineData(@"\\wsl$\openSUSE-42\home", "openSUSE-42", "/home")]
+        [InlineData(@"\\wsl.localhost\ubuntu", "ubuntu", "/")]
+        [InlineData(@"\\wsl.localhost\ubuntu\", "ubuntu", "/")]
+        [InlineData(@"\\wsl.localhost\ubuntu\home", "ubuntu", "/home")]
+        [InlineData(@"\\wsl.localhost\ubuntu\HOME", "ubuntu", "/HOME")]
+        [InlineData(@"\\wsl.localhost\UBUNTU\home", "UBUNTU", "/home")]
+        [InlineData(@"\\wsl.localhost\ubuntu\home\", "ubuntu", "/home/")]
+        [InlineData(@"\\wsl.localhost\openSUSE-42\home", "openSUSE-42", "/home")]
         public void WslUtils_ConvertToDistroPath(string path, string expectedDistro, string expectedPath)
         {
             string actualPath = WslUtils.ConvertToDistroPath(path, out string actualDistro);
             Assert.Equal(expectedPath, actualPath);
             Assert.Equal(expectedDistro, actualDistro);
         }
 
-        [PlatformTheory(Platforms.Windows)]
+        [Theory]
         [InlineData(null)]
         [InlineData(@"")]
         [InlineData(@" ")]
@@ -61,6 +80,12 @@ public void WslUtils_ConvertToDistroPath(string path, string expectedDistro, str
         [InlineData(@"\\wsl")]
         [InlineData(@"\\wsl$")]
         [InlineData(@"\\wsl$\")]
+        [InlineData(@"wsl.localhost")]
+        [InlineData(@"\wsl.localhost\ubuntu\home")]
+        [InlineData(@"wsl.localhost\ubuntu\home")]
+        [InlineData(@"//wsl.localhost/ubuntu/home")]
+        [InlineData(@"\\wsl.localhost")]
+        [InlineData(@"\\wsl.localhost\")]
         public void WslUtils_ConvertToDistroPath_Invalid_ThrowsException(string path)
         {
             Assert.Throws<ArgumentException>(() => WslUtils.ConvertToDistroPath(path, out _));

src/shared/Core/WslUtils.cs

@@ -8,6 +8,7 @@ namespace GitCredentialManager
     public static class WslUtils
     {
         private const string WslUncPrefix = @"\\wsl$\";
+        private const string WslLocalHostUncPrefix = @"\\wsl.localhost\";
         private const string WslCommandName = "wsl.exe";
 
         /// <summary>
@@ -19,8 +20,10 @@ public static bool IsWslPath(string path)
         {
             if (string.IsNullOrWhiteSpace(path)) return false;
 
-            return path.StartsWith(WslUncPrefix, StringComparison.OrdinalIgnoreCase) &&
-                   path.Length > WslUncPrefix.Length;
+            return (path.StartsWith(WslUncPrefix, StringComparison.OrdinalIgnoreCase) &&
+                    path.Length > WslUncPrefix.Length) ||
+                   (path.StartsWith(WslLocalHostUncPrefix, StringComparison.OrdinalIgnoreCase) &&
+                    path.Length > WslLocalHostUncPrefix.Length);
         }
 
         /// <summary>
@@ -54,7 +57,20 @@ public static string ConvertToDistroPath(string path, out string distribution)
         {
             if (!IsWslPath(path)) throw new ArgumentException("Must provide a WSL path", nameof(path));
 
-            int distroStart = WslUncPrefix.Length;
+            int distroStart;
+            if (path.StartsWith(WslUncPrefix, StringComparison.OrdinalIgnoreCase))
+            {
+                distroStart = WslUncPrefix.Length;
+            }
+            else if (path.StartsWith(WslLocalHostUncPrefix, StringComparison.OrdinalIgnoreCase))
+            {
+                distroStart = WslLocalHostUncPrefix.Length;
+            }
+            else
+            {
+                throw new Exception("Invalid WSL path prefix");
+            }
+
             int distroEnd = path.IndexOf('\\', distroStart);
 
             if (distroEnd < 0) distroEnd = path.Length;