Try to sanitize invalid YAML containing unescaped double quotes (#970)

* Add test case for Stylelint message containing double quote
* Add YAML sanitation to parser

Author: pascalberger

src/Cake.Issues.Tap.Tests/LogFileFormat/StylelintLogFileFormatTests.cs

@@ -129,5 +129,30 @@ public void Should_Read_Issue_Correct_When_Parse_Error()
                     .OfRule("unknown")
                     .Create());
         }
+
+        [Fact]
+        public void Should_Read_Issue_Correct_When_Message_Contains_Double_Quotes()
+        {
+            // Given
+            var fixture = new TapIssuesProviderFixture<StylelintLogFileFormat>("double-quotes-in-message.tap");
+
+            // When
+            var issues = fixture.ReadIssues().ToList();
+
+            // Then
+            issues.Count.ShouldBe(1);
+
+            var issue = issues[0];
+            IssueChecker.Check(
+                issue,
+                IssueBuilder.NewIssue(
+                    "Unexpected \"width\" property. Use \"inline-size\". (csstools/use-logical)",
+                    "Cake.Issues.Tap.TapIssuesProvider",
+                    "TAP")
+                    .InFile("path/to/file.css", 13, 13, 3, 15)
+                    .WithPriority(IssuePriority.Error)
+                    .OfRule("csstools/use-logical")
+                    .Create());
+        }
     }
 }

src/Cake.Issues.Tap.Tests/Testfiles/StylelintLogFileFormat/double-quotes-in-message.tap

@@ -0,0 +1,12 @@
+TAP version 14
+1..1
+not ok 1 - path/to/file.css
+  ---
+  csstools/use-logical:
+    - message: "Unexpected "width" property. Use "inline-size". (csstools/use-logical)"
+      severity: error
+      line: 13
+      column: 3
+      endLine: 13
+      endColumn: 15
+  ...

src/Cake.Issues.Tap/Parser/TapParser.cs

@@ -2,6 +2,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Text.RegularExpressions;
 using YamlDotNet.Serialization;
 using YamlDotNet.Serialization.NamingConventions;
@@ -76,6 +77,9 @@ public void Parse(string tapContent)
     [GeneratedRegex(@"^#\s*(.*)$")]
     private static partial Regex CommentRegEx14();
 
+    [GeneratedRegex(": \"(.*)\"$")]
+    private static partial Regex YamlSanitizeUnescapedDoubeQuotesRegEx();
+
     /// <summary>
     /// Parses the content of a TAP file.
     /// </summary>
@@ -157,6 +161,38 @@ private void ParseVersion14(string[] lines)
 
     private void ParseYamlVersion14(List<string> yamlLines)
     {
+        // Deserializes YAML content into diagnostics of a TapTestPoint.
+        static void DeserializeYaml(TapTestPoint testPoint, string yamlContent)
+        {
+            var deserializer = new DeserializerBuilder()
+                .WithNamingConvention(CamelCaseNamingConvention.Instance)
+                .Build();
+            var yamlData = deserializer.Deserialize<Dictionary<string, object>>(yamlContent);
+
+            foreach (var entry in yamlData)
+            {
+                testPoint.Diagnostics[entry.Key] = entry.Value;
+            }
+        }
+
+        // Tries to sanitizes invalid YAML content reported by linters.
+        static string SanitizeYaml(string yamlContent)
+        {
+            var lines = yamlContent.Split('\n');
+            return string.Join("\n", lines.Select(line =>
+            {
+                // Replace unescaped double quotes with escaped double quotes.
+                var match = YamlSanitizeUnescapedDoubeQuotesRegEx().Match(line);
+                if (match.Success)
+                {
+                    var value = match.Groups[1].Value.Replace("\"", "\\\"");
+                    return line.Replace(match.Groups[1].Value, value);
+                }
+
+                return line;
+            }));
+        }
+
         if (this.Results.Count == 0)
         {
             return;
@@ -167,14 +203,13 @@ private void ParseYamlVersion14(List<string> yamlLines)
 
         try
         {
-            var deserializer = new DeserializerBuilder()
-                .WithNamingConvention(CamelCaseNamingConvention.Instance)
-                .Build();
-            var yamlData = deserializer.Deserialize<Dictionary<string, object>>(yamlContent);
-            foreach (var entry in yamlData)
-            {
-                lastResult.Diagnostics[entry.Key] = entry.Value;
-            }
+            DeserializeYaml(lastResult, yamlContent);
+        }
+        catch (YamlDotNet.Core.SemanticErrorException)
+        {
+            // Attempt to sanitize and retry parsing
+            yamlContent = SanitizeYaml(yamlContent);
+            DeserializeYaml(lastResult, yamlContent);
         }
         catch (Exception ex)
         {