Fix roundtrip of Git engine spec query string (#338)

Author: hach-que

UET/Redpoint.Uet.BuildPipeline/Executors/BuildEngineSpecification.cs

@@ -2,6 +2,7 @@
 {
     using System.Collections.Specialized;
     using System.Diagnostics.CodeAnalysis;
+    using System.Web;
 
     public enum BuildEngineSpecificationEngineBuildType
     {
@@ -146,7 +147,25 @@ public string ToReparsableString()
                 {
                     options.Add($",mc:{_gitSharedMacCachePath}");
                 }
-                return $"git:{_gitCommit}@{_gitUrl}{string.Join("", options)}";
+                if (options.Count > 0)
+                {
+                    if (_queryString == null)
+                    {
+                        _queryString = [];
+                    }
+                    if (_queryString["config"] == null)
+                    {
+                        // Only set 'config' if it's not already set, since the options
+                        // will have originally come from the 'config' key if it exists.
+                        _queryString["config"] = string.Join("", options).TrimStart(',');
+                    }
+                }
+
+                var queryString = (_queryString == null || _queryString.Count == 0)
+                    ? string.Empty
+                    : ("?" + string.Join("&",
+                        _queryString.AllKeys.Select(a => HttpUtility.UrlEncode(a) + "=" + HttpUtility.UrlEncode(_queryString[a]))));
+                return $"git:{_gitCommit}@{_gitUrl}{queryString}";
             }
             else
             {

UET/Redpoint.Uet.Tests/EngineSpecTests.cs

@@ -19,6 +19,7 @@ public void Path()
             Assert.NotNull(spec);
             Assert.Equal(EngineSpecType.Path, spec.Type);
             Assert.Equal(Environment.CurrentDirectory, spec.Path);
+            Assert.Equal(Environment.CurrentDirectory, spec.ToBuildEngineSpecification(string.Empty).ToReparsableString());
         }
 
         [Fact]
@@ -34,6 +35,9 @@ public void Git()
             Assert.Equal(EngineSpecType.GitCommit, spec.Type);
             Assert.Equal("main", spec.GitCommit);
             Assert.Equal("[email protected]:group/repository.git", spec.GitUrl);
+            Assert.Equal(
+                "git:main@[email protected]:group/repository.git",
+                spec.ToBuildEngineSpecification(string.Empty).ToReparsableString());
         }
 
         [Fact]
@@ -55,6 +59,9 @@ public void GitLegacy()
             Assert.Equal("b", Assert.Single(spec.ZipLayers));
             Assert.Equal("c", spec.WindowsSharedGitCachePath);
             Assert.Equal("d", spec.MacSharedGitCachePath);
+            Assert.Equal(
+                "git:main@[email protected]:group/repository.git?config=z%3ab%2cwc%3ac%2cmc%3ad",
+                spec.ToBuildEngineSpecification(string.Empty).ToReparsableString());
         }
 
         [Fact]
@@ -63,7 +70,7 @@ public void GitWithOptions()
             var option = new Option<EngineSpec>("--engine", parseArgument: EngineSpec.ParseEngineSpecContextless());
             var result = option.Parse([
                 "--engine",
-                "git:main@[email protected]:group/repository.git?submodules=false&lfs=true&config=f:a,z:b,wc:c,mc:d"
+                "git:main@[email protected]:group/repository.git?submodules=false&lfs=true&lfsStoragePath=C%3A%5CGitLFSCache&config=f:a,z:b,wc:c,mc:d"
             ]);
             var spec = result.GetValueForOption(option);
             Assert.NotNull(spec);
@@ -72,13 +79,17 @@ public void GitWithOptions()
             Assert.Equal("[email protected]:group/repository.git", spec.GitUrl);
             Assert.Equal("false", spec.GitQueryString?["submodules"]);
             Assert.Equal("true", spec.GitQueryString?["lfs"]);
+            Assert.Equal(@"C:\GitLFSCache", spec.GitQueryString?["lfsStoragePath"]);
             Assert.Equal("f:a,z:b,wc:c,mc:d", spec.GitQueryString?["config"]);
             Assert.NotNull(spec.FolderLayers);
             Assert.Equal("a", Assert.Single(spec.FolderLayers));
             Assert.NotNull(spec.ZipLayers);
             Assert.Equal("b", Assert.Single(spec.ZipLayers));
             Assert.Equal("c", spec.WindowsSharedGitCachePath);
             Assert.Equal("d", spec.MacSharedGitCachePath);
+            Assert.Equal(
+                "git:main@[email protected]:group/repository.git?submodules=false&lfs=true&lfsStoragePath=C%3a%5cGitLFSCache&config=f%3aa%2cz%3ab%2cwc%3ac%2cmc%3ad",
+                spec.ToBuildEngineSpecification(string.Empty).ToReparsableString());
         }
 
         [Fact]
@@ -93,6 +104,9 @@ public void Uefs()
             Assert.NotNull(spec);
             Assert.Equal(EngineSpecType.UEFSPackageTag, spec.Type);
             Assert.Equal("example.com/path:tag", spec.UEFSPackageTag);
+            Assert.Equal(
+                "uefs:example.com/path:tag",
+                spec.ToBuildEngineSpecification(string.Empty).ToReparsableString());
         }
     }
 }

UET/uet/Commands/ParameterSpec/EngineSpec.cs

@@ -609,6 +609,10 @@ public BuildEngineSpecification ToBuildEngineSpecification(
                         GitCommit!,
                         ZipLayers,
                         isEngineBuild: false,
+                        windowsSharedGitCachePath:
+                            windowsSharedGitCachePath ?? WindowsSharedGitCachePath,
+                        macSharedGitCachePath:
+                            macSharedGitCachePath ?? MacSharedGitCachePath,
                         queryString: GitQueryString);
                 case EngineSpecType.SelfEngineByBuildConfig:
                     if (distributionSpec != null)