Add support for response files (#2320)

* Add support for response files I make workaround here for now, but essentially issues in CommadLine library. Also place workardoud for stupid bug with quoted argumetns with space in them. I notice issue with parsing and request for RSP on Discord where @kg and @radical discuss how to feed proper parameters in `benchmarks_ci.py` * Address PR feedback
dotnet · Jun 30, 2023 · 977c05e · 977c05e
1 parent 58ee5c7
commit 977c05e
Show file tree

Hide file tree

Showing 2 changed files with 149 additions and 0 deletions.
diff --git a/src/BenchmarkDotNet/ConsoleArguments/ConfigParser.cs b/src/BenchmarkDotNet/ConsoleArguments/ConfigParser.cs
@@ -3,6 +3,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
+using System.Text;
 using BenchmarkDotNet.Columns;
 using BenchmarkDotNet.Configs;
 using BenchmarkDotNet.Diagnosers;
@@ -75,6 +76,13 @@ public static (bool isSuccess, IConfig config, CommandLineOptions options) Parse
         {
             (bool isSuccess, IConfig config, CommandLineOptions options) result = default;
 
+            var (expandSuccess, expandedArgs) = ExpandResponseFile(args, logger);
+            if (!expandSuccess)
+            {
+                return (false, default, default);
+            }
+
+            args = expandedArgs;
             using (var parser = CreateParser(logger))
             {
                 parser
@@ -86,6 +94,115 @@ public static (bool isSuccess, IConfig config, CommandLineOptions options) Parse
             return result;
         }
 
+        private static (bool Success, string[] ExpandedTokens) ExpandResponseFile(string[] args, ILogger logger)
+        {
+            List<string> result = new ();
+            foreach (var arg in args)
+            {
+                if (arg.StartsWith("@"))
+                {
+                    var fileName = arg.Substring(1);
+                    try
+                    {
+                        if (File.Exists(fileName))
+                        {
+                            var lines = File.ReadAllLines(fileName);
+                            foreach (var line in lines)
+                            {
+                                result.AddRange(ConsumeTokens(line));
+                            }
+                        }
+                        else
+                        {
+                            logger.WriteLineError($"Response file {fileName} does not exists.");
+                            return (false, Array.Empty<string>());
+                        }
+                    }
+                    catch (Exception ex)
+                    {
+                        logger.WriteLineError($"Failed to parse RSP file: {fileName}, {ex.Message}");
+                        return (false, Array.Empty<string>());
+                    }
+                }
+                else
+                {
+                    if (arg.Contains(' '))
+                    {
+                        // Workaround for CommandLine library issue with parsing these kind of args.
+                        result.Add(" " + arg);
+                    }
+                    else
+                    {
+                        result.Add(arg);
+                    }
+                }
+            }
+
+            return (true, result.ToArray());
+        }
+
+        private static IEnumerable<string> ConsumeTokens(string line)
+        {
+            bool insideQuotes = false;
+            var token = new StringBuilder();
+            for (int i = 0; i < line.Length; i++)
+            {
+                char currentChar = line[i];
+                if (currentChar == ' ' && !insideQuotes)
+                {
+                    if (token.Length > 0)
+                    {
+                        yield return GetToken();
+                        token = new StringBuilder();
+                    }
+
+                    continue;
+                }
+
+                if (currentChar == '"')
+                {
+                    insideQuotes = !insideQuotes;
+                    continue;
+                }
+
+                if (currentChar == '\\' && insideQuotes)
+                {
+                    if (line[i + 1] == '"')
+                    {
+                        insideQuotes = false;
+                        i++;
+                        continue;
+                    }
+
+                    if (line[i + 1] == '\\')
+                    {
+                        token.Append('\\');
+                        i++;
+                        continue;
+                    }
+                }
+
+                token.Append(currentChar);
+            }
+
+            if (token.Length > 0)
+            {
+                yield return GetToken();
+            }
+
+            string GetToken()
+            {
+                var result = token.ToString();
+                if (result.Contains(' '))
+                {
+                    // Workaround for CommandLine library issue with parsing these kind of args.
+                    return " " + result;
+                }
+
+                return result;
+            }
+        }
+
         internal static bool TryUpdateArgs(string[] args, out string[]? updatedArgs, Action<CommandLineOptions> updater)
         {
             (bool isSuccess, CommandLineOptions options) result = default;

diff --git a/tests/BenchmarkDotNet.Tests/ConfigParserTests.cs b/tests/BenchmarkDotNet.Tests/ConfigParserTests.cs
@@ -587,6 +587,38 @@ public void UsersCanSpecifyWithoutOverheadEvalution()
             }
         }
 
+        [Fact]
+        public void UserCanSpecifyWasmArgs()
+        {
+            var parsedConfiguration = ConfigParser.Parse(new[] { "--runtimes", "wasm", "--wasmArgs", "--expose_wasm --module" }, new OutputLogger(Output));
+            Assert.True(parsedConfiguration.isSuccess);
+            var jobs = parsedConfiguration.config.GetJobs();
+            foreach (var job in parsedConfiguration.config.GetJobs())
+            {
+                var wasmRuntime = Assert.IsType<WasmRuntime>(job.Environment.Runtime);
+                Assert.Equal(" --expose_wasm --module", wasmRuntime.JavaScriptEngineArguments);
+            }
+        }
+
+        [Fact]
+        public void UserCanSpecifyWasmArgsViaResponseFile()
+        {
+            var tempResponseFile = Path.GetRandomFileName();
+            File.WriteAllLines(tempResponseFile, new[]
+            {
+                "--runtimes wasm",
+                "--wasmArgs \"--expose_wasm --module\""
+            });
+            var parsedConfiguration = ConfigParser.Parse(new[] { $"@{tempResponseFile}" }, new OutputLogger(Output));
+            Assert.True(parsedConfiguration.isSuccess);
+            var jobs = parsedConfiguration.config.GetJobs();
+            foreach (var job in parsedConfiguration.config.GetJobs())
+            {
+                var wasmRuntime = Assert.IsType<WasmRuntime>(job.Environment.Runtime);
+                Assert.Equal(" --expose_wasm --module", wasmRuntime.JavaScriptEngineArguments);
+            }
+        }
+
         [Theory]
         [InlineData("--filter abc", "--filter *")]
         [InlineData("-f abc", "--filter *")]