Ignore Comments in .rsp files

Example of an .rsp file: "/example/to/binary/example.exe" # Binary # ---- Libraries ---- "/example/to/libraries/library1.dll" "/example/to/libraries/library2.dll" would result in: "/example/to/binary/example.exe" "/example/to/libraries/library1.dll" "/example/to/libraries/library2.dll"
microsoft · Oct 30, 2024 · a4d66a2 · a4d66a2
1 parent 8d31b06
commit a4d66a2
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 1 deletion.
diff --git a/src/BinSkim.Driver/ExpandArguments.cs b/src/BinSkim.Driver/ExpandArguments.cs
@@ -48,7 +48,16 @@ private static void ExpandResponseFile(string[] responseFileLines, List<string>
         {
             foreach (string responseFileLine in responseFileLines)
             {
-                List<string> fileList = ArgumentSplitter.CommandLineToArgvW(responseFileLine.Trim()) ??
+                string responseFilePath = responseFileLine;
+
+                // Ignore comments from response file lines
+                int commentIndex = responseFileLine.IndexOf('#');
+                if (commentIndex >= 0)
+                {
+                    responseFilePath = responseFileLine.Substring(0, commentIndex);
+                }
+
+                List<string> fileList = ArgumentSplitter.CommandLineToArgvW(responseFilePath.Trim()) ??
                     throw new InvalidOperationException("Could not parse response file line:" + responseFileLine);
 
                 expandedArguments.AddRange(fileList);

diff --git a/src/Test.UnitTests.BinSkim.Driver/ExpandArgumentsUnitTests.cs b/src/Test.UnitTests.BinSkim.Driver/ExpandArgumentsUnitTests.cs
@@ -90,6 +90,32 @@ public void GenerateArguments_ExpandsResponseFileContents(string[] rspContent, s
             environmentVariablesMock.Verify(ev => ev.ExpandEnvironmentVariables(ResponseFileName), Times.Once);
         }
 
+        [Theory]
+        [InlineData(new[] { "/b", "/c:val /d", "# Random Comment" ,"   /e   " }, new[] { "/a", "/b", "/c:val", "/d", "/e", "/f" })]
+        [InlineData(new[] { "/b", "/c:val /d#Another Comment", "   /e   " }, new[] { "/a", "/b", "/c:val", "/d", "/e", "/f" })]
+        public void GenerateArguments_TrimCommentsFromResponseFileContents(string[] rspContent, string[] expected)
+        {
+            const string ResponseFileName = "Mocked.rsp";
+            string[] args = new[] { "/a", "@" + ResponseFileName, "/f" };
+
+            SetupTestMocks(
+                ResponseFileName,
+                rspContent,
+                out Mock<IFileSystem> fileSystemMock,
+                out Mock<IEnvironmentVariables> environmentVariablesMock);
+
+            IFileSystem fileSystem = fileSystemMock.Object;
+            IEnvironmentVariables environmentVariables = environmentVariablesMock.Object;
+
+            string[] result = ExpandArguments.GenerateArguments(args, fileSystem, environmentVariables);
+
+            result.Should().ContainInOrder(expected);
+
+            fileSystemMock.Verify(fs => fs.PathGetFullPath(ResponseFileName), Times.Once);
+            fileSystemMock.Verify(fs => fs.FileReadAllLines(ResponseFileName), Times.Once);
+            environmentVariablesMock.Verify(ev => ev.ExpandEnvironmentVariables(ResponseFileName), Times.Once);
+        }
+
         [Theory]
         [InlineData(new[] { "a \"one two\" b" }, new[] { "a", "one two", "b" })]
         public void GenerateArguments_StripsQuotesFromAroundArgsWithSpacesInResponseFiles(string[] rspContent, string[] expected)