Support absolute paths in TAP stylelint format (#974)

Author: pascalberger

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

@@ -154,5 +154,67 @@ public void Should_Read_Issue_Correct_When_Message_Contains_Double_Quotes()
                     .OfRule("csstools/use-logical")
                     .Create());
         }
+
+        [Theory]
+        [InlineData(@"c:\Source\Cake.Issues", "test.scss")]
+        [InlineData(@"c:\Source\Cake.Issues\", "test.scss")]
+        [InlineData(@"c:/Source/Cake.Issues", "test.scss")]
+        [InlineData(@"c:/Source/Cake.Issues/", "test.scss")]
+        [InlineData(@"c:\Source", @"Cake.Issues\test.scss")]
+        [InlineData(@"c:\Source\", @"Cake.Issues\test.scss")]
+        [InlineData(@"c:/Source", @"Cake.Issues\test.scss")]
+        [InlineData(@"c:/Source/", @"Cake.Issues\test.scss")]
+        public void Should_Read_Issue_Correct_When_Absolute_Windows_Path(string repositoryRoot, string relativeFilePath)
+        {
+            // Given
+            var fixture = new TapIssuesProviderFixture<StylelintLogFileFormat>("absolute-windows-path.tap", repositoryRoot);
+
+            // When
+            var issues = fixture.ReadIssues().ToList();
+
+            // Then
+            issues.Count.ShouldBe(1);
+
+            var issue = issues[0];
+            IssueChecker.Check(
+                issue,
+                IssueBuilder.NewIssue(
+                    "Unexpected empty block (block-no-empty)",
+                    "Cake.Issues.Tap.TapIssuesProvider",
+                    "TAP")
+                    .InFile(relativeFilePath, 16, 16, 6, 8)
+                    .WithPriority(IssuePriority.Error)
+                    .OfRule("block-no-empty")
+                    .Create());
+        }
+
+        [Theory]
+        [InlineData("/src/Cake.Issues", "test.scss")]
+        [InlineData("/src/Cake.Issues/", "test.scss")]
+        [InlineData("/src", "Cake.Issues/test.scss")]
+        [InlineData("/src/", "Cake.Issues/test.scss")]
+        public void Should_Read_Issue_Correct_When_Absolute_Linux_Path(string repositoryRoot, string relativeFilePath)
+        {
+            // Given
+            var fixture = new TapIssuesProviderFixture<StylelintLogFileFormat>("absolute-linux-path.tap", repositoryRoot);
+
+            // When
+            var issues = fixture.ReadIssues().ToList();
+
+            // Then
+            issues.Count.ShouldBe(1);
+
+            var issue = issues[0];
+            IssueChecker.Check(
+                issue,
+                IssueBuilder.NewIssue(
+                    "Unexpected empty block (block-no-empty)",
+                    "Cake.Issues.Tap.TapIssuesProvider",
+                    "TAP")
+                    .InFile(relativeFilePath, 16, 16, 6, 8)
+                    .WithPriority(IssuePriority.Error)
+                    .OfRule("block-no-empty")
+                    .Create());
+        }
     }
 }

src/Cake.Issues.Tap.Tests/TapIssuesProviderFixture.cs

@@ -5,10 +5,15 @@ internal class TapIssuesProviderFixture<T>
     where T : BaseTapLogFileFormat
 {
     public TapIssuesProviderFixture(string fileResourceName)
+        : this(fileResourceName, @"c:\Source\Cake.Issues")
+    {
+    }
+
+    public TapIssuesProviderFixture(string fileResourceName, string repositoryRoot)
         : base(fileResourceName)
     {
         this.ReadIssuesSettings =
-            new ReadIssuesSettings(@"c:\Source\Cake.Issues");
+            new ReadIssuesSettings(repositoryRoot);
     }
 
     protected override string FileResourceNamespace => "Cake.Issues.Tap.Tests.Testfiles." + typeof(T).Name + ".";

src/Cake.Issues.Tap.Tests/Testfiles/StylelintLogFileFormat/absolute-linux-path.tap

@@ -0,0 +1,12 @@
+TAP version 14
+1..153
+not ok 123 - /src/Cake.Issues/test.scss
+  ---
+  block-no-empty:
+    - message: "Unexpected empty block (block-no-empty)"
+      severity: error
+      line: 16
+      column: 6
+      endLine: 16
+      endColumn: 8
+  ...

src/Cake.Issues.Tap.Tests/Testfiles/StylelintLogFileFormat/absolute-windows-path.tap

@@ -0,0 +1,12 @@
+TAP version 14
+1..153
+not ok 123 - c:\Source\Cake.Issues\test.scss
+  ---
+  block-no-empty:
+    - message: "Unexpected empty block (block-no-empty)"
+      severity: error
+      line: 16
+      column: 6
+      endLine: 16
+      endColumn: 8
+  ...

src/Cake.Issues.Tap/BaseTapLogFileFormat.cs

@@ -1,6 +1,7 @@
 namespace Cake.Issues.Tap;
 
 using Cake.Core.Diagnostics;
+using Cake.Core.IO;
 
 /// <summary>
 /// Base class for all log file formats supported by the TAP issue provider.
@@ -9,4 +10,23 @@
 public abstract class BaseTapLogFileFormat(ICakeLog log)
     : BaseLogFileFormat<TapIssuesProvider, TapIssuesSettings>(log)
 {
+    /// <summary>
+    /// Validates a file path.
+    /// </summary>
+    /// <param name="filePath">Full file path.</param>
+    /// <param name="repositorySettings">Repository settings.</param>
+    /// <returns>Tuple containing a value if validation was successful, and file path relative to repository root.</returns>
+    protected static (bool Valid, string FilePath) ValidateFilePath(string filePath, IRepositorySettings repositorySettings)
+    {
+        filePath.NotNullOrWhiteSpace();
+        repositorySettings.NotNull();
+
+        // Make path relative to repository root.
+        if (!new FilePath(filePath).IsRelative)
+        {
+            filePath = filePath.NormalizePath().MakeFilePathRelativeToRepositoryRoot(repositorySettings);
+        }
+
+        return (true, filePath);
+    }
 }

src/Cake.Issues.Tap/LogFileFormat/StylelintLogFileFormat.cs

@@ -37,12 +37,19 @@ public override IEnumerable<IIssue> ReadIssues(
                     {
                         if (diagnostic is Dictionary<object, object> diagnosticDict)
                         {
+                            // Read affected file from the result.
+                            if (!TryGetFile(tapResult, repositorySettings, out var fileName))
+                            {
+                                this.Log.Information("Skip element since file path could not be parsed");
+                                continue;
+                            }
+
                             // Build issue.
                             var issueBuilder =
                                 IssueBuilder
                                     .NewIssue(diagnosticDict["message"].ToString(), issueProvider)
                                     .InFile(
-                                        tapResult.Description.ToString(),
+                                        fileName,
                                         diagnosticDict.ContainsKey("line") ? int.Parse(diagnosticDict["line"].ToString()) : null,
                                         diagnosticDict.ContainsKey("endLine") ? int.Parse(diagnosticDict["endLine"].ToString()) : null,
                                         diagnosticDict.ContainsKey("column") ? int.Parse(diagnosticDict["column"].ToString()) : null,
@@ -65,4 +72,23 @@ public override IEnumerable<IIssue> ReadIssues(
         "warning" => IssuePriority.Warning,
         _ => IssuePriority.Undefined,
     };
+
+    /// <summary>
+    /// Reads the affected file path from a result.
+    /// </summary>
+    /// <param name="tapResult">Result entry.</param>
+    /// <param name="repositorySettings">Repository settings to use.</param>
+    /// <param name="fileName">Returns the full path to the affected file.</param>
+    /// <returns>True if the file path could be parsed.</returns>
+    private static bool TryGetFile(
+        TapTestPoint tapResult,
+        IRepositorySettings repositorySettings,
+        out string fileName)
+    {
+        fileName = tapResult.Description.ToString();
+
+        // Validate file path and make relative to repository root.
+        (var result, fileName) = ValidateFilePath(fileName, repositorySettings);
+        return result;
+    }
 }